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