docs/diploma

annotate docs/masqmail.cx/docs/masqmail.8.html @ 1:7b2a5fe2aedd

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