Removed paragraphs which looked like forgotten to remove.
[mmh] / man / mh-tailor.man5
1 .\"
2 .\" %nmhwarning%
3 .\"
4 .TH MH-TAILOR %manext5% "%nmhdate%" MH.6.8 [%nmhversion%]
5 .SH NAME
6 mh-tailor, mts.conf \- mail transport customization for nmh message handler
7 .SH SYNOPSIS
8 .I %etcdir%/mts.conf
9 .SH DESCRIPTION
10 The file
11 .I %etcdir%/mts.conf
12 defines run-time options for those
13 .B nmh
14 programs which interact (in some form) with the message transport system.
15 At present, these (user) programs are:
16 .BR ap ,
17 .BR conflict ,
18 .BR inc ,
19 .BR msgchk ,
20 .BR post ,
21 .BR rcvdist ,
22 and
23 .BR rcvpack .
24 .PP
25 Each option should be given on a single line.  Blank lines and lines
26 which begin with `#' are ignored.  The options available along with
27 default values and a description of their meanings are listed below:
28 .PP
29 .B spost
30 will send messages by forking a
31 local copy of
32 .BR sendmail .
33 .PP
34 .BR mmdfldir :
35 %mailspool%
36 .RS 5
37 The directory where maildrops are kept.  If this option is set, but empty,
38 the user's home directory is used.  This overrides the default value
39 chosen at the time of compilation.
40 .RE
41 .PP
42 .BR mmdflfil :
43 .RS 5
44 The name of the maildrop file in the directory where maildrops are kept.
45 If this is empty, the user's login name is used.  This overrides the default
46 value (which is empty).
47 .RE
48 .PP
49 .BR mmdelim1 :
50 \&\\001\\001\\001\\001\\n
51 .RS 5
52 The beginning-of-message delimiter for maildrops.
53 .RE
54 .PP
55 .BR mmdelim2 :
56 \&\\001\\001\\001\\001\\n
57 .RS 5
58 The end-of-message delimiter for maildrops.
59 .RE
60 .PP
61 .BR masquerade:
62 .RS 5
63 This directive controls three different types of email address masquerading.
64 The three possible values, which may be specified in any combination on the
65 line, separated by spaces, are \*(lqdraft_from\*(rq, \*(lqmmailid\*(rq, and
66 \*(lqusername_extension\*(rq.
67 .PP
68 \*(lqmmailid\*(rq was the only type of masquerading in the original MH package, and
69 apparently stands for \*(lqmasquerade mail identification\*(rq.  This type of
70 masquerading keys off of the GECOS field of the passwd file.  When enabled,
71 .B nmh
72 will check if the user's pw_gecos field in the passwd file is of the
73 form:
74 .PP
75 .RS 5
76 Full Name <fakeusername>
77 .RE
78 .PP
79 If it is, the internal
80 .B nmh
81 routines that find the username and full name
82 of that user will return \*(lqfakeusername\*(rq and \*(lqFull Name\*(rq respectively.  This is
83 useful if you want the messages you send to always appear to come from the name
84 of an MTA alias rather than your actual account name.  For instance, many
85 organizations set up \*(lqFirst.Last\*(rq sendmail aliases for all users.  If this is
86 the case, the GECOS field for each user should look like:
87 .PP
88 .RS 5
89 First [Middle] Last <First.Last>
90 .RE
91 .PP
92 \*(lqusername_extension\*(rq, when specified on the \*(lqmasquerade:\*(rq line, allows a second
93 type of username masquerading.  If the user sets the
94 .B $USERNAME_EXTENSION
95 environment variable, its value will be appended to the actual login name.  For
96 instance, if I am \*(lqdan@company.com\*(rq, and I set
97 .B $USERNAME_EXTENSION
98 to \*(lq\-www\*(rq, my mail will appear to come from \*(lqdan\-www@company.com\*(rq.  This is meant
99 to interact with qmail's \*(lquser\-extension\*(rq feature, where mail sent to
100 .IR user \- string
101 will be delivered to
102 .IR user .
103 Likewise, those using
104 versions of sendmail for which \*(lqplussed user\*(rq processing is active can set
105 .B $USERNAME_EXTENSION
106 to \*(lq+\fIstring\fR\*(rq.  These MTA features are useful
107 because they allow one to use different email addresses in different situations
108 (to aid in automatic mail filtering or in determining where spammers got one's
109 address) while only actually having a single account.  Note that
110 .B $USERNAME_EXTENSION
111 is only appended to the username when \fIpost\fR is
112 generating \*(lq[Resent\-]From:\*(rq lines and the SMTP envelope
113 \*(lqFrom:\*(rq.
114 .BR inc ,
115 for instance, will not try to read from a maildrop file called \*(lqdan\-www\*(rq (to
116 recall the earlier example).
117 .PP
118 \*(lqdraft_from\*(rq controls the most powerful type of address masquerading.  Normally,
119 when a user explicitly specifies a \*(lqFrom:\*(rq header in a draft,
120 .B nmh
121 uses it
122 rather than constructing its own.  However, to discourage email forgery, the
123 SMTP envelope \*(lqFrom:\*(rq and a \*(lqSender:\*(rq header are set to the user's real address.
124 When \*(lqdraft_from\*(rq is turned on, though, the envelope \*(lqFrom:\*(rq will use the
125 address specified in the draft, and there will be no \*(lqSender:\*(rq header.  This is
126 useful when a user wants to pretend to be sending mail \*(lqdirectly\*(rq from a remote
127 POP3 account, or when remote mail robots incorrectly use the envelope \*(lqFrom:\*(rq in
128 preference to the body \*(lqFrom:\*(rq (or refuse to take action when the two don't
129 match).  Note that the MTA may still reveal the user's real identity (e.g.
130 .BR sendmail 's
131 \*(lqX\-Authentication\-Warning:\*(rq header).
132 .RE
133 .PP
134 .BR maildelivery :
135 %libdir%/maildelivery
136 .RS 5
137 The name of the system-wide default
138 .I maildelivery
139 file.
140 See
141 .BR slocal (1)
142 for the details.
143 .RE
144 .PP
145 .BR everyone :
146 200
147 .RS 5
148 The highest user-id which should NOT receive mail addressed to
149 \*(lqeveryone\*(rq.
150 .RE
151 .PP
152 .BR noshell :
153 .RS 5
154 If set, then each user-id greater than \*(lqeveryone\*(rq that has a
155 login shell equivalent to the given value (e.g., \*(lq/bin/csh\*(rq)
156 indicates that mail for \*(lqeveryone\*(rq should not be sent to them.
157 This is useful for handling admin, dummy, and guest logins.
158 .SS "File Locking"
159 A few words on locking:
160 .B nmh
161 has several methods for creating locks
162 on files.  When configuring
163 .BR nmh ,
164 you will need to decide on the
165 locking style and locking directory (if any).  The first controls the
166 method of locking, the second says where lock files should be created.
167 .PP
168 To configure
169 .B nmh
170 for kernel locking, use the \*(lq--with-locking=flock\*(rq configure option if
171 you want to use the
172 .B flock
173 system call; use \*(lq--with-locking=lockf\*(rq if
174 you want to use the
175 .B lockf
176 system call; or use \*(lq--with-locking=fcntl\*(rq
177 if you want to use the
178 .B fcntl
179 system call for kernel-level locking.
180 .PP
181 Instead of kernel locking, you can configure
182 .B nmh
183 to use dot locking by using \*(lq--with-locking=dot\*(rq.  Dot locking
184 specifies that
185 a file should be created whose existence means \*(lqlocked\*(rq and
186 whose non-existence means \*(lqunlocked\*(rq.  The name of this file is
187 constructed by appending \*(lq.lock\*(rq to the name of the file being
188 locked.  If
189 .B LOCKDIR
190 is not specified, lock files will be created
191 in the directory where the file being locked resides.  Otherwise, lock
192 files will be created in the directory specified by
193 .BR LOCKDIR .
194 .PP
195 Prior to installing
196 .BR nmh ,
197 you should see how locking is done at
198 your site, and set the appropriate values.
199
200 .SH FILES
201 .fc ^ ~
202 .nf
203 .ta \w'%etcdir%/ExtraBigFileName  'u
204 ^%etcdir%/mts.conf~^nmh mts configuration file
205 .fi
206
207 .SH "PROFILE COMPONENTS"
208 None
209
210 .SH "SEE ALSO"
211 mh\-mts(8), post(8)
212
213 .SH DEFAULTS
214 As listed above