aboutsummaryrefslogtreecommitdiffstats
path: root/doc/gawkbug.1
blob: eb6889e7da048f920ed74b634ed2133c0d718080 (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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
GAWKBUG(1)                           General Commands Manual                           GAWKBUG(1)

NAME
       gawkbug - report a bug in gawk

SYNOPSIS
       gawkbug [--version] [--help] [email-address]

DESCRIPTION
       gawkbug is a shell script to help the user compose and mail bug reports concerning gawk in
       a standard format.  gawkbug invokes the editor specified by the environment variable  EDI-
       TOR on a temporary copy of the bug report format outline. The user must fill in the appro-
       priate fields and exit the editor.  gawkbug  then  mails  the  completed  report  to  bug-
       gawk@gnu.org,  or  email-address.  If the report cannot be mailed, it is saved in the file
       dead.gawkbug 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 gawk version, and the compilation en-
       vironment.  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.

ENVIRONMENT
       gawkbug will utilize the following environment variables if they exist:

       EDITOR Specifies the preferred editor. If EDITOR is not set, gawkbug attempts to locate  a
              number  of alternative editors, including vim, and if must, emacs.  If gawkbug can-
              not locate any of the alternative editors, it attempts to execute vi.

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

       TMPDIR Directory in which to create temporary files and directories.

SEE ALSO
       gawk(1)

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

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

       Arnold Robbins
       bug-gawk@gnu.org

GNU Awk 5.2                                2022 Feb 26                                 GAWKBUG(1)