muttbug(1) has a manual page of it's own now.

1 files changed, 175 insertions, 0 deletions

diff --git a/doc/muttbug.man b/doc/muttbug.man
new file mode 100644
index 00000000..a78c5fcf
--- /dev/null
+++ b/doc/muttbug.man
@@ -0,0 +1,175 @@
+.\" -*-nroff-*-
+.\"
+.\"
+.\"     Copyright (C) 1996-2000 Thomas Roessler <roessler@guug.de>
+.\" 
+.\"     This program is free software; you can redistribute it and/or modify
+.\"     it under the terms of the GNU General Public License as published by
+.\"     the Free Software Foundation; either version 2 of the License, or
+.\"     (at your option) any later version.
+.\" 
+.\"     This program is distributed in the hope that it will be useful,
+.\"     but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\"     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+.\"     GNU General Public License for more details.
+.\" 
+.\"     You should have received a copy of the GNU General Public License
+.\"     along with this program; if not, write to the Free Software
+.\"     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+.\"
+.TH mutt 1 "July 2000" Unix "User Manuals"
+.SH NAME
+.PP
+muttbug \- report a bug in mutt
+.SH SYNOPSIS
+.PP
+.B muttbug
+.SH DESCRIPTION
+.PP
+.B muttbug
+is a shell script which helps you to submit a bug report against the 
+.BR mutt (1)
+mail user agent.
+.PP
+If you invoke muttbug, you'll first be prompted for a short
+description of the problem you experience.  This will be used as the
+bug report's subject line, so it should be concise, but informative.
+.PP
+You are then asked to assign an initial severity level to the
+problem you observe; 
+.B muttbug
+will give you a description which severity level is appropriate or
+not.
+.PP
+Then, you are asked for the location of a core dump (normally named
+\(lqcore\(rq which may have been left over by a crash of your mutt.
+You can just type \(lqno\(rq here, or you can enter the path leading 
+to a core dump.
+.B muttbug
+will try to use either
+.BR sdb (1),
+.BR dbx (1),
+or
+.BR gdb (1)
+to extract some information from this core dump which may be helpful
+to developers in order to determine the reason for the crash.
+.PP
+Finally, you are asked whether or not you want to include personal
+and system 
+.BR mutt (1)
+configuration files with the bug report.  If at all possible, we
+urge you to answer these questions with \(lqyes\(rq, since a
+reference configuration makes it incredibly easier to track down a
+problem.
+.PP
+If you are using Debian GNU/Linux,
+.B muttbug
+will now check whether or not mutt has been installed as a Debian
+package on your system, and suggest to file the bug against the
+.BR mutt (1)
+and Debian bug tracking systems.  This option was added since the 
+.BR mutt (1)
+project uses another instantiation of the Debian buck tracking
+system, so submitting bugs against both systems in one pass is
+simple.
+.PP
+You are then dropped into your favorite editor as determined by the 
+.B EDITOR
+and
+.B VISUAL
+environment variables.  Please give us details about the problem in
+the empty space below the line reading \(lqPlease type your report
+below this line\(rq.  We are most interested in precise information
+on what symptoms you observe and what steps may be used to reproduce
+the bug.  Chances are that problems which can easily be reproduced
+will be fixed quickly.  So please take some time when filling out
+this part of the template.
+.PP
+The rest of the template contains various kinds of information
+gathered from your system, including output of the
+.BR uname (1)
+command, output from
+.BR mutt (1)
+itself, and your system's 
+.BR mutt (1)
+configuration files.  Yoy may wish to browse through this part of
+the bug report form in order to avoid leaking confidential
+information to the public.
+.PP
+If you leave the editor, 
+.B muttbug
+will give you the option to view, re-edit, submit, or abandon your
+bug report.
+.PP
+While your bug report is being processed, you will receive various
+e-mail messages from the bug tracking system informing you about
+what's going on: Once your bug report has been entered into the bug
+tracking system, it will be assigned a unique serial number about
+which you are informed via e-mail.  If you wish to submit additional
+information about the bug, you can just send it to the address
+.BR \fIserial\fP@bugs.guug.de .
+.PP
+Later, you will most likely receive questions from the developers
+about the problem you observed, and you will eventually be informed
+that your bug report has been closed.  This means that the bug has
+been fixed at least in the 
+.BR cvs (1)
+repository.   If the answers you receive don't satisfy you, don't
+hesitate to contact the developers directly under 
+.BR mutt-dev@mutt.org.
+.SH
+ENVIRONMENT
+.PP
+.B muttbug
+will use the following environment variables:
+.IP "EMAIL"
+Your electronic mail address.  Will be used to set the bug report's
+From header, and to send you a copy of the report.
+.IP "LOGNAME"
+Your login name.  If the
+.B EMAIL
+environment variable isn't set, this will be used instead to send
+you a copy of the report.  Setting the sender will be left to 
+.BR sendmail (8)
+on your system.
+.IP "REPLYTO"
+If set, the bug report will contain a Reply-To header with the
+e-mail address contained in this environment variable.
+.IP "ORGANIZATION"
+If set, the bug report will contain an Organization header with the
+contents of this environment variable.
+.IP "PAGER"
+If set, this environment variable will be expected to contain the
+path to your favorite pager for viewing the bug report.  If unset, 
+.BR more (1)
+will be used.
+.IP "VISUAL"
+If set, this environment variable will be expected to contain the
+path to your favorite visual editor.
+.IP "EDITOR"
+If set, this environment variable will be expected to contain the
+path to your favorite editor.  This variable is examined if and only
+if the 
+.B VISUAL
+environment variable is unset.  If
+.B EDITOR
+is unset, 
+.BR vi (1)
+will be used to edit the bug report.
+.SH 
+SEE ALSO
+.PP
+.BR mutt (1),
+.BR muttrc (5),
+.BR sdb (1),
+.BR gdb (1),
+.BR dbx (1),
+.BR vi (1)
+.PP
+The mutt bug tracking system: http://bugs.guug.de/
+.SH
+AUTHOR
+.PP
+.B muttbug
+and this manual page were written by Thomas Roessler
+<roessler@guug.de>.