doc/bashbug.1

   1 .TH BASHBUG 1 "1998 July 30" GNU
   2 .SH NAME
   3 bashbug \- report a bug in bash
   4 .SH SYNOPSIS
   5 \fBbashbug\fP [\fIaddress\fP]
   6 .SH DESCRIPTION
   7 .B bashbug
   8 is a shell script to help the user compose and mail bug reports
   9 concerning bash in a standard format.
  10 .B bashbug
  11 invokes the editor specified by the environment variable
  12 .SM
  13 .B EDITOR
  14 on a temporary copy of the bug report format outline. The user must
  15 fill in the appropriate fields and exit the editor.
  16 .B bashbug
  17 then mails the completed report to \fIbug-bash@gnu.org\fP, or
  18 \fIaddress\fP.  If the report cannot be mailed, it is saved in the
  19 file \fIdead.bashbug\fP in the invoking user's home directory.
  20 .PP
  21 The bug report format outline consists of several sections.  The first
  22 section provides information about the machine, operating system, the
  23 bash version, and the compilation environment.  The second section
  24 should be filled in with a description of the bug.  The third section
  25 should be a description of how to reproduce the bug.  The optional
  26 fourth section is for a proposed fix.  Fixes are encouraged.
  27 .SH ENVIRONMENT
  28 .B bashbug
  29 will utilize the following environment variables if they exist:
  30 .TP
  31 .B EDITOR
  32 Specifies the preferred editor. If
  33 .SM
  34 .B EDITOR
  35 is not set,
  36 .B bashbug
  37 defaults to
  38 .BR emacs .
  39 .TP
  40 .B HOME
  41 Directory in which the failed bug report is saved if the mail fails.