Renamed -version switch to -Version to remove the conflict with -verbose.
[mmh] / man / ap.man8
index af967df..c96770c 100644 (file)
@@ -10,12 +10,8 @@ ap \- parse addresses 822-style
 .B %libdir%/ap
 .RB [ \-form
 .IR formatfile ]
-.RB [ \-format
-.IR string ]
 .RB [ \-normalize " | " \-nonormalize ]
-.RB [ \-width
-.IR columns ]
-.RB [ \-version ]
+.RB [ \-Version ]
 .RB [ \-help ]
 .I addrs
 \&...
@@ -37,14 +33,15 @@ usually best to enclose each argument in double\-quotes for the shell.
 To override the output format used by
 .BR ap ,
 the
-.B \-format
-.I string
-or
-.B \-format
+.B \-form
 .I file
-switches are used.  This permits individual fields of
-the address to be extracted with ease.  The string is simply a format
-string, and the file is simply a format file.  See
+switch is used.  This permits individual fields of
+the address to be extracted with ease.
+The
+.I file
+is either the name of a format file or it may be
+a format string directly, if prepended with an equal sign `='.
+See
 .BR mh\-format (5)
 for the details.
 .PP
@@ -55,7 +52,7 @@ also recognizes the following additional escape:
 .RS 5
 .nf
 .ta \w'Escape  'u +\w'Returns  'u
-.I Escape      Returns Description
+.I "Escape     Returns Description
 error  string  A diagnostic if the parse failed
 .RE
 .fi
@@ -71,7 +68,9 @@ Here is the default format string used by
 .BR ap :
 .PP
 .RS 5
+.nf
 %<{error}%{error}: %{text}%|%(putstr(proper{text}))%>
+.fi
 .RE
 .PP
 which says that if an error was detected, print the error, a `:', and
@@ -95,19 +94,9 @@ dp(8),
 
 .SH DEFAULTS
 .nf
-.RB ` \-format "' defaults as described above"
+.RB ` \-form "' defaults as described above"
 .RB ` \-normalize '
-.RB ` \-width "' defaults to the width of the terminal"
 .fi
 
 .SH CONTEXT
 None
-
-.SH BUGS
-The argument to the
-.B \-format
-switch must be interpreted as a single token
-by the shell that invokes
-.BR ap .
-Therefore,
-one must usually place the argument to this switch inside double\-quotes.