source: vendor/bash/3.1/doc/bashbug.1

Last change on this file was 3228, checked in by bird, 18 years ago

bash 3.1

File size: 1.3 KB
Line 
1.TH BASHBUG 1 "1998 July 30" GNU
2.SH NAME
3bashbug \- report a bug in bash
4.SH SYNOPSIS
5\fBbashbug\fP [\fIaddress\fP]
6.SH DESCRIPTION
7.B bashbug
8is a shell script to help the user compose and mail bug reports
9concerning bash in a standard format.
10.B bashbug
11invokes the editor specified by the environment variable
12.SM
13.B EDITOR
14on a temporary copy of the bug report format outline. The user must
15fill in the appropriate fields and exit the editor.
16.B bashbug
17then mails the completed report to \fIbug-bash@gnu.org\fP, or
18\fIaddress\fP. If the report cannot be mailed, it is saved in the
19file \fIdead.bashbug\fP in the invoking user's home directory.
20.PP
21The bug report format outline consists of several sections. The first
22section provides information about the machine, operating system, the
23bash version, and the compilation environment. The second section
24should be filled in with a description of the bug. The third section
25should be a description of how to reproduce the bug. The optional
26fourth section is for a proposed fix. Fixes are encouraged.
27.SH ENVIRONMENT
28.B bashbug
29will utilize the following environment variables if they exist:
30.TP
31.B EDITOR
32Specifies the preferred editor. If
33.SM
34.B EDITOR
35is not set,
36.B bashbug
37defaults to
38.BR emacs .
39.TP
40.B HOME
41Directory in which the failed bug report is saved if the mail fails.
Note: See TracBrowser for help on using the repository browser.