Mercurial > masqmail

comparison docs/masqmail.8 @ 16:163aa299bedb

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
fixed man pages added backslashes to dashes (to satisfy Debian) removed wrong sentence about /etc/aliases. Thanks to Alexis. (Closes Debian bug #480477) fixed typos reported by Reuben Thomas. (Closes Debian bug #427096)
author meillo@marmaro.de
date Thu, 06 Nov 2008 09:33:32 +0100
parents 8c55886cacd8
children 607221b0dac1
comparison
equal deleted inserted replaced
15:f671821d8222 16:163aa299bedb
1 .TH masqmail 8 User Manuals 1 .TH masqmail 8 User Manuals
2 .SH NAME 2 .SH NAME
3 masqmail \- An offline Mail Transfer Agent 3 masqmail \- An offline Mail Transfer Agent
4 .SH SYNOPSIS 4 .SH SYNOPSIS
5 \fB/usr/sbin/masqmail [-C \fIfile\f1\fB] [-odq] [-bd] [-q\fIinterval\f1\fB] 5 \fB/usr/sbin/masqmail [\-C \fIfile\f1\fB] [\-odq] [\-bd] [\-q\fIinterval\f1\fB]
6 6
7 \fB/usr/sbin/masqmail [-odq] [-bs] 7 \fB/usr/sbin/masqmail [\-odq] [\-bs]
8 8
9 \fB/usr/sbin/masqmail [-bp] 9 \fB/usr/sbin/masqmail [\-bp]
10 10
11 \fB/usr/sbin/masqmail [-q] 11 \fB/usr/sbin/masqmail [\-q]
12 12
13 \fB/usr/sbin/masqmail [-qo [\fIname\f1\fB]] 13 \fB/usr/sbin/masqmail [\-qo [\fIname\f1\fB]]
14 14
15 \fB/usr/sbin/masqmail [-odq] [-g [\fIname\f1\fB]] 15 \fB/usr/sbin/masqmail [\-odq] [\-g [\fIname\f1\fB]]
16 16
17 \fB/usr/sbin/masqmail [-odq] [-go [\fIname\f1\fB]] 17 \fB/usr/sbin/masqmail [\-odq] [\-go [\fIname\f1\fB]]
18 18
19 \fB/usr/sbin/masqmail [-t] [-oi] [-f \fIaddress\f1\fB] [--] \fIaddress...\f1\fB 19 \fB/usr/sbin/masqmail [\-t] [\-oi] [\-f \fIaddress\f1\fB] [\-\-] \fIaddress...\f1\fB
20 20
21 \fB/usr/sbin/mailq 21 \fB/usr/sbin/mailq
22 22
23 \fB 23 \fB
24 .SH DESCRIPTION 24 .SH DESCRIPTION
25 25
26 MasqMail is a mail server designed for hosts that do not have a permanent internet connection eg. a home network or a single host at home. It has special support for connections to different ISPs. It replaces sendmail or other MTAs such as qmail or exim. It can also act as a pop3 client. 26 MasqMail is a mail server designed for hosts that do not have a permanent internet connection eg. a home network or a single host at home. It has special support for connections to different ISPs. It replaces sendmail or other MTAs such as qmail or exim. It can also act as a pop3 client.
27 27
28 .SH OPTIONS 28 .SH OPTIONS
29 29
30 Since masqmail is intended to replace sendmail, it uses the same command line options, but not all are implemented. There are also two additional options, which are unique to masqmail (-qo \fIconnection\f1 and -g) 30 Since masqmail is intended to replace sendmail, it uses the same command line options, but not all are implemented. There are also two additional options, which are unique to masqmail (\-qo \fIconnection\f1 and \-g)
31 .TP 31 .TP
32 32
33 \fB--\f1 33 \fB\-\-\f1
34 34
35 Not a 'real' option, it means that all following arguments are to be understood as arguments and not as options even if they begin with a leading dash '-'. Mutt is known to call sendmail with this option. 35 Not a 'real' option, it means that all following arguments are to be understood as arguments and not as options even if they begin with a leading dash '\-'. Mutt is known to call sendmail with this option.
36 .TP 36 .TP
37 37
38 \fB-bd\f1 38 \fB\-bd\f1
39 39
40 Run as daemon, accepting connections, usually on port 25 if not configured differently. This is usually used in the startup script at system boot and together with the -q option (see below). 40 Run as daemon, accepting connections, usually on port 25 if not configured differently. This is usually used in the startup script at system boot and together with the \-q option (see below).
41 .TP 41 .TP
42 42
43 \fB-bi\f1 43 \fB\-bi\f1
44 44
45 Old sendmail rebuilds its alias database when invoked with this option. Masqmail ignores it. Masqmail reads directly from the file given with alias_file in the config file. 45 Old sendmail rebuilds its alias database when invoked with this option. Masqmail ignores it. Masqmail reads directly from the file given with alias_file in the config file.
46 .TP 46 .TP
47 47
48 \fB-bp\f1 48 \fB\-bp\f1
49 49
50 Show the messages in the queue. Same as calling masqmail as 'mailq'. 50 Show the messages in the queue. Same as calling masqmail as 'mailq'.
51 .TP 51 .TP
52 52
53 \fB-bs\f1 53 \fB\-bs\f1
54 54
55 Accept SMTP commands from stdin. Some mailers (eg pine) use this option as an interface. It can also be used to call masqmail from inetd. 55 Accept SMTP commands from stdin. Some mailers (eg pine) use this option as an interface. It can also be used to call masqmail from inetd.
56 .TP 56 .TP
57 57
58 \fB-B \fIarg\f1\fB\f1 58 \fB\-B \fIarg\f1\fB\f1
59 59
60 \fIarg\f1 is usually 8BITMIME. Some mailers use this to indicate that the message contains characters > 127. Masqmail is 8-bit clean and ignores this, so you do not have to recompile elm, which is very painful ;-). Note though that this violates some conventions: masqmail does not convert 8 bit messages to any MIME format if it encounters a mail server which does not advertise its 8BITMIME capability, masqmail does not advertise this itself. This is the same practice as that of exim (but different to sendmail). 60 \fIarg\f1 is usually 8BITMIME. Some mailers use this to indicate that the message contains characters > 127. Masqmail is 8-bit clean and ignores this, so you do not have to recompile elm, which is very painful ;-). Note though that this violates some conventions: masqmail does not convert 8 bit messages to any MIME format if it encounters a mail server which does not advertise its 8BITMIME capability, masqmail does not advertise this itself. This is the same practice as that of exim (but different to sendmail).
61 .TP 61 .TP
62 62
63 \fB-bV \f1 63 \fB\-bV \f1
64 64
65 Show version information. 65 Show version information.
66 .TP 66 .TP
67 67
68 \fB-C \f1\fIfilename\f1 68 \fB\-C \f1\fIfilename\f1
69 69
70 Use another configuration than \fI/etc/masqmail/masqmail.conf\f1. Useful for debugging purposes. If not invoked by a privileged user, masqmail will drop all privileges. 70 Use another configuration than \fI/etc/masqmail/masqmail.conf\f1. Useful for debugging purposes. If not invoked by a privileged user, masqmail will drop all privileges.
71 .TP 71 .TP
72 72
73 \fB-d \fInumber\f1\fB\f1 73 \fB\-d \fInumber\f1\fB\f1
74 74
75 Set the debug level. This takes precedence before the value ofdebug_level in the configuration file. Read the warning in the description of the latter. 75 Set the debug level. This takes precedence before the value ofdebug_level in the configuration file. Read the warning in the description of the latter.
76 .TP 76 .TP
77 77
78 \fB-f [\fIaddress\f1\fB]\f1 78 \fB\-f [\fIaddress\f1\fB]\f1
79 79
80 Set the return path address to \fIaddress\f1. Only root, the user mail and anyoune in group trusted is allowed to do that. 80 Set the return path address to \fIaddress\f1. Only root, the user mail and anyone in group mail is allowed to do that.
81 .TP 81 .TP
82 82
83 \fB-F [\fIstring\f1\fB]\f1 83 \fB\-F [\fIstring\f1\fB]\f1
84 84
85 Set the full sender name (in the From: header) to \fIstring\f1. 85 Set the full sender name (in the From: header) to \fIstring\f1.
86 .TP 86 .TP
87 87
88 \fB-g [\fIname\f1\fB]\f1 88 \fB\-g [\fIname\f1\fB]\f1
89 89
90 Get mail (using pop3 or apop), using the configurations given with get.\fIname\f1 in the main configuration. Without \fIname\f1, all get configurations will be used. See also \fBmasqmail.get (5)\f1 90 Get mail (using pop3 or apop), using the configurations given with get.\fIname\f1 in the main configuration. Without \fIname\f1, all get configurations will be used. See also \fBmasqmail.get (5)\f1
91 .TP 91 .TP
92 92
93 \fB-go [\fIinterval\f1\fB] [\fIname\f1\fB]\f1 93 \fB\-go [\fIinterval\f1\fB] [\fIname\f1\fB]\f1
94 94
95 Can be followed by a connection name. Use this option in your script which starts as soon as a link to the internet has been set up (usually ip-up). When masqmail is called with this option, the specified get configuration(s) is(are) read and mail will be retrieved from servers on the internet. The \fIname\f1 is defined in the configuration (see \fBonline_gets.\fIname\f1\fB\f1). 95 Can be followed by a connection name. Use this option in your script which starts as soon as a link to the internet has been set up (usually ip-up). When masqmail is called with this option, the specified get configuration(s) is(are) read and mail will be retrieved from servers on the internet. The \fIname\f1 is defined in the configuration (see \fBonline_gets.\fIname\f1\fB\f1).
96 96
97 If called with an interval option (recognized by a digit as the first characater), masqmail starts as a daemon and tries to get mail in these intervals. It checks for the online status first. Example: masqmail -go 5m will retrieve mail all five minutes. 97 If called with an interval option (recognized by a digit as the first characater), masqmail starts as a daemon and tries to get mail in these intervals. It checks for the online status first. Example: masqmail \-go 5m will retrieve mail every five minutes.
98 98
99 If called without \fIname\f1 the online status is determined with the configured method (see \fBonline_detect\f1 in config.html). 99 If called without \fIname\f1 the online status is determined with the configured method (see \fBonline_detect\f1 in \fBmasqmail.conf (5)\f1).
100 .TP 100 .TP
101 101
102 \fB-i\f1 102 \fB\-i\f1
103 103
104 Same as -oi, see below. 104 Same as \-oi, see below.
105 .TP 105 .TP
106 106
107 \fB-Mrm \fIlist\f1\fB\f1 107 \fB\-Mrm \fIlist\f1\fB\f1
108 108
109 Remove given messages from the queue. Only allowed for privileged users. 109 Remove given messages from the queue. Only allowed for privileged users.
110 .TP 110 .TP
111 111
112 \fB-oem\f1 112 \fB\-oem\f1
113 113
114 If the -oi ist not also given, always return with a non zero return code. Maybe someone tells me what this is good for... 114 If the \-oi ist not also given, always return with a non zero return code. Maybe someone tells me what this is good for...
115 .TP 115 .TP
116 116
117 \fB-odb\f1 117 \fB\-odb\f1
118 118
119 Deliver in background. Masqmail always does this, which makes this option pretty much useless. 119 Deliver in background. Masqmail always does this, which makes this option pretty much useless.
120 .TP 120 .TP
121 121
122 \fB-odq\f1 122 \fB\-odq\f1
123 123
124 Do not attempt to deliver immediately. Any messages will be queued until the next queue running process picks them up and delivers them. You get the same effect by setting the do_queue option in /etc/masqmail/masqmail.conf. 124 Do not attempt to deliver immediately. Any messages will be queued until the next queue running process picks them up and delivers them. You get the same effect by setting the do_queue option in /etc/masqmail/masqmail.conf.
125 .TP 125 .TP
126 126
127 \fB-oi\f1 127 \fB\-oi\f1
128 128
129 A dot as a single character in a line does not terminate the message. 129 A dot as a single character in a line does not terminate the message.
130 .TP 130 .TP
131 131
132 \fB-q [\fIinterval\f1\fB]\f1 132 \fB\-q [\fIinterval\f1\fB]\f1
133 133
134 If not given with an argument, run a queue process, ie. try to deliver all messages in the queue. Masqmail sends only to those addresses that are on the local net, not to those that are outside. Use -qo for those. 134 If not given with an argument, run a queue process, ie. try to deliver all messages in the queue. Masqmail sends only to those addresses that are on the local net, not to those that are outside. Use \-qo for those.
135 135
136 If you have configured inetd to start masqmail, you can use this option in a cron job which starts in regular time intervals, to mimic the same effect as starting masqmail with -bd -q30m. 136 If you have configured inetd to start masqmail, you can use this option in a cron job which starts in regular time intervals, to mimic the same effect as starting masqmail with \-bd \-q30m.
137 137
138 An argument may be a time interval ie. a numerical value followed by one of the letters. s,m,h,d,w which are interpreted as seconds, minutes, hours, days or weeks respectively. Example: -q30m. Masqmail starts as a daemon and a queue runner process will be started automatically once in this time interval. This is usually used together with -bd (see above). 138 An argument may be a time interval ie. a numerical value followed by one of the letters. s,m,h,d,w which are interpreted as seconds, minutes, hours, days or weeks respectively. Example: \-q30m. Masqmail starts as a daemon and a queue runner process will be started automatically once in this time interval. This is usually used together with \-bd (see above).
139 .TP 139 .TP
140 140
141 \fB-qo [\fIname\f1\fB]\f1 141 \fB\-qo [\fIname\f1\fB]\f1
142 142
143 Can be followed by a connection name. Use this option in your script which starts as soon as a link to the internet has been set up (usually ip-up). When masqmail is called with this option, the specified route configuration is read and the queued mail with destinations on the internet will be sent. The \fIname\f1 is defined in the configuration (see \fBonline_routes.\fIname\f1\fB\f1). 143 Can be followed by a connection name. Use this option in your script which starts as soon as a link to the internet has been set up (usually ip-up). When masqmail is called with this option, the specified route configuration is read and the queued mail with destinations on the internet will be sent. The \fIname\f1 is defined in the configuration (see \fBonline_routes.\fIname\f1\fB\f1).
144 144
145 If called without \fIname\f1 the online status is determined with the configured method (see \fBonline_detect\f1 in config.html) 145 If called without \fIname\f1 the online status is determined with the configured method (see \fBonline_detect\f1 in \fBmasqmail.conf (5)\f1)
146 .TP 146 .TP
147 147
148 \fB-t\f1 148 \fB\-t\f1
149 149
150 Read recipients from headers. Delete 'Bcc:' headers. If any arguments are given, these are interpreted as recipient addresses and the message will not be sent to these. 150 Read recipients from headers. Delete 'Bcc:' headers. If any arguments are given, these are interpreted as recipient addresses and the message will not be sent to these.
151 .TP 151 .TP
152 152
153 \fB-v\f1 153 \fB\-v\f1
154 154
155 Log also to stdout. Currently, some log messages are marked as 'write to stdout' and additionally, all messages with priority 'LOG_ALERT' and 'LOG_WARNING' will be written to stdout if this option is given. It is disabled in daemon mode. 155 Log also to stdout. Currently, some log messages are marked as 'write to stdout' and additionally, all messages with priority 'LOG_ALERT' and 'LOG_WARNING' will be written to stdout if this option is given. It is disabled in daemon mode.
156 .SH ENVIRONMENT FOR PIPES AND MDAS 156 .SH ENVIRONMENT FOR PIPES AND MDAS
157 157
158 For security reasons, before any pipe command from an alias expansion or an mda is called, the environment variables will be completely discarded and newly set up. These are: 158 For security reasons, before any pipe command from an alias expansion or an mda is called, the environment variables will be completely discarded and newly set up. These are:
173 173
174 .SH FILES 174 .SH FILES
175 175
176 \fI/etc/masqmail/masqmail.conf\f1 is the main configuration for masqmail. Depending on the settings in this file, you will also have other configuration files in \fI/etc/masqmail/\f1. 176 \fI/etc/masqmail/masqmail.conf\f1 is the main configuration for masqmail. Depending on the settings in this file, you will also have other configuration files in \fI/etc/masqmail/\f1.
177 177
178 \fI/etc/aliases\f1 is the alias file, if not set differently in \fI/etc/masqmail/masqmail.conf\f1.
179
180 \fI/var/spool/masqmail/\f1 is the spool directory where masqmail stores its spooled messages and the uniq pop ids. 178 \fI/var/spool/masqmail/\f1 is the spool directory where masqmail stores its spooled messages and the uniq pop ids.
181 179
182 \fI/var/spool/mail/\f1 is the directory where locally delivered mail will be put, if not configured differently in \fImasqmail.conf\f1. 180 \fI/var/spool/mail/\f1 is the directory where locally delivered mail will be put, if not configured differently in \fImasqmail.conf\f1.
183 181
184 \fI/var/log/masqmail/\f1 is the directory where masqmail stores its log mesages. This can also be somewhere else if configured differently by your sysadmin or the package mantainer. 182 \fI/var/log/masqmail/\f1 is the directory where masqmail stores its log mesages. This can also be somewhere else if configured differently by your sysadmin or the package mantainer.
195 193
196 .SH AUTHOR 194 .SH AUTHOR
197 195
198 masqmail was written by Oliver Kurth <oku@masqmail.cx> 196 masqmail was written by Oliver Kurth <oku@masqmail.cx>
199 197
200 You will find the newest version of masqmail at \fBhttp://masqmail.cx/masqmail/\f1 or search for it in freshmeat (\fBhttp://www.freshmeat.net\f1). There is also a mailing list, you will find information about it at masqmails main site. 198 You will find the newest version of masqmail at \fBhttp://masqmail.cx/masqmail/\f1 or search for it in freshmeat (\fBhttp://www.freshmeat.net\f1). There is also a mailing list, you will find information about it at masqmail's main site.
201 199
202 .SH BUGS 200 .SH BUGS
203 201
204 You should report them to the mailing list. 202 You should report them to the mailing list.
205 203