Annotation of 43BSD/contrib/mh/conf/doc/inc.rf, revision 1.1.1.1

1.1       root        1: .\"    @(MHWARNING)
                      2: .TH INC 1 "April 22, 1986" MH [mh.6]
                      3: .UC 6
                      4: .SH NAME
                      5: inc \- incorporate new mail
                      6: .SH SYNOPSIS
                      7: .in +.5i
                      8: .ti -.5i
                      9: inc
                     10: \%[+folder]
                     11: \%[\-audit\ audit\-file] \%[\-noaudit]
                     12: \%[\-changecur] \%[\-nochangecur]
                     13: @BEGIN: TMA
                     14: \%[\-decrypt] \%[\-nodecrypt] 
                     15: @END: TMA
                     16: \%[\-form\ formatfile]
                     17: \%[\-format\ string]
                     18: \%[\-file\ name]
                     19: \%[\-silent] \%[\-nosilent]
                     20: \%[\-truncate] \%[\-notruncate]
                     21: \%[\-width\ columns]
                     22: @BEGIN: MF
                     23: \%[\-uucp] \%[\-nouucp]
                     24: @END: MF
                     25: @BEGIN: POP
                     26: \%[\-host\ host] \%[\-user\ user]
                     27: \%[\-pack\ file] \%[\-nopack]
                     28: \%[\-rpop] \%[\-norpop]
                     29: @END: POP
                     30: \%[\-help]
                     31: .in -.5i
                     32: .SH DESCRIPTION
                     33: \fIInc\fR incorporates mail from the user's incoming mail drop
                     34: into an \fIMH\fR folder.
                     35: If `+folder' isn't specified,
                     36: the folder named \*(lqinbox\*(rq in the user's \fIMH\fR directory will be used.
                     37: The
                     38: new messages being incorporated are assigned numbers starting
                     39: with the next highest number in the folder.
                     40: If the specified (or default) folder doesn't exist,
                     41: the user will be queried prior to its creation.
                     42: As the messages are processed,
                     43: a \fIscan\fR listing of the new mail is produced.
                     44: 
                     45: If the user's profile contains a \*(lqMsg\-Protect: nnn\*(rq entry, it
                     46: will be used as the protection on the newly created messages,
                     47: otherwise the \fIMH\fR default of 0644 will be used.
                     48: During all operations on messages,
                     49: this initially assigned protection will
                     50: be preserved for each message, so \fIchmod\fR(1) may be used to set a
                     51: protection on an individual message, and its protection will be
                     52: preserved thereafter.
                     53: 
                     54: If the switch `\-audit\ audit\-file' is specified (usually as a
                     55: default switch in the profile), then \fIinc\fR will append a header
                     56: line and a line per message to the end of the specified
                     57: audit\-file with the format:
                     58: 
                     59: .nf
                     60: .ti 1i
                     61: \*(<<inc\*(>> date
                     62: .ti 1.5i
                     63: <scan line for first message>
                     64: .ti 1.5i
                     65: <scan line for second message>
                     66: .ti 2.5i
                     67: <etc.>
                     68: .fi
                     69: 
                     70: This is useful for keeping track of volume and source of incoming
                     71: mail.
                     72: Eventually, \fIrepl\fR, \fIforw\fR, \fIcomp\fR, and \fIdist\fR may also
                     73: produce audits to this (or another) file, perhaps with
                     74: \*(lqMessage\-Id:\*(rq information to keep an exact correspondence history.
                     75: \*(lqAudit\-file\*(rq will be in the user's MH directory unless a full
                     76: path is specified.
                     77: 
                     78: \fIInc\fR will incorporate even improperly formatted messages into the
                     79: user's MH folder, inserting a blank line prior to the offending
                     80: component and printing a comment identifying the bad message.
                     81: 
                     82: In all cases, the user's mail drop will be zeroed,
                     83: unless the `\-notruncate' switch is given.
                     84: 
                     85: If the profile entry \*(lqUnseen\-Sequence\*(rq is present and non\-empty,
                     86: then \fIinc\fR will add each of the newly incorporated messages to each
                     87: sequence named by the profile entry.
                     88: This is similar to the \*(lqPrevious\-Sequence\*(rq profile entry supported
                     89: by all \fIMH\fR commands which take `msgs' or `msg' arguments.
                     90: Note that \fIinc\fR will not zero each sequence prior to adding messages.
                     91: 
                     92: The interpretation of the `\-form\ formatfile', `\-format\ string',
                     93: and `\-width\ columns' switches is the same as in \fIscan\fR\0(1).
                     94: @BEGIN: MF
                     95: 
                     96: If the `\-uucp' switch is given, \fIUUCP\fR mail will be \fRinc\fRorporated
                     97: as well.  This option will work only on those sites that optionally
                     98: use \*(lqmail filtering\*(rq software.
                     99: @END: MF
                    100: 
                    101: By using the `\-file\ name' switch, one can direct \fIinc\fR to incorporate
                    102: messages from a file other than the user's maildrop.
                    103: Note that the name file will NOT be zeroed,
                    104: unless the `\-truncate' switch is given.
                    105: 
                    106: If the envariable \fB$MAILDROP\fR is set,
                    107: then \fIinc\fR uses it as the location of the user's maildrop instead of the
                    108: default (the `-file\ name' switch still overrides this, however).
                    109: If this envariable is not set,
                    110: then \fIinc\fR will consult the profile entry \*(lqMailDrop\*(rq for this
                    111: information.
                    112: If the value found is not absolute,
                    113: then it is interpreted relative to the user's \fIMH\fR directory.
                    114: If the value is not found,
                    115: then \fIinc\fR will look in the standard system location for the user's
                    116: maildrop.
                    117: 
                    118: The `\-silent' switch directs \fIinc\fR to be quiet and not ask any questions
                    119: at all.
                    120: This is useful for putting \fIinc\fR in the background and going on to other
                    121: things.
                    122: @BEGIN: POP
                    123: 
                    124: If the local host is configured as a POP client,
                    125: or if the `\-host\ host' switch is given,
                    126: then \fIinc\fR will query the POP service host as to the status of mail
                    127: waiting.
                    128: The `\-user\ user' switch may be given to specify the name of the POP
                    129: subscriber you wish to check mail for on the POP service host.
                    130: The `\-rpop' switch uses the UNIX \fIrPOP\fR
                    131: (authentication done via trusted connections).
                    132: In contrast, the `\-norpop' switch uses the ARPA \fIPOP\fR
                    133: (in which case \fIinc\fR will prompt for a password).
                    134: 
                    135: If \fIinc\fR uses POP,
                    136: then the `\-pack\ file' switch is considered.
                    137: If given,
                    138: then \fIinc\fR simply uses the POP to \fIpackf\fR\0(1) the user's maildrop
                    139: from the POP service host to the named file.
                    140: This switch is provided for those users who prefer to use \fImsh\fR to
                    141: read their maildrops.
                    142: @END: POP
                    143: .Fi
                    144: ^$HOME/\&.mh\(ruprofile~^The user profile
                    145: ^@(MHETCPATH)/mtstailor~^tailor file
                    146: ^@(MHDROPLOC)~^Location of mail drop
                    147: .Pr
                    148: ^Path:~^To determine the user's MH directory
                    149: .Ps
                    150: ^Alternate\-Mailboxes:~^To determine the user's mailboxes
                    151: .Ps
                    152: ^Folder\-Protect:~^To set mode when creating a new folder
                    153: .Ps
                    154: ^Msg\-Protect:~^To set mode when creating a new message and audit\-file
                    155: .Ps
                    156: ^Unseen\-Sequence:~^To name sequences denoting unseen messages
                    157: .Sa
                    158: @BEGIN: POP
                    159: \fIPost Office Protocol (revised)\fR (aka RFC\-819 with revisions),
                    160: .br
                    161: @END: POP
                    162: mhmail(1), scan(1), mh\-mail(5), post(8)
                    163: .De
                    164: `+folder' defaults to \*(lqinbox\*(rq
                    165: .Ds
                    166: `\-noaudit'
                    167: .Ds
                    168: `\-changecur'
                    169: @BEGIN: TMA
                    170: `\-decrypt'
                    171: @END: TMA
                    172: .Ds
                    173: `\-format' defaulted as described above
                    174: .Ds
                    175: `\-nosilent'
                    176: .Ds
                    177: `\-truncate' if `\-file\ name' not given, `\-notruncate' otherwise
                    178: .Ds
                    179: `\-width' defaulted to the width of the terminal
                    180: @BEGIN: MF
                    181: .Ds
                    182: `\-uucp'
                    183: @END: MF
                    184: @BEGIN: POP
                    185: .Ds
                    186: `\-nopack'
                    187: .Ds
                    188: `\-rpop'
                    189: @END: POP
                    190: .Co
                    191: The folder into which messages are being incorporated will become the
                    192: current folder.
                    193: The first message incorporated will become the current message,
                    194: unless the `\-nochangecur' option is specified.
                    195: This leaves the context ready for a \fIshow\fR
                    196: of the first new message.
                    197: .Bu
                    198: The argument to the `\-format' switch must be interpreted as a single token
                    199: by the shell that invokes \fIinc\fR.
                    200: Therefore,
                    201: one must usually place the argument to this switch inside double\-quotes.
                    202: .En

unix.superglobalmegacorp.com

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