masqmail-0.2

changeset 67:bce7604e0465

updated README; added howto-report-bugs removed old future goals for masqmail, which oku had
author meillo@marmaro.de
date Sun, 30 May 2010 19:15:26 +0200
parents 4762e0d26d8e
children 08e258ed1ebc
files README docs/howto-report-bugs
diffstat 2 files changed, 83 insertions(+), 31 deletions(-) [+]
line diff
     1.1 --- a/README	Sun May 30 17:11:07 2010 +0200
     1.2 +++ b/README	Sun May 30 19:15:26 2010 +0200
     1.3 @@ -1,6 +1,7 @@
     1.4 -MasqMail README
     1.5 +Masqmail README
     1.6 +===============
     1.7  
     1.8 -MasqMail is a mail server designed for hosts that are not permanently
     1.9 +Masqmail is a mail server designed for hosts that are not permanently
    1.10  connected to the internet. It handles outgoing messages, i.e. those
    1.11  that are to be sent over the non-permanent link (usually a ppp or slip
    1.12  connection over a modem or ISDN adapter) specially and delivers them
    1.13 @@ -11,7 +12,7 @@
    1.14  provider 1, it may be delivered when connected to provider 2. For each
    1.15  provider another mail host (or none) can be specified.
    1.16  
    1.17 -MasqMail provides (a yet simple) mechanism to rewrite headers, also
    1.18 +Masqmail provides (a yet simple) mechanism to rewrite headers, also
    1.19  depending on the current connection. This makes it possible to deliver
    1.20  messages with a return address on the local network which will be
    1.21  rewitten at delivery time. The purpose of this is:
    1.22 @@ -29,54 +30,71 @@
    1.23  there is still the problem with the failure messages...), but it is a
    1.24  problem if you use different ones from time to time.
    1.25  
    1.26 -MasqMail shall once be a complete replacement for sendmail (or other
    1.27 +Masqmail shall once be a complete replacement for sendmail (or other
    1.28  MTAs such as exim, qmail or smail) on a local network, but it is NOT
    1.29  supposed to be installed in a network with a permanent internet
    1.30  connection (at least if it is not behind a secure firewall) because
    1.31  it has no ability to check for undesired relaying or spam filtering.
    1.32  
    1.33 -Missing, but soon to be realized features:
    1.34  
    1.35 -- .forward file support (alias file is supported)
    1.36 -- mailer demon messages (mail from the server in cases of delivery failures
    1.37 -or malformed addresses)
    1.38 +Masqmail's website is:
    1.39  
    1.40 -Future plans are:
    1.41 +	http://marmaro.de/prog/masqmail
    1.42  
    1.43 -- initiate connections on its own
    1.44 -- integration to the masqdialer system (mserver) as an option
    1.45 -- possibly a pop3 server
    1.46 +The email address of it's mailing list is:
    1.47 +
    1.48 +	<masqmail@marmaro.de>
    1.49 +
    1.50 +To subscribe yourself to the list, send a mail with the subject
    1.51 +``subscribe masqmail'' to <minimalist@marmaro.de>. The mailing list
    1.52 +archive is accessible at: http://lists.marmaro.de/masqmail/ . If you
    1.53 +have any problems, contact me: markus schnalke <meillo@marmaro.de>.
    1.54 +
    1.55 +
    1.56 +INSTALLATION
    1.57 +------------
    1.58  
    1.59  For installation instructions, see INSTALL.
    1.60  
    1.61 -Bugs: MasqMail is still very young, and there are probably at lot of
    1.62 -bugs in it. I need every bug reported to me! If you do, please send me
    1.63 -the configuration files, the logs, the version, and a good description
    1.64 -on how to reproduce the error. The more bug reports I get, the better
    1.65 -masqmail will get!
    1.66  
    1.67 -CREDITS:
    1.68 ---------
    1.69 +BUGS
    1.70 +----
    1.71 +
    1.72 +There are probably a lot of bugs in masqmail. Please report any one you
    1.73 +discover to me. The more bug reports I get, the better masqmail will
    1.74 +get.
    1.75 +
    1.76 +See docs/howto-report-bugs for detailed instructions.
    1.77 +
    1.78 +
    1.79 +CREDITS
    1.80 +-------
    1.81  
    1.82  I would like to thank everyone who has submitted suggestions and bug
    1.83  reports. Special thanks to:
    1.84  
    1.85  Gregor Hoffleit for beta testing and his suggestions for delivering
    1.86 -mail immediately when online.
    1.87 -Gregor Hoffleit again for supplying a patch which made maqmail work with mutt.
    1.88 -And again for making the Debian package. And more patches.
    1.89 +mail immediately when online. And for supplying a patch which made
    1.90 +masqmail work with mutt. And again for making the Debian package. And
    1.91 +more patches.
    1.92  
    1.93 -Dale Perkel for patiently trying to make MM compile and run with libc5 and
    1.94 -various bug reports.
    1.95 +Dale Perkel for patiently trying to make MM compile and run with libc5
    1.96 +and various bug reports.
    1.97  
    1.98  Andre Masloch for finding most bugs.
    1.99  
   1.100 -Edouard G. Parmelan for many patches and bug reports
   1.101 +Edouard G. Parmelan for many patches and bug reports.
   1.102  
   1.103 -Iain Lea for the Redhat spec file
   1.104 +Iain Lea for the Redhat spec file.
   1.105  
   1.106 -...and many others
   1.107 ---
   1.108 -Oliver Kurth <oku@masqmail.cx>
   1.109 -http://masqmail.cx/
   1.110 -last change: Feb. 3, 2000
   1.111 +Juergen Daubert for excellent bug reports including patches and various
   1.112 +feedback.
   1.113 +
   1.114 +... and many others.
   1.115 +See ChangeLog, the code repository log, and the mailing list for more.
   1.116 +Feel free to tell me if you think you are missing on this list.
   1.117 +
   1.118 +
   1.119 +
   1.120 +This file was originally written by by Oliver Kurth <oku@masqmail.cx>.
   1.121 +Later updated and extended by markus schnalke <meillo@marmaro.de>.
     2.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     2.2 +++ b/docs/howto-report-bugs	Sun May 30 19:15:26 2010 +0200
     2.3 @@ -0,0 +1,34 @@
     2.4 +Howto report bugs
     2.5 +=================
     2.6 +
     2.7 +All non-trivial software has bugs and so does masqmail.
     2.8 +
     2.9 +If you discover a bug then please report it. Your bug reports are an
    2.10 +important help in improving masqmail.
    2.11 +
    2.12 +Valuable bug report include the following information. The first two
    2.13 +are essential, the others can also be added on request.
    2.14 +
    2.15 +- A good description of what you consider to be the bug.
    2.16 +
    2.17 +- The version of masqmail that was used. (The output of: masqmail -bV).
    2.18 +
    2.19 +- A description on how to reproduce it. This includes information on
    2.20 +  other software that is involved.
    2.21 +
    2.22 +- The configuration files. These are probably the contents of
    2.23 +  /etc/masqmail/*. Don't forget to substitute confidential data with
    2.24 +  placeholders.
    2.25 +
    2.26 +- The relevant log files. Have a look at the value of use_syslog and
    2.27 +  log_dir in masqmail.conf. If use_syslog is enabled, the files are
    2.28 +  probably some of /var/log/mail*. If you don't use syslog, then the
    2.29 +  files reside unter the path assigned to log_dir, or by default in
    2.30 +  /var/log/masqmail/. Take care to substitute confidential data if you
    2.31 +  send debug files. (It's good to run masqmail with `-d 5' or `-d 6' to
    2.32 +  generate debugging data that may help to track down the bug.
    2.33 +
    2.34 +Report the bug to the mailing list <masqmail@marmaro.de>. You don't
    2.35 +have to be subscribed to write to the list. Please tell us if you're
    2.36 +not subscribed so that we set you on CC. If you want to subscribe, send
    2.37 +a mail with subject ``subscribe masqmail'' to <minimalist@marmaro.de>.