git.marmaro.de Git - mmh/blob - man/mh-tailor.man

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