Debian Codegraph @

upstream/debian-unstable/man1/gawkbug.1

raw
1 .\"
2 .\" MAN PAGE COMMENTS to
3 .\"
4 .\" Arnold Robbins
5 .\" [email protected]
6 .\"
7 .TH GAWKBUG 1 "2023 October 18" "GNU Awk 5.3"
8 .SH NAME
9 gawkbug \- report a bug in gawk
10 .SH SYNOPSIS
11 \fBgawkbug\fP [\fI\-\^\-version\fP] [\fI\-\^\-help\fP] [\fIemail-address\fP]
12 .SH DESCRIPTION
13 .B gawkbug
14 is a shell script to help the user compose and mail bug reports
15 concerning
16 .B gawk
17 in a standard format.
18 .B gawkbug
19 invokes the editor specified by the environment variable
20 .SM
21 .B EDITOR
22 on a temporary copy of the bug report format outline. The user must
23 fill in the appropriate fields and exit the editor.
24 .B gawkbug
25 then mails the completed report to \[email protected]\fP, or
26 \fIemail-address\fP. If the report cannot be mailed, it is saved in the
27 file \fIdead.gawkbug\fP in the invoking user's home directory.
28 .PP
29 The bug report format outline consists of several sections. The first
30 section provides information about the machine, operating system, the
31 .B gawk
32 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 gawkbug
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 gawkbug
46 attempts to locate a number of alternative editors, including
47 .BR vim ,
48 and if it must,
49 .BR emacs .
50 If
51 .B gawkbug
52 cannot locate any of the alternative editors, it attempts to execute \fBvi\fP.
53 .TP
54 .B HOME
55 Directory in which the failed bug report is saved if the mail fails.
56 .TP
57 .B TMPDIR
58 Directory in which to create temporary files and directories.
59 .SH "SEE ALSO"
60 .TP
61 \fIgawk\fP(1)
62 .SH AUTHORS
63 Brian Fox, Free Software Foundation
64 .br
65 [email protected]
66 .PP
67 Chet Ramey, Case Western Reserve University
68 .br
69 [email protected]
70 .PP
71 Arnold Robbins
72 .br
73 [email protected]