Fix spelling and encoding errors in manpages and an error message
[mmh] / 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 mh
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 ` Inbox '
40 entry in the user's profile, or the folder named
41 .RI ` inbox '.
42 If the specified (or default) folder doesn't
43 exist, the user will (in
44 .B \-nosilent
45 mode) 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 ` "Msg\-Protect: nnn" '
55 entry, it
56 will be used as the protection on the newly created messages, otherwise
57 the
58 .B mmh
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 ` Message\-Id '
89 information to keep an exact correspondence
90 history.
91 .RI ` Audit\-file '
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 mh 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 ` Unseen\-Sequence '
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 and
116 .B \-width
117 .I columns
118 switches is the same as in
119 .BR scan .
120 .PP
121 By using the
122 .B \-file
123 .I name
124 switch, one can direct
125 .B inc
126 to incorporate messages from a file other than the user's maildrop.
127 Note that the named file will NOT be zeroed, unless the
128 .B \-truncate
129 switch is given.
130 .PP
131 If the environment variable
132 .B $MAILDROP
133 is set, then
134 .B inc
135 uses it as the location of the user's maildrop instead of the default
136 (the
137 .B -file
138 .I name
139 switch still overrides this, however).  If this
140 environment variable is not set, then
141 .B inc
142 will consult the profile entry
143 .RI ` MailDrop '
144 for this information.  If the value found is
145 not absolute, then it is interpreted relative to the user's
146 .B mh
147 directory.  If the value is not found, then
148 .B inc
149 will look in the standard system location for the user's maildrop.
150 .PP
151 The
152 .B \-silent
153 switch directs
154 .B inc
155 to be quiet and not ask any questions at all.  This is useful for putting
156 .B inc
157 in the background and going on to other things.
158
159 .SH FILES
160 .fc ^ ~
161 .nf
162 .ta \w'%etcdir%/ExtraBigFileName  'u
163 ^$HOME/.mmh/profile~^The user profile
164 ^%mailspool%/$USER~^Location of mail drop
165 .fi
166
167 .SH "PROFILE COMPONENTS"
168 .fc ^ ~
169 .nf
170 .ta 2.4i
171 .ta \w'ExtraBigProfileName  'u
172 ^Path:~^To determine the user's mail storage
173 ^Alternate\-Mailboxes:~^To determine the user's mailboxes
174 ^Inbox:~^To determine the inbox, default `inbox'
175 ^Folder\-Protect:~^To set mode when creating a new folder
176 ^Msg\-Protect:~^To set mode when creating a new message and audit\-file
177 ^Unseen\-Sequence:~^To name sequences denoting unseen messages
178 .fi
179
180 .SH "SEE ALSO"
181 scan(1), mh\-mail(5)
182
183 .SH DEFAULTS
184 .nf
185 .RB ` +folder "' defaulted by `Inbox' above"
186 .RB ` \-noaudit '
187 .RB ` \-changecur '
188 .RB ` \-form "' defaulted as described above"
189 .RB ` \-nosilent '
190 .RB ` \-truncate "' if `" \-file " name' not given, `" \-notruncate "' otherwise"
191 .RB ` \-width "' defaulted to the width of the terminal"
192 .fi
193
194 .SH CONTEXT
195 The folder into which messages are being incorporated will become the
196 current folder.  The first message incorporated will become the current
197 message, unless the
198 .B \-nochangecur
199 option is specified.  This leaves the context ready for a
200 .B show
201 of the first new message.