doc/bushbug.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: Sun Aug  2 15:39:07 EDT 2020
   9 .\"
  10 .TH BUSHBUG 1 "2020 August 1" "GNU Bush 5.1"
  11 .SH NAME
  12 bushbug \- report a bug in bush
  13 .SH SYNOPSIS
  14 \fBbushbug\fP [\fI--version\fP] [\fI--help\fP] [\fIemail-address\fP]
  15 .SH DESCRIPTION
  16 .B bushbug
  17 is a shell script to help the user compose and mail bug reports
  18 concerning bush in a standard format.
  19 .B bushbug
  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 bushbug
  26 then mails the completed report to \fIbug-bush@gnu.org\fP, or
  27 \fIemail-address\fP.  If the report cannot be mailed, it is saved in the
  28 file \fIdead.bushbug\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 bush 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 bushbug
  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 bushbug
  46 attempts to locate a number of alternative editors, including
  47 .BR emacs .
  48 If
  49 .B bushbug
  50 cannot locate any of the alternative editors, it attempts to execute \fBvi\fP.
  51 .TP
  52 .B HOME
  53 Directory in which the failed bug report is saved if the mail fails.
  54 .TP
  55 .B TMPDIR
  56 Directory in which to create temporary files and directories.
  57 .SH "SEE ALSO"
  58 .TP
  59 \fIbush\fP(1)
  60 .SH AUTHORS
  61 Brian Fox, Free Software Foundation
  62 .br
  63 bfox@gnu.org
  64 .PP
  65 Chet Ramey, Case Western Reserve University
  66 .br
  67 chet@po.cwru.edu