X-Git-Url: http://git.marmaro.de/?p=mmh;a=blobdiff_plain;f=man%2Fap.man;h=c77b39ede574cb0f79bf2eb564c9a01875045737;hp=d4c24a9e86024d9b03c0b756ca101924f1c11fc1;hb=5dd6771b28c257af405d7248639ed0e3bcdce38b;hpb=1691e80890e5d8ba258c51c214a3e91880e1db2b diff --git a/man/ap.man b/man/ap.man index d4c24a9..c77b39e 100644 --- a/man/ap.man +++ b/man/ap.man @@ -1,84 +1,114 @@ .\" .\" %nmhwarning% -.\" $Id$ .\" -.\" include the -mh macro file -.so %etcdir%/tmac.h -.\" -.TH AP %manext8% MH.6.8 [%nmhversion%] +.TH AP %manext8% "%nmhdate%" MH.6.8 [%nmhversion%] .SH NAME ap \- parse addresses 822-style .SH SYNOPSIS -.in +.5i -.ti -.5i -%libdir%/ap -\%[\-form\ formatfile] -.br -\%[\-format\ string] -\%[\-normalize] \%[\-nonormalize] -.br -\%[\-width\ columns] -addrs\ ... -.br -\%[\-version] -\%[\-help] -.in -.5i +.HP 5 +.na +.B %libdir%/ap +.RB [ \-form +.IR formatfile ] +.RB [ \-format +.IR string ] +.RB [ \-normalize " | " \-nonormalize ] +.RB [ \-width +.IR columns ] +.RB [ \-version ] +.RB [ \-help ] +.I addrs +\&... +.ad .SH DESCRIPTION -\fIAp\fR is a program that parses addresses according to the ARPA +.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 \fInmh\fR will interpret an address. - -The \fIap\fR program treats each argument as one or more addresses, and +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 822\-format. Hence, it is usually best to enclose each argument in double\-quotes for the shell. - -To override the output format used by \fIap\fR, the `\-format\ string' or -`\-format\ file' switches are used. This permits individual fields of +.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 \fImh\-format\fR\0(5) +string, and the file is simply a format file. See +.BR mh\-format (5) for the details. - +.PP In addition to the standard escapes, -\fIap\fR also recognizes the following additional escape: -.sp 1 +.B ap +also recognizes the following additional escape: +.PP +.RS 5 .nf .ta \w'Escape 'u +\w'Returns 'u -\fIEscape\fR \fIReturns\fR \fIDescription\fR +.I Escape Returns Description error string A diagnostic if the parse failed -.re +.RE .fi - -If the `\-normalize' switch is given, \fIap\fR will try to track down +.PP +If the +.B \-normalize +switch is given, +.B ap +will try to track down the official hostname of the address. - -Here is the default format string used by \fIap\fR: - -.ti +.5i +.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 822\-proper format of the address. -.Fi + +.SH FILES +.fc ^ ~ +.nf +.ta \w'%etcdir%/ExtraBigFileName 'u ^$HOME/\&.mh\(ruprofile~^The user profile ^%etcdir%/mts.conf~^nmh mts configuration file -.Pr +.fi + +.SH "PROFILE COMPONENTS" None -.Sa + +.SH "SEE ALSO" dp(8), -.br -\fIStandard for the Format of ARPA Internet Text Messages\fR (RFC\-822) -.De -`\-format' defaults as described above -.Ds -`\-normalize' -.Ds -`\-width' defaults to the width of the terminal -.Co +.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 + +.SH CONTEXT None -.Bu -The argument to the `\-format' switch must be interpreted as a single token -by the shell that invokes \fIap\fR. + +.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. -.En