git.marmaro.de Git - mmh/blob - docs/historical/mh-6.8.5/conf/doc/inc.rf

   1 .\"     @(MHWARNING)
   2 .\" @(#)$Id: inc.rf,v 1.8 1992/02/04 21:41:21 jromine Exp $
   3 .SC INC 1
   4 .NA
   5 inc \- incorporate new mail
   6 .SY
   7 inc
   8 \%[+folder]
   9 \%[\-audit\ audit\-file] \%[\-noaudit]
  10 \%[\-changecur] \%[\-nochangecur]
  11 @BEGIN: TMA
  12 \%[\-decrypt] \%[\-nodecrypt]
  13 @END: TMA
  14 \%[\-form\ formatfile]
  15 \%[\-format\ string]
  16 \%[\-file\ name]
  17 \%[\-silent] \%[\-nosilent]
  18 \%[\-truncate] \%[\-notruncate]
  19 \%[\-width\ columns]
  20 @BEGIN: MF
  21 \%[\-uucp] \%[\-nouucp]
  22 @END: MF
  23 @BEGIN: POP
  24 \%[\-host\ host] \%[\-user\ user]
  25 \%[\-apop] \%[\-noapop]
  26 \%[\-rpop] \%[\-norpop]
  27 \%[\-pack\ file] \%[\-nopack]
  28 @END: POP
  29 \%[\-help]
  30 .DE
  31 \fIInc\fR incorporates mail from the user's incoming mail drop
  32 into an \fIMH\fR folder.
  33 If `+folder' isn't specified,
  34 a folder in the user's \fIMH\fR directory will be used, either that
  35 specified by the \*(lqInbox:\*(rq entry in the user's profile, or
  36 the folder named \*(lqinbox\*(rq.
  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 If the `\-user\ user' switch is not given,
 129 then the current username is used.
 130 Normally,
 131 \fIinc\fR will prompt for a password to use.
 132 However,
 133 if the `\-apop' switch is given,
 134 \fIinc\fR will generate authentication credentials to provide
 135 for origin authentication and replay protection,
 136 but which do not involve sending a password in the clear over the network.
 137 Otherwise,
 138 if the `\-rpop' switch is given,
 139 then \fIinc\fR will try to use a \*(lqtrusted\*(rq connection
 140 (ala the BSD r-commands).
 141
 142 If \fIinc\fR uses POP,
 143 then the `\-pack\ file' switch is considered.
 144 If given,
 145 then \fIinc\fR simply uses the POP to \fIpackf\fR\0(1) the user's maildrop
 146 from the POP service host to the named file.
 147 This switch is provided for those users who prefer to use \fImsh\fR to
 148 read their maildrops.
 149 @END: POP
 150 .Fi
 151 ^$HOME/\&.mh\(ruprofile~^The user profile
 152 ^@(MHETCPATH)/mtstailor~^tailor file
 153 ^@(MHDROPLOC)~^Location of mail drop
 154 .Pr
 155 ^Path:~^To determine the user's MH directory
 156 .Ps
 157 ^Alternate\-Mailboxes:~^To determine the user's mailboxes
 158 .Ps
 159 ^Inbox:~^To determine the inbox, default \*(lqinbox\*(rq
 160 .Ps
 161 ^Folder\-Protect:~^To set mode when creating a new folder
 162 .Ps
 163 ^Msg\-Protect:~^To set mode when creating a new message and audit\-file
 164 .Ps
 165 ^Unseen\-Sequence:~^To name sequences denoting unseen messages
 166 .Sa
 167 @BEGIN: POP
 168 \fIPost Office Protocol - version 3\fR (aka RFC\-1081),
 169 .br
 170 @END: POP
 171 mhmail(1), scan(1), mh\-mail(5), post(8)
 172 .De
 173 `+folder' defaulted by \*(lqInbox\*(rq above
 174 .Ds
 175 `\-noaudit'
 176 .Ds
 177 `\-changecur'
 178 @BEGIN: TMA
 179 `\-decrypt'
 180 @END: TMA
 181 .Ds
 182 `\-format' defaulted as described above
 183 .Ds
 184 `\-nosilent'
 185 .Ds
 186 `\-truncate' if `\-file\ name' not given, `\-notruncate' otherwise
 187 .Ds
 188 `\-width' defaulted to the width of the terminal
 189 @BEGIN: MF
 190 .Ds
 191 `\-uucp'
 192 @END: MF
 193 @BEGIN: POP
 194 .Ds
 195 `\-nopack'
 196 .Ds
 197 `\-rpop'
 198 @END: POP
 199 .Co
 200 The folder into which messages are being incorporated will become the
 201 current folder.
 202 The first message incorporated will become the current message,
 203 unless the `\-nochangecur' option is specified.
 204 This leaves the context ready for a \fIshow\fR
 205 of the first new message.
 206 .Bu
 207 The argument to the `\-format' switch must be interpreted as a single token
 208 by the shell that invokes \fIinc\fR.
 209 Therefore,
 210 one must usually place the argument to this switch inside double\-quotes.
 211 .En