doc/muttbug.man

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