diplodocus.org Git - nmh/blob - man/mh-tailor.man

   1 .TH MH-TAILOR %manext5% "July 11, 2012" "%nmhversion%"
   2 .\"
   3 .\" %nmhwarning%
   4 .\"
   5 .SH NAME
   6 mh-tailor, mts.conf \- mail transport configuration for nmh message handler
   7 .SH DESCRIPTION
   8 The file
   9 .I %etcdir%/mts.conf
  10 defines run-time options for those
  11 .B nmh
  12 programs which interact (in some form) with the message transport system.
  13 At present, these (user) programs are:
  14 .BR ap ,
  15 .BR conflict ,
  16 .BR inc ,
  17 .BR msgchk ,
  18 .BR msh ,
  19 .BR post ,
  20 .BR rcvdist ,
  21 and
  22 .BR rcvpack .
  23 .PP
  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 .PP
  28 .BR mts :
  29 .RS 5
  30 The mail transport method to use.  The three acceptable options are
  31 .B smtp
  32 (which is the default),
  33 .BR sendmail/smtp ,
  34 and
  35 .BR sendmail/pipe .
  36 .PP
  37 If you use
  38 .BR smtp ,
  39 this will enable a direct SMTP (simple mail transport
  40 protocol) interface in
  41 .BR nmh .
  42 When sending mail, instead of passing the
  43 message to the mail transport agent,
  44 .B post
  45 will open a socket connection
  46 to the mail port on the machine specified in the
  47 .B servers
  48 entry.
  49 .PP
  50 If you use
  51 .BR sendmail/smtp ,
  52 then
  53 .B post
  54 will send messages by forking a
  55 local copy of
  56 .BR sendmail .
  57 It will still speak SMTP with this local copy of
  58 .BR sendmail .
  59 For backward compatibility,
  60 .B sendmail/smtp
  61 can be abbreviated to
  62 .BR sendmail .
  63 .PP
  64 The third alternative,
  65 .BR sendmail/pipe ,
  66 also forks a local copy of
  67 .B sendmail
  68 but feeds the message directly to it, using
  69 .B sendmail
  70 .BR -t .
  71 This replaces the old, undocumented
  72 .B spost
  73 mechanism and retains some of its limitations, such as lack of
  74 support for the
  75 .B \-whom
  76 switch and
  77 \*(lqDcc:\*(rq header field.
  78 .RE
  79 .PP
  80 .BR localname :
  81 .RS 5
  82 The hostname
  83 .B nmh
  84 considers local.  It should typically be a fully
  85 qualified hostname.  If this is not set, depending on the version of
  86 UNIX you're running,
  87 .B nmh
  88 will query the system for this value
  89 (e.g. uname, gethostname, etc.), and attempt to fully qualify this
  90 value.
  91 .PP
  92 If you are using POP to retrieve new messages, you may want to set this
  93 value to the name of the POP server, so that outgoing message appear to
  94 have originated on the POP server.
  95 .RE
  96 .PP
  97 .BR localdomain :
  98 .RS 5
  99 If this is set, a `.' followed by this string will be appended to your
 100 hostname.
 101 .PP
 102 This should only be needed, if for some reason
 103 .B nmh
 104 is not able to
 105 fully qualify the hostname returned by the system (e.g. uname,
 106 gethostname, etc.).
 107 .RE
 108 .PP
 109 .BR clientname :
 110 .RS 5
 111 This option specifies the host name that
 112 .B nmh
 113 will give in the
 114 SMTP
 115 .B HELO
 116 (and
 117 .BR EHLO )
 118 command, when posting mail.  If not
 119 set, the default is to use the host name that
 120 .B nmh
 121 considers local
 122 (see
 123 .B localname
 124 above).  If this option is set, but empty, no
 125 .B HELO
 126 command will be given.
 127 .PP
 128 Although the
 129 .B HELO
 130 command is required by RFC 821, many SMTP servers
 131 do not require it.  Early versions of
 132 .I SendMail
 133 will fail if the hostname
 134 given in the
 135 .B HELO
 136 command is the local host.  Later versions of
 137 .I SendMail
 138 will complain if you omit the
 139 .B HELO
 140 command.  If you run
 141 .IR SendMail ,
 142 find out what your system expects and set this field if needed.
 143 .RE
 144 .PP
 145 .BR systemname :
 146 .RS 5
 147 This option is only used for UUCP mail.  It specifies the name of the
 148 local host in the UUCP \*(lqdomain\*(rq.  If not set, depending
 149 on the version of UNIX you're running,
 150 .B nmh
 151 will query the system
 152 for this value.  This has no equivalent in the
 153 .B nmh
 154 configuration
 155 file.
 156 .RE
 157 .PP
 158 .BR mmdfldir :
 159 %mailspool%
 160 .RS 5
 161 The directory where maildrops are kept.  If this option is set, but empty,
 162 the user's home directory is used.  This overrides the default value
 163 chosen at the time of compilation.
 164 .RE
 165 .PP
 166 .BR mmdflfil :
 167 .RS 5
 168 The name of the maildrop file in the directory where maildrops are kept.
 169 If this is empty, the user's login name is used.  This overrides the default
 170 value (which is empty).
 171 .RE
 172 .PP
 173 .BR mmdelim1 :
 174 \&\\001\\001\\001\\001\\n
 175 .RS 5
 176 The beginning-of-message delimiter for maildrops.
 177 .RE
 178 .PP
 179 .BR mmdelim2 :
 180 \&\\001\\001\\001\\001\\n
 181 .RS 5
 182 The end-of-message delimiter for maildrops.
 183 .RE
 184 .PP
 185 .BR spoollocking :
 186 %default_locking%
 187 .RS 5
 188 The locking algorithm to use when opening the maildrop.  Can be any one of
 189 the following:
 190 .PP
 191 .RS 5
 192 .nf
 193 %supported_locks%
 194 .fi
 195 .RE
 196 .RE
 197 .PP
 198 .BR maildelivery :
 199 %libdir%/maildelivery
 200 .RS 5
 201 The name of the system-wide default
 202 .I maildelivery
 203 file.
 204 See
 205 .IR slocal (1)
 206 for the details.
 207 .RE
 208 .PP
 209 .BR everyone :
 210 200
 211 .RS 5
 212 The highest user-id which should NOT receive mail addressed to
 213 \*(lqeveryone\*(rq.
 214 .RE
 215 .PP
 216 .BR noshell :
 217 .RS 5
 218 If set, then each user-id greater than \*(lqeveryone\*(rq that has a
 219 login shell equivalent to the given value (e.g., \*(lq/bin/csh\*(rq)
 220 indicates that mail for \*(lqeveryone\*(rq should not be sent to them.
 221 This is useful for handling admin, dummy, and guest logins.
 222 .RE
 223 .SS "SMTP support"
 224 This option is only available if you set
 225 .B mts
 226 to
 227 .BR smtp .
 228 .PP
 229 .BR servers :
 230 localhost
 231 .RS 5
 232 A lists of hosts and networks which to look for SMTP servers when
 233 posting non\-local mail.  It turns out this is a major win for hosts
 234 which don't run an message transport system.  The value of
 235 .B servers
 236 should be one or more items.  Each item is the name of a host which
 237 is (hopefully) running a SMTP server.
 238 .SS "SendMail"
 239 This option is only available if you set
 240 .B mts
 241 to
 242 .BR sendmail .
 243 .PP
 244 .BR sendmail :
 245 %sendmailpath%
 246 .RS 5
 247 The pathname to the
 248 .B sendmail
 249 program.
 250 .RE
 251 .SS "Post Office Protocol"
 252 This option is only available if you have compiled
 253 .B nmh
 254 with POP support enabled (i.e., \*(lq--enable-pop\*(rq).
 255 .PP
 256 .BR pophost :
 257 .RS 5
 258 The name of the default POP service host.  If this is not set, then
 259 .B nmh
 260 looks in the standard maildrop areas for waiting mail, otherwise
 261 the named POP service host is consulted.
 262 .RE
 263 \"  .SS "BBoards Delivery"
 264 \"  This option is only available if you compiled \fInmh\fP with
 265 \"  \*(lqbbdelivery:\ on\*(rq.
 266 \"  .PP
 267 \"  .BR bbdomain :
 268 \"  .RS 5
 269 \"  The local BBoards domain (a UCI hack).
 270 \"  .RE
 271 \"  .SS "BBoards & The POP"
 272 \"  These options are only available if you compiled \fInmh\fP with
 273 \"  \*(lqbboards:\ pop\*(rq and \*(lqpop:\ on\*(rq.
 274 \"  .PP
 275 \"  .BR popbbhost :
 276 \"  .RS 5
 277 \"  The POP service host which also acts as a BBoard server.  This variable
 278 \"  should be set on the POP BBoards client host.
 279 \"  .RE
 280 \"  .PP
 281 \"  .BR popbbuser :
 282 \"  .RS 5
 283 \"  The guest account on the POP/BB service host.  This should be a different
 284 \"  login ID than either the POP user or the BBoards user.  (The user-id
 285 \"  \*(lqftp\*(rq is highly recommended.)  This variable should be set on
 286 \"  both the POP BBoards client and service hosts.
 287 \"  .RE
 288 \"  .PP
 289 \"  .BR popbblist :
 290 \"  %etcdir%/hosts.popbb
 291 \"  .RS 5
 292 \"  A file containing of lists of hosts that are allowed to use the POP
 293 \"  facility to access BBoards using the guest account.  If this file is not
 294 \"  present, then no check is made.  This variable should be set on the POP
 295 \"  BBoards service host.
 296 \"  .RE
 297 .SS "File Locking"
 298 A few words on locking:
 299 .B nmh
 300 has several methods for creating locks
 301 on files.  When configuring
 302 .BR nmh ,
 303 you will need to decide on the
 304 locking style and locking directory (if any).  The first controls the
 305 method of locking, the second says where lock files should be created.
 306 .PP
 307 To configure
 308 .B nmh
 309 for kernel locking, use the \*(lq--with-locking=flock\*(rq configure option if
 310 you want to use the
 311 .B flock
 312 system call; use \*(lq--with-locking=lockf\*(rq if
 313 you want to use the
 314 .B lockf
 315 system call; or use \*(lq--with-locking=fcntl\*(rq
 316 if you want to use the
 317 .B fcntl
 318 system call for kernel-level locking.
 319 .PP
 320 Instead of kernel locking, you can configure
 321 .B nmh
 322 to use dot locking by using \*(lq--with-locking=dot\*(rq.  Dot locking
 323 specifies that
 324 a file should be created whose existence means \*(lqlocked\*(rq and
 325 whose non-existence means \*(lqunlocked\*(rq.  The name of this file is
 326 constructed by appending \*(lq.lock\*(rq to the name of the file being
 327 locked.  If \*(lq--enable-lockdir=directory\*(rq
 328 is not specified at build time, lock files will be created
 329 in the directory where the file being locked resides.  Otherwise, lock
 330 files will be created in the directory specified by
 331 \*(lq--enable-lockdir\*(rq.
 332 .PP
 333 Prior to installing
 334 .BR nmh ,
 335 you should see how locking is done at
 336 your site, and set the appropriate values.
 337 .SH FILES
 338 .fc ^ ~
 339 .nf
 340 .ta \w'%etcdir%/ExtraBigFileName  'u
 341 ^%etcdir%/mts.conf~^nmh mts configuration file
 342 .fi
 343 .SH "PROFILE COMPONENTS"
 344 None
 345 .SH "SEE ALSO"
 346 .IR mh\-mts (8),
 347 .IR post (8)
 348 .SH DEFAULTS
 349 As listed above.  The path of the mail transport configuration
 350 file can be changed with the
 351 .B MHMTSCONF
 352 environment variable and augmented with the
 353 .B MHMTSUSERCONF
 354 environment variable, see mh\-profile(5).
 355 .SH BUGS
 356 Failure to open any mail transport configuration file is silently
 357 ignored.  Therefore, it's best to avoid dynamic creation of such
 358 a file with the intent of use via the
 359 .B MHMTSCONF
 360 or
 361 .B MHMTSUSERCONF
 362 environment variables.  If such use is necessary, the ability
 363 to successfully open the file should first be verified.