summaryrefslogtreecommitdiffstats
path: root/doc/bashbug.0
blob: 58f08de22a07dd62b4a8771b115be13c8473d37c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
BASHBUG(1)                  General Commands Manual                 BASHBUG(1)



NNAAMMEE
       bashbug - report a bug in bash

SSYYNNOOPPSSIISS
       bbaasshhbbuugg [_-_-_v_e_r_s_i_o_n] [_-_-_h_e_l_p] [_e_m_a_i_l_-_a_d_d_r_e_s_s]

DDEESSCCRRIIPPTTIIOONN
       bbaasshhbbuugg is a shell script to help the user compose and mail bug reports
       concerning bash in a standard format.  bbaasshhbbuugg invokes the editor spec-
       ified by the environment variable EEDDIITTOORR on a temporary copy of the bug
       report format outline. The user must fill in the appropriate fields and
       exit  the  editor.   bbaasshhbbuugg  then  mails  the completed report to _b_u_g_-
       _b_a_s_h_@_g_n_u_._o_r_g, or _e_m_a_i_l_-_a_d_d_r_e_s_s.  If the report cannot be mailed, it  is
       saved in the file _d_e_a_d_._b_a_s_h_b_u_g 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.

EENNVVIIRROONNMMEENNTT
       bbaasshhbbuugg will utilize the following environment variables if they exist:

       EEDDIITTOORR Specifies the preferred editor. If EEDDIITTOORR is  not  set,  bbaasshhbbuugg
              attempts  to  locate  a number of alternative editors, including
              eemmaaccss.  If bbaasshhbbuugg cannot locate any of the alternative editors,
              it attempts to execute vvii.

       HHOOMMEE   Directory  in  which  the failed bug report is saved if the mail
              fails.

       TTMMPPDDIIRR Directory in which to create temporary files and directories.

SSEEEE AALLSSOO
       _b_a_s_h(1)

AAUUTTHHOORRSS
       Brian Fox, Free Software Foundation
       bfox@gnu.org

       Chet Ramey, Case Western Reserve University
       chet@po.cwru.edu



GNU Bash 5.2                     2020 August 1                      BASHBUG(1)