Imported from ../bash-4.0.tar.gz.

[thirdparty/bash.git] / doc / bashbug.0

diff --git a/doc/bashbug.0 b/doc/bashbug.0
new file mode 100644 (file)
index 0000000..41fc1ed
--- /dev/null
+++ b/doc/bashbug.0
@@ -0,0 +1,50 @@
+BASHBUG(1)                                                          BASHBUG(1)
+
+
+
+N\bNA\bAM\bME\bE
+       bashbug - report a bug in bash
+
+S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
+       b\bba\bas\bsh\bhb\bbu\bug\bg [_\b-_\b-_\bv_\be_\br_\bs_\bi_\bo_\bn] [_\b-_\b-_\bh_\be_\bl_\bp] [_\be_\bm_\ba_\bi_\bl_\b-_\ba_\bd_\bd_\br_\be_\bs_\bs]
+
+D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
+       b\bba\bas\bsh\bhb\bbu\bug\bg is a shell script to help the user compose and mail bug reports
+       concerning bash in a standard format.  b\bba\bas\bsh\bhb\bbu\bug\bg invokes the editor spec-
+       ified by the environment variable E\bED\bDI\bIT\bTO\bOR\bR on a temporary copy of the bug
+       report format outline. The user must fill in the appropriate fields and
+       exit  the  editor.   b\bba\bas\bsh\bhb\bbu\bug\bg  then  mails  the completed report to _\bb_\bu_\bg_\b-
+       _\bb_\ba_\bs_\bh_\b@_\bg_\bn_\bu_\b._\bo_\br_\bg, or _\be_\bm_\ba_\bi_\bl_\b-_\ba_\bd_\bd_\br_\be_\bs_\bs.  If the report cannot be mailed, it  is
+       saved in the file _\bd_\be_\ba_\bd_\b._\bb_\ba_\bs_\bh_\bb_\bu_\bg in the invoking user's home directory.
+
+       The  bug report format outline consists of several sections.  The first
+       section provides information about the machine, operating  system,  the
+       bash  version,  and  the  compilation  environment.  The second section
+       should be filled in with a description of the bug.  The  third  section
+       should  be  a  description  of  how to reproduce the bug.  The optional
+       fourth section is for a proposed fix.  Fixes are encouraged.
+
+E\bEN\bNV\bVI\bIR\bRO\bON\bNM\bME\bEN\bNT\bT
+       b\bba\bas\bsh\bhb\bbu\bug\bg will utilize the following environment variables if they exist:
+
+       E\bED\bDI\bIT\bTO\bOR\bR Specifies  the  preferred  editor. If E\bED\bDI\bIT\bTO\bOR\bR is not set, b\bba\bas\bsh\bhb\bbu\bug\bg
+              defaults to e\bem\bma\bac\bcs\bs.
+
+       H\bHO\bOM\bME\bE   Directory in which the failed bug report is saved  if  the  mail
+              fails.
+
+       T\bTM\bMP\bPD\bDI\bIR\bR Directory in which to create temporary files and directories.
+
+S\bSE\bEE\bE A\bAL\bLS\bSO\bO
+       _\bb_\ba_\bs_\bh(1)
+
+A\bAU\bUT\bTH\bHO\bOR\bRS\bS
+       Brian Fox, Free Software Foundation
+       bfox@gnu.org
+
+       Chet Ramey, Case Western Reserve University
+       chet@po.cwru.edu
+
+
+
+GNU Bash-4.0                     1998 July 30                       BASHBUG(1)