Automated #define of MAILGROUP and installation of inc as setgid mail when the
[mmh] / man / mh-tailor.man
1 .\"
2 .\" %nmhwarning%
3 .\" $Id$
4 .\"
5 .\" include the -mh macro file
6 .so %etcdir%/tmac.h
7 .\"
8 .TH MH-TAILOR %manext5% MH.6.8 [%nmhversion%]
9 .SH NAME
10 mh-tailor, mts.conf \- mail transport customization for nmh message handler
11
12 .SH SYNOPSIS
13 .in +.5i
14 .ti -.5i
15 \fI%etcdir%/mts.conf\fP
16 .in -.5i
17 .SH DESCRIPTION
18 The file %etcdir%/mts.conf defines run-time options for those \fInmh\fR
19 programs which interact (in some form) with the message transport system.
20 At present, these (user) programs are: \fIap\fR, \fIconflict\fR,
21 \fIinc\fR, \fImsgchk\fR, \fImsh\fR, \fIpost\fR, \fIrcvdist\fR, and
22 \fIrcvpack\fR.
23
24 Each option should be given on a single line.  Blank lines and lines
25 which begin with `#' are ignored.  The options available along with
26 default values and a description of their meanings are listed below:
27
28 .in +.5i
29 .ti -.5i
30 localname:
31 .br
32 The hostname \fInmh\fR considers local.  It should typically be a fully
33 qualified hostname.  If this is not set, depending on the version of
34 UNIX you're running, \fInmh\fR will query the system for this value
35 (e.g., uname, gethostname, etc.), and attempt to fully qualify this
36 value.
37
38 If you are using POP to retrieve new messages, you may want to set this
39 value to the name of the POP server, so that outgoing message appear to
40 have originated on the POP server.
41
42 .ti -.5i
43 localdomain:
44 .br
45 If this is set, a `.' followed by this string will be appended to your
46 hostname.
47
48 This should only be needed, if for some reason \fInmh\fR is not able to
49 fully qualify the hostname returned by the system (e.g., uname,
50 gethostname, etc.).
51
52 .ti -.5i
53 clientname:
54 .br
55 This option specifies the host name that \fInmh\fP will give in the
56 SMTP \fBHELO\fP (and \fBEHLO\fP) command, when posting mail.  If not
57 set, the default is to use the host name that \fInmh\fR considers local
58 (see \*(lqlocalname\*(rq above).  If this option is set, but empty, no
59 \fBHELO\fP command will be given.
60
61 .sp
62 Although the \fBHELO\fP command is required by RFC\-821, many SMTP servers
63 do not require it.  Early versions of SendMail will fail if the hostname
64 given in the \fBHELO\fP command is the local host.  Later versions of
65 SendMail will complain if you omit the \fBHELO\fP command.  If you run
66 SendMail, find out what your system expects and set this field if needed.
67
68 .ti -.5i
69 systemname:
70 .br
71 This option is only used for UUCP mail.  It specifies the name of the
72 local host in the \fIUUCP\fR \*(lqdomain\*(rq.  If not set, depending
73 on the version of UNIX you're running, \fInmh\fR will query the system
74 for this value.  This has no equivalent in the \fInmh\fR configuration
75 file.
76
77 .ti -.5i
78 mmdfldir: %mailspool%
79 .br
80 The directory where maildrops are kept.  If this option is set, but empty,
81 the user's home directory is used.  This overrides the default value
82 chosen at the time of compilation.
83
84 .ti -.5i
85 mmdflfil: 
86 .br
87 The name of the maildrop file in the directory where maildrops are kept.
88 If this is empty, the user's login name is used.  This overrides the default
89 value (which is empty).
90
91 .ti -.5i
92 mmdelim1: \\001\\001\\001\\001\\n
93 .br
94 The beginning-of-message delimiter for maildrops.
95
96 .ti -.5i
97 mmdelim2: \\001\\001\\001\\001\\n
98 .br
99 The end-of-message delimiter for maildrops.
100
101 .ti -.5i
102 mmailid: 0
103 .br
104 If this is non-zero, then activate support for MMailids (username
105 masquerading).  When this is activated, \fInmh\fR will check if the
106 pw_gecos field in the password file has the form
107
108 .ti +.5i
109 Full Name <fakeusername>
110
111 If the pw_gecos field has this form, then the internal \fInmh\fR
112 routines that find the username and full name of a user will return
113 \*(lqfakeusername\*(rq and \*(lqFull Name\*(rq respectively.  If
114 the pw_gecos field for a user is not of this form, there will be
115 no username masquerading for that user.
116
117 This facility is useful if you are using POP, and wish for messages
118 that are sent by users to appear to originate from the username of
119 their POP account, rather than their username on the local machine.
120
121 .ti -.5i
122 maildelivery: %libdir%/maildelivery
123 .br
124 The name of the system-wide default \fI\&.maildelivery\fR file.
125 See \fIslocal\fR\0(1) for the details.
126
127 .ti -.5i
128 everyone: 200
129 .br
130 The highest user-id which should NOT receive mail addressed to
131 \*(lqeveryone\*(rq.
132
133 .ti -.5i
134 noshell: 
135 .br
136 If set, then each user-id greater than \*(lqeveryone\*(rq that has a
137 login shell equivalent to the given value (e.g., \*(lq/bin/csh\*(rq)
138 indicates that mail for \*(lqeveryone\*(rq should not be sent to them.
139 This is useful for handling admin, dummy, and guest logins.
140
141 .in -.5i
142 .Uh "SMTP support"
143 These options are only available if you compiled \fInmh\fP with the
144 \*(lq/smtp\*(rq support.
145
146 .in +.5i
147 .ti -.5i
148 hostable: %etcdir%/hosts
149 .br
150 The exceptions file for /etc/hosts used by \fIpost\fR to try to find
151 official names.  The format of this file is quite simple:
152
153 .in +.5i
154 1. Comments are surrounded by sharp (`#') and newline.
155 .br
156 2. Words are surrounded by white space.
157 .br
158 3. The first word on the line is the official name of a host.
159 .br
160 4. All words following the official names are aliases for that host.
161 .in -.5i
162
163 .ti -.5i
164 servers: localhost \\01localnet
165 .br
166 A lists of hosts and networks which to look for SMTP servers when
167 posting local mail.  It turns out this is a major win for hosts which
168 don't run an message transport system.  The value of \*(lqservers\*(rq
169 should be one or more items.  Each item is the name of either a host
170 or a net (in the latter case, precede the name of the net by a \\01).
171 This list is searched when looking for a smtp server to post mail.
172 If a host is present, the SMTP port on that host is tried.  If a net
173 is present, the SMTP port on each host in that net is tried.  Note that
174 if you are running with the BIND code, then any networks specified are
175 ignored (sorry, the interface went away under BIND).
176
177 .in -.5i
178 .Uh "SendMail"
179 This option is only available if you compiled \fInmh\fP to use
180 \fISendMail\fP as your delivery agent.
181
182 .in +.5i
183 .ti -.5i
184 sendmail: %sendmailpath%
185 .br
186 The pathname to the \fIsendmail\fR program.
187
188 .in -.5i
189 .Uh "Post Office Protocol"
190 This option is only available if you have compiled \fInmh\fP with POP
191 support enabled (i.e., \*(lq--enable-nmh-pop\*(rq).
192
193 .in +.5i
194 .ti -.5i
195 pophost:
196 .br
197 The name of the default POP service host.  If this is not set, then
198 \fInmh\fR looks in the standard maildrop areas for waiting mail, otherwise
199 the named POP service host is consulted.
200
201 .in -.5i
202 .Uh "BBoards Delivery"
203 This option is only available if you compiled \fInmh\fP with
204 \*(lqbbdelivery:\ on\*(rq.
205
206 .in +.5i
207 .ti -.5i
208 bbdomain:
209 .br
210 The local BBoards domain (a UCI hack).
211
212 .in -.5i
213 .Uh "BBoards & The POP"
214 These options are only available if you compiled \fInmh\fP with
215 \*(lqbboards:\ pop\*(rq and \*(lqpop:\ on\*(rq.
216
217 .in +.5i
218 .ti -.5i
219 popbbhost:
220 .br
221 The POP service host which also acts as a BBoard server.  This variable
222 should be set on the POP BBoards client host.
223
224 .ti -.5i
225 popbbuser:
226 .br
227 The guest account on the POP/BB service host.  This should be a different
228 login ID than either the POP user or the BBoards user.  (The user-id
229 \*(lqftp\*(rq is highly recommended.)  This variable should be set on
230 both the POP BBoards client and service hosts.
231
232 .ti -.5i
233 popbblist: %etcdir%/hosts.popbb
234 .br
235 A file containing of lists of hosts that are allowed to use the POP
236 facility to access BBoards using the guest account.  If this file is not
237 present, then no check is made.  This variable should be set on the POP
238 BBoards service host.
239
240 .in -.5i
241 .if n .ne 8
242 .Uh "BBoards & The NNTP"
243 This option is only available if you compiled \fInmh\fP with
244 \*(lqbboards:\ nntp\*(rq and \*(lqpop:\ on\*(rq.
245
246 .in +.5i
247 .ti -.5i
248 nntphost:
249 .br
250 The host which provides the NNTP service.  This variable should be set
251 on the NNTP BBoards client host.
252
253 .in -.5i
254 .Uh "File Locking"
255 A few words on locking: \fInmh\fR has several methods for creating locks
256 on files.  When configuring \fInmh\fR, you will need to decide on the
257 locking style and locking directory (if any).  The first controls the
258 method of locking, the second says where lock files should be created.
259
260 To configure \fInmh\fR for kernel locking, define \fBFLOCK_LOCKING\fP if
261 you want to use the \fIflock\fP system call; define \fBLOCKF_LOCKING\fP if
262 you want to use the \fIlockf\fP system call; or define \fBFCNTL_LOCKING\fP
263 if you want to use the \fIfcntl\fP system call for kernel-level locking.
264
265 Instead of kernel locking, you can configure \fInmh\fR to use dot
266 locking by defining \fBDOT_LOCKING\fP.  Dot locking specifies that
267 a file should be created whose existence means \*(lqlocked\*(rq and
268 whose non-existence means \*(lqunlocked\*(rq.  The name of this file is
269 constructed by appending \*(lq.lock\*(rq to the name of the file being
270 locked.  If \fBLOCKDIR\fP is not specified, lock files will be created
271 in the directory where the file being locked resides.  Otherwise, lock
272 files will be created in the directory specified by \fBLOCKDIR\fP.
273
274 Prior to installing \fInmh\fR, you should see how locking is done at
275 your site, and set the appropriate values.
276
277 .Fi
278 ^%etcdir%/mts.conf~^nmh mts configuration file
279 .Pr
280 None
281 .Sa
282 mh\-mts(8)
283 .De
284 As listed above
285 .Co
286 None
287 .En