diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ChangeLog | 5 | ||||
| -rw-r--r-- | doc/Makefile.am | 23 | ||||
| -rw-r--r-- | doc/Makefile.in | 23 | ||||
| -rw-r--r-- | doc/gawkbug.1 | 72 | ||||
| -rw-r--r-- | doc/wordlist5 | 13 |
5 files changed, 126 insertions, 10 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog index 5d8cc9af..26452dfa 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,5 +1,10 @@ 2022-02-27 Arnold D. Robbins <arnold@skeeve.com> + * gawkbug.1, wordlist5: New files. + * Makefile.am: Adjust everything for additional man page. + +2022-02-27 Arnold D. Robbins <arnold@skeeve.com> + * gawktexi.in (Array Sorting Functions): Add a note to be careful to use local variables in comparison functions. diff --git a/doc/Makefile.am b/doc/Makefile.am index e5d6bf19..fd44ba53 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -27,7 +27,7 @@ info_TEXINFOS = gawk.texi gawkinet.texi gawkworkflow.texi -man_MANS = gawk.1 +man_MANS = gawk.1 gawkbug.1 EXTRA_DIST = ChangeLog ChangeLog.0 ChangeLog.1 \ README.card ad.block setter.outline \ @@ -54,7 +54,7 @@ EXTRA_DIST = ChangeLog ChangeLog.0 ChangeLog.1 \ bc_notes # Get rid of generated files when cleaning -CLEANFILES = *.ps *.html *.dvi *~ awkcard.nc awkcard.tr gawk.pdf gawkinet.pdf gawkworkflow.pdf awkcard.pdf gawk.1.pdf +CLEANFILES = *.ps *.html *.dvi *~ awkcard.nc awkcard.tr gawk.pdf gawkinet.pdf gawkworkflow.pdf awkcard.pdf gawk.1.pdf gawkbug.1.pdf MAKEINFO = @MAKEINFO@ --no-split --force @@ -80,9 +80,9 @@ AWKCARD = awkcard.ps gawk.texi: $(srcdir)/gawktexi.in $(srcdir)/sidebar.awk awk -f $(srcdir)/sidebar.awk < $(srcdir)/gawktexi.in > gawk.texi -postscript: gawk.ps gawkinet.ps gawkworkflow.ps gawk.1.ps $(AWKCARD) +postscript: gawk.ps gawkinet.ps gawkworkflow.ps gawk.1.ps gawkbug.1.ps $(AWKCARD) -pdf-local: postscript gawk.pdf gawkinet.pdf awkcard.pdf gawk.1.pdf +pdf-local: postscript gawk.pdf gawkinet.pdf awkcard.pdf gawk.1.pdf gawkbug.1.pdf gawk.ps: gawk.dvi TEXINPUTS=$(srcdir): dvips -o gawk.ps gawk.dvi @@ -99,6 +99,12 @@ gawk.1.ps: gawk.1 gawk.1.pdf: gawk.1.ps ps2pdf gawk.1.ps gawk.1.pdf +gawkbug.1.ps: gawkbug.1 + -groff -man $(srcdir)/gawkbug.1 > gawkbug.1.ps + +gawkbug.1.pdf: gawkbug.1.ps + ps2pdf gawkbug.1.ps gawkbug.1.pdf + awkcard.tr: awkcard.in sed 's:SRCDIR:$(srcdir):' < $(srcdir)/awkcard.in > awkcard.tr @@ -123,11 +129,18 @@ spellworkflow: export LC_ALL=C ; spell "$(srcdir)"/gawkworkflow.texi | \ sort -u | comm -23 - "$(srcdir)"/wordlist2 -spellmanpage: +spellmanpage: spellgawkmanpage spellgawkbugmanpage + +spellgawkmanpage: @echo ==== gawk.1 ==== export LC_ALL=C ; spell "$(srcdir)"/gawk.1 | \ sort -u | comm -23 - "$(srcdir)"/wordlist3 +spellgawkbugmanpage: + @echo ==== gawkbug.1 ==== + export LC_ALL=C ; spell "$(srcdir)"/gawkbug.1 | \ + sort -u | comm -23 - "$(srcdir)"/wordlist5 + spellinet: @echo ==== gawkinet.texi ==== export LC_ALL=C ; spell "$(srcdir)"/gawkinet.texi | \ diff --git a/doc/Makefile.in b/doc/Makefile.in index 2984eb32..aa9f18e7 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -365,7 +365,7 @@ top_build_prefix = @top_build_prefix@ top_builddir = @top_builddir@ top_srcdir = @top_srcdir@ info_TEXINFOS = gawk.texi gawkinet.texi gawkworkflow.texi -man_MANS = gawk.1 +man_MANS = gawk.1 gawkbug.1 EXTRA_DIST = ChangeLog ChangeLog.0 ChangeLog.1 \ README.card ad.block setter.outline \ awkcard.in awkforai.txt texinfo.tex cardfonts \ @@ -392,7 +392,7 @@ EXTRA_DIST = ChangeLog ChangeLog.0 ChangeLog.1 \ # Get rid of generated files when cleaning -CLEANFILES = *.ps *.html *.dvi *~ awkcard.nc awkcard.tr gawk.pdf gawkinet.pdf gawkworkflow.pdf awkcard.pdf gawk.1.pdf +CLEANFILES = *.ps *.html *.dvi *~ awkcard.nc awkcard.tr gawk.pdf gawkinet.pdf gawkworkflow.pdf awkcard.pdf gawk.1.pdf gawkbug.1.pdf TROFF = groff -t -Tps -U SEDME = sed -e "s/^level0 restore/level0 restore flashme 100 72 moveto (Copyright `date '+%m-%d-%y %T'`, FSF, Inc. (all)) show/" \ -e "s/^\/level0 save def/\/level0 save def 30 -48 translate/" @@ -905,9 +905,9 @@ uninstall-man: uninstall-man1 gawk.texi: $(srcdir)/gawktexi.in $(srcdir)/sidebar.awk awk -f $(srcdir)/sidebar.awk < $(srcdir)/gawktexi.in > gawk.texi -postscript: gawk.ps gawkinet.ps gawkworkflow.ps gawk.1.ps $(AWKCARD) +postscript: gawk.ps gawkinet.ps gawkworkflow.ps gawk.1.ps gawkbug.1.ps $(AWKCARD) -pdf-local: postscript gawk.pdf gawkinet.pdf awkcard.pdf gawk.1.pdf +pdf-local: postscript gawk.pdf gawkinet.pdf awkcard.pdf gawk.1.pdf gawkbug.1.pdf gawk.ps: gawk.dvi TEXINPUTS=$(srcdir): dvips -o gawk.ps gawk.dvi @@ -924,6 +924,12 @@ gawk.1.ps: gawk.1 gawk.1.pdf: gawk.1.ps ps2pdf gawk.1.ps gawk.1.pdf +gawkbug.1.ps: gawkbug.1 + -groff -man $(srcdir)/gawkbug.1 > gawkbug.1.ps + +gawkbug.1.pdf: gawkbug.1.ps + ps2pdf gawkbug.1.ps gawkbug.1.pdf + awkcard.tr: awkcard.in sed 's:SRCDIR:$(srcdir):' < $(srcdir)/awkcard.in > awkcard.tr @@ -948,11 +954,18 @@ spellworkflow: export LC_ALL=C ; spell "$(srcdir)"/gawkworkflow.texi | \ sort -u | comm -23 - "$(srcdir)"/wordlist2 -spellmanpage: +spellmanpage: spellgawkmanpage spellgawkbugmanpage + +spellgawkmanpage: @echo ==== gawk.1 ==== export LC_ALL=C ; spell "$(srcdir)"/gawk.1 | \ sort -u | comm -23 - "$(srcdir)"/wordlist3 +spellgawkbugmanpage: + @echo ==== gawkbug.1 ==== + export LC_ALL=C ; spell "$(srcdir)"/gawkbug.1 | \ + sort -u | comm -23 - "$(srcdir)"/wordlist5 + spellinet: @echo ==== gawkinet.texi ==== export LC_ALL=C ; spell "$(srcdir)"/gawkinet.texi | \ diff --git a/doc/gawkbug.1 b/doc/gawkbug.1 new file mode 100644 index 00000000..eb6889e7 --- /dev/null +++ b/doc/gawkbug.1 @@ -0,0 +1,72 @@ +.\" +.\" MAN PAGE COMMENTS to +.\" +.\" Arnold Robbins +.\" bug-gawk@gnu.org +.\" +.\" Last Change: Sat Feb 26 22:38:19 IST 2022 +.\" +.TH GAWKBUG 1 "2022 Feb 26" "GNU Awk 5.2" +.SH NAME +gawkbug \- report a bug in gawk +.SH SYNOPSIS +\fBgawkbug\fP [\fI--version\fP] [\fI--help\fP] [\fIemail-address\fP] +.SH DESCRIPTION +.B gawkbug +is a shell script to help the user compose and mail bug reports +concerning gawk in a standard format. +.B gawkbug +invokes the editor specified by the environment variable +.SM +.B EDITOR +on a temporary copy of the bug report format outline. The user must +fill in the appropriate fields and exit the editor. +.B gawkbug +then mails the completed report to \fIbug-gawk@gnu.org\fP, or +\fIemail-address\fP. If the report cannot be mailed, it is saved in the +file \fIdead.gawkbug\fP in the invoking user's home directory. +.PP +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 environment. 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. +.SH ENVIRONMENT +.B gawkbug +will utilize the following environment variables if they exist: +.TP +.B EDITOR +Specifies the preferred editor. If +.SM +.B EDITOR +is not set, +.B gawkbug +attempts to locate a number of alternative editors, including +.BR vim , +and if must, +.BR emacs . +If +.B gawkbug +cannot locate any of the alternative editors, it attempts to execute \fBvi\fP. +.TP +.B HOME +Directory in which the failed bug report is saved if the mail fails. +.TP +.B TMPDIR +Directory in which to create temporary files and directories. +.SH "SEE ALSO" +.TP +\fIgawk\fP(1) +.SH AUTHORS +Brian Fox, Free Software Foundation +.br +bfox@gnu.org +.PP +Chet Ramey, Case Western Reserve University +.br +chet@po.cwru.edu +.PP +Arnold Robbins +.br +bug-gawk@gnu.org diff --git a/doc/wordlist5 b/doc/wordlist5 new file mode 100644 index 00000000..63b99038 --- /dev/null +++ b/doc/wordlist5 @@ -0,0 +1,13 @@ +Awk +Chet +GAWKBUG +IST +Ramey +TMPDIR +bfox +chet +cwru +edu +gawkbug +org +po |