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

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