ea95045a3e977ac33ba0f63c33192698cdb4d21e
[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, two different types of email address masquerading are
105 allowed ("mmailid" = "masquerade mail ID").  The first type is GECOS-based
106 masquerading.  \fInmh\fR will check if the user's pw_gecos field in the passwd
107 file is of the form:
108
109 .ti +.5i
110 Full Name <fakeusername>
111
112 If it is, the internal \fInmh\fR routines that find the username and full name
113 of that user will return "fakeusername" and "Full Name" respectively.  This is
114 useful if you want the messages you send to always appear to come from the name
115 of an MTA alias rather than your actual account name.  For instance, many
116 organizations set up "First.Last" sendmail aliases for all users.  If this is
117 the case, the GECOS field for each user should look like:
118
119 .ti +.5i
120 First [Middle] Last <First.Last>
121
122 The other type of masquerading that mmailid turns on is envelope "From:"
123 masquerading based on draft contents.  When a user explicitly specifies a
124 "From:" header in a message, \fInmh\fR uses it rather than constructing its own.
125 However, the SMTP envelope "From:" and the "Sender:" header are set to the
126 user's real address.  Turning on mmailid prevents this latter behavior.  This is
127 useful when the user wants to pretend to be sending mail "directly" from a
128 remote POP3 account, or when remote mail robots incorrectly use the envelope
129 "From:" in preference to the body "From:" (or refuse to take action when the two
130 don't match).
131
132 .ti -.5i
133 maildelivery: %libdir%/maildelivery
134 .br
135 The name of the system-wide default \fI\&.maildelivery\fR file.
136 See \fIslocal\fR\0(1) for the details.
137
138 .ti -.5i
139 everyone: 200
140 .br
141 The highest user-id which should NOT receive mail addressed to
142 \*(lqeveryone\*(rq.
143
144 .ti -.5i
145 noshell: 
146 .br
147 If set, then each user-id greater than \*(lqeveryone\*(rq that has a
148 login shell equivalent to the given value (e.g., \*(lq/bin/csh\*(rq)
149 indicates that mail for \*(lqeveryone\*(rq should not be sent to them.
150 This is useful for handling admin, dummy, and guest logins.
151
152 .in -.5i
153 .Uh "SMTP support"
154 These options are only available if you compiled \fInmh\fP with the
155 \*(lq/smtp\*(rq support.
156
157 .in +.5i
158 .ti -.5i
159 hostable: %etcdir%/hosts
160 .br
161 The exceptions file for /etc/hosts used by \fIpost\fR to try to find
162 official names.  The format of this file is quite simple:
163
164 .in +.5i
165 1. Comments are surrounded by sharp (`#') and newline.
166 .br
167 2. Words are surrounded by white space.
168 .br
169 3. The first word on the line is the official name of a host.
170 .br
171 4. All words following the official names are aliases for that host.
172 .in -.5i
173
174 .ti -.5i
175 servers: localhost \\01localnet
176 .br
177 A lists of hosts and networks which to look for SMTP servers when
178 posting local mail.  It turns out this is a major win for hosts which
179 don't run an message transport system.  The value of \*(lqservers\*(rq
180 should be one or more items.  Each item is the name of either a host
181 or a net (in the latter case, precede the name of the net by a \\01).
182 This list is searched when looking for a smtp server to post mail.
183 If a host is present, the SMTP port on that host is tried.  If a net
184 is present, the SMTP port on each host in that net is tried.  Note that
185 if you are running with the BIND code, then any networks specified are
186 ignored (sorry, the interface went away under BIND).
187
188 .in -.5i
189 .Uh "SendMail"
190 This option is only available if you compiled \fInmh\fP to use
191 \fISendMail\fP as your delivery agent.
192
193 .in +.5i
194 .ti -.5i
195 sendmail: %sendmailpath%
196 .br
197 The pathname to the \fIsendmail\fR program.
198
199 .in -.5i
200 .Uh "Post Office Protocol"
201 This option is only available if you have compiled \fInmh\fP with POP
202 support enabled (i.e., \*(lq--enable-nmh-pop\*(rq).
203
204 .in +.5i
205 .ti -.5i
206 pophost:
207 .br
208 The name of the default POP service host.  If this is not set, then
209 \fInmh\fR looks in the standard maildrop areas for waiting mail, otherwise
210 the named POP service host is consulted.
211
212 .in -.5i
213 .Uh "BBoards Delivery"
214 This option is only available if you compiled \fInmh\fP with
215 \*(lqbbdelivery:\ on\*(rq.
216
217 .in +.5i
218 .ti -.5i
219 bbdomain:
220 .br
221 The local BBoards domain (a UCI hack).
222
223 .in -.5i
224 .Uh "BBoards & The POP"
225 These options are only available if you compiled \fInmh\fP with
226 \*(lqbboards:\ pop\*(rq and \*(lqpop:\ on\*(rq.
227
228 .in +.5i
229 .ti -.5i
230 popbbhost:
231 .br
232 The POP service host which also acts as a BBoard server.  This variable
233 should be set on the POP BBoards client host.
234
235 .ti -.5i
236 popbbuser:
237 .br
238 The guest account on the POP/BB service host.  This should be a different
239 login ID than either the POP user or the BBoards user.  (The user-id
240 \*(lqftp\*(rq is highly recommended.)  This variable should be set on
241 both the POP BBoards client and service hosts.
242
243 .ti -.5i
244 popbblist: %etcdir%/hosts.popbb
245 .br
246 A file containing of lists of hosts that are allowed to use the POP
247 facility to access BBoards using the guest account.  If this file is not
248 present, then no check is made.  This variable should be set on the POP
249 BBoards service host.
250
251 .in -.5i
252 .if n .ne 8
253 .Uh "BBoards & The NNTP"
254 This option is only available if you compiled \fInmh\fP with
255 \*(lqbboards:\ nntp\*(rq and \*(lqpop:\ on\*(rq.
256
257 .in +.5i
258 .ti -.5i
259 nntphost:
260 .br
261 The host which provides the NNTP service.  This variable should be set
262 on the NNTP BBoards client host.
263
264 .in -.5i
265 .Uh "File Locking"
266 A few words on locking: \fInmh\fR has several methods for creating locks
267 on files.  When configuring \fInmh\fR, you will need to decide on the
268 locking style and locking directory (if any).  The first controls the
269 method of locking, the second says where lock files should be created.
270
271 To configure \fInmh\fR for kernel locking, define \fBFLOCK_LOCKING\fP if
272 you want to use the \fIflock\fP system call; define \fBLOCKF_LOCKING\fP if
273 you want to use the \fIlockf\fP system call; or define \fBFCNTL_LOCKING\fP
274 if you want to use the \fIfcntl\fP system call for kernel-level locking.
275
276 Instead of kernel locking, you can configure \fInmh\fR to use dot
277 locking by defining \fBDOT_LOCKING\fP.  Dot locking specifies that
278 a file should be created whose existence means \*(lqlocked\*(rq and
279 whose non-existence means \*(lqunlocked\*(rq.  The name of this file is
280 constructed by appending \*(lq.lock\*(rq to the name of the file being
281 locked.  If \fBLOCKDIR\fP is not specified, lock files will be created
282 in the directory where the file being locked resides.  Otherwise, lock
283 files will be created in the directory specified by \fBLOCKDIR\fP.
284
285 Prior to installing \fInmh\fR, you should see how locking is done at
286 your site, and set the appropriate values.
287
288 .Fi
289 ^%etcdir%/mts.conf~^nmh mts configuration file
290 .Pr
291 None
292 .Sa
293 mh\-mts(8)
294 .De
295 As listed above
296 .Co
297 None
298 .En