annotate conf/doc/ap.rf @ 12:441a2190cfae

Lion fix
author Shinji KONO <kono@ie.u-ryukyu.ac.jp>
date Sat, 21 Apr 2012 13:10:49 +0900
parents bce86c4163a3
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
bce86c4163a3 Initial revision
kono
parents:
diff changeset
1 .\" @(MHWARNING)
12
441a2190cfae Lion fix
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 0
diff changeset
2 .\" @(#)$Id: ap.rf,v 1.1.1.1 2005/04/18 14:46:03 kono Exp $
0
bce86c4163a3 Initial revision
kono
parents:
diff changeset
3 .SC AP 8
bce86c4163a3 Initial revision
kono
parents:
diff changeset
4 .NA
bce86c4163a3 Initial revision
kono
parents:
diff changeset
5 ap \- parse addresses 822-style
bce86c4163a3 Initial revision
kono
parents:
diff changeset
6 .SY
bce86c4163a3 Initial revision
kono
parents:
diff changeset
7 @(MHETCPATH)/ap
bce86c4163a3 Initial revision
kono
parents:
diff changeset
8 \%[\-form\ formatfile]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
9 \%[\-format\ string]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
10 \%[\-normalize] \%[\-nonormalize]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
11 \%[\-width\ columns]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
12 addrs\ ...
bce86c4163a3 Initial revision
kono
parents:
diff changeset
13 \%[\-help]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
14 .DE
bce86c4163a3 Initial revision
kono
parents:
diff changeset
15 \fIAp\fR is a program that parses addresses according to the ARPA Internet
bce86c4163a3 Initial revision
kono
parents:
diff changeset
16 standard.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
17 It also understands many non\-standard formats.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
18 It is useful for seeing how \fIMH\fR will interpret an address.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
19
bce86c4163a3 Initial revision
kono
parents:
diff changeset
20 The \fIap\fR program treats each argument as one or more addresses,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
21 and prints those addresses out in the official 822\-format.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
22 Hence, it is usually best to enclose each argument in double\-quotes for the
bce86c4163a3 Initial revision
kono
parents:
diff changeset
23 shell.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
24
bce86c4163a3 Initial revision
kono
parents:
diff changeset
25 To override the output format used by \fIap\fR,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
26 the `\-format\ string' or `\-format\ file' switches are used.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
27 This permits individual fields of the address to be extracted with ease.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
28 The string is simply a format stringand thefile is simply a format file.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
29 See \fImh\-format\fR\0(5) for the details.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
30
bce86c4163a3 Initial revision
kono
parents:
diff changeset
31 In addition to the standard escapes,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
32 \fIap\fR also recognizes the following additional escape:
bce86c4163a3 Initial revision
kono
parents:
diff changeset
33 .sp 1
bce86c4163a3 Initial revision
kono
parents:
diff changeset
34 .nf
bce86c4163a3 Initial revision
kono
parents:
diff changeset
35 .ta \w'Escape 'u +\w'Returns 'u
bce86c4163a3 Initial revision
kono
parents:
diff changeset
36 \fIEscape\fR \fIReturns\fR \fIDescription\fR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
37 error string A diagnostic if the parse failed
bce86c4163a3 Initial revision
kono
parents:
diff changeset
38 .re
bce86c4163a3 Initial revision
kono
parents:
diff changeset
39 .fi
bce86c4163a3 Initial revision
kono
parents:
diff changeset
40
bce86c4163a3 Initial revision
kono
parents:
diff changeset
41 If the `\-normalize' switch is given,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
42 \fIap\fR will try to track down the official hostname of the address.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
43
bce86c4163a3 Initial revision
kono
parents:
diff changeset
44 Here is the default format string used by \fIap\fR:
bce86c4163a3 Initial revision
kono
parents:
diff changeset
45
bce86c4163a3 Initial revision
kono
parents:
diff changeset
46 .ti +.5i
bce86c4163a3 Initial revision
kono
parents:
diff changeset
47 %<{error}%{error}: %{text}%|%(putstr(proper{text}))%>
bce86c4163a3 Initial revision
kono
parents:
diff changeset
48
bce86c4163a3 Initial revision
kono
parents:
diff changeset
49 which says that if an error was detected, print the error, a `:',
bce86c4163a3 Initial revision
kono
parents:
diff changeset
50 and the address in error.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
51 Otherwise, output the 822\-proper format of the address.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
52 .Fi
bce86c4163a3 Initial revision
kono
parents:
diff changeset
53 ^$HOME/\&.mh\(ruprofile~^The user profile
bce86c4163a3 Initial revision
kono
parents:
diff changeset
54 ^@(MHETCPATH)/mtstailor~^tailor file
bce86c4163a3 Initial revision
kono
parents:
diff changeset
55 .Pr
bce86c4163a3 Initial revision
kono
parents:
diff changeset
56 None
bce86c4163a3 Initial revision
kono
parents:
diff changeset
57 .Sa
bce86c4163a3 Initial revision
kono
parents:
diff changeset
58 dp(8),
bce86c4163a3 Initial revision
kono
parents:
diff changeset
59 .br
bce86c4163a3 Initial revision
kono
parents:
diff changeset
60 \fIStandard for the Format of ARPA Internet Text Messages\fR (aka RFC\-822)
bce86c4163a3 Initial revision
kono
parents:
diff changeset
61 .De
bce86c4163a3 Initial revision
kono
parents:
diff changeset
62 `\-format' defaults as described above
bce86c4163a3 Initial revision
kono
parents:
diff changeset
63 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
64 `\-normalize'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
65 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
66 `\-width' defaults to the width of the terminal
bce86c4163a3 Initial revision
kono
parents:
diff changeset
67 .Co
bce86c4163a3 Initial revision
kono
parents:
diff changeset
68 None
bce86c4163a3 Initial revision
kono
parents:
diff changeset
69 .Bu
bce86c4163a3 Initial revision
kono
parents:
diff changeset
70 The argument to the `\-format' switch must be interpreted as a single token
bce86c4163a3 Initial revision
kono
parents:
diff changeset
71 by the shell that invokes \fIap\fR.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
72 Therefore,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
73 one must usually place the argument to this switch inside double\-quotes.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
74
bce86c4163a3 Initial revision
kono
parents:
diff changeset
75 On hosts where \fIMH\fR was configured with the BERK option,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
76 address parsing is not enabled.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
77 .En