Added all of the MH sources, including RCS files, in
[mmh] / docs / historical / mh-6.8.5 / doc / mh-tailor.me
1 .\"     This file is automatically generated.  Do not edit!
2 .\" @(#)$Id: mh-tailor.rf,v 2.21 1994/03/23 23:32:50 jromine Exp $
3 .SC MH-TAILOR 5
4 .NA
5 mh-tailor, mtstailor \- system customization for MH message handler
6
7 .SY
8 \fI/opt/mh-6.8.5/lib/mtstailor\fP
9 .DE
10 The file /opt/mh-6.8.5/lib/mtstailor defines run-time options for those \fIMH\fR
11 programs which interact (in some form) with the message transport system.
12 At present, these (user) programs are:
13 \fIap\fR, \fIconflict\fR, \fIinc\fR, \fImsgchk\fR,
14 \fImsh\fR, \fIpost\fR, \fIrcvdist\fR, and \fIrcvpack\fR.
15
16 Each option should be given on a single line.  Blank lines
17 and lines which begin with `#' are ignored.
18 The options available along with default values and a description of their
19 meanings are listed below:
20
21 .in +.5i
22 .ti -.5i
23 localname:
24 .br
25 The host name \fIMH\fR considers local.
26 If not set, depending on the version of UNIX you're running,
27 \fIMH\fR will query the system for this value
28 (e.g., <whoami.h>, gethostname, etc.).
29 This has no equivalent in the \fIMH\fR configuration file.
30 POP client hosts should set this value to the name of the POP service host.
31
32 .ti -.5i
33 localdomain:
34 .br
35 If this is set, a `.' followed by this string will be
36 appended to your host name.
37 This might be useful for sites
38 where the host name returned by the system
39 (e.g., <whoami.h>, gethostname, etc.), 
40 is not a \*(lqfully qualified domain name\*(rq
41 (i.e., does not contain a `.').
42
43 .ti -.5i
44 clientname:
45 .br
46 The host name \fIMH\fP will give in the
47 SMTP \fBHELO\fP (and \fBEHLO\fP) command, when posting mail.
48 If not set, the host name \fIMH\fR considers local is used
49 (see \*(lqlocalname\*(rq above).
50 If empty, no \fBHELO\fP command will be given.
51 Although the \fBHELO\fP command is required by RFC 821, 
52 many SMTP servers do not require it.
53 .sp
54 Early versions of SendMail will fail if the host name
55 given in the \fBHELO\fP command is the local host; 
56 later versions of SendMail will complain if you omit the
57 \fBHELO\fP command.  If you run SendMail, find out what
58 your system expects and set this field if needed.
59
60 .ti -.5i
61 systemname:
62 .br
63 The name of the local host in the \fIUUCP\fR \*(lqdomain\*(rq.
64 If not set, depending on the version of UNIX you're running,
65 \fIMH\fR will query the system for this value.
66 This has no equivalent in the \fIMH\fR configuration file.
67
68 .ti -.5i
69 mmdfldir: /var/spool/mail
70 .br
71 The directory where maildrops are kept.
72 If this is empty, the user's home directory is used.
73 This overrides the \*(lqmail\*(rq field in the \fIMH\fR configuration file.
74
75 .ti -.5i
76 mmdflfil: 
77 .br
78 The name of the maildrop file in the directory where maildrops are kept.
79 If this is empty, the user's login name is used.
80 This overrides the \*(lqmail\*(rq field in the \fIMH\fR configuration file.
81
82 .ti -.5i
83 mmdelim1: \\001\\001\\001\\001\\n
84 .br
85 The beginning-of-message delimiter for maildrops.
86
87 .ti -.5i
88 mmdelim2: \\001\\001\\001\\001\\n
89 .br
90 The end-of-message delimiter for maildrops.
91
92 .ti -.5i
93 mmailid: 0
94 .br
95 If non-zero, then support for MMailids in \fB/etc/passwd\fR is enabled.
96 Basically, the pw_gecos field in the password file is of the form
97
98 .ti +.5i
99 My Full Name <mailid>
100
101 The \fIMH\fR internal routines that deal with user and full names will return
102 \*(lqmailid\*(rq and \*(lqMy Full Name\*(rq respectively.
103
104 .ti -.5i
105 lockstyle: 0
106 .br
107 The locking discipline to perform.
108 A value of \*(lq0\*(rq means to use kernel-level locking
109 if available.
110 (See below for more details.)
111 On systems compiled without kernel-level locking,
112 standard \fIBellMail\fR locking is used.
113 A value of \*(lq1\*(rq means to use \fIBellMail\fR locking always
114 (the name of the lock is based on the file name).
115 A value of \*(lq2\*(rq means to use \fIMMDF\fR locking always
116 (the name of the lock is based on device/inode pairs).
117
118 .ti -.5i
119 lockldir:
120 .br
121 The name of the directory for making locks.
122 If your system isn't configured to use kernel-level locking,
123 then this directory is used when creating locks.
124 If the value is empty,
125 then the directory of the file to be locked is used.
126
127 .ti -.5i
128 maildelivery: /opt/mh-6.8.5/lib/maildelivery
129 .br
130 The name of the system-wide default \fI\&.maildelivery\fR file.
131 See \fImhook\fR\0(1) for the details.
132
133 .ti -.5i
134 everyone: 200
135 .br
136 The highest user-id which should NOT receive mail addressed to
137 \*(lqeveryone\*(rq.
138
139 .ti -.5i
140 noshell: 
141 .br
142 If set, then each user-id greater than \*(lqeveryone\*(rq
143 that has a login shell equivalent to the given value (e.g.,
144 \*(lq/bin/csh\*(rq)
145 indicates that mail for \*(lqeveryone\*(rq should not be sent to them.
146 This is useful for handling admin, dummy, and guest logins.
147 .\" @BEGIN: MF
148 .in -.5i
149 .Uh "Mail Filtering"
150 These options are only available if you compiled \fIMH\fP with
151 \*(lqoptions\ MF\*(rq.
152
153 .in +.5i
154 .ti -.5i
155 uucpchan: name of \fIUUCP\fR channel
156 .br
157 Usually \*(lqUUCP\*(rq.
158 This has no equivalent in the \fIMH\fR configuration file.
159
160 .ti -.5i
161 uucpldir: /usr/spool/mail
162 .br
163 The name of the directory where \fIUUCP\fR maildrops are kept.
164 This has no equivalent in the \fIMH\fR configuration file.
165
166 .ti -.5i
167 uucplfil:
168 .br
169 The name of the maildrop file in the directory where \fIUUCP\fR maildrops are
170 kept.
171 If this is empty, the user's login name is used.
172 This has no equivalent in the \fIMH\fR configuration file.
173
174 .ti -.5i
175 umincproc: /opt/mh-6.8.5/lib/uminc
176 .br
177 The path to the program that filters \fIUUCP\fR\^-style maildrops to
178 \fIMMDF\fR\^-style maildrops.
179 .\" @END: MF
180 .\" @BEGIN: MHMTS
181 .in -.5i
182 .Uh "Stand-Alone Delivery"
183 These options are only available if you compiled \fIMH\fP 
184 to use stand-alone delivery (i.e., \*(lqmts:\ mh\*(rq).
185
186 .in +.5i
187 .ti -.5i
188 mailqdir: /usr/spool/netmail
189 .br
190 The directory where network mail is queued.
191
192 .ti -.5i
193 tmailqdir: /usr/tmp
194 .br
195 The directory where network mail queue files are built.
196
197 .ti -.5i
198 syscpy: 1
199 .br
200 If ON, unauthorized mail is copied to the overseer.
201
202 .ti -.5i
203 overseer: root
204 .br
205 The user that receives reports of unauthorized mail.
206
207 .ti -.5i
208 mailer: root
209 .br
210 The user acting for the mail system.
211
212 .ti -.5i
213 fromtmp: /tmp/rml.f.XXXXXX
214 .br
215 The \fImktemp\fR template for storing from lines.
216
217 .ti -.5i
218 msgtmp: /tmp/rml.m.XXXXXX
219 .br
220 The \fImktemp\fR template for storing the rest of the message.
221
222 .ti -.5i
223 errtmp: /tmp/rml.e.XXXXXX
224 .br
225 The \fImktemp\fR template for storing error messages from other mailers.
226
227 .ti -.5i
228 tmpmode: 0600
229 .br
230 The octal mode which temporary files are set to.
231
232 .ti -.5i
233 okhosts: /opt/mh-6.8.5/lib/Rmail.OKHosts
234 .br
235 A file containing a list of hosts that can send ARPAnet mail.
236
237 .ti -.5i
238 okdests: /opt/mh-6.8.5/lib/RMail.OKDests
239 .br
240 A file containing a list of hosts that can always receive mail.
241 .\" @END: MHMTS
242 .\" @BEGIN: SMTP
243 .in -.5i
244 .Uh "The `/smtp' MTS Suffix"
245 These options are only available if you compiled \fIMH\fP with
246 the \*(lq/smtp\*(rq suffix to your \*(lqmts:\*(rq configuration.
247
248 .in +.5i
249 .ti -.5i
250 hostable: /opt/mh-6.8.5/lib/hosts
251 .br
252 The exceptions file for /etc/hosts used by \fIpost\fR to try to find official
253 names.
254 The format of this file is quite simple:
255
256 .in +.5i
257 1. Comments are surrounded by sharp (`#') and newline.
258 .br
259 2. Words are surrounded by white space.
260 .br
261 3. The first word on the line is the official name of a host.
262 .br
263 4. All words following the official names are aliases for that host.
264 .in -.5i
265
266 .ti -.5i
267 servers: localhost \\01localnet
268 .br
269 A lists of hosts and networks which to look for SMTP servers
270 when posting local mail.
271 It turns out this is a major win for hosts which don't run an message
272 transport system.
273 The value of \*(lqservers\*(rq should be one or more items.
274 Each item is the name of either a host or a net
275 (in the latter case, precede the name of the net by a \\01).
276 This list is searched when looking for a smtp server to post mail.
277 If a host is present, the SMTP port on that host is tried.
278 If a net is present,
279 the SMTP port on each host in that net is tried.
280 Note that if you are running with the BIND code,
281 then any networks specified are ignored
282 (sorry, the interface went away under BIND).
283 .\" @END: SMTP
284 .\" @BEGIN: SENDMTS
285 .in -.5i
286 .Uh "SendMail"
287 This option is only available if you compiled \fIMH\fP to
288 use \fISendMail\fP as your delivery agent (i.e., \*(lqmts:\ sendmail\*(rq).
289
290 .in +.5i
291 .ti -.5i
292 sendmail: /usr/lib/sendmail
293 .br
294 The pathname to the \fIsendmail\fR program.
295 .\" @END: SENDMTS
296 .\" @BEGIN: POP
297 .in -.5i
298 .Uh "Post Office Protocol"
299 This option is only available if you compiled \fIMH\fP with POP
300 support enabled (i.e., \*(lqpop:\ on\*(rq).
301
302 .in +.5i
303 .ti -.5i
304 pophost:
305 .br
306 The name of the default POP service host.
307 If this is not set,
308 then \fIMH\fR looks in the standard maildrop areas for waiting mail,
309 otherwise the named POP service host is consulted.
310 .\" @END: POP
311 .\" @BEGIN: BBSERVER
312 .in -.5i
313 .Uh "BBoards Delivery"
314 This option is only available if you compiled \fIMH\fP with
315 \*(lqbbdelivery:\ on\*(rq.
316
317 .in +.5i
318 .ti -.5i
319 bbdomain:
320 .br
321 The local BBoards domain (a UCI hack).
322 .\" @END: BBSERVER
323 .\" @BEGIN: BPOP
324 .in -.5i
325 .Uh "BBoards & The POP"
326 These options are only available if you compiled \fIMH\fP with
327 \*(lqbboards:\ pop\*(rq and \*(lqpop:\ on\*(rq.
328
329 .in +.5i
330 .ti -.5i
331 popbbhost:
332 .br
333 The POP service host which also acts as a BBoard server.
334 This variable should be set on the POP BBoards client host.
335
336 .ti -.5i
337 popbbuser:
338 .br
339 The guest account on the POP/BB service host.
340 This should be a different login ID than either the POP user or the BBoards
341 user.
342 (The user-id \*(lqftp\*(rq is highly recommended.)
343 This variable should be set on both the POP BBoards client and service hosts.
344
345 .ti -.5i
346 popbblist: /opt/mh-6.8.5/lib/hosts.popbb
347 .br
348 A file containing of lists of hosts that are allowed to use the POP facility
349 to access BBoards using the guest account.
350 If this file is not present,
351 then no check is made.
352 This variable should be set on the POP BBoards service host.
353 .\" @END: BPOP
354 .\" @BEGIN: NNTP
355 .in -.5i
356 .if n .ne 8
357 .Uh "BBoards & The NNTP"
358 This option is only available if you compiled \fIMH\fP with
359 \*(lqbboards:\ nntp\*(rq and \*(lqpop:\ on\*(rq.
360
361 .in +.5i
362 .ti -.5i
363 nntphost:
364 .br
365 The host which provides the NNTP service.
366 This variable should be set on the NNTP BBoards client host.
367 .\" @END: NNTP
368 .in -.5i
369 .Uh "File Locking"
370 A few words on locking:
371 \fIMH\fR has a flexible locking system for making locks on files.
372 There are two \fBmtstailor\fR variables you should be aware of
373 \*(lqlockstyle\*(rq and \*(lqlockldir\*(rq.
374 The first controls the method of locking,
375 the second says where lock files should be created.
376
377 The \*(lqlockstyle\*(rq variable can take on three values: 0, 1, 2.
378 A value of 0 is useful on systems with kernel-level locking.
379 If you are on a \fBBSD42\fP system, \fIMH\fP assumes
380 you have the \fIflock\fR system call.
381 On other systems:
382 define \fBFLOCK\fP if you want to use the \fIflock\fP system call;
383 define \fBLOCKF\fP if you want to use the \fIlockf\fP system call;
384 or define \fBFCNTL\fP if you want to use the \fIfcntl\fP system call
385 for kernel-level locking.
386 If you haven't configured \fIMH\fP to use kernel-level locking,
387 a locking style of 0 is considered the same as locking style 1.
388
389 A value of 1 or 2 specifies that a file should be created whose existence
390 means \*(lqlocked\*(rq and whose non-existence means \*(lqunlocked\*(rq.
391 A value of 1 says to construct the lockname by appending \*(lq.lock\*(rq to
392 the name of the file being locked.
393 A value of 2 says to construct the lockname by looking at the device and
394 inode numbers of the file being locked.
395 If the \*(lqlockldir\*(rq variable is not specified,
396 lock files will be created in the directory where the file being locked
397 resides.
398 Otherwise, lock files will be created in the directory specified by
399 \*(lqlockldir\*(rq.
400 Prior to installing \fIMH\fR,
401 you should see how locking is done at your site,
402 and set the appropriate values.
403 .Fi
404 ^/opt/mh-6.8.5/lib/mtstailor~^tailor file
405 .Pr
406 None
407 .Sa
408 mh\-gen(8), mh\-mts(8)
409 .De
410 As listed above
411 .Co
412 None
413 .En