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