Return to inc.me CVS log

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

Annotation of 43BSD/contrib/mh/doc/inc.me, revision 1.1

1.1     ! root        1: .\"    This file is automatically generated.  Do not edit!
        !             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: \%[\-form\ formatfile]
        !            14: \%[\-format\ string]
        !            15: \%[\-file\ name]
        !            16: \%[\-silent] \%[\-nosilent]
        !            17: \%[\-truncate] \%[\-notruncate]
        !            18: \%[\-width\ columns]
        !            19: \%[\-help]
        !            20: .in -.5i
        !            21: .SH DESCRIPTION
        !            22: \fIInc\fR incorporates mail from the user's incoming mail drop
        !            23: into an \fIMH\fR folder.
        !            24: If `+folder' isn't specified,
        !            25: the folder named \*(lqinbox\*(rq in the user's \fIMH\fR directory will be used.
        !            26: The
        !            27: new messages being incorporated are assigned numbers starting
        !            28: with the next highest number in the folder.
        !            29: If the specified (or default) folder doesn't exist,
        !            30: the user will be queried prior to its creation.
        !            31: As the messages are processed,
        !            32: a \fIscan\fR listing of the new mail is produced.
        !            33: 
        !            34: If the user's profile contains a \*(lqMsg\-Protect: nnn\*(rq entry, it
        !            35: will be used as the protection on the newly created messages,
        !            36: otherwise the \fIMH\fR default of 0644 will be used.
        !            37: During all operations on messages,
        !            38: this initially assigned protection will
        !            39: be preserved for each message, so \fIchmod\fR(1) may be used to set a
        !            40: protection on an individual message, and its protection will be
        !            41: preserved thereafter.
        !            42: 
        !            43: If the switch `\-audit\ audit\-file' is specified (usually as a
        !            44: default switch in the profile), then \fIinc\fR will append a header
        !            45: line and a line per message to the end of the specified
        !            46: audit\-file with the format:
        !            47: 
        !            48: .nf
        !            49: .ti 1i
        !            50: \*(<<inc\*(>> date
        !            51: .ti 1.5i
        !            52: <scan line for first message>
        !            53: .ti 1.5i
        !            54: <scan line for second message>
        !            55: .ti 2.5i
        !            56: <etc.>
        !            57: .fi
        !            58: 
        !            59: This is useful for keeping track of volume and source of incoming
        !            60: mail.
        !            61: Eventually, \fIrepl\fR, \fIforw\fR, \fIcomp\fR, and \fIdist\fR may also
        !            62: produce audits to this (or another) file, perhaps with
        !            63: \*(lqMessage\-Id:\*(rq information to keep an exact correspondence history.
        !            64: \*(lqAudit\-file\*(rq will be in the user's MH directory unless a full
        !            65: path is specified.
        !            66: 
        !            67: \fIInc\fR will incorporate even improperly formatted messages into the
        !            68: user's MH folder, inserting a blank line prior to the offending
        !            69: component and printing a comment identifying the bad message.
        !            70: 
        !            71: In all cases, the user's mail drop will be zeroed,
        !            72: unless the `\-notruncate' switch is given.
        !            73: 
        !            74: If the profile entry \*(lqUnseen\-Sequence\*(rq is present and non\-empty,
        !            75: then \fIinc\fR will add each of the newly incorporated messages to each
        !            76: sequence named by the profile entry.
        !            77: This is similar to the \*(lqPrevious\-Sequence\*(rq profile entry supported
        !            78: by all \fIMH\fR commands which take `msgs' or `msg' arguments.
        !            79: Note that \fIinc\fR will not zero each sequence prior to adding messages.
        !            80: 
        !            81: The interpretation of the `\-form\ formatfile', `\-format\ string',
        !            82: and `\-width\ columns' switches is the same as in \fIscan\fR\0(1).
        !            83: 
        !            84: By using the `\-file\ name' switch, one can direct \fIinc\fR to incorporate
        !            85: messages from a file other than the user's maildrop.
        !            86: Note that the name file will NOT be zeroed,
        !            87: unless the `\-truncate' switch is given.
        !            88: 
        !            89: If the envariable \fB$MAILDROP\fR is set,
        !            90: then \fIinc\fR uses it as the location of the user's maildrop instead of the
        !            91: default (the `-file\ name' switch still overrides this, however).
        !            92: If this envariable is not set,
        !            93: then \fIinc\fR will consult the profile entry \*(lqMailDrop\*(rq for this
        !            94: information.
        !            95: If the value found is not absolute,
        !            96: then it is interpreted relative to the user's \fIMH\fR directory.
        !            97: If the value is not found,
        !            98: then \fIinc\fR will look in the standard system location for the user's
        !            99: maildrop.
        !           100: 
        !           101: The `\-silent' switch directs \fIinc\fR to be quiet and not ask any questions
        !           102: at all.
        !           103: This is useful for putting \fIinc\fR in the background and going on to other
        !           104: things.
        !           105: .Fi
        !           106: ^$HOME/\&.mh\(ruprofile~^The user profile
        !           107: ^/usr/new/lib/mh/mtstailor~^tailor file
        !           108: ^/usr/spool/mail/$USER~^Location of mail drop
        !           109: .Pr
        !           110: ^Path:~^To determine the user's MH directory
        !           111: .Ps
        !           112: ^Alternate\-Mailboxes:~^To determine the user's mailboxes
        !           113: .Ps
        !           114: ^Folder\-Protect:~^To set mode when creating a new folder
        !           115: .Ps
        !           116: ^Msg\-Protect:~^To set mode when creating a new message and audit\-file
        !           117: .Ps
        !           118: ^Unseen\-Sequence:~^To name sequences denoting unseen messages
        !           119: .Sa
        !           120: mhmail(1), scan(1), mh\-mail(5), post(8)
        !           121: .De
        !           122: `+folder' defaults to \*(lqinbox\*(rq
        !           123: .Ds
        !           124: `\-noaudit'
        !           125: .Ds
        !           126: `\-changecur'
        !           127: .Ds
        !           128: `\-format' defaulted as described above
        !           129: .Ds
        !           130: `\-nosilent'
        !           131: .Ds
        !           132: `\-truncate' if `\-file\ name' not given, `\-notruncate' otherwise
        !           133: .Ds
        !           134: `\-width' defaulted to the width of the terminal
        !           135: .Co
        !           136: The folder into which messages are being incorporated will become the
        !           137: current folder.
        !           138: The first message incorporated will become the current message,
        !           139: unless the `\-nochangecur' option is specified.
        !           140: This leaves the context ready for a \fIshow\fR
        !           141: of the first new message.
        !           142: .Bu
        !           143: The argument to the `\-format' switch must be interpreted as a single token
        !           144: by the shell that invokes \fIinc\fR.
        !           145: Therefore,
        !           146: one must usually place the argument to this switch inside double\-quotes.
        !           147: .En

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