]> diplodocus.org Git - nmh/blobdiff - man/ap.man
prevent spurious errors when requesting specific message parts
[nmh] / man / ap.man
index a7d79a7419da9524178753e8a34059e2dfab131d..375a4fa1aa88f7d5e0cd5078784c1773ab4b0e06 100644 (file)
@@ -1,19 +1,17 @@
+.TH AP %manext8% "December 4, 2013" "%nmhversion%"
 .\"
 .\" %nmhwarning%
-.\" $Id$
 .\"
-.TH AP %manext8% "%nmhdate%" MH.6.8 [%nmhversion%]
 .SH NAME
-ap \- parse addresses 822-style
+ap \- parse addresses RFC 822-style
 .SH SYNOPSIS
 .HP 5
 .na
-.B %libdir%/ap
+.B %nmhlibexecdir%/ap
 .RB [ \-form
 .IR formatfile ]
 .RB [ \-format
 .IR string ]
-.RB [ \-normalize " | " \-nonormalize ]
 .RB [ \-width
 .IR columns ]
 .RB [ \-version ]
@@ -32,8 +30,8 @@ will interpret an address.
 The
 .B ap
 program treats each argument as one or more addresses, and
-prints those addresses out in the official 822\-format.  Hence, it is
-usually best to enclose each argument in double\-quotes for the shell.
+prints those addresses out in the official RFC 822 format.  Hence, it is
+usually best to enclose each argument in quotes for the shell.
 .PP
 To override the output format used by
 .BR ap ,
@@ -46,7 +44,7 @@ or
 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
-.BR mh\-format (5)
+.IR mh\-format (5)
 for the details.
 .PP
 In addition to the standard escapes,
@@ -56,18 +54,11 @@ 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
 .PP
-If the
-.B \-normalize
-switch is given,
-.B ap
-will try to track down
-the official hostname of the address.
-.PP
 Here is the default format string used by
 .BR ap :
 .PP
@@ -76,40 +67,33 @@ Here is the default format string used by
 .RE
 .PP
 which says that if an error was detected, print the error, a `:', and
-the address in error.  Otherwise, output the 822\-proper format of
+the address in error.  Otherwise, output the RFC 822\-proper format of
 the address.
-
 .SH FILES
-.fc ^ ~
-.nf
-.ta \w'/usr/local/nmh/etc/ExtraBigFileName  'u
-^$HOME/\&.mh\(ruprofile~^The user profile
-^%etcdir%/mts.conf~^nmh mts configuration file
-.fi
-
+.PD 0
+.TP 20
+$HOME/\&.mh\(ruprofile
+The user's profile.
+.TP
+%nmhetcdir%/mts.conf
+The mts configuration file.
+.PD
 .SH "PROFILE COMPONENTS"
 None
-
 .SH "SEE ALSO"
-dp(8),
-.I "Standard for the Format of ARPA Internet Text Messages"
-(RFC\-822)
-
+.IR dp (8)
+.PP
+.I
+Standard for the Format of ARPA Internet Text Messages
+(RFC 822)
 .SH DEFAULTS
-.nf
-.RB ` \-format "' defaults as described above"
-.RB ` \-normalize '
-.RB ` \-width "' defaults to the width of the terminal"
-.fi
-
+.PD 0
+.TP 20
+-format
+As described above.
+.TP
+\-width
+The width of the terminal.
+.PD
 .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.