jcs.org
mutt stable branch with some hacks
1.\" -*-nroff-*-
2.\"
3.\"
4.\" Copyright (C) 1996-2000 Thomas Roessler <roessler@does-not-exist.org>
5.\"
6.\" This program is free software; you can redistribute it and/or modify
7.\" it under the terms of the GNU General Public License as published by
8.\" the Free Software Foundation; either version 2 of the License, or
9.\" (at your option) any later version.
10.\"
11.\" This program is distributed in the hope that it will be useful,
12.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
13.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14.\" GNU General Public License for more details.
15.\"
16.\" You should have received a copy of the GNU General Public License
17.\" along with this program; if not, write to the Free Software
18.\" Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19.\"
20.TH flea 1 "July 2000" Unix "User Manuals"
21.SH NAME
22flea \- Report a bug (or rather a flea) in mutt.
23.SH SYNOPSIS
24.PP
25.B flea
26.SH DESCRIPTION
27.PP
28.B flea
29is a shell script which helps you to submit a bug report against the
30.BR mutt (1)
31mail user agent.
32.PP
33If you invoke
34.BR flea ,
35you'll first be prompted for a short
36description of the problem you experience. This will be used as the
37bug report's subject line, so it should be concise, but informative.
38.PP
39You are then asked to assign an initial severity level to the
40problem you observe;
41.B flea
42will give you a description which severity level is appropriate or
43not.
44.PP
45Then, you are asked for the location of a core dump (normally named
46.BR core )
47which may have been left over by a crash of your
48.BR mutt (1).
49You can just type \(lqno\(rq here, or you can enter the path leading
50to a core dump.
51.B flea
52will try to use either
53.BR sdb (1),
54.BR dbx (1),
55or
56.BR gdb (1)
57to extract some information from this core dump which may be helpful
58to developers in order to determine the reason for the crash.
59.PP
60Finally, you are asked whether or not you want to include personal
61and system
62.BR mutt (1)
63configuration files with the bug report. If at all possible, we
64urge you to answer these questions with \(lqyes\(rq, since a
65reference configuration makes it incredibly easier to track down a
66problem.
67.PP
68If you are using Debian GNU/Linux,
69.B flea
70will now check whether or not
71.B mutt
72has been installed as a Debian
73package on your system, and suggest to file the bug against the
74.BR mutt (1)
75and Debian bug tracking systems. This option was added since the
76.BR mutt (1)
77project uses another instantiation of the Debian bug tracking
78system, so submitting bugs against both systems in one pass is
79simple.
80.PP
81You are then dropped into your favorite editor as determined by the
82.B EDITOR
83and
84.B VISUAL
85environment variables.
86.PP
87Please give us details about the problem in the empty space below
88the line reading \(lqPlease type your report below this line\(rq.
89We are most interested in precise information on what symptoms you
90observe and what steps may be used to reproduce the bug. Chances
91are that problems which can easily be reproduced will be fixed
92quickly. So please take some time when filling out this part of the
93template.
94.PP
95The remainder of the template contains various kinds of information
96gathered from your system, including output of the
97.BR uname (1)
98command, output from
99.BR mutt (1)
100itself, and your system's
101.BR mutt (1)
102configuration files. You may wish to browse through this part of
103the bug report form in order to avoid leaking confidential
104information to the public.
105.PP
106If you leave the editor,
107.B flea
108will give you the option to review, re-edit, submit, or abandon your
109bug report. If you decide to submit it, a mail message containing
110your report will be sent to <fleas@mutt.org>. You'll receive a
111copy of this message.
112.PP
113While your bug report is being processed by the bug tracking system,
114you will receive various e-mail messages from the bug tracking
115system informing you about what's going on: Once your bug report has
116been entered into the bug tracking system, it will be assigned a
117unique serial number about which you are informed via e-mail. If
118you wish to submit additional information about the bug, you can
119just send it to the address
120.BR fleas@mutt.org
121with #\fIserial\fP in the subject.
122.PP
123Later, you will most likely receive questions from the developers
124about the problem you observed, and you will eventually be informed
125that your bug report has been closed. This means that the bug has
126been fixed at least in the
127.BR hg (1)
128repository. If the answers you receive don't satisfy you, don't
129hesitate to contact the developers directly under
130.BR mutt-dev@mutt.org.
131.PP
132You can also browse your bug report and all additional information
133and replies connected to it using the bug tracking system's Web
134interface under the following URL:
135http://bugs.mutt.org/
136.SH
137ENVIRONMENT
138.PP
139.B flea
140will use the following environment variables:
141.IP "EMAIL"
142Your electronic mail address. Will be used to set the bug report's
143From header, and to send you a copy of the report.
144.IP "LOGNAME"
145Your login name. If the
146.B EMAIL
147environment variable isn't set, this will be used instead to send
148you a copy of the report. Setting the sender will be left to
149.BR sendmail (1)
150on your system.
151.IP "REPLYTO"
152If set, the bug report will contain a Reply-To header with the
153e-mail address contained in this environment variable.
154.IP "ORGANIZATION"
155If set, the bug report will contain an Organization header with the
156contents of this environment variable.
157.IP "PAGER"
158If set, this environment variable will be expected to contain the
159path to your favorite pager for viewing the bug report. If unset,
160.BR more (1)
161will be used.
162.IP "VISUAL"
163If set, this environment variable will be expected to contain the
164path to your favorite visual editor.
165.IP "EDITOR"
166If set, this environment variable will be expected to contain the
167path to your favorite editor. This variable is examined if and only
168if the
169.B VISUAL
170environment variable is unset. If
171.B EDITOR
172is unset,
173.BR vi (1)
174will be used to edit the bug report.
175.SH
176FILES
177.PP
178.IP "core"
179If present, this file may contain a post-mortem memory dump of mutt.
180It will be inspected using the debugger installed on your system.
181.SH
182SEE ALSO
183.PP
184.BR dbx (1),
185.BR gdb (1),
186.BR lynx (1),
187.BR mutt (1),
188.BR muttrc (5),
189.BR sdb (1),
190.BR sendmail (1),
191.BR uname (1),
192.BR vi (1)
193.PP
194The mutt bug tracking system: http://bugs.mutt.org/
195.SH
196AUTHOR
197.PP
198.B flea
199and this manual page were written by Thomas Roessler
200<roessler@does-not-exist.org>.