masqmail-0.2

annotate docs/old-manual/docs/masqmail.8.html @ 56:f6a6f55b7b9e

find changesets by author, revision, files, or words in the commit message
added old manual from the old website it is dated May/July 2000
author meillo@marmaro.de
date Sat, 29 May 2010 21:51:13 +0200
parents
children
rev   line source
meillo@56 1 <body text="#000000" link="#0000ff" bgcolor="#ffffff"><center><table width="80%">
meillo@56 2 <tr><td><h1>masqmail</h1>
meillo@56 3 <h2>An offline Mail Transfer Agent</h2>
meillo@56 4
meillo@56 5
meillo@56 6 <h2>Synopsis</h2>
meillo@56 7 <b>
meillo@56 8 /usr/sbin/masqmail [-C <em>file</em>] [-odq] [-bd] [-q<em>interval</em>]<br>
meillo@56 9
meillo@56 10 /usr/sbin/masqmail [-odq] [-bs]<br>
meillo@56 11
meillo@56 12 /usr/sbin/masqmail [-bp]<br>
meillo@56 13
meillo@56 14 /usr/sbin/masqmail [-q]<br>
meillo@56 15
meillo@56 16 /usr/sbin/masqmail [-qo [<em>name</em>]]<br>
meillo@56 17
meillo@56 18 /usr/sbin/masqmail [-odq] [-g [<em>name</em>]]<br>
meillo@56 19
meillo@56 20 /usr/sbin/masqmail [-odq] [-go [<em>name</em>]]<br>
meillo@56 21
meillo@56 22 /usr/sbin/masqmail [-t] [-oi] [-f <em>address</em>] [--] <em>address...</em><br>
meillo@56 23
meillo@56 24 /usr/sbin/mailq<br>
meillo@56 25
meillo@56 26 </b>
meillo@56 27
meillo@56 28
meillo@56 29 <h2>Description</h2>
meillo@56 30
meillo@56 31 <p>MasqMail is a mail server designed for hosts that do
meillo@56 32 not have a permanent internet connection eg. a home network or a
meillo@56 33 single host at home. It has special support for connections to
meillo@56 34 different ISPs. It replaces sendmail or other MTAs such as qmail or
meillo@56 35 exim. It can also act as a pop3 client.</p>
meillo@56 36
meillo@56 37
meillo@56 38
meillo@56 39 <h2>Options</h2>
meillo@56 40
meillo@56 41 <p>Since masqmail is intended to replace sendmail, it uses the same
meillo@56 42 command line options, but not all are implemented. There are also two
meillo@56 43 additional options, which are unique to masqmail (-qo <em>connection</em> and -g)
meillo@56 44 </p>
meillo@56 45
meillo@56 46
meillo@56 47 <p><b>--</b></p>
meillo@56 48 <p>Not a 'real' option, it means that all following arguments are to
meillo@56 49 be understood as arguments and not as options even if they begin with a
meillo@56 50 leading dash '-'. Mutt is known to call sendmail with this option.</p>
meillo@56 51
meillo@56 52
meillo@56 53
meillo@56 54 <p><b>-bd</b></p>
meillo@56 55 <p>Run as daemon, accepting connections, usually on port 25 if not
meillo@56 56 configured differently. This is usually used in the startup script at system boot and
meillo@56 57 together with the -q option (see below).</p>
meillo@56 58
meillo@56 59
meillo@56 60
meillo@56 61 <p><b>-bi</b></p>
meillo@56 62 <p>Old sendmail rebuilds its alias database when invoked with this
meillo@56 63 option. Masqmail ignores it. Masqmail reads directly from the file
meillo@56 64 given with alias_file in the config file.</p>
meillo@56 65
meillo@56 66
meillo@56 67
meillo@56 68 <p><b>-bp</b></p>
meillo@56 69 <p>Show the messages in the queue. Same as calling masqmail as
meillo@56 70 'mailq'.</p>
meillo@56 71
meillo@56 72
meillo@56 73
meillo@56 74 <p><b>-bs</b></p>
meillo@56 75 <p>Accept SMTP commands from stdin. Some mailers (eg pine) use this
meillo@56 76 option as an interface. It can also be used to call masqmail from
meillo@56 77 inetd.</p>
meillo@56 78
meillo@56 79
meillo@56 80
meillo@56 81 <p><b>-B <em>arg</em></b></p>
meillo@56 82 <p><em>arg</em> is usually 8BITMIME. Some mailers use this
meillo@56 83 to indicate that the message contains characters > 127. Masqmail is
meillo@56 84 8-bit clean and ignores this, so you do not have to recompile elm,
meillo@56 85 which is very painful ;-). Note though that this violates some
meillo@56 86 conventions: masqmail does not convert 8 bit messages to any
meillo@56 87 MIME format if it encounters a mail server which does not advertise
meillo@56 88 its 8BITMIME capability, masqmail does not advertise this itself. This
meillo@56 89 is the same practice as that of exim (but different to
meillo@56 90 sendmail).</p>
meillo@56 91
meillo@56 92
meillo@56 93 <p><b>-bV </b></p>
meillo@56 94 <p>Show version information.</p>
meillo@56 95
meillo@56 96
meillo@56 97
meillo@56 98
meillo@56 99 <p><b>-C </b><em>filename</em></p>
meillo@56 100 <p>Use another configuration than <em>/etc/masqmail/masqmail.conf</em>. Useful for
meillo@56 101 debugging purposes. If not invoked by a privileged user, masqmail will drop all privileges.
meillo@56 102 </p>
meillo@56 103
meillo@56 104
meillo@56 105
meillo@56 106 <p><b>-d <em>number</em></b></p>
meillo@56 107
meillo@56 108 <p>Set the debug level. This takes precedence before the value of
meillo@56 109 debug_level in the configuration file. Read the warning in the
meillo@56 110 description of the latter.
meillo@56 111 </p>
meillo@56 112
meillo@56 113
meillo@56 114
meillo@56 115
meillo@56 116 <p><b>-f [<em>address</em>]</b></p>
meillo@56 117
meillo@56 118 <p>Set the return path address to <em>address</em>. Only root, the
meillo@56 119 user mail and anyoune in group trusted is allowed to do that.</p>
meillo@56 120
meillo@56 121
meillo@56 122
meillo@56 123
meillo@56 124 <p><b>-F [<em>string</em>]</b></p>
meillo@56 125
meillo@56 126 <p>Set the full sender name (in the From: header)
meillo@56 127 to <em>string</em>.</p>
meillo@56 128
meillo@56 129
meillo@56 130
meillo@56 131
meillo@56 132 <p><b>-g [<em>name</em>]</b></p>
meillo@56 133
meillo@56 134 <p>Get mail (using pop3 or apop), using the configurations given
meillo@56 135 with get.<em>name</em> in the main configuration. Without <em>name</em>,
meillo@56 136 all get configurations will be used. See also <a href="masqmail.get.5.html">masqmail.get</a></p>
meillo@56 137
meillo@56 138
meillo@56 139
meillo@56 140
meillo@56 141 <p><b>-go [<em>interval</em>] [<em>name</em>]</b></p>
meillo@56 142
meillo@56 143 <p>Can be followed by a connection name. Use this option in your
meillo@56 144 script which starts as soon as a link to the internet has been set up
meillo@56 145 (usually ip-up). When masqmail is called with this option, the
meillo@56 146 specified get configuration(s) is(are) read and mail will be
meillo@56 147 retrieved from servers on the internet.
meillo@56 148 The <em>name</em> is defined
meillo@56 149 in the configuration (see <b>online_gets.<em>name</em></b>).
meillo@56 150 </p><p>
meillo@56 151 If called with an interval option (recognized by a digit
meillo@56 152 as the first characater), masqmail starts as a daemon and tries to
meillo@56 153 get mail in these intervals. It checks for the online status first.
meillo@56 154 Example: masqmail -go 5m will retrieve mail
meillo@56 155 all five minutes.
meillo@56 156 </p><p>
meillo@56 157 If called without <em>name</em> the online status is determined with
meillo@56 158 the configured method (see <b>online_detect</b> in config.html).
meillo@56 159 </p>
meillo@56 160
meillo@56 161
meillo@56 162
meillo@56 163
meillo@56 164 <p><b>-i</b></p>
meillo@56 165 <p>Same as -oi, see below.</p>
meillo@56 166
meillo@56 167
meillo@56 168
meillo@56 169 <p><b>-Mrm <em>list</em></b></p>
meillo@56 170 <p>Remove given messages from the queue. Only allowed for privileged users.</p>
meillo@56 171
meillo@56 172
meillo@56 173
meillo@56 174 <p><b>-oem</b></p>
meillo@56 175 <p>If the -oi ist not also given, always return with a non zero
meillo@56 176 return code. Maybe someone tells me what this is good for...</p>
meillo@56 177
meillo@56 178
meillo@56 179
meillo@56 180 <p><b>-odb</b></p>
meillo@56 181 <p>Deliver in background. Masqmail always does this, which
meillo@56 182 makes this option pretty much useless.</p>
meillo@56 183
meillo@56 184
meillo@56 185
meillo@56 186 <p><b>-odq</b></p>
meillo@56 187 <p>Do not attempt to deliver immediately. Any messages will be queued
meillo@56 188 until the next queue running process picks them up and delivers
meillo@56 189 them. You get the same effect by setting the do_queue option in
meillo@56 190 /etc/masqmail/masqmail.conf.</p>
meillo@56 191
meillo@56 192
meillo@56 193
meillo@56 194 <p><b>-oi</b></p>
meillo@56 195 <p>A dot as a single character in a line does not terminate
meillo@56 196 the message.</p>
meillo@56 197
meillo@56 198
meillo@56 199
meillo@56 200 <p><b>-q [<em>interval</em>]</b></p>
meillo@56 201 <p>If not given with an argument, run a queue process, ie. try to
meillo@56 202 deliver all messages in the queue. Masqmail sends only to those
meillo@56 203 addresses that are on the local net, not to those that are
meillo@56 204 outside. Use -qo for those.</p>
meillo@56 205 <p>
meillo@56 206 If you have configured inetd to start masqmail, you can use this
meillo@56 207 option in a cron job which starts in regular time intervals, to mimic
meillo@56 208 the same effect as starting masqmail with -bd -q30m.
meillo@56 209 </p><p>
meillo@56 210 An argument may be a time interval ie. a numerical value followed
meillo@56 211 by one of the letters. s,m,h,d,w which are interpreted as seconds,
meillo@56 212 minutes, hours, days or weeks respectively. Example: -q30m. Masqmail
meillo@56 213 starts as a daemon and a queue runner process will be started
meillo@56 214 automatically once in this time interval. This is usually used
meillo@56 215 together with -bd (see above).
meillo@56 216 </p>
meillo@56 217
meillo@56 218
meillo@56 219
meillo@56 220
meillo@56 221 <p><b>-qo [<em>name</em>]</b></p>
meillo@56 222
meillo@56 223 <p>Can be followed by a connection name. Use this option in your
meillo@56 224 script which starts as soon as a link to the internet has been set up
meillo@56 225 (usually ip-up). When masqmail is called with this option, the
meillo@56 226 specified route configuration is read and the queued mail with
meillo@56 227 destinations on the internet will be sent. The <em>name</em> is defined
meillo@56 228 in the configuration (see <b>online_routes.<em>name</em></b>).
meillo@56 229 </p><p>
meillo@56 230 If called without <em>name</em> the online status is determined with
meillo@56 231 the configured method (see <b>online_detect</b> in config.html)
meillo@56 232 </p>
meillo@56 233
meillo@56 234
meillo@56 235
meillo@56 236
meillo@56 237 <p><b>-t</b></p>
meillo@56 238 <p>Read recipients from headers. Delete 'Bcc:' headers. If any
meillo@56 239 arguments are given, these are interpreted as recipient addresses and
meillo@56 240 the message will not be sent to these.</p>
meillo@56 241
meillo@56 242
meillo@56 243
meillo@56 244 <p><b>-v</b></p>
meillo@56 245 <p>Log also to stdout. Currently, some log messages are
meillo@56 246 marked as 'write to stdout' and additionally, all messages with
meillo@56 247 priority 'LOG_ALERT' and 'LOG_WARNING' will be written to stdout
meillo@56 248 if this option is given. It is disabled in daemon mode.
meillo@56 249 </p>
meillo@56 250
meillo@56 251
meillo@56 252
meillo@56 253
meillo@56 254 <h2>Environment for pipes and mdas</h2>
meillo@56 255
meillo@56 256
meillo@56 257 <p>For security reasons, before any pipe command from an alias
meillo@56 258 expansion or an mda is called, the environment variables will be
meillo@56 259 completely discarded and newly set up. These are:</p>
meillo@56 260 <p>SENDER, RETURN_PATH - the return path.</p>
meillo@56 261 <p>SENDER_DOMAIN - the domain part of the return path.</p>
meillo@56 262 <p>SENDER_LOCAL - the local part of the return path.</p>
meillo@56 263 <p>RECEIVED_HOST - the host the message was received from (unless local).</p>
meillo@56 264 <p>LOCAL_PART, USER, LOGNAME - the local part of the (original) recipient.</p>
meillo@56 265 <p>MESSAGE_ID - the unique message id. This is not necessarily identical with the Message ID as given in the Message ID: header.</p>
meillo@56 266 <p>QUALIFY_DOMAIN - the domain which will be appended to unqualified addresses.</p>
meillo@56 267
meillo@56 268
meillo@56 269
meillo@56 270
meillo@56 271 <h2>Files</h2>
meillo@56 272
meillo@56 273 <p><em>/etc/masqmail/masqmail.conf</em> is the main configuration
meillo@56 274 for masqmail. Depending on the settings in this file, you will also
meillo@56 275 have other configuration files in <em>/etc/masqmail/</em>.</p>
meillo@56 276 <p><em>/etc/aliases</em> is the alias file, if not set differently
meillo@56 277 in <em>/etc/masqmail/masqmail.conf</em>.</p>
meillo@56 278 <p><em>/var/spool/masqmail/</em> is the spool directory where masqmail
meillo@56 279 stores its spooled messages and the uniq pop ids.</p>
meillo@56 280 <p><em>/var/spool/mail/</em> is the directory where locally delivered mail will be put, if not configured differently in <em>masqmail.conf</em>.</p>
meillo@56 281 <p><em>/var/log/masqmail/</em> is the directory where masqmail stores
meillo@56 282 its log mesages. This can also be somewhere else if configured
meillo@56 283 differently by your sysadmin or the package mantainer.</p>
meillo@56 284
meillo@56 285
meillo@56 286
meillo@56 287 <h2>Conforming to</h2>
meillo@56 288
meillo@56 289 <p>RFC 821, 822, 1869, 1870, 2197, 2554 (SMTP)</p>
meillo@56 290 <p>RFC 1725, 1939 (POP3)</p>
meillo@56 291 <p>RFC 1321 (MD5)</p>
meillo@56 292 <p>RFC 2195 (CRAM-MD5)</p>
meillo@56 293
meillo@56 294
meillo@56 295
meillo@56 296 <h2>Author</h2>
meillo@56 297
meillo@56 298 <p>masqmail was written by Oliver Kurth
meillo@56 299 <oku@masqmail.cx></p><p>You will find the newest version of
meillo@56 300 masqmail at <a href = "http://masqmail.cx/masqmail/">http://masqmail.cx/masqmail/</a> or search for it
meillo@56 301 in freshmeat (<a href = "http://www.freshmeat.net">http://www.freshmeat.net</a>). There is also a mailing list,
meillo@56 302 you will find information about it at masqmails main site.</p>
meillo@56 303
meillo@56 304
meillo@56 305
meillo@56 306 <h2>Bugs</h2>
meillo@56 307
meillo@56 308 <p>You should report them to the mailing list.</p>
meillo@56 309
meillo@56 310
meillo@56 311
meillo@56 312 <h2>See also</h2>
meillo@56 313
meillo@56 314 <p>
meillo@56 315 <a href="masqmail.conf.5.html">masqmail.conf</a>, <a href="masqmail.route.5.html">masqmail.route</a>, <a href="masqmail.get.5.html">masqmail.get</a>, <a href="masqmail.aliases.5.html">masqmail.aliases</a>
meillo@56 316 </p>
meillo@56 317
meillo@56 318
meillo@56 319
meillo@56 320 <h2>Comments</h2>
meillo@56 321
meillo@56 322 <p>This man page was written using <a href="http://masqmail.cx/xml2man/">xml2man</a> by the same author.</p>
meillo@56 323
meillo@56 324
meillo@56 325
meillo@56 326 </td></tr></table></center>
meillo@56 327 </body>