.TH AP 8mh 2013-12-05 "nmh-1.8"
.
.\" THIS FILE HAS BEEN AUTOMATICALLY GENERATED.  DO NOT EDIT.
.
.SH NAME
ap \- nmh parser of RFC 822-style addresses
.SH SYNOPSIS
.HP 5
.na
.B /usr/lib/mh/ap
.RB [ \-help ]
.RB [ \-version ]
.RB [ \-form
.IR formatfile ]
.RB [ \-format
.IR string ]
.RB [ \-width
.IR columns ]
.I addrs
\&...
.ad
.SH DESCRIPTION
.B ap
is a program that parses addresses according to the ARPA
Internet standard.  It also understands many non-standard formats.
It is useful for seeing how
.B nmh
will interpret an address.
.PP
The
.B ap
program treats each argument as one or more addresses, and
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 ,
the
.B \-format
.I string
or
.B \-format
.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
.IR mh\-format (5)
for the details.
.PP
In addition to the standard escapes,
.B ap
also recognizes the following additional escape:
.PP
.RS 5
.nf
.ta \w'Escape  'u +\w'Returns  'u
.I "Escape	Returns	Description"
error	string	A diagnostic if the parse failed
.RE
.fi
.PP
Here is the default format string used by
.BR ap :
.PP
.RS 5
%<{error}%{error}: %{text}%|%(putstr(proper{text}))%>
.RE
.PP
which says that if an error was detected, print the error, a `:', and
the address in error.  Otherwise, output the RFC 822\-proper format of
the address.
.SH FILES
.PD 0
.TP 20
$HOME/.mh_profile
The user's profile.
.TP
/etc/nmh/mts.conf
The mts configuration file.
.PD
.SH "PROFILE COMPONENTS"
None
.SH "SEE ALSO"
.IR fmttest (1),
.IR dp (8)
.PP
.I
Standard for the Format of ARPA Internet Text Messages
(RFC 822)
.SH DEFAULTS
.PD 0
.TP 20
-format
As described above.
.TP
\-width
The width of the terminal.
.PD
.SH CONTEXT
None