doc/bashbug.1

   1 .\"
   2 .\" MAN PAGE COMMENTS to
   3 .\"
   4 .\"     Chet Ramey
   5 .\"     Case Western Reserve University
   6 .\"     chet@po.cwru.edu
   7 .\"
   8 .\"     Last Change: Tue Apr  3 15:46:30 EDT 2007
   9 .\"
  10 .TH BASHBUG 1 "1998 July 30" "GNU Bash-4.0"
  11 .SH NAME
  12 bashbug \- report a bug in bash
  13 .SH SYNOPSIS
  14 \fBbashbug\fP [\fI--version\fP] [\fI--help\fP] [\fIemail-address\fP]
  15 .SH DESCRIPTION
  16 .B bashbug
  17 is a shell script to help the user compose and mail bug reports
  18 concerning bash in a standard format.
  19 .B bashbug
  20 invokes the editor specified by the environment variable
  21 .SM
  22 .B EDITOR
  23 on a temporary copy of the bug report format outline. The user must
  24 fill in the appropriate fields and exit the editor.
  25 .B bashbug
  26 then mails the completed report to \fIbug-bash@gnu.org\fP, or
  27 \fIemail-address\fP.  If the report cannot be mailed, it is saved in the
  28 file \fIdead.bashbug\fP in the invoking user's home directory.
  29 .PP
  30 The bug report format outline consists of several sections.  The first
  31 section provides information about the machine, operating system, the
  32 bash version, and the compilation environment.  The second section
  33 should be filled in with a description of the bug.  The third section
  34 should be a description of how to reproduce the bug.  The optional
  35 fourth section is for a proposed fix.  Fixes are encouraged.
  36 .SH ENVIRONMENT
  37 .B bashbug
  38 will utilize the following environment variables if they exist:
  39 .TP
  40 .B EDITOR
  41 Specifies the preferred editor. If
  42 .SM
  43 .B EDITOR
  44 is not set,
  45 .B bashbug
  46 defaults to
  47 .BR emacs .
  48 .TP
  49 .B HOME
  50 Directory in which the failed bug report is saved if the mail fails.
  51 .TP
  52 .B TMPDIR
  53 Directory in which to create temporary files and directories.
  54 .SH "SEE ALSO"
  55 .TP
  56 \fIbash\fP(1)
  57 .SH AUTHORS
  58 Brian Fox, Free Software Foundation
  59 .br
  60 bfox@gnu.org
  61 .PP
  62 Chet Ramey, Case Western Reserve University
  63 .br
  64 chet@po.cwru.edu