From: Thomas Roessler Date: Tue, 25 Jul 2000 16:02:33 +0000 (+0000) Subject: muttbug(1) has a manual page of it's own now. X-Git-Tag: mutt-1-3-6-rel~10 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=25440dc51490cf5b1d276b4bdf4f353fb57601d7;p=mutt muttbug(1) has a manual page of it's own now. --- diff --git a/doc/Makefile.in b/doc/Makefile.in index 5825e61a..c608dfc5 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -36,6 +36,7 @@ INCLUDES=-I. -I.. -I$(includedir) -I$(top_srcdir) MAKEDOC_CPP=$(CPP) $(INCLUDES) $(DEFS) $(CPPFLAGS) -D_MAKEDOC -C DISTFILES = Makefile.in dotlock.man \ + muttbug.man \ mutt.man \ PGP-Notes.txt \ applying-patches.txt \ @@ -70,6 +71,7 @@ install: all $(top_srcdir)/mkinstalldirs $(DESTDIR)$(mandir)/man1 $(top_srcdir)/mkinstalldirs $(DESTDIR)$(mandir)/man5 $(INSTALL) -m 644 $(srcdir)/mutt.man $(DESTDIR)$(mandir)/man1/mutt.1 + $(INSTALL) -m 644 $(srcdir)/muttbug.man $(DESTDIR)$(mandir)/man1/muttbug.1 $(INSTALL) -m 644 $(srcdir)/dotlock.man \ $(DESTDIR)$(mandir)/man1/mutt_dotlock.1 $(INSTALL) -m 644 muttrc.man $(DESTDIR)$(mandir)/man5/muttrc.5 diff --git a/doc/mutt.man b/doc/mutt.man index 116ae35a..858b7c9d 100644 --- a/doc/mutt.man +++ b/doc/mutt.man @@ -146,9 +146,9 @@ The help line for the index menu is not updated if you change the bindings for one of the functions listed while Mutt is running. .PP For a more up-to-date list of bugs, please visit the mutt project's -bug tracking system under http://bugs.guug.de/. If you wish to -report a bug, please use the -.B muttbug +bug tracking system under http://bugs.guug.de/. To report a bug, +please use the +.BR muttbug (1) program. .SH NO WARRANTIES This program is distributed in the hope that it will be useful, @@ -157,6 +157,7 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. .SH SEE ALSO .PP +.BR muttbug (1), .BR muttrc (5), .BR curses (3), .BR mutt_dotlock (1), 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 +.\" +.\" 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 +.