1.1 --- a/docs/masqmail.get.5	Thu May 06 13:31:57 2010 +0200
     1.2 +++ b/docs/masqmail.get.5	Fri May 07 13:50:23 2010 +0200
     1.3 @@ -1,100 +1,134 @@
     1.4 -.TH masqmail.get 5 User Manuals
     1.5 +.TH masqmail.get 5 2010-05-07 masqmail-0.2.21 "File Formats"
     1.6 +
     1.7  .SH NAME
     1.8  masqmail.get \- masqmail get configuration file
     1.9 +
    1.10 +
    1.11  .SH DESCRIPTION
    1.12   
    1.13  This man page describes the options available for the masqmail get configuration.
    1.14  
    1.15 +
    1.16  .SH OPTIONS
    1.17 +
    1.18  .TP
    1.19 +\fBprotocol\fR = \fIstring\fR
    1.20  
    1.21 -\fBprotocol\f1 = \fIstring\f1
    1.22 +The protocol with which you retrieve your mail.
    1.23 +Currently only `pop3' and `apop' are supported.
    1.24 +There is no default.
    1.25  
    1.26 -The protocol with which you retrieve your mail. Currently only 'pop3' and 'apop' are supported. There is no default.
    1.27  .TP
    1.28 -
    1.29 -\fBserver\f1 = \fIstring\f1
    1.30 +\fBserver\fR = \fIstring\fR
    1.31  
    1.32  The server you get your mail from.
    1.33 +
    1.34  .TP
    1.35 +\fBresolve_list\fR = \fIlist\fR
    1.36  
    1.37 -\fBresolve_list\f1 = \fIlist\f1
    1.38 +Specify the method how the domain of the server is resolved.
    1.39 +Possible values are dns_mx, dns_a, byname.
    1.40 +For `dns_mx', the domain is assumed to be an MX pointer to a list of host names,
    1.41 +these will be tried each in order
    1.42 +(lowest preference value first, equal preference values in random order).
    1.43 +For `dns_a', the domain is assumed to be an A pointer.
    1.44 +For `byname', the library function \fBgethostbyname(3)\fR will be used.
    1.45  
    1.46 -Specify the method how the domain of the server is resolved. Possible values are dns_mx, dns_a, byname. For 'dns_mx', the domain is assumed to be an MX pointer to a list of host names, these will be tried each in order (lowest preference value first, equal preference values in random order). For 'dns_a', the domain is assumed to be an A pointer. For 'byname', the library function \fBgethostbyname (3)\f1 will be used.
    1.47 +The default is "dns_a;byname".
    1.48 +It does not make much sense here to use `dns_mx'.
    1.49  
    1.50 -The default is "dns_a;byname". It does not make much sense here to use 'dns_mx'.
    1.51  .TP
    1.52 -
    1.53 -\fBuser\f1 = \fIstring\f1
    1.54 +\fBuser\fR = \fIstring\fR
    1.55  
    1.56  Your login name.
    1.57 +
    1.58  .TP
    1.59 -
    1.60 -\fBpass\f1 = \fIstring\f1
    1.61 +\fBpass\fR = \fIstring\fR
    1.62  
    1.63  Your password.
    1.64 +
    1.65  .TP
    1.66 +\fBaddress\fR = \fIaddress\fR
    1.67  
    1.68 -\fBaddress\f1 = \fIaddress\f1
    1.69 +The address where the retrieved mail should be sent to.
    1.70 +It can be any address, but you probably want to set this to a local address on your LAN.
    1.71  
    1.72 -The address where the retrieved mail should be sent to. It can be any address, but you probably want to set this to a local address on your LAN.
    1.73  .TP
    1.74 +\fBreturn_path\fR = \fIaddress\fR
    1.75  
    1.76 -\fBreturn_path\f1 = \fIaddress\f1
    1.77 +If set, masqmail sets the return path to this address.
    1.78 +Bounces generated during further delivery will be sent to this address.
    1.79 +If unset, masqmail looks for the Return-Path: header in the mail,
    1.80 +if this does not exist it uses the From: address and if this fails, postmaster will be used.
    1.81  
    1.82 -If set, masqmail sets the return path to this address. Bounces generated during further delivery will be sent to this address. If unset, masqmail looks for the Return-Path: header in the mail, if this does not exist it uses the From: address and if this fails, postmaster will be used.
    1.83 +It is in most cases not useful to set this to the same address as the `address'
    1.84 +option as this may generate multiple bounces.
    1.85 +postmaster is recommended.
    1.86  
    1.87 -It is in most cases not useful to set this to the same address as the 'address' option as this may generate multiple bounces. postmaster is recommended.
    1.88  .TP
    1.89 +\fBdo_keep\fR = \fIboolean\fR
    1.90  
    1.91 -\fBdo_keep\f1 = \fIboolean\f1
    1.92 +If you want to keep your mail on the server after you retrieved it, set this to true.
    1.93 +It is recommended that you also set do_uidl,
    1.94 +otherwise you will get the mail again each time you connect to the server.
    1.95 +Masqmail does not check any headers before it retrieves mail, which may mark it as already fetched.
    1.96 +Note that this behaviour is different to that of fetchmail.
    1.97 +The default is false.
    1.98  
    1.99 -If you want to keep your mail on the server after you retrieved it, set this to true. It is recommended that you also set do_uidl, otherwise you will get the mail again each time you connect to the server. Masqmail does not check any headers before it retrieves mail, which may mark it as already fetched. Note that this behaviour is different to that of fetchmail. The default is false.
   1.100  .TP
   1.101 +\fBdo_uidl\fR = \fIboolean\fR
   1.102  
   1.103 -\fBdo_uidl\f1 = \fIboolean\f1
   1.104 +If set, masqmail keeps a list of unique IDs of mails already fetched,
   1.105 +so that they will not be retrieved again.
   1.106 +Default is false.
   1.107  
   1.108 -If set, MasqMail keeps a list of unique IDs of mails already fetched, so that they will not be retrieved again. Default is false.
   1.109  .TP
   1.110 +\fBdo_uidl_dele\fR = \fIboolean\fR
   1.111  
   1.112 -\fBdo_uidl_dele\f1 = \fIboolean\f1
   1.113 +If set, and \fBdo_uidl\fR is also set, MasqMail sends a delete (DELE) command
   1.114 +to the server for each message uid in the uid listing at the beginning of the session.
   1.115 +This prevents mail to be left on the server if masqmail gets interrupted during
   1.116 +a session before it can send the QUIT command to the server.
   1.117 +Default is false.
   1.118  
   1.119 -If set, and \fBdo_uidl\f1 is also set, MasqMail sends a delete (DELE) command to the server for each message uid in the uid listing at the beginning of the session. This prevents mail to be left on the server if masqmail gets interrupted during a session before it can send the QUIT command to the server. Default is false.
   1.120  .TP
   1.121 +\fBmax_size\fR = \fInumeric\fR
   1.122  
   1.123 -\fBmax_size\f1 = \fInumeric\f1
   1.124 +If set to a value > 0, only messages smaller than this in bytes will be retrieved.
   1.125 +The default is 0.
   1.126  
   1.127 -If set to a value > 0, only messages smaller than this in bytes will be retrieved. The default is 0.
   1.128  .TP
   1.129 +\fBmax_count\fR = \fInumeric\fR
   1.130  
   1.131 -\fBmax_count\f1 = \fInumeric\f1
   1.132 +If set to a value > 0, only \fBmax_count\fR messages will be retrieved.
   1.133 +The default is 0.
   1.134  
   1.135 -If set to a value > 0, only \fBmax_count\f1 messages will be retrieved. The default is 0.
   1.136  .TP
   1.137 +\fBwrapper\fR = \fIcommand\fR
   1.138  
   1.139 -\fBwrapper\f1 = \fIcommand\f1
   1.140 -
   1.141 -If set, instead of opening a connection to a remote server, \fIcommand\f1 will be called and all traffic will be piped to its stdin and from its stdout. Purpose is to tunnel ip traffic, eg. for ssl.
   1.142 +If set, instead of opening a connection to a remote server,
   1.143 +\fIcommand\fR will be called and all traffic will be piped to its stdin and from its stdout.
   1.144 +Purpose is to tunnel ip traffic, e.g. for ssl.
   1.145  
   1.146  Example for ssl tunneling:
   1.147  
   1.148  wrapper="/usr/bin/openssl s_client \-quiet \-connect pop.gmx.net:995 2>/dev/null"
   1.149 +
   1.150 +
   1.151  .SH AUTHOR
   1.152  
   1.153 -masqmail was written by Oliver Kurth. It is now maintained by Markus Schnalke <meillo@marmaro.de>.
   1.154 +Masqmail was written by Oliver Kurth.
   1.155 +It is now maintained by Markus Schnalke <meillo@marmaro.de>.
   1.156  
   1.157 -You will find the newest version of masqmail at \fBhttp://prog.marmaro.de/masqmail/\f1.
   1.158 +You will find the newest version of masqmail at \fBhttp://prog.marmaro.de/masqmail/\fR.
   1.159  There is also a mailing list, you will find information about it at masqmail's main site.
   1.160  
   1.161 +
   1.162  .SH BUGS
   1.163  
   1.164 -You should report them to the mailing list.
   1.165 +Please report bugs to the mailing list.
   1.166 +
   1.167  
   1.168  .SH SEE ALSO
   1.169  
   1.170 -\fBmasqmail (8)\f1, \fBmasqmail.route (5)\f1, \fBmasqmail.conf (5)\f1
   1.171 -
   1.172 -.SH COMMENTS
   1.173 -
   1.174 -This man page was written using \fBxml2man (1)\f1 by the same author.
   1.175 -
   1.176 +\fBmasqmail(8)\fR, \fBmasqmail.route(5)\fR, \fBmasqmail.conf(5)\fR