| Jari Aalto | 3185942 | 2009-01-12 13:36:28 +0000 | [diff] [blame] | 1 | .\" |
| 2 | .\" MAN PAGE COMMENTS to |
| 3 | .\" |
| 4 | .\" Chet Ramey |
| 5 | .\" Case Western Reserve University |
| 6 | .\" chet@po.cwru.edu |
| 7 | .\" |
| Chet Ramey | 8868eda | 2020-12-06 15:51:17 -0500 | [diff] [blame] | 8 | .\" Last Change: Sun Aug 2 15:39:07 EDT 2020 |
| Jari Aalto | 3185942 | 2009-01-12 13:36:28 +0000 | [diff] [blame] | 9 | .\" |
| Chet Ramey | 8868eda | 2020-12-06 15:51:17 -0500 | [diff] [blame] | 10 | .TH BASHBUG 1 "2020 August 1" "GNU Bash 5.1" |
| Jari Aalto | ccc6cda | 1996-12-23 17:02:34 +0000 | [diff] [blame] | 11 | .SH NAME |
| 12 | bashbug \- report a bug in bash |
| 13 | .SH SYNOPSIS |
| Jari Aalto | 3185942 | 2009-01-12 13:36:28 +0000 | [diff] [blame] | 14 | \fBbashbug\fP [\fI--version\fP] [\fI--help\fP] [\fIemail-address\fP] |
| Jari Aalto | ccc6cda | 1996-12-23 17:02:34 +0000 | [diff] [blame] | 15 | .SH DESCRIPTION |
| 16 | .B bashbug |
| 17 | is a shell script to help the user compose and mail bug reports |
| 18 | concerning bash in a standard format. |
| 19 | .B bashbug |
| 20 | invokes the editor specified by the environment variable |
| 21 | .SM |
| 22 | .B EDITOR |
| 23 | on a temporary copy of the bug report format outline. The user must |
| 24 | fill in the appropriate fields and exit the editor. |
| 25 | .B bashbug |
| Jari Aalto | b72432f | 1999-02-19 17:11:39 +0000 | [diff] [blame] | 26 | then mails the completed report to \fIbug-bash@gnu.org\fP, or |
| Jari Aalto | 3185942 | 2009-01-12 13:36:28 +0000 | [diff] [blame] | 27 | \fIemail-address\fP. If the report cannot be mailed, it is saved in the |
| Jari Aalto | ccc6cda | 1996-12-23 17:02:34 +0000 | [diff] [blame] | 28 | file \fIdead.bashbug\fP in the invoking user's home directory. |
| 29 | .PP |
| 30 | The bug report format outline consists of several sections. The first |
| 31 | section provides information about the machine, operating system, the |
| 32 | bash version, and the compilation environment. The second section |
| 33 | should be filled in with a description of the bug. The third section |
| 34 | should be a description of how to reproduce the bug. The optional |
| 35 | fourth section is for a proposed fix. Fixes are encouraged. |
| 36 | .SH ENVIRONMENT |
| 37 | .B bashbug |
| 38 | will utilize the following environment variables if they exist: |
| 39 | .TP |
| 40 | .B EDITOR |
| 41 | Specifies the preferred editor. If |
| 42 | .SM |
| 43 | .B EDITOR |
| 44 | is not set, |
| 45 | .B bashbug |
| Chet Ramey | a0c0a00 | 2016-09-15 16:59:08 -0400 | [diff] [blame] | 46 | attempts to locate a number of alternative editors, including |
| Chet Ramey | 8868eda | 2020-12-06 15:51:17 -0500 | [diff] [blame] | 47 | .BR emacs . |
| 48 | If |
| 49 | .B bashbug |
| 50 | cannot locate any of the alternative editors, it attempts to execute \fBvi\fP. |
| Jari Aalto | ccc6cda | 1996-12-23 17:02:34 +0000 | [diff] [blame] | 51 | .TP |
| 52 | .B HOME |
| 53 | Directory in which the failed bug report is saved if the mail fails. |
| Jari Aalto | 3185942 | 2009-01-12 13:36:28 +0000 | [diff] [blame] | 54 | .TP |
| 55 | .B TMPDIR |
| 56 | Directory in which to create temporary files and directories. |
| 57 | .SH "SEE ALSO" |
| 58 | .TP |
| 59 | \fIbash\fP(1) |
| 60 | .SH AUTHORS |
| 61 | Brian Fox, Free Software Foundation |
| 62 | .br |
| 63 | bfox@gnu.org |
| 64 | .PP |
| 65 | Chet Ramey, Case Western Reserve University |
| 66 | .br |
| 67 | chet@po.cwru.edu |