1.1 --- a/man/masqmail.8	Tue Dec 07 17:09:07 2010 -0300
     1.2 +++ b/man/masqmail.8	Tue Dec 07 17:10:07 2010 -0300
     1.3 @@ -4,19 +4,28 @@
     1.4  masqmail \- An offline Mail Transfer Agent
     1.5  
     1.6  .SH SYNOPSIS
     1.7 -\fB/usr/sbin/masqmail \fR[\fB\-C \fIfile\fR] [\fB\-odq\fR] [\fB\-bd\fR] [\fB\-q\fIinterval\fR]
     1.8  
     1.9 -\fB/usr/sbin/masqmail \fR[\fB\-odq\fR] [\fB\-bs\fR]
    1.10 +.BR masqmail\  [ \-t ] \  [ \-oi ] \  [ \-f\ \fIADDRESS ] \ \fIRECIPIENT...
    1.11  
    1.12 -\fB/usr/sbin/masqmail \fR[\fB\-bp\fR]
    1.13 +.B mailq
    1.14 +.br
    1.15 +.B masqmail \-bp
    1.16  
    1.17 -\fB/usr/sbin/masqmail \fR[\fB\-q\fR]
    1.18 +.B runq
    1.19 +.br
    1.20 +.B masqmail \-q
    1.21  
    1.22 -\fB/usr/sbin/masqmail \fR[\fB\-qo \fR[\fIname\fR]]
    1.23 +.BR masqmail\ \-qo\  [ \fINAME ]
    1.24  
    1.25 -\fB/usr/sbin/masqmail \fR[\fB\-t\fR] [\fB\-oi\fR] [\fB\-f \fIaddress\fR] [\fB\-\-\fR] \fIaddress...
    1.26 +.BI mailrm\  MSGID...
    1.27 +.br
    1.28 +.BI masqmail\ -Mrm\  MSGID...
    1.29  
    1.30 -\fB/usr/sbin/mailq\fR
    1.31 +.BR masqmail\  [ \-C\ \fIFILE ] \  [ \-odq ]\  \-bs
    1.32 +
    1.33 +.BR masqmail\  [ \-C\ \fIFILE ] \  [ \-odq ]\  \-bd\ \-q\fIINTERVAL
    1.34 +
    1.35 +(This list is a selection.)
    1.36  
    1.37  
    1.38  .SH DESCRIPTION
    1.39 @@ -32,55 +41,153 @@
    1.40  Masqmail operates in one of several exclusive modes.
    1.41  
    1.42  The daemon mode has two flavors that may be,
    1.43 -and usually are, combined:
    1.44 +and usually are, used in combination:
    1.45  .TP
    1.46 +.B Daemon (listen)
    1.47  .B \-bd
    1.48 -listen daemon; listens for incoming SMTP connections.
    1.49 +or invoked as
    1.50 +.B smtpd
    1.51 +
    1.52 +Run as daemon.
    1.53 +Act as SMTP server and accept SMTP connections,
    1.54 +on port 25 if not configured differently.
    1.55 +
    1.56 +This is normally used in the startup script at system boot
    1.57 +and together with \fB\-q\fIINTERVAL\fR (see below).
    1.58 +
    1.59 +Alternatively masqmail can be run with the \fB\-bs\fR option
    1.60 +from inetd.
    1.61 +
    1.62  .TP
    1.63 -.B \-q\fRINTERVAL
    1.64 -queue daemon; processes the queue in a regular interval.
    1.65 +.B Daemon (queue)
    1.66 +.B \-q\fIINTERVAL
    1.67 +
    1.68 +Run as daemon.
    1.69 +Do regular queue runs at the specified time interval.
    1.70 +This is normally used together with \fB\-bd\fR (see above).
    1.71 +
    1.72 +An argument may be a time interval i.e. a numerical value followed by one
    1.73 +of the letters s,m,h,d,w which are interpreted as
    1.74 +seconds, minutes, hours, days or weeks respectively.
    1.75 +Example: \fB\-q30m\fR.
    1.76 +Combinations like \fB\-q1h30m\fR, which sendmail accepts, are not possible.
    1.77 +
    1.78 +Alternatively single queue runs (\fB\-q\fR) can be started from cron.
    1.79  
    1.80  .P
    1.81 -The queue processing mode has two flavors that may be combined:
    1.82 +The queue processing mode has two flavors that may be
    1.83 +used in combination:
    1.84 +
    1.85  .TP
    1.86 -.BR \-q
    1.87 +.B Single queue run (normal)
    1.88 +.B \-q
    1.89  (without argument)
    1.90 -do a single queue run.
    1.91 +or invoked as
    1.92 +.B runq
    1.93 +
    1.94 +Do a single queue run.
    1.95 +Try to deliver all messages in the queue.
    1.96 +Masqmail sends to addresses on the local host, on the local net,
    1.97 +and if it detects an online connection to remote ones too.
    1.98 +That means, masqmail sends all queued mail it can.
    1.99 +.B \-q
   1.100 +includes
   1.101 +.B \-qo
   1.102 +(without argument).
   1.103 +
   1.104  .TP
   1.105 -.B \-qo
   1.106 -do a single queue run and deliver only using a specific online route.
   1.107 +.B Single queue run (online)
   1.108 +.B \-qo \fR[\fB\fINAME\fR]
   1.109 +
   1.110 +Do a single queue run and deliver only using one specific online route.
   1.111 +
   1.112 +If a connection name is given, then this one will be used.
   1.113 +
   1.114 +If no connection name is given, it will be determined with the configured
   1.115 +method (see \fBonline_detect\fR in \fBmasqmail.conf(5)\fR) and,
   1.116 +if none is available no mail will be delivered.
   1.117 +
   1.118 +The specified route configuration is read and queued mail to matching
   1.119 +remote recipients will be sent.
   1.120 +The \fINAME\fR is defined in the configuration
   1.121 +(see \fBonline_routes.\fINAME\fR).
   1.122 +
   1.123 +You may want to use this option in scripts that run as soon as a link
   1.124 +to the internet has been set up (e.g. ip-up).
   1.125  
   1.126  .P
   1.127  The other modes are simple ones:
   1.128 +
   1.129  .TP
   1.130 +.B Rebuild alias database
   1.131  .B \-bi
   1.132 -a no-op for masqmail, just exit.
   1.133 +or invoked as
   1.134 +.B newaliases
   1.135 +
   1.136 +A no-op for masqmail, just exit.
   1.137 +Old sendmail rebuilds its alias database when invoked with this option.
   1.138 +Masqmail reads directly from its alias file
   1.139 +(see config option `alias_file'),
   1.140 +thus no database needs to be updated.
   1.141 +
   1.142  .TP
   1.143 -.B \-bm
   1.144 -accept messages on stdin. (The default)
   1.145 +.B Accept messages
   1.146 +.BR \-bm ,
   1.147 +also the default mode
   1.148 +
   1.149 +Accept a text message on stdin.
   1.150 +This is the default mode of operation.
   1.151 +One will hardly use this switch as it is the default.
   1.152 +
   1.153 +The command line options
   1.154 +.BR \-f , \-F , \-i / \-oi , \-t
   1.155 +are only used in this mode.
   1.156 +
   1.157  .TP
   1.158 +.B Print queue
   1.159  .B \-bp
   1.160 -print the contents of the queue.
   1.161 +or invoked as
   1.162 +.B mailq
   1.163 +
   1.164 +Show the messages in the queue.
   1.165 +
   1.166  .TP
   1.167 +.B Stand-alone SMTP server
   1.168  .B \-bs
   1.169 -accept messages by speaking SMTP on stdin.
   1.170 +
   1.171 +Act as SMTP server by reading commands from stdin
   1.172 +and writing to stdout.
   1.173 +Some mailers (e.g. pine) use this option as an interface.
   1.174 +It can also be used to call masqmail from inetd.
   1.175 +
   1.176  .TP
   1.177 +.B Print version
   1.178  .B \-bV
   1.179 -print version information.
   1.180 +or if called without arguments
   1.181 +
   1.182 +Print version information, then exit.
   1.183 +
   1.184  .TP
   1.185 +.B Queue manipulation mode
   1.186  .B \-Mrm
   1.187 -remove messages from the queue.
   1.188 +or invoked as
   1.189 +.B mailrm
   1.190 +
   1.191 +Remove given messages from the queue.
   1.192 +Privileged users may remove any message, other users only their own.
   1.193 +The message identifiers are listed when printing the queue
   1.194 +(see \fB\-bp\fR).
   1.195 +
   1.196  .P
   1.197 -Some of the modes are also available by calling masqmail
   1.198 -under a special name.
   1.199 -
   1.200 +The default mode:
   1.201 +.P
   1.202  When no mode had been specified by either one of the above command line
   1.203  options or by calling masqmail under a special name,
   1.204  then the default mode \fB\-bm\fR
   1.205  (i.e. accept messages on stdin) is entered.
   1.206  However, if neither address arguments are specified nor
   1.207 -\fB\-t\fR is given, then no recipients are available and thus mail can not
   1.208 -be sent, hence something more useful is done: \fB\-bV\fP is assumed.
   1.209 +\fB\-t\fR is given, then mail can not be sent,
   1.210 +hence something more useful is done: \fB\-bV\fP is assumed.
   1.211  
   1.212  
   1.213  .SH OPTIONS
   1.214 @@ -100,42 +207,32 @@
   1.215  .TP
   1.216  \fB\-bd\fR
   1.217  
   1.218 -Run as daemon, accepting connections,
   1.219 -usually on port 25 if not configured differently.
   1.220 -This is usually used in the startup script at system boot and together with
   1.221 -the \fB\-q\fR option (see below).
   1.222 +``Daemon (listen)'' mode. See above.
   1.223  
   1.224  .TP
   1.225  \fB\-bi\fR
   1.226  
   1.227 -Old sendmail rebuilds its alias database when invoked with this option.
   1.228 -Masqmail reads directly from the file given with `alias_file' in the config file.
   1.229 -Hence masqmail simply exits in this mode.
   1.230 +``Rebuild alias database'' mode. See above.
   1.231  
   1.232  .TP
   1.233  .B \-bm
   1.234  
   1.235 -Accept a text message on stdin.
   1.236 -This is the default mode of operation.
   1.237 -One will hardly use this switch as it is the default.
   1.238 +``Accept message'' mode. See above.
   1.239  
   1.240  .TP
   1.241  \fB\-bp\fR
   1.242  
   1.243 -Show the messages in the queue.
   1.244 -Same as calling masqmail as `mailq'.
   1.245 +``Print queue'' mode. See above.
   1.246  
   1.247  .TP
   1.248  \fB\-bs\fR
   1.249  
   1.250 -Accept SMTP commands from stdin.
   1.251 -Some mailers (e.g. pine) use this option as an interface.
   1.252 -It can also be used to call masqmail from inetd.
   1.253 +``Stand-alone SMTP server'' mode. See above.
   1.254  
   1.255  .TP
   1.256  \fB\-bV \fR
   1.257  
   1.258 -Show version information, then exit.
   1.259 +``Print version'' mode. See above.
   1.260  
   1.261  .TP
   1.262  \fB\-B \fIarg\fR
   1.263 @@ -185,12 +282,7 @@
   1.264  .TP
   1.265  \fB\-Mrm \fImsgid...\fR
   1.266  
   1.267 -``Queue manipulation mode''
   1.268 -
   1.269 -Remove given messages from the queue.
   1.270 -Privileged users may remove any message, other users only their own.
   1.271 -The message identifiers are listed in the output of
   1.272 -\fImasqmail \-bp\fP (aka. \fImailq\fR).
   1.273 +``Queue manipulation'' mode. See above.
   1.274  
   1.275  .TP
   1.276  \fB\-m\fR
   1.277 @@ -233,52 +325,19 @@
   1.278  This especially affects \-om, \-oem, \-oee.
   1.279  
   1.280  .TP
   1.281 -\fB\-q [\fIinterval\fB]\fR
   1.282 +\fB\-q
   1.283  
   1.284 -Without argument:
   1.285 -Do a single queue run, i.e. try to deliver all messages in the queue.
   1.286 -Masqmail sends to addresses on the local host, on the local net,
   1.287 -and if it detects an online connection, to remote ones too.
   1.288 -That means, that masqmail sends any queued mail it can.
   1.289 -.B \-q
   1.290 -includes
   1.291 -.B \-qo
   1.292 -(without argument).
   1.293 +``Single queue run (normal)'' mode. See above.
   1.294  
   1.295 -With an argument:
   1.296 -Start as a daemon and do a queue run automatically once in the specified
   1.297 -time interval.
   1.298 -This is usually used together with \fB\-bd\fR (see above).
   1.299 +.TP
   1.300 +\fB\-q\fIINTERVAL
   1.301  
   1.302 -An argument may be a time interval i.e. a numerical value followed by one
   1.303 -of the letters s,m,h,d,w which are interpreted as
   1.304 -seconds, minutes, hours, days or weeks respectively.
   1.305 -Example: \fB\-q30m\fR.
   1.306 -
   1.307 -Running masqmail from inetd and starting single queue runs from cron
   1.308 -mimics the same effect as starting masqmail with something like
   1.309 -\fB\-bd \-q30m\fR.
   1.310 +``Daemon (queue)'' mode. See above.
   1.311  
   1.312  .TP
   1.313  \fB\-qo [\fIname\fB]\fR
   1.314  
   1.315 -Online queue runs.
   1.316 -
   1.317 -Without a connection name:
   1.318 -Determine the online status with the configured method
   1.319 -(see \fBonline_detect\fR in \fBmasqmail.conf(5)\fR)
   1.320 -and, if a connection is available, send remote mail over it.
   1.321 -
   1.322 -With a connection name:
   1.323 -Send remote mail over the specified connection,
   1.324 -no online detection is made.
   1.325 -
   1.326 -The specified route configuration is read and queued mail to remote
   1.327 -recipients will be sent.
   1.328 -The \fIname\fR is defined in the configuration (see \fBonline_routes.\fIname\fR).
   1.329 -
   1.330 -Use this option in your script which starts as soon as a link to the internet
   1.331 -has been set up (usually ip-up).
   1.332 +``Single queue run (online)'' mode. See above.
   1.333  
   1.334  .TP
   1.335  \fB\-t\fR