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

   1 .TH MH-TAILOR %manext5% 2017-02-19 "%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 %nmhetcdir%/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 inc ,
  16 .BR msgchk ,
  17 .BR post ,
  18 .BR rcvdist ,
  19 and
  20 .BR rcvpack .
  21 .PP
  22 Each option should be given on a single line.  Blank lines and lines
  23 which begin with `#' are ignored.  The options available along with
  24 default values and a description of their meanings are listed below:
  25 .PP
  26 .BR mts :
  27 .RS 5
  28 The mail transport method to use.  The three acceptable options are
  29 .B smtp
  30 (which is the default),
  31 .BR sendmail/smtp ,
  32 and
  33 .BR sendmail/pipe .
  34 .PP
  35 If you use
  36 .BR smtp ,
  37 this will enable a direct SMTP interface in
  38 .BR nmh .
  39 When sending mail, instead of passing the message to the mail
  40 transport agent,
  41 .B post
  42 will open a socket connection to the mail port on the machine
  43 specified in the
  44 .B servers
  45 entry.
  46 .PP
  47 If you use
  48 .BR sendmail/smtp ,
  49 then
  50 .B post
  51 will send messages by forking a local copy of
  52 .BR sendmail .
  53 It will still speak SMTP with this local copy of
  54 .BR sendmail .
  55 For backward compatibility,
  56 .B sendmail/smtp
  57 can be abbreviated to
  58 .BR sendmail .
  59 .PP
  60 The third alternative,
  61 .BR sendmail/pipe ,
  62 also forks a local copy of
  63 .B sendmail
  64 but feeds the message directly to it, using
  65 .B sendmail
  66 .BR -t .
  67 This replaces the old, undocumented
  68 .B spost
  69 mechanism and retains some of its limitations, such as lack of
  70 support for the
  71 .B \-whom
  72 switch and \*(lqDcc:\*(rq header field.
  73 .RE
  74 .PP
  75 .BR localname :
  76 .RS 5
  77 The hostname
  78 .B nmh
  79 considers local.  It should typically be a fully qualified hostname.
  80 If this is not set, depending on the version of Unix you're running,
  81 .B nmh
  82 will query the system for this value (e.g.\& uname, gethostname, etc.),
  83 and attempt to fully qualify this value.
  84 .PP
  85 If you are using POP to retrieve new messages, you may want to set this
  86 value to the name of the POP server, so that outgoing messages appear to
  87 have originated on the POP server.
  88 .RE
  89 .PP
  90 .BR localdomain :
  91 .RS 5
  92 If this is set, a `.' followed by this string will be appended to your
  93 hostname.
  94 .PP
  95 This should only be needed, if for some reason
  96 .B nmh
  97 is not able to fully qualify the hostname returned by the system
  98 (e.g.\& uname, gethostname, etc.).
  99 .RE
 100 .PP
 101 .BR clientname :
 102 .RS 5
 103 This option specifies the host name that
 104 .B nmh
 105 will give in the SMTP
 106 .B HELO
 107 (and
 108 .BR EHLO )
 109 command, when posting mail.  If not set, the default is to use the
 110 host name that
 111 .B nmh
 112 considers local (see
 113 .B localname
 114 above).  If this option is set, but empty, no
 115 .B HELO
 116 command will be given.
 117 .PP
 118 Although the
 119 .B HELO
 120 command is required by RFC 821, many SMTP servers do not require it.
 121 Early versions of
 122 .I SendMail
 123 will fail if the hostname given in the
 124 .B HELO
 125 command is the local host.  Later versions of
 126 .I SendMail
 127 will complain if you omit the
 128 .B HELO
 129 command.  If you run
 130 .IR SendMail ,
 131 find out what your system expects and set this field if needed.
 132 .RE
 133 .PP
 134 .BR systemname :
 135 .RS 5
 136 This option is only used for UUCP mail.  It specifies the name of the
 137 local host in the UUCP \*(lqdomain\*(rq.  If not set, depending
 138 on the version of Unix you're running,
 139 .B nmh
 140 will query the system
 141 for this value.  This has no equivalent in the
 142 .B nmh
 143 configuration
 144 file.
 145 .RE
 146 .PP
 147 .BR mmdfldir :
 148 %mailspool%
 149 .RS 5
 150 The directory where mail drops are kept.  If this option is set, but empty,
 151 the user's home directory is used.  This overrides the default value
 152 chosen at the time of compilation.
 153 .RE
 154 .PP
 155 .BR mmdflfil :
 156 .RS 5
 157 The name of the mail drop file in the directory where mail drops are kept.
 158 If this is empty, the user's login name is used.  This overrides the default
 159 value (which is empty).
 160 .RE
 161 .PP
 162 .BR mmdelim1 :
 163 \\001\\001\\001\\001\\n
 164 .RS 5
 165 The beginning-of-message delimiter for mail drops.
 166 .RE
 167 .PP
 168 .BR mmdelim2 :
 169 \\001\\001\\001\\001\\n
 170 .RS 5
 171 The end-of-message delimiter for mail drops.
 172 .RE
 173 .PP
 174 .BR spoollocking :
 175 %default_locking%
 176 .RS 5
 177 The locking algorithm to use when opening the mail drop.  Can be any one of
 178 the following:
 179 .PP
 180 .RS 5
 181 .nf
 182 %supported_locks%
 183 .fi
 184 .RE
 185 .RE
 186 .PP
 187 .BR maildelivery :
 188 %nmhlibexecdir%/maildelivery
 189 .RS 5
 190 The name of the system-wide default
 191 .I maildelivery
 192 file.
 193 See
 194 .IR slocal (1)
 195 for the details.
 196 .RE
 197 .SS "SMTP support"
 198 This option is only available if you set
 199 .B mts
 200 to
 201 .BR smtp .
 202 .PP
 203 .BR servers :
 204 localhost
 205 .RS 5
 206 A single hostname to be used when performing mail submission via SMTP.
 207 Previous versions of
 208 .B nmh
 209 supported multiple hostnames for
 210 .BR servers ,
 211 but the current version of
 212 .B nmh
 213 only supports a single entry (the name is kept for backwards compatibility
 214 reasons).  This can be overridden via the
 215 .B \-server
 216 switch to
 217 .IR send (1).
 218 It is not possible to change the mail submission port number in the
 219 .B servers
 220 entry; see the
 221 .B \-port
 222 switch to
 223 .BR send (1)
 224 for this functionality.
 225 .SS "SendMail"
 226 This option is only available if you set
 227 .B mts
 228 to
 229 .BR sendmail .
 230 .PP
 231 .BR sendmail :
 232 %sendmailpath%
 233 .RS 5
 234 The pathname to the
 235 .B sendmail
 236 program.
 237 .RE
 238 .SS "Post Office Protocol"
 239 .BR pophost :
 240 .RS 5
 241 The name of the default POP service host.  If this is not set, then
 242 .B nmh
 243 looks in the standard mail drop areas for waiting mail, otherwise
 244 the named POP service host is consulted.
 245 .RE
 246 .\"  .SS "BBoards Delivery"
 247 .\"  This option is only available if you compiled \fInmh\fP with
 248 .\"  \*(lqbbdelivery:\ on\*(rq.
 249 .\"  .PP
 250 .\"  .BR bbdomain :
 251 .\"  .RS 5
 252 .\"  The local BBoards domain (a UCI hack).
 253 .\"  .RE
 254 .\"  .SS "BBoards & The POP"
 255 .\"  These options are only available if you compiled \fInmh\fP with
 256 .\"  \*(lqbboards:\ pop\*(rq and \*(lqpop:\ on\*(rq.
 257 .\"  .PP
 258 .\"  .BR popbbhost :
 259 .\"  .RS 5
 260 .\"  The POP service host which also acts as a BBoard server.  This variable
 261 .\"  should be set on the POP BBoards client host.
 262 .\"  .RE
 263 .\"  .PP
 264 .\"  .BR popbbuser :
 265 .\"  .RS 5
 266 .\"  The guest account on the POP/BB service host.  This should be a different
 267 .\"  login ID than either the POP user or the BBoards user.  (The user-id
 268 .\"  \*(lqftp\*(rq is highly recommended.)  This variable should be set on
 269 .\"  both the POP BBoards client and service hosts.
 270 .\"  .RE
 271 .\"  .PP
 272 .\"  .BR popbblist :
 273 .\"  %nmhetcdir%/hosts.popbb
 274 .\"  .RS 5
 275 .\"  A file containing of lists of hosts that are allowed to use the POP
 276 .\"  facility to access BBoards using the guest account.  If this file is not
 277 .\"  present, then no check is made.  This variable should be set on the POP
 278 .\"  BBoards service host.
 279 .\"  .RE
 280 .SS "File Locking"
 281 A few words on locking:
 282 .B nmh
 283 has two main uses for locking: locking the mail spool during mail
 284 incorporation, and locking metadata files (sequence files, the context)
 285 during updates.  These locking methods can be configured separately
 286 from each other.
 287 .PP
 288 For locking the mail spool, the
 289 .B spoollocking
 290 entry in
 291 .IR mh\-tailor (5)
 292 will control the locking algorithm to use when
 293 .B inc
 294 incorporates mail from the spool file.  If no entry is given, a default
 295 based on the operating system type will be chosen.
 296 .PP
 297 For locking all other files, the
 298 .B datalocking
 299 entry in
 300 .IR mh-profile (5)
 301 controls the locking algorithm used for all other file access.
 302 If no entry is given, the
 303 .B fcntl
 304 lock method will be chosen.
 305 .PP
 306 If you do not wish to use kernel-based locking,
 307 .I dot
 308 locking is an option available.  If \*(lq--enable-lockdir=directory\*(rq
 309 is not specified at build time, lock files will be created in the
 310 directory where the file being locked resides.  Otherwise, lock
 311 files will be created in the directory specified by
 312 \*(lq--enable-lockdir\*(rq.
 313 .PP
 314 Prior to installing
 315 .BR nmh ,
 316 you should see how locking is done at your site, and set the appropriate values.
 317 .SH FILES
 318 .TP 20
 319 %nmhetcdir%/mts.conf
 320 nmh mts configuration file
 321 .SH "PROFILE COMPONENTS"
 322 None
 323 .SH "SEE ALSO"
 324 .IR mh\-mts (8),
 325 .IR post (8)
 326 .SH DEFAULTS
 327 As listed above.  The path of the mail transport configuration file can
 328 be changed with the MHMTSCONF environment variable and augmented with the
 329 MHMTSUSERCONF environment variable, see
 330 .IR mh\-profile (5).
 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 MHMTSCONF or MHMTSUSERCONF
 335 environment variables.  If such use is necessary, the ability
 336 to successfully open the file should first be verified.