annotate conf/doc/inc.rf @ 12:441a2190cfae

Lion fix
author Shinji KONO <kono@ie.u-ryukyu.ac.jp>
date Sat, 21 Apr 2012 13:10:49 +0900
parents bce86c4163a3
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
bce86c4163a3 Initial revision
kono
parents:
diff changeset
1 .\" @(MHWARNING)
12
441a2190cfae Lion fix
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 0
diff changeset
2 .\" @(#)$Id: inc.rf,v 1.1.1.1 2005/04/18 14:46:03 kono Exp $
0
bce86c4163a3 Initial revision
kono
parents:
diff changeset
3 .SC INC 1
bce86c4163a3 Initial revision
kono
parents:
diff changeset
4 .NA
bce86c4163a3 Initial revision
kono
parents:
diff changeset
5 inc \- incorporate new mail
bce86c4163a3 Initial revision
kono
parents:
diff changeset
6 .SY
bce86c4163a3 Initial revision
kono
parents:
diff changeset
7 inc
bce86c4163a3 Initial revision
kono
parents:
diff changeset
8 \%[+folder]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
9 \%[\-audit\ audit\-file] \%[\-noaudit]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
10 \%[\-changecur] \%[\-nochangecur]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
11 @BEGIN: TMA
bce86c4163a3 Initial revision
kono
parents:
diff changeset
12 \%[\-decrypt] \%[\-nodecrypt]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
13 @END: TMA
bce86c4163a3 Initial revision
kono
parents:
diff changeset
14 \%[\-form\ formatfile]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
15 \%[\-format\ string]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
16 \%[\-file\ name]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
17 \%[\-silent] \%[\-nosilent]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
18 \%[\-truncate] \%[\-notruncate]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
19 \%[\-width\ columns]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
20 @BEGIN: MF
bce86c4163a3 Initial revision
kono
parents:
diff changeset
21 \%[\-uucp] \%[\-nouucp]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
22 @END: MF
bce86c4163a3 Initial revision
kono
parents:
diff changeset
23 @BEGIN: POP
bce86c4163a3 Initial revision
kono
parents:
diff changeset
24 \%[\-host\ host] \%[\-user\ user]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
25 \%[\-apop] \%[\-noapop]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
26 \%[\-rpop] \%[\-norpop]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
27 \%[\-pack\ file] \%[\-nopack]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
28 @END: POP
bce86c4163a3 Initial revision
kono
parents:
diff changeset
29 \%[\-help]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
30 .DE
bce86c4163a3 Initial revision
kono
parents:
diff changeset
31 \fIInc\fR incorporates mail from the user's incoming mail drop
bce86c4163a3 Initial revision
kono
parents:
diff changeset
32 into an \fIMH\fR folder.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
33 If `+folder' isn't specified,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
34 a folder in the user's \fIMH\fR directory will be used, either that
bce86c4163a3 Initial revision
kono
parents:
diff changeset
35 specified by the \*(lqInbox:\*(rq entry in the user's profile, or
bce86c4163a3 Initial revision
kono
parents:
diff changeset
36 the folder named \*(lqinbox\*(rq.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
37 The
bce86c4163a3 Initial revision
kono
parents:
diff changeset
38 new messages being incorporated are assigned numbers starting
bce86c4163a3 Initial revision
kono
parents:
diff changeset
39 with the next highest number in the folder.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
40 If the specified (or default) folder doesn't exist,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
41 the user will be queried prior to its creation.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
42 As the messages are processed,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
43 a \fIscan\fR listing of the new mail is produced.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
44
bce86c4163a3 Initial revision
kono
parents:
diff changeset
45 If the user's profile contains a \*(lqMsg\-Protect: nnn\*(rq entry, it
bce86c4163a3 Initial revision
kono
parents:
diff changeset
46 will be used as the protection on the newly created messages,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
47 otherwise the \fIMH\fR default of 0644 will be used.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
48 During all operations on messages,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
49 this initially assigned protection will
bce86c4163a3 Initial revision
kono
parents:
diff changeset
50 be preserved for each message, so \fIchmod\fR(1) may be used to set a
bce86c4163a3 Initial revision
kono
parents:
diff changeset
51 protection on an individual message, and its protection will be
bce86c4163a3 Initial revision
kono
parents:
diff changeset
52 preserved thereafter.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
53
bce86c4163a3 Initial revision
kono
parents:
diff changeset
54 If the switch `\-audit\ audit\-file' is specified (usually as a
bce86c4163a3 Initial revision
kono
parents:
diff changeset
55 default switch in the profile), then \fIinc\fR will append a header
bce86c4163a3 Initial revision
kono
parents:
diff changeset
56 line and a line per message to the end of the specified
bce86c4163a3 Initial revision
kono
parents:
diff changeset
57 audit\-file with the format:
bce86c4163a3 Initial revision
kono
parents:
diff changeset
58
bce86c4163a3 Initial revision
kono
parents:
diff changeset
59 .nf
bce86c4163a3 Initial revision
kono
parents:
diff changeset
60 .ti 1i
bce86c4163a3 Initial revision
kono
parents:
diff changeset
61 \*(<<inc\*(>> date
bce86c4163a3 Initial revision
kono
parents:
diff changeset
62 .ti 1.5i
bce86c4163a3 Initial revision
kono
parents:
diff changeset
63 <scan line for first message>
bce86c4163a3 Initial revision
kono
parents:
diff changeset
64 .ti 1.5i
bce86c4163a3 Initial revision
kono
parents:
diff changeset
65 <scan line for second message>
bce86c4163a3 Initial revision
kono
parents:
diff changeset
66 .ti 2.5i
bce86c4163a3 Initial revision
kono
parents:
diff changeset
67 <etc.>
bce86c4163a3 Initial revision
kono
parents:
diff changeset
68 .fi
bce86c4163a3 Initial revision
kono
parents:
diff changeset
69
bce86c4163a3 Initial revision
kono
parents:
diff changeset
70 This is useful for keeping track of volume and source of incoming
bce86c4163a3 Initial revision
kono
parents:
diff changeset
71 mail.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
72 Eventually, \fIrepl\fR, \fIforw\fR, \fIcomp\fR, and \fIdist\fR may also
bce86c4163a3 Initial revision
kono
parents:
diff changeset
73 produce audits to this (or another) file, perhaps with
bce86c4163a3 Initial revision
kono
parents:
diff changeset
74 \*(lqMessage\-Id:\*(rq information to keep an exact correspondence history.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
75 \*(lqAudit\-file\*(rq will be in the user's MH directory unless a full
bce86c4163a3 Initial revision
kono
parents:
diff changeset
76 path is specified.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
77
bce86c4163a3 Initial revision
kono
parents:
diff changeset
78 \fIInc\fR will incorporate even improperly formatted messages into the
bce86c4163a3 Initial revision
kono
parents:
diff changeset
79 user's MH folder, inserting a blank line prior to the offending
bce86c4163a3 Initial revision
kono
parents:
diff changeset
80 component and printing a comment identifying the bad message.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
81
bce86c4163a3 Initial revision
kono
parents:
diff changeset
82 In all cases, the user's mail drop will be zeroed,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
83 unless the `\-notruncate' switch is given.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
84
bce86c4163a3 Initial revision
kono
parents:
diff changeset
85 If the profile entry \*(lqUnseen\-Sequence\*(rq is present and non\-empty,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
86 then \fIinc\fR will add each of the newly incorporated messages to each
bce86c4163a3 Initial revision
kono
parents:
diff changeset
87 sequence named by the profile entry.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
88 This is similar to the \*(lqPrevious\-Sequence\*(rq profile entry supported
bce86c4163a3 Initial revision
kono
parents:
diff changeset
89 by all \fIMH\fR commands which take `msgs' or `msg' arguments.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
90 Note that \fIinc\fR will not zero each sequence prior to adding messages.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
91
bce86c4163a3 Initial revision
kono
parents:
diff changeset
92 The interpretation of the `\-form\ formatfile', `\-format\ string',
bce86c4163a3 Initial revision
kono
parents:
diff changeset
93 and `\-width\ columns' switches is the same as in \fIscan\fR\0(1).
bce86c4163a3 Initial revision
kono
parents:
diff changeset
94 @BEGIN: MF
bce86c4163a3 Initial revision
kono
parents:
diff changeset
95
bce86c4163a3 Initial revision
kono
parents:
diff changeset
96 If the `\-uucp' switch is given, \fIUUCP\fR mail will be \fRinc\fRorporated
bce86c4163a3 Initial revision
kono
parents:
diff changeset
97 as well. This option will work only on those sites that optionally
bce86c4163a3 Initial revision
kono
parents:
diff changeset
98 use \*(lqmail filtering\*(rq software.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
99 @END: MF
bce86c4163a3 Initial revision
kono
parents:
diff changeset
100
bce86c4163a3 Initial revision
kono
parents:
diff changeset
101 By using the `\-file\ name' switch, one can direct \fIinc\fR to incorporate
bce86c4163a3 Initial revision
kono
parents:
diff changeset
102 messages from a file other than the user's maildrop.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
103 Note that the name file will NOT be zeroed,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
104 unless the `\-truncate' switch is given.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
105
bce86c4163a3 Initial revision
kono
parents:
diff changeset
106 If the envariable \fB$MAILDROP\fR is set,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
107 then \fIinc\fR uses it as the location of the user's maildrop instead of the
bce86c4163a3 Initial revision
kono
parents:
diff changeset
108 default (the `-file\ name' switch still overrides this, however).
bce86c4163a3 Initial revision
kono
parents:
diff changeset
109 If this envariable is not set,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
110 then \fIinc\fR will consult the profile entry \*(lqMailDrop\*(rq for this
bce86c4163a3 Initial revision
kono
parents:
diff changeset
111 information.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
112 If the value found is not absolute,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
113 then it is interpreted relative to the user's \fIMH\fR directory.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
114 If the value is not found,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
115 then \fIinc\fR will look in the standard system location for the user's
bce86c4163a3 Initial revision
kono
parents:
diff changeset
116 maildrop.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
117
bce86c4163a3 Initial revision
kono
parents:
diff changeset
118 The `\-silent' switch directs \fIinc\fR to be quiet and not ask any questions
bce86c4163a3 Initial revision
kono
parents:
diff changeset
119 at all.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
120 This is useful for putting \fIinc\fR in the background and going on to other
bce86c4163a3 Initial revision
kono
parents:
diff changeset
121 things.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
122 @BEGIN: POP
bce86c4163a3 Initial revision
kono
parents:
diff changeset
123
bce86c4163a3 Initial revision
kono
parents:
diff changeset
124 If the local host is configured as a POP client,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
125 or if the `\-host\ host' switch is given,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
126 then \fIinc\fR will query the POP service host as to the status of mail
bce86c4163a3 Initial revision
kono
parents:
diff changeset
127 waiting.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
128 If the `\-user\ user' switch is not given,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
129 then the current username is used.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
130 Normally,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
131 \fIinc\fR will prompt for a password to use.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
132 However,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
133 if the `\-apop' switch is given,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
134 \fIinc\fR will generate authentication credentials to provide
bce86c4163a3 Initial revision
kono
parents:
diff changeset
135 for origin authentication and replay protection,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
136 but which do not involve sending a password in the clear over the network.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
137 Otherwise,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
138 if the `\-rpop' switch is given,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
139 then \fIinc\fR will try to use a \*(lqtrusted\*(rq connection
bce86c4163a3 Initial revision
kono
parents:
diff changeset
140 (ala the BSD r-commands).
bce86c4163a3 Initial revision
kono
parents:
diff changeset
141
bce86c4163a3 Initial revision
kono
parents:
diff changeset
142 If \fIinc\fR uses POP,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
143 then the `\-pack\ file' switch is considered.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
144 If given,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
145 then \fIinc\fR simply uses the POP to \fIpackf\fR\0(1) the user's maildrop
bce86c4163a3 Initial revision
kono
parents:
diff changeset
146 from the POP service host to the named file.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
147 This switch is provided for those users who prefer to use \fImsh\fR to
bce86c4163a3 Initial revision
kono
parents:
diff changeset
148 read their maildrops.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
149 @END: POP
bce86c4163a3 Initial revision
kono
parents:
diff changeset
150 .Fi
bce86c4163a3 Initial revision
kono
parents:
diff changeset
151 ^$HOME/\&.mh\(ruprofile~^The user profile
bce86c4163a3 Initial revision
kono
parents:
diff changeset
152 ^@(MHETCPATH)/mtstailor~^tailor file
bce86c4163a3 Initial revision
kono
parents:
diff changeset
153 ^@(MHDROPLOC)~^Location of mail drop
bce86c4163a3 Initial revision
kono
parents:
diff changeset
154 .Pr
bce86c4163a3 Initial revision
kono
parents:
diff changeset
155 ^Path:~^To determine the user's MH directory
bce86c4163a3 Initial revision
kono
parents:
diff changeset
156 .Ps
bce86c4163a3 Initial revision
kono
parents:
diff changeset
157 ^Alternate\-Mailboxes:~^To determine the user's mailboxes
bce86c4163a3 Initial revision
kono
parents:
diff changeset
158 .Ps
bce86c4163a3 Initial revision
kono
parents:
diff changeset
159 ^Inbox:~^To determine the inbox, default \*(lqinbox\*(rq
bce86c4163a3 Initial revision
kono
parents:
diff changeset
160 .Ps
bce86c4163a3 Initial revision
kono
parents:
diff changeset
161 ^Folder\-Protect:~^To set mode when creating a new folder
bce86c4163a3 Initial revision
kono
parents:
diff changeset
162 .Ps
bce86c4163a3 Initial revision
kono
parents:
diff changeset
163 ^Msg\-Protect:~^To set mode when creating a new message and audit\-file
bce86c4163a3 Initial revision
kono
parents:
diff changeset
164 .Ps
bce86c4163a3 Initial revision
kono
parents:
diff changeset
165 ^Unseen\-Sequence:~^To name sequences denoting unseen messages
bce86c4163a3 Initial revision
kono
parents:
diff changeset
166 .Sa
bce86c4163a3 Initial revision
kono
parents:
diff changeset
167 @BEGIN: POP
bce86c4163a3 Initial revision
kono
parents:
diff changeset
168 \fIPost Office Protocol - version 3\fR (aka RFC\-1081),
bce86c4163a3 Initial revision
kono
parents:
diff changeset
169 .br
bce86c4163a3 Initial revision
kono
parents:
diff changeset
170 @END: POP
bce86c4163a3 Initial revision
kono
parents:
diff changeset
171 mhmail(1), scan(1), mh\-mail(5), post(8)
bce86c4163a3 Initial revision
kono
parents:
diff changeset
172 .De
bce86c4163a3 Initial revision
kono
parents:
diff changeset
173 `+folder' defaulted by \*(lqInbox\*(rq above
bce86c4163a3 Initial revision
kono
parents:
diff changeset
174 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
175 `\-noaudit'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
176 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
177 `\-changecur'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
178 @BEGIN: TMA
bce86c4163a3 Initial revision
kono
parents:
diff changeset
179 `\-decrypt'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
180 @END: TMA
bce86c4163a3 Initial revision
kono
parents:
diff changeset
181 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
182 `\-format' defaulted as described above
bce86c4163a3 Initial revision
kono
parents:
diff changeset
183 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
184 `\-nosilent'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
185 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
186 `\-truncate' if `\-file\ name' not given, `\-notruncate' otherwise
bce86c4163a3 Initial revision
kono
parents:
diff changeset
187 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
188 `\-width' defaulted to the width of the terminal
bce86c4163a3 Initial revision
kono
parents:
diff changeset
189 @BEGIN: MF
bce86c4163a3 Initial revision
kono
parents:
diff changeset
190 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
191 `\-uucp'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
192 @END: MF
bce86c4163a3 Initial revision
kono
parents:
diff changeset
193 @BEGIN: POP
bce86c4163a3 Initial revision
kono
parents:
diff changeset
194 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
195 `\-nopack'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
196 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
197 `\-rpop'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
198 @END: POP
bce86c4163a3 Initial revision
kono
parents:
diff changeset
199 .Co
bce86c4163a3 Initial revision
kono
parents:
diff changeset
200 The folder into which messages are being incorporated will become the
bce86c4163a3 Initial revision
kono
parents:
diff changeset
201 current folder.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
202 The first message incorporated will become the current message,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
203 unless the `\-nochangecur' option is specified.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
204 This leaves the context ready for a \fIshow\fR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
205 of the first new message.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
206 .Bu
bce86c4163a3 Initial revision
kono
parents:
diff changeset
207 The argument to the `\-format' switch must be interpreted as a single token
bce86c4163a3 Initial revision
kono
parents:
diff changeset
208 by the shell that invokes \fIinc\fR.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
209 Therefore,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
210 one must usually place the argument to this switch inside double\-quotes.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
211 .En