No specific user configuration
[platform/upstream/bash.git] / doc / bashbug.0
1 BASHBUG(1)                                                          BASHBUG(1)
2
3
4
5 N\bNA\bAM\bME\bE
6        bashbug - report a bug in bash
7
8 S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
9        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]
10
11 D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
12        b\bba\bas\bsh\bhb\bbu\bug\bg is a shell script to help the user compose and mail bug reports
13        concerning bash in a standard format.  b\bba\bas\bsh\bhb\bbu\bug\bg invokes the editor spec-
14        ified by the environment variable E\bED\bDI\bIT\bTO\bOR\bR on a temporary copy of the bug
15        report format outline. The user must fill in the appropriate fields and
16        exit  the  editor.   b\bba\bas\bsh\bhb\bbu\bug\bg  then  mails  the completed report to _\bb_\bu_\bg_\b-
17        _\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
18        saved in the file _\bd_\be_\ba_\bd_\b._\bb_\ba_\bs_\bh_\bb_\bu_\bg in the invoking user's home directory.
19
20        The  bug report format outline consists of several sections.  The first
21        section provides information about the machine, operating  system,  the
22        bash  version,  and  the  compilation  environment.  The second section
23        should be filled in with a description of the bug.  The  third  section
24        should  be  a  description  of  how to reproduce the bug.  The optional
25        fourth section is for a proposed fix.  Fixes are encouraged.
26
27 E\bEN\bNV\bVI\bIR\bRO\bON\bNM\bME\bEN\bNT\bT
28        b\bba\bas\bsh\bhb\bbu\bug\bg will utilize the following environment variables if they exist:
29
30        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
31               defaults to e\bem\bma\bac\bcs\bs.
32
33        H\bHO\bOM\bME\bE   Directory in which the failed bug report is saved  if  the  mail
34               fails.
35
36        T\bTM\bMP\bPD\bDI\bIR\bR Directory in which to create temporary files and directories.
37
38 S\bSE\bEE\bE A\bAL\bLS\bSO\bO
39        _\bb_\ba_\bs_\bh(1)
40
41 A\bAU\bUT\bTH\bHO\bOR\bRS\bS
42        Brian Fox, Free Software Foundation
43        bfox@gnu.org
44
45        Chet Ramey, Case Western Reserve University
46        chet@po.cwru.edu
47
48
49
50 GNU Bash-4.0                     1998 July 30                       BASHBUG(1)