git.marmaro.de Git - mmh/blob - man/inc.man1

   1 .\"
   2 .\" %nmhwarning%
   3 .\"
   4 .TH INC %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
   5 .SH NAME
   6 inc \- incorporate new mail
   7 .SH SYNOPSIS
   8 .HP 5
   9 .na
  10 .B inc
  11 .RI [ +folder ]
  12 .RB [ \-audit
  13 .IR audit\-file ]
  14 .RB [ \-noaudit ]
  15 .RB [ \-changecur " | " \-nochangecur ]
  16 .RB [ \-form
  17 .IR formfile ]
  18 .RB [ \-file
  19 .IR name ]
  20 .RB [ \-silent " | " \-nosilent ]
  21 .RB [ \-truncate " | " \-notruncate ]
  22 .RB [ \-width
  23 .IR columns ]
  24 .RB [ \-version ]
  25 .RB [ \-help ]
  26 .ad
  27 .SH DESCRIPTION
  28 .B Inc
  29 incorporates mail from the user's incoming mail drop into
  30 an
  31 .B nmh
  32 folder.
  33 .PP
  34 You may specify which folder to use with
  35 .IR +folder .
  36 If no folder is specified, then
  37 .B inc
  38 will use either the folder given by a (non\-empty)
  39 .RI \*(lq Inbox \*(rq
  40 entry in the user's profile, or the folder named
  41 .RI \*(lq inbox \*(rq.
  42 If the specified (or default) folder doesn't
  43 exist, the user will be queried prior to its creation.
  44 .PP
  45 When the new messages are incorporated into the folder, they are assigned
  46 numbers starting with the next highest number for the folder.  As the
  47 messages are processed, a
  48 .B scan
  49 listing of the new mail is produced.
  50 .PP
  51 If the user's profile contains a
  52 .RI \*(lq "Msg\-Protect: nnn" \*(rq
  53 entry, it
  54 will be used as the protection on the newly created messages, otherwise
  55 the
  56 .B nmh
  57 default of 0644 will be used.  For all subsequent operations
  58 on these messages, this initially assigned protection will be preserved.
  59 .PP
  60 If the switch
  61 .B \-audit
  62 .I audit\-file
  63 is specified (usually as a default
  64 switch in the profile), then
  65 .B inc
  66 will append a header line and a
  67 line per message to the end of the specified audit\-file with the format:
  68 .PP
  69 .RS 5
  70 .nf
  71 <<inc>> date
  72 <scan line for first message>
  73 <scan line for second message>
  74 <etc.>
  75 .fi
  76 .RE
  77 .PP
  78 This is useful for keeping track of volume and source of incoming mail.
  79 Eventually,
  80 .BR repl ,
  81 .BR forw ,
  82 .BR comp ,
  83 and
  84 .B dist
  85 may also produce audits to this (or another) file, perhaps with
  86 .RI \*(lq Message\-Id \*(rq
  87 information to keep an exact correspondence
  88 history.
  89 .RI \*(lq Audit\-file \*(rq
  90 will be in the current directory unless a full path is specified.
  91 .PP
  92 .B Inc
  93 will incorporate even improperly formatted messages into the
  94 user's nmh folder, inserting a blank line prior to the offending component
  95 and printing a comment identifying the bad message.
  96 .PP
  97 In all cases, the user's mail drop will be zeroed, unless the
  98 .B \-notruncate
  99 switch is given.
 100 .PP
 101 If the profile entry
 102 .RI \*(lq Unseen\-Sequence \*(rq
 103 is present and non\-empty, then
 104 .B inc
 105 will add each of the newly incorporated messages to
 106 each sequence named by the profile entry.
 107 .B Inc
 108 will not zero each sequence prior to adding messages.
 109 .PP
 110 The interpretation of the
 111 .B \-form
 112 .IR formatfile ,
 113 and
 114 .B \-width
 115 .I columns
 116 switches is the same as in
 117 .BR scan .
 118 .PP
 119 By using the
 120 .B \-file
 121 .I name
 122 switch, one can direct
 123 .B inc
 124 to incorporate messages from a file other than the user's maildrop.
 125 Note that the name file will NOT be zeroed, unless the
 126 .B \-truncate
 127 switch is given.
 128 .PP
 129 If the environment variable
 130 .B $MAILDROP
 131 is set, then
 132 .B inc
 133 uses it as the location of the user's maildrop instead of the default
 134 (the
 135 .B -file
 136 .I name
 137 switch still overrides this, however).  If this
 138 environment variable is not set, then
 139 .B inc
 140 will consult the profile entry
 141 .RI \*(lq MailDrop \*(rq
 142 for this information.  If the value found is
 143 not absolute, then it is interpreted relative to the user's
 144 .B nmh
 145 directory.  If the value is not found, then
 146 .B inc
 147 will look in the standard system location for the user's maildrop.
 148 .PP
 149 The
 150 .B \-silent
 151 switch directs
 152 .B inc
 153 to be quiet and not ask any questions at all.  This is useful for putting
 154 .B inc
 155 in the background and going on to other things.
 156
 157 .SH FILES
 158 .fc ^ ~
 159 .nf
 160 .ta \w'%etcdir%/ExtraBigFileName  'u
 161 ^$HOME/.mmh/profile~^The user profile
 162 ^%mailspool%/$USER~^Location of mail drop
 163 .fi
 164
 165 .SH "PROFILE COMPONENTS"
 166 .fc ^ ~
 167 .nf
 168 .ta 2.4i
 169 .ta \w'ExtraBigProfileName  'u
 170 ^Path:~^To determine the user's mail storage
 171 ^Alternate\-Mailboxes:~^To determine the user's mailboxes
 172 ^Inbox:~^To determine the inbox, default \*(lqinbox\*(rq
 173 ^Folder\-Protect:~^To set mode when creating a new folder
 174 ^Msg\-Protect:~^To set mode when creating a new message and audit\-file
 175 ^Unseen\-Sequence:~^To name sequences denoting unseen messages
 176 .fi
 177
 178 .SH "SEE ALSO"
 179 mhmail(1), scan(1), mh\-mail(5), post(8)
 180
 181 .SH DEFAULTS
 182 .nf
 183 .RB ` +folder "' defaulted by \*(lqInbox\*(rq above"
 184 .RB ` \-noaudit '
 185 .RB ` \-changecur '
 186 .RB ` \-form "' defaulted as described above"
 187 .RB ` \-nosilent '
 188 .RB ` \-truncate "' if `" \-file " name' not given, `" \-notruncate "' otherwise"
 189 .RB ` \-width "' defaulted to the width of the terminal"
 190 .fi
 191
 192 .SH CONTEXT
 193 The folder into which messages are being incorporated will become the
 194 current folder.  The first message incorporated will become the current
 195 message, unless the
 196 .B \-nochangecur
 197 option is specified.  This leaves the context ready for a
 198 .B show
 199 of the first new message.
 200
 201 .SH BUGS
 202 The argument to the
 203 .B \-form
 204 switch must be interpreted as a single
 205 token by the shell that invokes
 206 .BR inc .
 207 Therefore, one must usually place the argument to this switch inside
 208 double\-quotes.