git.marmaro.de Git - mmh/blob - docs/historical/mh-6.8.5/conf/doc/RCS/ap.rf,v

   1 head    1.7;
   2 access;
   3 symbols;
   4 locks; strict;
   5
   6
   7 1.7
   8 date    92.05.12.22.23.34;      author jromine; state Exp;
   9 branches;
  10 next    1.6;
  11
  12 1.6
  13 date    90.04.05.15.10.21;      author sources; state Exp;
  14 branches;
  15 next    1.5;
  16
  17 1.5
  18 date    90.03.22.11.30.49;      author sources; state Exp;
  19 branches;
  20 next    1.4;
  21
  22 1.4
  23 date    90.03.20.19.41.25;      author sources; state Exp;
  24 branches;
  25 next    1.3;
  26
  27 1.3
  28 date    90.03.20.17.35.43;      author sources; state Exp;
  29 branches;
  30 next    1.2;
  31
  32 1.2
  33 date    90.03.16.15.57.20;      author sources; state Exp;
  34 branches;
  35 next    1.1;
  36
  37 1.1
  38 date    90.03.16.15.56.13;      author sources; state Exp;
  39 branches;
  40 next    ;
  41
  42
  43 desc
  44 @@
  45
  46
  47 1.7
  48 log
  49 @fixup for nroff problems
  50 @
  51 text
  52 @.\"    @@(MHWARNING)
  53 .\" @@(#)$Id: ap.rf,v 1.6 1990/04/05 15:10:21 sources Exp jromine $
  54 .SC AP 8
  55 .NA
  56 ap \- parse addresses 822-style
  57 .SY
  58 @@(MHETCPATH)/ap
  59 \%[\-form\ formatfile]
  60 \%[\-format\ string]
  61 \%[\-normalize] \%[\-nonormalize]
  62 \%[\-width\ columns]
  63 addrs\ ...
  64 \%[\-help]
  65 .DE
  66 \fIAp\fR is a program that parses addresses according to the ARPA Internet
  67 standard.
  68 It also understands many non\-standard formats.
  69 It is useful for seeing how \fIMH\fR will interpret an address.
  70
  71 The \fIap\fR program treats each argument as one or more addresses,
  72 and prints those addresses out in the official 822\-format.
  73 Hence, it is usually best to enclose each argument in double\-quotes for the
  74 shell.
  75
  76 To override the output format used by \fIap\fR,
  77 the `\-format\ string' or `\-format\ file' switches are used.
  78 This permits individual fields of the address to be extracted with ease.
  79 The string is simply a format stringand thefile is simply a format file.
  80 See \fImh\-format\fR\0(5) for the details.
  81
  82 In addition to the standard escapes,
  83 \fIap\fR also recognizes the following additional escape:
  84 .sp 1
  85 .nf
  86 .ta \w'Escape  'u +\w'Returns  'u
  87 \fIEscape\fR    \fIReturns\fR   \fIDescription\fR
  88 error   string  A diagnostic if the parse failed
  89 .re
  90 .fi
  91
  92 If the `\-normalize' switch is given,
  93 \fIap\fR will try to track down the official hostname of the address.
  94
  95 Here is the default format string used by \fIap\fR:
  96
  97 .ti +.5i
  98 %<{error}%{error}: %{text}%|%(putstr(proper{text}))%>
  99
 100 which says that if an error was detected, print the error, a `:',
 101 and the address in error.
 102 Otherwise, output the 822\-proper format of the address.
 103 .Fi
 104 ^$HOME/\&.mh\(ruprofile~^The user profile
 105 ^@@(MHETCPATH)/mtstailor~^tailor file
 106 .Pr
 107 None
 108 .Sa
 109 dp(8),
 110 .br
 111 \fIStandard for the Format of ARPA Internet Text Messages\fR (aka RFC\-822)
 112 .De
 113 `\-format' defaults as described above
 114 .Ds
 115 `\-normalize'
 116 .Ds
 117 `\-width' defaults to the width of the terminal
 118 .Co
 119 None
 120 .Bu
 121 The argument to the `\-format' switch must be interpreted as a single token
 122 by the shell that invokes \fIap\fR.
 123 Therefore,
 124 one must usually place the argument to this switch inside double\-quotes.
 125
 126 On hosts where \fIMH\fR was configured with the BERK option,
 127 address parsing is not enabled.
 128 .En
 129 @
 130
 131
 132 1.6
 133 log
 134 @add ID
 135 @
 136 text
 137 @d2 1
 138 a2 1
 139 .\" @@(#)$Id:$
 140 d5 1
 141 a5 1
 142 ap \- parse addresses 822\-style
 143 @
 144
 145
 146 1.5
 147 log
 148 @put things back, do .NA stuff another way
 149 @
 150 text
 151 @d2 1
 152 @
 153
 154
 155 1.4
 156 log
 157 @typo
 158 @
 159 text
 160 @d2 2
 161 a3 2
 162 .TH AP 8 @@(MHCENTERFOOT) @@(MHLEFTFOOT)
 163 .SH .NA
 164 d5 1
 165 a5 1
 166 .SH .SY
 167 @
 168
 169
 170 1.3
 171 log
 172 @fixup for makewhatis
 173 @
 174 text
 175 @d2 1
 176 a2 1
 177 .TH AP 8 [mh.6] MH
 178 @
 179
 180
 181 1.2
 182 log
 183 @fixup
 184 @
 185 text
 186 @d2 2
 187 a3 2
 188 .SC AP 8
 189 .NA
 190 d5 1
 191 a5 1
 192 .SY
 193 @
 194
 195
 196 1.1
 197 log
 198 @Initial revision
 199 @
 200 text
 201 @d31 2
 202 a32 1
 203 \fIscan\fR also recognizes the following additional escape:
 204 d34 3
 205 a36 3
 206 .ta \w'escape  'u
 207 \fIescape\fR    \fIsubstitution\fR
 208 error   a diagnostic if the parse failed
 209 @