Debian Codegraph @

upstream/debian-trixie/man1/gawkbug.1

raw
1 .\"
2 .\" MAN PAGE COMMENTS to
3 .\"
4 .\" Arnold Robbins
5 .\" [email protected]
6 .\"
7 .\" Last Change: Mon Apr 18 16:21:25 IDT 2022
8 .\"
9 .TH GAWKBUG 1 "2022 Apr 18" "GNU Awk 5.2"
10 .SH NAME
11 gawkbug \- report a bug in gawk
12 .SH SYNOPSIS
13 \fBgawkbug\fP [\fI--version\fP] [\fI--help\fP] [\fIemail-address\fP]
14 .SH DESCRIPTION
15 .B gawkbug
16 is a shell script to help the user compose and mail bug reports
17 concerning
18 .B gawk
19 in a standard format.
20 .B gawkbug
21 invokes the editor specified by the environment variable
22 .SM
23 .B EDITOR
24 on a temporary copy of the bug report format outline. The user must
25 fill in the appropriate fields and exit the editor.
26 .B gawkbug
27 then mails the completed report to \[email protected]\fP, or
28 \fIemail-address\fP. If the report cannot be mailed, it is saved in the
29 file \fIdead.gawkbug\fP in the invoking user's home directory.
30 .PP
31 The bug report format outline consists of several sections. The first
32 section provides information about the machine, operating system, the
33 .B gawk
34 version, and the compilation environment. The second section
35 should be filled in with a description of the bug. The third section
36 should be a description of how to reproduce the bug. The optional
37 fourth section is for a proposed fix. Fixes are encouraged.
38 .SH ENVIRONMENT
39 .B gawkbug
40 will utilize the following environment variables if they exist:
41 .TP
42 .B EDITOR
43 Specifies the preferred editor. If
44 .SM
45 .B EDITOR
46 is not set,
47 .B gawkbug
48 attempts to locate a number of alternative editors, including
49 .BR vim ,
50 and if it must,
51 .BR emacs .
52 If
53 .B gawkbug
54 cannot locate any of the alternative editors, it attempts to execute \fBvi\fP.
55 .TP
56 .B HOME
57 Directory in which the failed bug report is saved if the mail fails.
58 .TP
59 .B TMPDIR
60 Directory in which to create temporary files and directories.
61 .SH "SEE ALSO"
62 .TP
63 \fIgawk\fP(1)
64 .SH AUTHORS
65 Brian Fox, Free Software Foundation
66 .br
67 [email protected]
68 .PP
69 Chet Ramey, Case Western Reserve University
70 .br
71 [email protected]
72 .PP
73 Arnold Robbins
74 .br
75 [email protected]