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