Return to ap.rf CVS log

Up to [CSRG BSD Unix] / 43BSDReno / contrib / mh / conf / doc

Annotation of 43BSDReno/contrib/mh/conf/doc/ap.rf, revision 1.1

1.1     ! root        1: .\"    @(MHWARNING)
        !             2: .TH AP 8 "April 22, 1986" MH [mh.6]
        !             3: .UC 6
        !             4: .SH NAME
        !             5: ap \- parse addresses 822\-style
        !             6: .SH SYNOPSIS
        !             7: .in +.5i
        !             8: .ti -.5i
        !             9: @(MHETCPATH)/ap
        !            10: \%[\-form\ formatfile]
        !            11: \%[\-format\ string]
        !            12: \%[\-normalize] \%[\-nonormalize]
        !            13: \%[\-width\ columns]
        !            14: addrs\ ...
        !            15: \%[\-help] 
        !            16: .in -.5i
        !            17: .SH DESCRIPTION
        !            18: \fIAp\fR is a program that parses addresses according to the ARPA Internet
        !            19: standard.
        !            20: It also understands many non\-standard formats.
        !            21: It is useful for seeing how \fIMH\fR will interpret an address.
        !            22: 
        !            23: The \fIap\fR program treats each argument as one or more addresses,
        !            24: and prints those addresses out in the official 822\-format.
        !            25: Hence, it is usually best to enclose each argument in double\-quotes for the
        !            26: shell.
        !            27: 
        !            28: To override the output format used by \fIap\fR,
        !            29: the `\-format\ string' or `\-format\ file' switches are used.
        !            30: This permits individual fields of the address to be extracted with ease.
        !            31: The string is simply a format stringand thefile is simply a format file.
        !            32: See \fImh\-format\fR\0(5) for the details.
        !            33: 
        !            34: In addition to the standard escapes,
        !            35: \fIscan\fR also recognizes the following additional escape:
        !            36: .nf
        !            37: .ta \w'escape  'u
        !            38: \fIescape\fR   \fIsubstitution\fR
        !            39: error  a diagnostic if the parse failed
        !            40: .re
        !            41: .fi
        !            42: 
        !            43: If the `\-normalize' switch is given,
        !            44: \fIap\fR will try to track down the official hostname of the address.
        !            45: 
        !            46: Here is the default format string used by \fIap\fR:
        !            47: 
        !            48: .ti +.5i
        !            49: %<{error}%{error}: %{text}%|%(putstr(proper{text}))%>
        !            50: 
        !            51: which says that if an error was detected, print the error, a `:',
        !            52: and the address in error.
        !            53: Otherwise, output the 822\-proper format of the address.
        !            54: .Fi
        !            55: ^$HOME/\&.mh\(ruprofile~^The user profile
        !            56: ^@(MHETCPATH)/mtstailor~^tailor file
        !            57: .Pr
        !            58: None
        !            59: .Sa
        !            60: dp(8),
        !            61: .br
        !            62: \fIStandard for the Format of ARPA Internet Text Messages\fR (aka RFC\-822)
        !            63: .De
        !            64: `\-format' defaults as described above
        !            65: .Ds
        !            66: `\-normalize'
        !            67: .Ds
        !            68: `\-width' defaults to the width of the terminal
        !            69: .Co
        !            70: None
        !            71: .Bu
        !            72: The argument to the `\-format' switch must be interpreted as a single token
        !            73: by the shell that invokes \fIap\fR.
        !            74: Therefore,
        !            75: one must usually place the argument to this switch inside double\-quotes.
        !            76: 
        !            77: On hosts where \fIMH\fR was configured with the BERK option,
        !            78: address parsing is not enabled.
        !            79: .En

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.