masqmail

diff man/masqmail.8 @ 252:1b25fabdc3cb

improved man/masqmail.8 in various ways but mostly for -oem The man page documents the changes in cmdline argument processing, done just recently. The problem of -oem is not solved yet but documented.
author markus schnalke <meillo@marmaro.de>
date Thu, 04 Nov 2010 13:43:44 -0300
parents 3c40f86d50e4
children 05fa719b7002
line diff
     1.1 --- a/man/masqmail.8	Thu Nov 04 13:00:19 2010 -0300
     1.2 +++ b/man/masqmail.8	Thu Nov 04 13:43:44 2010 -0300
     1.3 @@ -31,8 +31,7 @@
     1.4  
     1.5  Since masqmail is intended to replace sendmail, it uses the same command line options,
     1.6  but not all are implemented.
     1.7 -There are also two additional options, which are unique to masqmail
     1.8 -(\fB\-qo \fIconnection\fR and \fB\-g\fR)
     1.9 +The \fB\-qo\fP option is additional, and unique to masqmail.
    1.10  
    1.11  .TP
    1.12  \fB\-\-\fR
    1.13 @@ -98,6 +97,7 @@
    1.14  Set the debug level.
    1.15  This takes precedence before the value of `debug_level' in the configuration file.
    1.16  Read the warning in the description of the latter.
    1.17 +Only root may set the debug level.
    1.18  
    1.19  .TP
    1.20  \fB\-f [\fIaddress\fB]\fR
    1.21 @@ -114,35 +114,78 @@
    1.22  \fB\-i\fR
    1.23  
    1.24  Same as \fB\-oi\fR, see below.
    1.25 +Kept for compatibility.
    1.26  
    1.27  .TP
    1.28 -\fB\-Mrm \fIlist\fR
    1.29 +\fB\-Mrm \fImsgid...\fR
    1.30  
    1.31  Remove given messages from the queue.
    1.32 -Only allowed for privileged users.
    1.33 -The identifiers of messages are listed in the output of
    1.34 -\fImasqmail \-bp\fP (\fImailq\fR).
    1.35 +Privileged users may remove any message,
    1.36 +other users only their own.
    1.37 +The message identifiers are listed in the output of
    1.38 +\fImasqmail \-bp\fP (aka. \fImailq\fR).
    1.39  
    1.40  .TP
    1.41  \fB\-m\fR
    1.42  
    1.43  Same as \fB\-om\fR, see below.
    1.44 +Kept for compatibility.
    1.45  
    1.46  .TP
    1.47  \fB\-oem\fR
    1.48  
    1.49 +Currently this option makes masqmail behave such:
    1.50 +
    1.51  If the \fB\-oi\fR ist not also given, always return with a non zero return code.
    1.52 -Maybe someone tells me what this is good for...
    1.53 +
    1.54 +It seems as if this current behavior is not like it should be.
    1.55 +
    1.56 +In exim this option makes it behave such:
    1.57 +
    1.58 +.in +4
    1.59 +.ll -4
    1.60 +If an error is detected while a non-SMTP message is being received
    1.61 +(for example, a malformed address),
    1.62 +the error is reported to the sender in a mail message.
    1.63 +Exim exits with a non-zero return code then,
    1.64 +no matter if the error message was successful or not.
    1.65 +(In exim, -oee is similar but exim returns successful
    1.66 +if the error message had been sent successful.)
    1.67 +.ll
    1.68 +.in
    1.69 +
    1.70 +The mutt wiki writes about ``sendmail -oi -oem'':
    1.71 +
    1.72 +.in +4
    1.73 +.ll -4
    1.74 +The mail server (in this case sendmail) will receive the message in input,
    1.75 +and will parse it. In case of a malformed message, it will send an error
    1.76 +message to the user to whom belongs the MUA trasmitting the message
    1.77 +(e.g. user@localhost.localdomain), and it will exit with a non zero exit code:
    1.78 +the -oem flag forces the returning of a non zero exit code even in
    1.79 +the case the error message has been successfully sent to the local server.
    1.80 +.ll
    1.81 +.in
    1.82 +
    1.83 +Masqmail's behavior is different in that:
    1.84 +First, it does not send such error messages.
    1.85 +Second, return non-zero whenever -oem is set (but -oi not).
    1.86 +Third, -oi overrules -oem, though as it seems the two options 
    1.87 +should not affect each other.
    1.88 +(Their relationship is just that -oem does only affect non-SMTP
    1.89 +messages on stdin, which is the typical use of -oi.)
    1.90  
    1.91  .TP
    1.92  \fB\-odb\fR
    1.93  
    1.94 -Deliver in background.
    1.95 -Masqmail always does this, which makes this option pretty much useless.
    1.96 +``Deliver in Background''
    1.97 +Masqmail always does this.
    1.98 +Hence masqmail ignores this switch.
    1.99  
   1.100  .TP
   1.101  \fB\-odq\fR
   1.102  
   1.103 +``Do Queueing''
   1.104  Do not attempt to deliver immediately.
   1.105  Any messages will be queued until the next queue running process picks them up and delivers them.
   1.106  You get the same effect by setting the do_queue option in /etc/masqmail/masqmail.conf.
   1.107 @@ -155,11 +198,15 @@
   1.108  .TP
   1.109  \fB\-om\fR
   1.110  
   1.111 -From exim(8)'s man page: In Sendmail, this option means ``me too'',
   1.112 -indicating that the sender of a message should receive a copy of the
   1.113 -message if the sender appears in an alias expansion.
   1.114 +``Me too''
   1.115 +Masqmail never excludes the sender from any alias expansions,
   1.116 +like if this switch is always set.
   1.117 +Specifying this switch changes nothing.
   1.118  
   1.119 -Masqmail always does this, hence the option does nothing. 
   1.120 +.TP
   1.121 +\fB\-oXXX\fR
   1.122 +
   1.123 +Any other switch starting with `-o' is ignored.
   1.124  
   1.125  .TP
   1.126  \fB\-q [\fIinterval\fB]\fR
   1.127 @@ -196,8 +243,6 @@
   1.128  \fB\-t\fR
   1.129  
   1.130  Read recipients from headers.
   1.131 -Delete `Bcc:' headers.
   1.132 -(Since 0.2.25, masqmail deletes Bcc: headers in all cases.)
   1.133  If any arguments are given, these are interpreted as recipient addresses
   1.134  and the message will not be sent to these,
   1.135  although they might appear in To:, Cc:, or Bcc: headers.
   1.136 @@ -211,6 +256,7 @@
   1.137  .TP
   1.138  \fB\-v\fR
   1.139  
   1.140 +``Verbose''
   1.141  Log also to stdout.
   1.142  Currently, some log messages are marked as `write to stdout' and additionally,
   1.143  all messages with priority `LOG_ALERT' and `LOG_WARNING' will be written to stdout