# HG changeset patch # User meillo@marmaro.de # Date 1275239726 -7200 # Node ID bce7604e0465f652e4f3762a1f7702e963cfdc74 # Parent 4762e0d26d8e4b35a5bee386ba3ad9146cf0a7bb updated README; added howto-report-bugs removed old future goals for masqmail, which oku had diff -r 4762e0d26d8e -r bce7604e0465 README --- a/README Sun May 30 17:11:07 2010 +0200 +++ b/README Sun May 30 19:15:26 2010 +0200 @@ -1,6 +1,7 @@ -MasqMail README +Masqmail README +=============== -MasqMail is a mail server designed for hosts that are not permanently +Masqmail is a mail server designed for hosts that are not permanently connected to the internet. It handles outgoing messages, i.e. those that are to be sent over the non-permanent link (usually a ppp or slip connection over a modem or ISDN adapter) specially and delivers them @@ -11,7 +12,7 @@ provider 1, it may be delivered when connected to provider 2. For each provider another mail host (or none) can be specified. -MasqMail provides (a yet simple) mechanism to rewrite headers, also +Masqmail provides (a yet simple) mechanism to rewrite headers, also depending on the current connection. This makes it possible to deliver messages with a return address on the local network which will be rewitten at delivery time. The purpose of this is: @@ -29,54 +30,71 @@ there is still the problem with the failure messages...), but it is a problem if you use different ones from time to time. -MasqMail shall once be a complete replacement for sendmail (or other +Masqmail shall once be a complete replacement for sendmail (or other MTAs such as exim, qmail or smail) on a local network, but it is NOT supposed to be installed in a network with a permanent internet connection (at least if it is not behind a secure firewall) because it has no ability to check for undesired relaying or spam filtering. -Missing, but soon to be realized features: -- .forward file support (alias file is supported) -- mailer demon messages (mail from the server in cases of delivery failures -or malformed addresses) +Masqmail's website is: -Future plans are: + http://marmaro.de/prog/masqmail -- initiate connections on its own -- integration to the masqdialer system (mserver) as an option -- possibly a pop3 server +The email address of it's mailing list is: + + + +To subscribe yourself to the list, send a mail with the subject +``subscribe masqmail'' to . The mailing list +archive is accessible at: http://lists.marmaro.de/masqmail/ . If you +have any problems, contact me: markus schnalke . + + +INSTALLATION +------------ For installation instructions, see INSTALL. -Bugs: MasqMail is still very young, and there are probably at lot of -bugs in it. I need every bug reported to me! If you do, please send me -the configuration files, the logs, the version, and a good description -on how to reproduce the error. The more bug reports I get, the better -masqmail will get! -CREDITS: --------- +BUGS +---- + +There are probably a lot of bugs in masqmail. Please report any one you +discover to me. The more bug reports I get, the better masqmail will +get. + +See docs/howto-report-bugs for detailed instructions. + + +CREDITS +------- I would like to thank everyone who has submitted suggestions and bug reports. Special thanks to: Gregor Hoffleit for beta testing and his suggestions for delivering -mail immediately when online. -Gregor Hoffleit again for supplying a patch which made maqmail work with mutt. -And again for making the Debian package. And more patches. +mail immediately when online. And for supplying a patch which made +masqmail work with mutt. And again for making the Debian package. And +more patches. -Dale Perkel for patiently trying to make MM compile and run with libc5 and -various bug reports. +Dale Perkel for patiently trying to make MM compile and run with libc5 +and various bug reports. Andre Masloch for finding most bugs. -Edouard G. Parmelan for many patches and bug reports +Edouard G. Parmelan for many patches and bug reports. -Iain Lea for the Redhat spec file +Iain Lea for the Redhat spec file. -...and many others --- -Oliver Kurth -http://masqmail.cx/ -last change: Feb. 3, 2000 +Juergen Daubert for excellent bug reports including patches and various +feedback. + +... and many others. +See ChangeLog, the code repository log, and the mailing list for more. +Feel free to tell me if you think you are missing on this list. + + + +This file was originally written by by Oliver Kurth . +Later updated and extended by markus schnalke . diff -r 4762e0d26d8e -r bce7604e0465 docs/howto-report-bugs --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/howto-report-bugs Sun May 30 19:15:26 2010 +0200 @@ -0,0 +1,34 @@ +Howto report bugs +================= + +All non-trivial software has bugs and so does masqmail. + +If you discover a bug then please report it. Your bug reports are an +important help in improving masqmail. + +Valuable bug report include the following information. The first two +are essential, the others can also be added on request. + +- A good description of what you consider to be the bug. + +- The version of masqmail that was used. (The output of: masqmail -bV). + +- A description on how to reproduce it. This includes information on + other software that is involved. + +- The configuration files. These are probably the contents of + /etc/masqmail/*. Don't forget to substitute confidential data with + placeholders. + +- The relevant log files. Have a look at the value of use_syslog and + log_dir in masqmail.conf. If use_syslog is enabled, the files are + probably some of /var/log/mail*. If you don't use syslog, then the + files reside unter the path assigned to log_dir, or by default in + /var/log/masqmail/. Take care to substitute confidential data if you + send debug files. (It's good to run masqmail with `-d 5' or `-d 6' to + generate debugging data that may help to track down the bug. + +Report the bug to the mailing list . You don't +have to be subscribed to write to the list. Please tell us if you're +not subscribed so that we set you on CC. If you want to subscribe, send +a mail with subject ``subscribe masqmail'' to .