1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/docs/howto-report-bugs	Sun May 30 19:15:26 2010 +0200
     1.3 @@ -0,0 +1,34 @@
     1.4 +Howto report bugs
     1.5 +=================
     1.6 +
     1.7 +All non-trivial software has bugs and so does masqmail.
     1.8 +
     1.9 +If you discover a bug then please report it. Your bug reports are an
    1.10 +important help in improving masqmail.
    1.11 +
    1.12 +Valuable bug report include the following information. The first two
    1.13 +are essential, the others can also be added on request.
    1.14 +
    1.15 +- A good description of what you consider to be the bug.
    1.16 +
    1.17 +- The version of masqmail that was used. (The output of: masqmail -bV).
    1.18 +
    1.19 +- A description on how to reproduce it. This includes information on
    1.20 +  other software that is involved.
    1.21 +
    1.22 +- The configuration files. These are probably the contents of
    1.23 +  /etc/masqmail/*. Don't forget to substitute confidential data with
    1.24 +  placeholders.
    1.25 +
    1.26 +- The relevant log files. Have a look at the value of use_syslog and
    1.27 +  log_dir in masqmail.conf. If use_syslog is enabled, the files are
    1.28 +  probably some of /var/log/mail*. If you don't use syslog, then the
    1.29 +  files reside unter the path assigned to log_dir, or by default in
    1.30 +  /var/log/masqmail/. Take care to substitute confidential data if you
    1.31 +  send debug files. (It's good to run masqmail with `-d 5' or `-d 6' to
    1.32 +  generate debugging data that may help to track down the bug.
    1.33 +
    1.34 +Report the bug to the mailing list <masqmail@marmaro.de>. You don't
    1.35 +have to be subscribed to write to the list. Please tell us if you're
    1.36 +not subscribed so that we set you on CC. If you want to subscribe, send
    1.37 +a mail with subject ``subscribe masqmail'' to <minimalist@marmaro.de>.