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