Add doc on gawkbug program.

9 files changed, 95 insertions, 86 deletions

diff --git a/ChangeLog b/ChangeLog
index e36b9189..09700d81 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,9 @@
 2022-02-27         Arnold D. Robbins     <arnold@skeeve.com>
 
+	* main.c (usage): Update the message for the gawkbug program.
+
+2022-02-27         Arnold D. Robbins     <arnold@skeeve.com>
+
 	Add `gawkbug' reporting program.
 
 	* gawkbug.in: New file.
diff --git a/doc/ChangeLog b/doc/ChangeLog
index 26452dfa..8a7a9c40 100644
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,5 +1,10 @@
 2022-02-27         Arnold D. Robbins     <arnold@skeeve.com>
 
+	* gawktexi.in (Bugs): Updated to describe the gawkbug program.
+	* awkcard.in: Ditto.
+
+2022-02-27         Arnold D. Robbins     <arnold@skeeve.com>
+
 	* gawkbug.1, wordlist5: New files.
 	* Makefile.am: Adjust everything for additional man page.
 
diff --git a/doc/awkcard.in b/doc/awkcard.in
index 76ae9f27..9c1095de 100644
--- a/doc/awkcard.in
+++ b/doc/awkcard.in
@@ -204,8 +204,8 @@ T}
 .\" --- Bug Reports
 .ES
 .fi
-\*(CDIf you find a bug in this reference card, please report it via electronic
-mail to \*(FCbug-gawk@gnu.org\*(FR.\*(CX
+\*(CDIf you find a bug in this reference card, please use
+\*(FCgawkbug\*(FR to report it.\*(CX
 .EB "\s+2\f(HBBUG REPORTS\*(FR\s0"
 
 .BT
diff --git a/doc/gawk.info b/doc/gawk.info
index 037df3d0..67b10ce3 100644
--- a/doc/gawk.info
+++ b/doc/gawk.info
@@ -31885,39 +31885,34 @@ make both your life and the lives of the maintainers much easier.
 
   5. Before reporting a bug or trying to fix it yourself, try to isolate
      it to the smallest possible 'awk' program and input data file that
-     reproduce the problem.  Then send us:
+     reproduce the problem.
 
-        * The program and data file.
-
-        * Some idea of what kind of Unix system you're using.
+  6. Use the 'gawkbug' program to submit the bug report.  This program
+     sets up a bug report template and opens it in your editor.  You
+     then need to edit it appropriately to include:
 
-        * The compiler you used to compile 'gawk'.
+        * The program and data file.
 
         * The exact results 'gawk' gave you.  Also say what you expected
           to occur; this helps us decide whether the problem is really
           in the documentation.
 
-        * The version number of 'gawk' you are using.  You can get this
-          information with the command 'gawk --version'.
+        * A fix if you have one.
 
-  6. Do _not_ send screenshots.  Instead, use copy/paste to send text,
+  7. Do _not_ send screenshots.  Instead, use copy/paste to send text,
      or send files.
 
-  7. Do send files as attachments, instead of inline.  This avoids
-     corruption by mailer programs out in the wilds of the Internet.
-
   8. Please be sure to send all mail in _plain text_, not (or not
      exclusively) in HTML.
 
   9. _All email must be in English.  This is the only language
      understood in common by all the maintainers._
 
-   Once you have a precise problem description, send email to
-<bug-gawk@gnu.org>.
+   The 'gawkbug' program sends email to <bug-gawk@gnu.org>.
 
    The 'gawk' maintainers subscribe to this address, and thus they will
-receive your bug report.  Although you can send mail to the maintainers
-directly, the bug reporting address is preferred because the email list
+receive your bug report.  Do _not_ send mail to the maintainers
+directly; the bug reporting address is preferred because the email list
 is archived at the GNU Project.
 
      NOTE: Many distributions of GNU/Linux and the various BSD-based
@@ -36027,8 +36022,8 @@ Index
 * buffers, flushing:                     I/O Functions.       (line  32)
 * buffers, flushing <1>:                 I/O Functions.       (line 168)
 * bug reports, email address, <bug-gawk@gnu.org>: Bug address.
-                                                              (line  56)
-* <bug-gawk@gnu.org> bug reporting address: Bug address.      (line  56)
+                                                              (line  52)
+* <bug-gawk@gnu.org> bug reporting address: Bug address.      (line  52)
 * built-in functions:                    Functions.           (line   6)
 * built-in functions, evaluation order:  Calling Built-in.    (line  30)
 * BusyBox Awk:                           Other Versions.      (line  92)
@@ -36628,7 +36623,7 @@ Index
                                                               (line  48)
 * elements in arrays, deleting:          Delete.              (line   6)
 * email address for bug reports, <bug-gawk@gnu.org>: Bug address.
-                                                              (line  56)
+                                                              (line  52)
 * empty array elements:                  Reference to Elements.
                                                               (line  18)
 * empty pattern:                         Empty.               (line   6)
@@ -37125,6 +37120,7 @@ Index
 * gawk, implementation issues, debugging: Compatibility Mode. (line   6)
 * gawk, features, adding:                Adding Code.         (line   6)
 * gawk, coding style in:                 Adding Code.         (line  37)
+* gawkbug utility:                       Bug address.         (line  31)
 * gawkextlib project:                    gawkextlib.          (line   6)
 * gawklibpath_append shell function:     Shell Startup Files. (line  29)
 * gawklibpath_default shell function:    Shell Startup Files. (line  22)
@@ -39351,42 +39347,42 @@ Node: VMS GNV1278546
 Node: Bugs1279260
 Node: Bug definition1280172
 Node: Bug address1283108
-Node: Usenet1286496
-Node: Performance bugs1287685
-Node: Asking for help1290606
-Node: Maintainers1292573
-Node: Other Versions1293767
-Node: Installation summary1301931
-Node: Notes1303295
-Node: Compatibility Mode1304089
-Node: Additions1304871
-Node: Accessing The Source1305796
-Node: Adding Code1307233
-Node: New Ports1313425
-Node: Derived Files1317800
-Ref: Derived Files-Footnote-11323460
-Ref: Derived Files-Footnote-21323495
-Ref: Derived Files-Footnote-31324093
-Node: Future Extensions1324207
-Node: Implementation Limitations1324865
-Node: Extension Design1326075
-Node: Old Extension Problems1327219
-Ref: Old Extension Problems-Footnote-11328737
-Node: Extension New Mechanism Goals1328794
-Ref: Extension New Mechanism Goals-Footnote-11332158
-Node: Extension Other Design Decisions1332347
-Node: Extension Future Growth1334460
-Node: Notes summary1335066
-Node: Basic Concepts1336224
-Node: Basic High Level1336905
-Ref: figure-general-flow1337187
-Ref: figure-process-flow1337873
-Ref: Basic High Level-Footnote-11341175
-Node: Basic Data Typing1341360
-Node: Glossary1344688
-Node: Copying1376575
-Node: GNU Free Documentation License1414118
-Node: Index1439238
+Node: Usenet1286296
+Node: Performance bugs1287485
+Node: Asking for help1290406
+Node: Maintainers1292373
+Node: Other Versions1293567
+Node: Installation summary1301731
+Node: Notes1303095
+Node: Compatibility Mode1303889
+Node: Additions1304671
+Node: Accessing The Source1305596
+Node: Adding Code1307033
+Node: New Ports1313225
+Node: Derived Files1317600
+Ref: Derived Files-Footnote-11323260
+Ref: Derived Files-Footnote-21323295
+Ref: Derived Files-Footnote-31323893
+Node: Future Extensions1324007
+Node: Implementation Limitations1324665
+Node: Extension Design1325875
+Node: Old Extension Problems1327019
+Ref: Old Extension Problems-Footnote-11328537
+Node: Extension New Mechanism Goals1328594
+Ref: Extension New Mechanism Goals-Footnote-11331958
+Node: Extension Other Design Decisions1332147
+Node: Extension Future Growth1334260
+Node: Notes summary1334866
+Node: Basic Concepts1336024
+Node: Basic High Level1336705
+Ref: figure-general-flow1336987
+Ref: figure-process-flow1337673
+Ref: Basic High Level-Footnote-11340975
+Node: Basic Data Typing1341160
+Node: Glossary1344488
+Node: Copying1376375
+Node: GNU Free Documentation License1413918
+Node: Index1439038
 
 End Tag Table
 
diff --git a/doc/gawk.texi b/doc/gawk.texi
index b7e8d888..d0d21f4f 100644
--- a/doc/gawk.texi
+++ b/doc/gawk.texi
@@ -43470,17 +43470,17 @@ to do something or not, report that too; it's a bug in the documentation!
 @item
 Before reporting a bug or trying to fix it yourself, try to isolate it
 to the smallest possible @command{awk} program and input @value{DF} that
-reproduce the problem.  Then send us:
-
-@itemize @bullet
-@item
-The program and @value{DF}.
+reproduce the problem.
 
 @item
-Some idea of what kind of Unix system you're using.
+@cindex @command{gawkbug} utility
+Use the @command{gawkbug} program to submit the bug report. This
+program sets up a bug report template and opens it in your editor.
+You then need to edit it appropriately to include:
 
+@itemize @bullet
 @item
-The compiler you used to compile @command{gawk}.
+The program and @value{DF}.
 
 @item
 The exact results
@@ -43488,17 +43488,16 @@ The exact results
 us decide whether the problem is really in the documentation.
 
 @item
-The version number of @command{gawk} you are using.
-You can get this information with the command @samp{gawk --version}.
+A fix if you have one.
 @end itemize
 
 @item
 Do @emph{not} send screenshots. Instead, use copy/paste to send text, or
 send files.
 
-@item
-Do send files as attachments, instead of inline. This avoids corruption
-by mailer programs out in the wilds of the Internet.
+@c @item
+@c Do send files as attachments, instead of inline. This avoids corruption
+@c by mailer programs out in the wilds of the Internet.
 
 @item
 Please be sure to send all mail in @emph{plain text},
@@ -43512,12 +43511,12 @@ understood in common by all the maintainers.}
 @cindex @email{bug-gawk@@gnu.org} bug reporting address
 @cindex email address for bug reports, @email{bug-gawk@@gnu.org}
 @cindex bug reports, email address, @email{bug-gawk@@gnu.org}
-Once you have a precise problem description, send email to
+The @command{gawkbug} program sends email to
 @EMAIL{bug-gawk@@gnu.org,bug dash gawk at gnu dot org}.
 
 The @command{gawk} maintainers subscribe to this address, and
 thus they will receive your bug report.
-Although you can send mail to the maintainers directly,
+Do @emph{not} send mail to the maintainers directly;
 the bug reporting address is preferred because the
 email list is archived at the GNU Project.
 
diff --git a/doc/gawktexi.in b/doc/gawktexi.in
index dde1aed2..63f31366 100644
--- a/doc/gawktexi.in
+++ b/doc/gawktexi.in
@@ -42313,17 +42313,17 @@ to do something or not, report that too; it's a bug in the documentation!
 @item
 Before reporting a bug or trying to fix it yourself, try to isolate it
 to the smallest possible @command{awk} program and input @value{DF} that
-reproduce the problem.  Then send us:
-
-@itemize @bullet
-@item
-The program and @value{DF}.
+reproduce the problem.
 
 @item
-Some idea of what kind of Unix system you're using.
+@cindex @command{gawkbug} utility
+Use the @command{gawkbug} program to submit the bug report. This
+program sets up a bug report template and opens it in your editor.
+You then need to edit it appropriately to include:
 
+@itemize @bullet
 @item
-The compiler you used to compile @command{gawk}.
+The program and @value{DF}.
 
 @item
 The exact results
@@ -42331,17 +42331,16 @@ The exact results
 us decide whether the problem is really in the documentation.
 
 @item
-The version number of @command{gawk} you are using.
-You can get this information with the command @samp{gawk --version}.
+A fix if you have one.
 @end itemize
 
 @item
 Do @emph{not} send screenshots. Instead, use copy/paste to send text, or
 send files.
 
-@item
-Do send files as attachments, instead of inline. This avoids corruption
-by mailer programs out in the wilds of the Internet.
+@c @item
+@c Do send files as attachments, instead of inline. This avoids corruption
+@c by mailer programs out in the wilds of the Internet.
 
 @item
 Please be sure to send all mail in @emph{plain text},
@@ -42355,12 +42354,12 @@ understood in common by all the maintainers.}
 @cindex @email{bug-gawk@@gnu.org} bug reporting address
 @cindex email address for bug reports, @email{bug-gawk@@gnu.org}
 @cindex bug reports, email address, @email{bug-gawk@@gnu.org}
-Once you have a precise problem description, send email to
+The @command{gawkbug} program sends email to
 @EMAIL{bug-gawk@@gnu.org,bug dash gawk at gnu dot org}.
 
 The @command{gawk} maintainers subscribe to this address, and
 thus they will receive your bug report.
-Although you can send mail to the maintainers directly,
+Do @emph{not} send mail to the maintainers directly;
 the bug reporting address is preferred because the
 email list is archived at the GNU Project.
 
diff --git a/main.c b/main.c
index 2469baa6..e044123b 100644
--- a/main.c
+++ b/main.c
@@ -641,7 +641,8 @@ usage(int exitval, FILE *fp)
 	/* This is one string to make things easier on translators. */
 	/* TRANSLATORS: --help output (end)
 	   no-wrap */
-	fputs(_("\nTo report bugs, see node `Bugs' in `gawk.info'\n\
+	fputs(_("\nTo report bugs, use the `gawkbug' program.\n\
+For full instructions, see the node `Bugs' in `gawk.info'\n\
 which is section `Reporting Problems and Bugs' in the\n\
 printed version.  This same information may be found at\n\
 https://www.gnu.org/software/gawk/manual/html_node/Bugs.html.\n\
diff --git a/test/ChangeLog b/test/ChangeLog
index 9b8567d1..44a0e951 100644
--- a/test/ChangeLog
+++ b/test/ChangeLog
@@ -1,3 +1,7 @@
+2022-02-27         Arnold D. Robbins     <arnold@skeeve.com>
+
+	* badargs.ok: Updated after code change.
+
 2022-02-10         Andrew J. Schorr      <aschorr@telemetry-investments.com>
 
 	* Makefile.am (EXTRA_DIST): close_status, new test.
diff --git a/test/badargs.ok b/test/badargs.ok
index 5ec0558c..ea022461 100644
--- a/test/badargs.ok
+++ b/test/badargs.ok
@@ -32,7 +32,8 @@ Short options:		GNU long options: (extensions)
 	-t			--lint-old
 	-V			--version
 
-To report bugs, see node `Bugs' in `gawk.info'
+To report bugs, use the `gawkbug' program.
+For full instructions, see the node `Bugs' in `gawk.info'
 which is section `Reporting Problems and Bugs' in the
 printed version.  This same information may be found at
 https://www.gnu.org/software/gawk/manual/html_node/Bugs.html.