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

   1 head    1.8;
   2 access;
   3 symbols;
   4 locks; strict;
   5
   6
   7 1.8
   8 date    92.02.04.21.41.21;      author jromine; state Exp;
   9 branches;
  10 next    1.7;
  11
  12 1.7
  13 date    92.02.04.00.04.30;      author jromine; state Exp;
  14 branches;
  15 next    1.6;
  16
  17 1.6
  18 date    90.04.09.20.22.39;      author sources; state Exp;
  19 branches;
  20 next    1.5;
  21
  22 1.5
  23 date    90.04.05.15.10.43;      author sources; state Exp;
  24 branches;
  25 next    1.4;
  26
  27 1.4
  28 date    90.03.22.11.31.08;      author sources; state Exp;
  29 branches;
  30 next    1.3;
  31
  32 1.3
  33 date    90.03.20.19.41.46;      author sources; state Exp;
  34 branches;
  35 next    1.2;
  36
  37 1.2
  38 date    90.03.20.17.36.03;      author sources; state Exp;
  39 branches;
  40 next    1.1;
  41
  42 1.1
  43 date    90.03.20.13.44.01;      author sources; state Exp;
  44 branches;
  45 next    ;
  46
  47
  48 desc
  49 @@
  50
  51
  52 1.8
  53 log
  54 @contributed patch
  55 @
  56 text
  57 @.\"    @@(MHWARNING)
  58 .\" @@(#)$Id: inc.rf,v 1.7 1992/02/04 00:04:30 jromine Exp jromine $
  59 .SC INC 1
  60 .NA
  61 inc \- incorporate new mail
  62 .SY
  63 inc
  64 \%[+folder]
  65 \%[\-audit\ audit\-file] \%[\-noaudit]
  66 \%[\-changecur] \%[\-nochangecur]
  67 @@BEGIN: TMA
  68 \%[\-decrypt] \%[\-nodecrypt]
  69 @@END: TMA
  70 \%[\-form\ formatfile]
  71 \%[\-format\ string]
  72 \%[\-file\ name]
  73 \%[\-silent] \%[\-nosilent]
  74 \%[\-truncate] \%[\-notruncate]
  75 \%[\-width\ columns]
  76 @@BEGIN: MF
  77 \%[\-uucp] \%[\-nouucp]
  78 @@END: MF
  79 @@BEGIN: POP
  80 \%[\-host\ host] \%[\-user\ user]
  81 \%[\-apop] \%[\-noapop]
  82 \%[\-rpop] \%[\-norpop]
  83 \%[\-pack\ file] \%[\-nopack]
  84 @@END: POP
  85 \%[\-help]
  86 .DE
  87 \fIInc\fR incorporates mail from the user's incoming mail drop
  88 into an \fIMH\fR folder.
  89 If `+folder' isn't specified,
  90 a folder in the user's \fIMH\fR directory will be used, either that
  91 specified by the \*(lqInbox:\*(rq entry in the user's profile, or
  92 the folder named \*(lqinbox\*(rq.
  93 The
  94 new messages being incorporated are assigned numbers starting
  95 with the next highest number in the folder.
  96 If the specified (or default) folder doesn't exist,
  97 the user will be queried prior to its creation.
  98 As the messages are processed,
  99 a \fIscan\fR listing of the new mail is produced.
 100
 101 If the user's profile contains a \*(lqMsg\-Protect: nnn\*(rq entry, it
 102 will be used as the protection on the newly created messages,
 103 otherwise the \fIMH\fR default of 0644 will be used.
 104 During all operations on messages,
 105 this initially assigned protection will
 106 be preserved for each message, so \fIchmod\fR(1) may be used to set a
 107 protection on an individual message, and its protection will be
 108 preserved thereafter.
 109
 110 If the switch `\-audit\ audit\-file' is specified (usually as a
 111 default switch in the profile), then \fIinc\fR will append a header
 112 line and a line per message to the end of the specified
 113 audit\-file with the format:
 114
 115 .nf
 116 .ti 1i
 117 \*(<<inc\*(>> date
 118 .ti 1.5i
 119 <scan line for first message>
 120 .ti 1.5i
 121 <scan line for second message>
 122 .ti 2.5i
 123 <etc.>
 124 .fi
 125
 126 This is useful for keeping track of volume and source of incoming
 127 mail.
 128 Eventually, \fIrepl\fR, \fIforw\fR, \fIcomp\fR, and \fIdist\fR may also
 129 produce audits to this (or another) file, perhaps with
 130 \*(lqMessage\-Id:\*(rq information to keep an exact correspondence history.
 131 \*(lqAudit\-file\*(rq will be in the user's MH directory unless a full
 132 path is specified.
 133
 134 \fIInc\fR will incorporate even improperly formatted messages into the
 135 user's MH folder, inserting a blank line prior to the offending
 136 component and printing a comment identifying the bad message.
 137
 138 In all cases, the user's mail drop will be zeroed,
 139 unless the `\-notruncate' switch is given.
 140
 141 If the profile entry \*(lqUnseen\-Sequence\*(rq is present and non\-empty,
 142 then \fIinc\fR will add each of the newly incorporated messages to each
 143 sequence named by the profile entry.
 144 This is similar to the \*(lqPrevious\-Sequence\*(rq profile entry supported
 145 by all \fIMH\fR commands which take `msgs' or `msg' arguments.
 146 Note that \fIinc\fR will not zero each sequence prior to adding messages.
 147
 148 The interpretation of the `\-form\ formatfile', `\-format\ string',
 149 and `\-width\ columns' switches is the same as in \fIscan\fR\0(1).
 150 @@BEGIN: MF
 151
 152 If the `\-uucp' switch is given, \fIUUCP\fR mail will be \fRinc\fRorporated
 153 as well.  This option will work only on those sites that optionally
 154 use \*(lqmail filtering\*(rq software.
 155 @@END: MF
 156
 157 By using the `\-file\ name' switch, one can direct \fIinc\fR to incorporate
 158 messages from a file other than the user's maildrop.
 159 Note that the name file will NOT be zeroed,
 160 unless the `\-truncate' switch is given.
 161
 162 If the envariable \fB$MAILDROP\fR is set,
 163 then \fIinc\fR uses it as the location of the user's maildrop instead of the
 164 default (the `-file\ name' switch still overrides this, however).
 165 If this envariable is not set,
 166 then \fIinc\fR will consult the profile entry \*(lqMailDrop\*(rq for this
 167 information.
 168 If the value found is not absolute,
 169 then it is interpreted relative to the user's \fIMH\fR directory.
 170 If the value is not found,
 171 then \fIinc\fR will look in the standard system location for the user's
 172 maildrop.
 173
 174 The `\-silent' switch directs \fIinc\fR to be quiet and not ask any questions
 175 at all.
 176 This is useful for putting \fIinc\fR in the background and going on to other
 177 things.
 178 @@BEGIN: POP
 179
 180 If the local host is configured as a POP client,
 181 or if the `\-host\ host' switch is given,
 182 then \fIinc\fR will query the POP service host as to the status of mail
 183 waiting.
 184 If the `\-user\ user' switch is not given,
 185 then the current username is used.
 186 Normally,
 187 \fIinc\fR will prompt for a password to use.
 188 However,
 189 if the `\-apop' switch is given,
 190 \fIinc\fR will generate authentication credentials to provide
 191 for origin authentication and replay protection,
 192 but which do not involve sending a password in the clear over the network.
 193 Otherwise,
 194 if the `\-rpop' switch is given,
 195 then \fIinc\fR will try to use a \*(lqtrusted\*(rq connection
 196 (ala the BSD r-commands).
 197
 198 If \fIinc\fR uses POP,
 199 then the `\-pack\ file' switch is considered.
 200 If given,
 201 then \fIinc\fR simply uses the POP to \fIpackf\fR\0(1) the user's maildrop
 202 from the POP service host to the named file.
 203 This switch is provided for those users who prefer to use \fImsh\fR to
 204 read their maildrops.
 205 @@END: POP
 206 .Fi
 207 ^$HOME/\&.mh\(ruprofile~^The user profile
 208 ^@@(MHETCPATH)/mtstailor~^tailor file
 209 ^@@(MHDROPLOC)~^Location of mail drop
 210 .Pr
 211 ^Path:~^To determine the user's MH directory
 212 .Ps
 213 ^Alternate\-Mailboxes:~^To determine the user's mailboxes
 214 .Ps
 215 ^Inbox:~^To determine the inbox, default \*(lqinbox\*(rq
 216 .Ps
 217 ^Folder\-Protect:~^To set mode when creating a new folder
 218 .Ps
 219 ^Msg\-Protect:~^To set mode when creating a new message and audit\-file
 220 .Ps
 221 ^Unseen\-Sequence:~^To name sequences denoting unseen messages
 222 .Sa
 223 @@BEGIN: POP
 224 \fIPost Office Protocol - version 3\fR (aka RFC\-1081),
 225 .br
 226 @@END: POP
 227 mhmail(1), scan(1), mh\-mail(5), post(8)
 228 .De
 229 `+folder' defaulted by \*(lqInbox\*(rq above
 230 .Ds
 231 `\-noaudit'
 232 .Ds
 233 `\-changecur'
 234 @@BEGIN: TMA
 235 `\-decrypt'
 236 @@END: TMA
 237 .Ds
 238 `\-format' defaulted as described above
 239 .Ds
 240 `\-nosilent'
 241 .Ds
 242 `\-truncate' if `\-file\ name' not given, `\-notruncate' otherwise
 243 .Ds
 244 `\-width' defaulted to the width of the terminal
 245 @@BEGIN: MF
 246 .Ds
 247 `\-uucp'
 248 @@END: MF
 249 @@BEGIN: POP
 250 .Ds
 251 `\-nopack'
 252 .Ds
 253 `\-rpop'
 254 @@END: POP
 255 .Co
 256 The folder into which messages are being incorporated will become the
 257 current folder.
 258 The first message incorporated will become the current message,
 259 unless the `\-nochangecur' option is specified.
 260 This leaves the context ready for a \fIshow\fR
 261 of the first new message.
 262 .Bu
 263 The argument to the `\-format' switch must be interpreted as a single token
 264 by the shell that invokes \fIinc\fR.
 265 Therefore,
 266 one must usually place the argument to this switch inside double\-quotes.
 267 .En
 268 @
 269
 270
 271 1.7
 272 log
 273 @contributed patch
 274 @
 275 text
 276 @d2 1
 277 a2 1
 278 .\" @@(#)$Id: inc.rf,v 1.6 1990/04/09 20:22:39 sources Exp jromine $
 279 d25 2
 280 a27 1
 281 \%[\-rpop] \%[\-norpop]
 282 d128 13
 283 a140 6
 284 The `\-user\ user' switch may be given to specify the name of the POP
 285 subscriber you wish to check mail for on the POP service host.
 286 The `\-rpop' switch uses the UNIX \fIrPOP\fR
 287 (authentication done via trusted connections).
 288 In contrast, the `\-norpop' switch uses the ARPA \fIPOP\fR
 289 (in which case \fIinc\fR will prompt for a password).
 290 @
 291
 292
 293 1.6
 294 log
 295 @fixup RFC references
 296 @
 297 text
 298 @d2 1
 299 a2 1
 300 .\" @@(#)$Id: inc.rf,v 1.5 90/04/05 15:10:43 sources Exp Locker: sources $
 301 d33 3
 302 a35 1
 303 the folder named \*(lqinbox\*(rq in the user's \fIMH\fR directory will be used.
 304 d151 2
 305 d165 1
 306 a165 1
 307 `+folder' defaults to \*(lqinbox\*(rq
 308 @
 309
 310
 311 1.5
 312 log
 313 @add ID
 314 @
 315 text
 316 @d2 1
 317 a2 1
 318 .\" @@(#)$Id:$
 319 d156 1
 320 a156 1
 321 \fIPost Office Protocol (revised)\fR (aka RFC\-819 with revisions),
 322 @
 323
 324
 325 1.4
 326 log
 327 @put things back, do .NA stuff another way
 328 @
 329 text
 330 @d2 1
 331 @
 332
 333
 334 1.3
 335 log
 336 @typo
 337 @
 338 text
 339 @d2 2
 340 a3 2
 341 .TH INC 1 @@(MHCENTERFOOT) @@(MHLEFTFOOT)
 342 .SH .NA
 343 d5 1
 344 a5 1
 345 .SH .SY
 346 @
 347
 348
 349 1.2
 350 log
 351 @fixup for makewhatis
 352 @
 353 text
 354 @d2 1
 355 a2 1
 356 .TH INC 1 [mh.6] MH
 357 @
 358
 359
 360 1.1
 361 log
 362 @Initial revision
 363 @
 364 text
 365 @d2 2
 366 a3 2
 367 .SC INC 1
 368 .NA
 369 d5 1
 370 a5 1
 371 .SY
 372 @