# HG changeset patch # User meillo@marmaro.de # Date 1279101721 -7200 # Node ID dbe3dadd1afe01e08f1266e2a62dd8d5ba887a58 # Parent 4917e764f1083dd6baa012927a8ff7cfa5bfdb6e Documentation improvements in the INSTALL file and some man pages thanks to Nico R. diff -r 4917e764f108 -r dbe3dadd1afe INSTALL --- a/INSTALL Wed Jul 14 11:48:59 2010 +0200 +++ b/INSTALL Wed Jul 14 12:02:01 2010 +0200 @@ -1,5 +1,5 @@ Additional information may be available in docs/ or on the website. -For installing on GNU/Linux distributions read docs/linux-distris. +For installing on GNU/Linux distributions read docs/INSTALL.linux. Installation instructions @@ -18,7 +18,7 @@ use any number you like, but preferably one < 100. It does not have to be the same for the user 'mail' and the group 'trusted'. -Compliling is a matter of the usual procedure. In the source directory, +Compiling is a matter of the usual procedure. In the source directory, after unpacking do: ./configure @@ -54,43 +54,44 @@ --enable-auth enables ESMTP AUTH support (disabled by default) ---disable-pop3 disables pop3 support (enabled by default) +--disable-pop3 disables POP3 support (enabled by default) --enable-maildir enables qmail style Maildir support (disabled by default) ---enable-ident enable RFC 1413 support. If you have the libident +--enable-ident enables RFC 1413 support. If you have the libident dynamic library installed, this will be linked, otherwise it will be statically linked using the sources included in the package. ---disable-resolver disable resolver support. Without the resolver functions, +--disable-resolver disables resolver support. Without the resolver functions, masqmail uses only gethostbyname() to resolve DNS names, and you cannot send mail without a smart host. Not recommended. You save 3K at most. ---disable-smtp-server disable SMTP server support. You may want this if you do +--disable-smtp-server disables SMTP server support. You may want this if you do not need masqmail to listen. In this case, you cannot use masqmail as a smart host for other hosts on your LAN, you cannot use mail clients that send SMTP, you cannot even use pine. In short, use of this option is discouraged unless your resources are extremely limited. ---enable-mserver enable online detection by connecting to the mserver +--enable-mserver enables online detection by connecting to the mserver (masqdialer system). --with-libcryto instead of using the md5 and hmac functions within the package, -link dynamically with libcrypto. This applies only if you have pop3 or SMTP -AUTH enabled. Makes only sense if your resources are limited and you have +link dynamically with libcrypto. This applies only if you have POP3 or SMTP +AUTH enabled. Only makes sense if your resources are limited and you have libcrypto installed. Untested. ---with-glib-static link with glib statically. This makes the binary larger +--with-glib-static links with glib statically. This makes the binary larger by around 30K (i386 architecture), but if masqmail is the only binary using glib, you save some space in total, because you do not need the shared glib library installed. ---disable-debug disable debugging, setting it on by command line or configuration -has no effect. Strongly discouraged, since you miss valuable information if something -goes wrong. You save 6K. +--disable-debug disables debugging; enabling it by command line or configuration +option has no effect. Strongly discouraged, since you miss valuable information +if something goes wrong. You save 6K. BTW, to get 3K of space, call strip --remove-section=.comment --remove-section=.note --strip-unneeded src/masqmail +after building. @@ -103,7 +104,7 @@ Check that 'make install' worked correctly. The following command: ls -ld /usr/sbin/masqmail /etc/masqmail /var/log/masqmail/ \ - /var/run/masqmail /var/spool/masqmail/ /var/spool/masqmail/* + /var/run/masqmail /var/spool/masqmail/ /var/spool/masqmail/* should give output similar to diff -r 4917e764f108 -r dbe3dadd1afe man/masqmail.8 --- a/man/masqmail.8 Wed Jul 14 11:48:59 2010 +0200 +++ b/man/masqmail.8 Wed Jul 14 12:02:01 2010 +0200 @@ -29,7 +29,8 @@ e.g. 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. +It can also act as a POP3 client (if this functionality has not been disabled at +build configuration time). .SH OPTIONS @@ -138,7 +139,7 @@ It checks for the online status first. Example: `masqmail \-go 5m' will retrieve mail every five minutes. -If called without \fIname\fR the online status is determined with the configured method +If called without \fIname\fR, the online status is determined with the configured method (see \fBonline_detect\fR in \fBmasqmail.conf(5)\fR). .TP diff -r 4917e764f108 -r dbe3dadd1afe man/masqmail.conf.5 --- a/man/masqmail.conf.5 Wed Jul 14 11:48:59 2010 +0200 +++ b/man/masqmail.conf.5 Wed Jul 14 12:02:01 2010 +0200 @@ -16,22 +16,22 @@ Where \fBval\fR is a variable name and \fIexpression\fR a string, which can be quoted with double quotes `"'. If the expression is on multiple lines or contains characters other than letters, -digits or the characters `.', `-', `_', `/', ';', '@', ':' it must be quoted. +digits or the characters `.', `-', `_', `/', ';', '@', ':', it must be quoted. You can use quotes inside quotes by escaping them with a backslash. -Each val has a type, which can be boolean, numeric, string or list. +Each \fBval\fP has a type, which can be boolean, numeric, string or list. A boolean variable can be set with one of the values `on', `yes', and `true' or `off', `no' and `false'. List items are separated with semicolons `;'. -For some values patterns (like `*',`?') can be used. -The spaces before and after the equal sign `=' are optional. +For some values, patterns (like `*',`?') can be used. +The spaces in front of and after the equal sign `=' are optional. Most lists (exceptions: \fBlocal_hosts\fR, \fBlocal_nets\fR, \fBlisten_addresses\fR, \fBonline_routes\fR, and \fBonline_gets\fR) accept files. These will be recognized by a leading slash `/'. The contents of these files will be included at the position of the file name, there can be items or other files before and after the file entry. -The format of the files is different though, within these files each entry is on another line. -(And not separated by semicolons). +The format of the files is different though, within these files each entry is on another line +and the entries are not separated by semicolons. This makes it easy to include large lists which are common in different configuration files, so they do not have to appear in every configuration file. @@ -65,8 +65,8 @@ .TP \fBlog_dir = \fIfile\fR -The directory where log are stored, if syslog is not used. -Debug files are stored in this directory anyways. +The directory where logs are stored, if syslog is not used. +Debug files are always stored in this directory if debugging is enabled. \fI/var/log/masqmail\fR is a common value. \fIfile\fR must be an absolute path.