]> git.ipfire.org Git - thirdparty/bash.git/blame - doc/bashbug.0
bash-5.2 distribution sources and documentation
[thirdparty/bash.git] / doc / bashbug.0
CommitLineData
a0c0a00f 1BASHBUG(1) General Commands Manual BASHBUG(1)
17345e5a
JA
2
3
4
5N\bNA\bAM\bME\bE
6 bashbug - report a bug in bash
7
8S\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
11D\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
27E\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
a0c0a00f
CR
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 attempts to locate a number of alternative editors, including
8868edaf
CR
32 e\bem\bma\bac\bcs\bs. If b\bba\bas\bsh\bhb\bbu\bug\bg cannot locate any of the alternative editors,
33 it attempts to execute v\bvi\bi.
17345e5a 34
8868edaf 35 H\bHO\bOM\bME\bE Directory in which the failed bug report is saved if the mail
17345e5a
JA
36 fails.
37
38 T\bTM\bMP\bPD\bDI\bIR\bR Directory in which to create temporary files and directories.
39
40S\bSE\bEE\bE A\bAL\bLS\bSO\bO
41 _\bb_\ba_\bs_\bh(1)
42
43A\bAU\bUT\bTH\bHO\bOR\bRS\bS
44 Brian Fox, Free Software Foundation
45 bfox@gnu.org
46
47 Chet Ramey, Case Western Reserve University
48 chet@po.cwru.edu
49
50
51
74091dd4 52GNU Bash 5.2 2020 August 1 BASHBUG(1)