diff options
| -rw-r--r-- | doc/ChangeLog | 5 | ||||
| -rw-r--r-- | doc/gawk.info | 270 | ||||
| -rw-r--r-- | doc/gawk.texi | 91 | ||||
| -rw-r--r-- | doc/gawktexi.in | 91 |
4 files changed, 233 insertions, 224 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog index 43970352..e3d16092 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,8 @@ +2021-09-27 Arnold D. Robbins <arnold@skeeve.com> + + * gawktexi.in: Small cleanups from Antonio Columbo. General + review of usage of @code. + 2021-09-24 Arnold D. Robbins <arnold@skeeve.com> * gawktexi.in (Building the Documentation): Improve the text, diff --git a/doc/gawk.info b/doc/gawk.info index 5ee07cb2..f8193175 100644 --- a/doc/gawk.info +++ b/doc/gawk.info @@ -26862,8 +26862,8 @@ termed a "symbol table". The functions are as follows: 'awk_bool_t sym_update_ns(const char *name_space, const char *name, awk_value_t *value);' This is like 'sym_update()', but the 'name_space' parameter allows you to specify which namespace 'name' is part of. 'name_space' - cannot be 'NULL'. If it is '""' or '"awk', then 'name' is searched - for in the default 'awk' namespace. + cannot be 'NULL'. If it is '""' or '"awk"', then 'name' is + searched for in the default 'awk' namespace. An extension can look up the value of 'gawk''s special variables. However, with the exception of the 'PROCINFO' array, an extension cannot @@ -30690,12 +30690,13 @@ Various '.c', '.y', and '.h' files of the subdirectories. 'NEWS' - A list of changes to 'gawk' since the last release or patch. + A list of changes to 'gawk' since the last release or patch. There + may be similar files in other subdirectories. 'NEWS.0' 'NEWS.1' - Older lists of changes to 'gawk'. There are similar files in all - of the subdirectories. + Older lists of changes to 'gawk'. There may be similar files in + other subdirectories. 'COPYING' The GNU General Public License. @@ -35553,7 +35554,7 @@ Index * arrays, sorting, IGNORECASE variable and: Array Sorting Functions. (line 88) * artificial intelligence, gawk and: Distribution contents. - (line 63) + (line 64) * ASCII: Escape Sequences. (line 31) * ASCII <1>: Bracket Expressions. (line 79) * ASCII <2>: Scalar Constants. (line 20) @@ -35867,8 +35868,9 @@ Index (line 51) * 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) +* bug reports, email address, <bug-gawk@gnu.org>: Bug address. + (line 56) +* <bug-gawk@gnu.org> bug reporting address: Bug address. (line 56) * built-in functions: Functions. (line 6) * built-in functions, evaluation order: Calling Built-in. (line 30) * BusyBox Awk: Other Versions. (line 92) @@ -36463,7 +36465,7 @@ Index * elements in arrays, order of access by in operator: Scanning an Array. (line 48) * elements in arrays, deleting: Delete. (line 6) -* email address for bug reports, bug-gawk@gnu.org: Bug address. +* email address for bug reports, <bug-gawk@gnu.org>: Bug address. (line 56) * empty array elements: Reference to Elements. (line 18) @@ -38351,7 +38353,7 @@ Index (line 6) * Texinfo <3>: Extract Program. (line 12) * Texinfo <4>: Distribution contents. - (line 88) + (line 89) * Texinfo <5>: Adding Code. (line 100) * text, printing: Print. (line 22) * text, printing, unduplicated lines of: Uniq Program. (line 6) @@ -39098,130 +39100,130 @@ Ref: table-value-types-returned1087562 Node: Accessing Parameters1088670 Node: Symbol Table Access1089907 Node: Symbol table by name1090419 -Ref: Symbol table by name-Footnote-11093443 -Node: Symbol table by cookie1093571 -Ref: Symbol table by cookie-Footnote-11097756 -Node: Cached values1097820 -Ref: Cached values-Footnote-11101356 -Node: Array Manipulation1101509 -Ref: Array Manipulation-Footnote-11102600 -Node: Array Data Types1102637 -Ref: Array Data Types-Footnote-11105295 -Node: Array Functions1105387 -Node: Flattening Arrays1109885 -Node: Creating Arrays1116861 -Node: Redirection API1121628 -Node: Extension API Variables1124461 -Node: Extension Versioning1125172 -Ref: gawk-api-version1125601 -Node: Extension GMP/MPFR Versioning1127332 -Node: Extension API Informational Variables1128960 -Node: Extension API Boilerplate1130033 -Node: Changes from API V11134007 -Node: Finding Extensions1135579 -Node: Extension Example1136138 -Node: Internal File Description1136936 -Node: Internal File Ops1141016 -Ref: Internal File Ops-Footnote-11152366 -Node: Using Internal File Ops1152506 -Ref: Using Internal File Ops-Footnote-11154889 -Node: Extension Samples1155163 -Node: Extension Sample File Functions1156692 -Node: Extension Sample Fnmatch1164341 -Node: Extension Sample Fork1165828 -Node: Extension Sample Inplace1167046 -Node: Extension Sample Ord1170672 -Node: Extension Sample Readdir1171508 -Ref: table-readdir-file-types1172397 -Node: Extension Sample Revout1173464 -Node: Extension Sample Rev2way1174053 -Node: Extension Sample Read write array1174793 -Node: Extension Sample Readfile1176735 -Node: Extension Sample Time1177830 -Node: Extension Sample API Tests1179582 -Node: gawkextlib1180074 -Node: Extension summary1182992 -Node: Extension Exercises1186694 -Node: Language History1187936 -Node: V7/SVR3.11189592 -Node: SVR41191744 -Node: POSIX1193178 -Node: BTL1194559 -Node: POSIX/GNU1195288 -Node: Feature History1201066 -Node: Common Extensions1218241 -Node: Ranges and Locales1219524 -Ref: Ranges and Locales-Footnote-11224140 -Ref: Ranges and Locales-Footnote-21224167 -Ref: Ranges and Locales-Footnote-31224402 -Node: Contributors1224625 -Node: History summary1230622 -Node: Installation1232002 -Node: Gawk Distribution1232946 -Node: Getting1233430 -Node: Extracting1234393 -Node: Distribution contents1236031 -Node: Unix Installation1243117 -Node: Quick Installation1243921 -Node: Compiling with MPFR1246397 -Node: Shell Startup Files1247089 -Node: Additional Configuration Options1248178 -Node: Configuration Philosophy1250493 -Node: Compiling from Git1252889 -Node: Building the Documentation1253444 -Node: Non-Unix Installation1254828 -Node: PC Installation1255288 -Node: PC Binary Installation1256126 -Node: PC Compiling1256561 -Node: PC Using1257678 -Node: Cygwin1261231 -Node: MSYS1262455 -Node: VMS Installation1263057 -Node: VMS Compilation1263776 -Ref: VMS Compilation-Footnote-11265005 -Node: VMS Dynamic Extensions1265063 -Node: VMS Installation Details1266748 -Node: VMS Running1269010 -Node: VMS GNV1273289 -Node: Bugs1274003 -Node: Bug definition1274915 -Node: Bug address1277419 -Node: Usenet1280807 -Node: Performance bugs1281816 -Node: Asking for help1284737 -Node: Maintainers1286699 -Node: Other Versions1287893 -Node: Installation summary1295745 -Node: Notes1297109 -Node: Compatibility Mode1297903 -Node: Additions1298685 -Node: Accessing The Source1299610 -Node: Adding Code1301047 -Node: New Ports1307266 -Node: Derived Files1311641 -Ref: Derived Files-Footnote-11317301 -Ref: Derived Files-Footnote-21317336 -Ref: Derived Files-Footnote-31317934 -Node: Future Extensions1318048 -Node: Implementation Limitations1318706 -Node: Extension Design1319916 -Node: Old Extension Problems1321060 -Ref: Old Extension Problems-Footnote-11322578 -Node: Extension New Mechanism Goals1322635 -Ref: Extension New Mechanism Goals-Footnote-11325999 -Node: Extension Other Design Decisions1326188 -Node: Extension Future Growth1328301 -Node: Notes summary1328907 -Node: Basic Concepts1330065 -Node: Basic High Level1330746 -Ref: figure-general-flow1331028 -Ref: figure-process-flow1331713 -Ref: Basic High Level-Footnote-11335014 -Node: Basic Data Typing1335199 -Node: Glossary1338527 -Node: Copying1370414 -Node: GNU Free Documentation License1407957 -Node: Index1433077 +Ref: Symbol table by name-Footnote-11093444 +Node: Symbol table by cookie1093572 +Ref: Symbol table by cookie-Footnote-11097757 +Node: Cached values1097821 +Ref: Cached values-Footnote-11101357 +Node: Array Manipulation1101510 +Ref: Array Manipulation-Footnote-11102601 +Node: Array Data Types1102638 +Ref: Array Data Types-Footnote-11105296 +Node: Array Functions1105388 +Node: Flattening Arrays1109886 +Node: Creating Arrays1116862 +Node: Redirection API1121629 +Node: Extension API Variables1124462 +Node: Extension Versioning1125173 +Ref: gawk-api-version1125602 +Node: Extension GMP/MPFR Versioning1127333 +Node: Extension API Informational Variables1128961 +Node: Extension API Boilerplate1130034 +Node: Changes from API V11134008 +Node: Finding Extensions1135580 +Node: Extension Example1136139 +Node: Internal File Description1136937 +Node: Internal File Ops1141017 +Ref: Internal File Ops-Footnote-11152367 +Node: Using Internal File Ops1152507 +Ref: Using Internal File Ops-Footnote-11154890 +Node: Extension Samples1155164 +Node: Extension Sample File Functions1156693 +Node: Extension Sample Fnmatch1164342 +Node: Extension Sample Fork1165829 +Node: Extension Sample Inplace1167047 +Node: Extension Sample Ord1170673 +Node: Extension Sample Readdir1171509 +Ref: table-readdir-file-types1172398 +Node: Extension Sample Revout1173465 +Node: Extension Sample Rev2way1174054 +Node: Extension Sample Read write array1174794 +Node: Extension Sample Readfile1176736 +Node: Extension Sample Time1177831 +Node: Extension Sample API Tests1179583 +Node: gawkextlib1180075 +Node: Extension summary1182993 +Node: Extension Exercises1186695 +Node: Language History1187937 +Node: V7/SVR3.11189593 +Node: SVR41191745 +Node: POSIX1193179 +Node: BTL1194560 +Node: POSIX/GNU1195289 +Node: Feature History1201067 +Node: Common Extensions1218242 +Node: Ranges and Locales1219525 +Ref: Ranges and Locales-Footnote-11224141 +Ref: Ranges and Locales-Footnote-21224168 +Ref: Ranges and Locales-Footnote-31224403 +Node: Contributors1224626 +Node: History summary1230623 +Node: Installation1232003 +Node: Gawk Distribution1232947 +Node: Getting1233431 +Node: Extracting1234394 +Node: Distribution contents1236032 +Node: Unix Installation1243174 +Node: Quick Installation1243978 +Node: Compiling with MPFR1246454 +Node: Shell Startup Files1247146 +Node: Additional Configuration Options1248235 +Node: Configuration Philosophy1250550 +Node: Compiling from Git1252946 +Node: Building the Documentation1253501 +Node: Non-Unix Installation1254885 +Node: PC Installation1255345 +Node: PC Binary Installation1256183 +Node: PC Compiling1256618 +Node: PC Using1257735 +Node: Cygwin1261288 +Node: MSYS1262512 +Node: VMS Installation1263114 +Node: VMS Compilation1263833 +Ref: VMS Compilation-Footnote-11265062 +Node: VMS Dynamic Extensions1265120 +Node: VMS Installation Details1266805 +Node: VMS Running1269067 +Node: VMS GNV1273346 +Node: Bugs1274060 +Node: Bug definition1274972 +Node: Bug address1277476 +Node: Usenet1280864 +Node: Performance bugs1281873 +Node: Asking for help1284794 +Node: Maintainers1286756 +Node: Other Versions1287950 +Node: Installation summary1295802 +Node: Notes1297166 +Node: Compatibility Mode1297960 +Node: Additions1298742 +Node: Accessing The Source1299667 +Node: Adding Code1301104 +Node: New Ports1307323 +Node: Derived Files1311698 +Ref: Derived Files-Footnote-11317358 +Ref: Derived Files-Footnote-21317393 +Ref: Derived Files-Footnote-31317991 +Node: Future Extensions1318105 +Node: Implementation Limitations1318763 +Node: Extension Design1319973 +Node: Old Extension Problems1321117 +Ref: Old Extension Problems-Footnote-11322635 +Node: Extension New Mechanism Goals1322692 +Ref: Extension New Mechanism Goals-Footnote-11326056 +Node: Extension Other Design Decisions1326245 +Node: Extension Future Growth1328358 +Node: Notes summary1328964 +Node: Basic Concepts1330122 +Node: Basic High Level1330803 +Ref: figure-general-flow1331085 +Ref: figure-process-flow1331770 +Ref: Basic High Level-Footnote-11335071 +Node: Basic Data Typing1335256 +Node: Glossary1338584 +Node: Copying1370471 +Node: GNU Free Documentation License1408014 +Node: Index1433134 End Tag Table diff --git a/doc/gawk.texi b/doc/gawk.texi index a71fe804..ec7afb8d 100644 --- a/doc/gawk.texi +++ b/doc/gawk.texi @@ -3865,7 +3865,7 @@ The following list describes options mandated by the POSIX standard: @itemx --field-separator @var{fs} @cindex @option{-F} option @cindex @option{--field-separator} option -@cindex @code{FS} variable @subentry @code{--field-separator} option and +@cindex @code{FS} variable @subentry @option{--field-separator} option and Set the @code{FS} variable to @var{fs} (@pxref{Field Separators}). @@ -4200,7 +4200,7 @@ if @command{gawk} is not compiled to use the GNU MPFR and MP libraries @cindex @option{--non-decimal-data} option @cindex hexadecimal values, enabling interpretation of @cindex octal values, enabling interpretation of -@cindex troubleshooting @subentry @code{--non-decimal-data} option +@cindex troubleshooting @subentry @option{--non-decimal-data} option Enable automatic interpretation of octal and hexadecimal values in input data (@pxref{Nondecimal Data}). @@ -4305,8 +4305,8 @@ data (@pxref{Locales}). @c @cindex automatic warnings @c @cindex warnings, automatic -@cindex @option{--traditional} option @subentry @code{--posix} option and -@cindex @option{--posix} option @subentry @code{--traditional} option and +@cindex @option{--traditional} option @subentry @option{--posix} option and +@cindex @option{--posix} option @subentry @option{--traditional} option and If you supply both @option{--traditional} and @option{--posix} on the command line, @option{--posix} takes precedence. @command{gawk} issues a warning if both options are supplied. @@ -6669,13 +6669,13 @@ in @ref{Regexp Operators}. @end ifnotdocbook @end ifnottex -@item @code{--posix} +@item @option{--posix} Match only POSIX regexps; the GNU operators are not special (e.g., @samp{\w} matches a literal @samp{w}). Interval expressions are allowed. @cindex Brian Kernighan's @command{awk} -@item @code{--traditional} +@item @option{--traditional} Match traditional Unix @command{awk} regexps. The GNU operators are not special, and interval expressions are not available. Because BWK @command{awk} supports them, @@ -6683,7 +6683,7 @@ the POSIX character classes (@samp{[[:alnum:]]}, etc.) are available. Characters described by octal and hexadecimal escape sequences are treated literally, even if they represent regexp metacharacters. -@item @code{--re-interval} +@item @option{--re-interval} Allow interval expressions in regexps, if @option{--traditional} has been provided. Otherwise, interval expressions are available by default. @@ -14143,8 +14143,8 @@ Field reference. @cindex @code{+} (plus sign) @subentry @code{++} operator @cindex plus sign (@code{+}) @subentry @code{++} operator -@cindex @code{-} (hyphen) @subentry @code{--} operator -@cindex hyphen (@code{-}) @subentry @code{--} operator +@cindex @code{-} (hyphen) @subentry @option{--} operator +@cindex hyphen (@code{-}) @subentry @option{--} operator @item @code{++ --} Increment, decrement. @@ -20728,7 +20728,7 @@ that illustrates the use of these functions: @cindex @code{bits2str()} user-defined function @cindex user-defined @subentry function @subentry @code{bits2str()} -@cindex @code{testbits.awk} program +@cindex @file{testbits.awk} program @example @group @c file eg/lib/bits2str.awk @@ -23655,7 +23655,7 @@ mechanism for dealing with files that can't be opened. However, the code here provides a portable solution.} You can do this by prepending the following program to your @command{awk} program: -@cindex @code{readable.awk} program +@cindex @file{readable.awk} program @example @c file eg/lib/readable.awk # readable.awk --- library file to skip over unreadable files @@ -23713,7 +23713,7 @@ in @ref{Filetrans Function}, the following library file calls a function named @code{zerofile()} that the user must provide. The arguments passed are the @value{FN} and the position in @code{ARGV} where it was found: -@cindex @code{zerofile.awk} program +@cindex @file{zerofile.awk} program @example @c file eg/lib/zerofile.awk # zerofile.awk --- library file to process empty input files @@ -23773,7 +23773,7 @@ Some users have suggested an additional command-line option for @command{gawk} to disable command-line assignments. However, some simple programming with a library file does the trick: -@cindex @code{noassign.awk} program +@cindex @file{noassign.awk} program @example @c file eg/lib/noassign.awk # noassign.awk --- library file to avoid the need for a @@ -25411,7 +25411,7 @@ functions needed, and a @code{usage()} function that prints out a usage message and exits. @code{usage()} is called if invalid arguments are supplied: -@cindex @code{cut.awk} program +@cindex @file{cut.awk} program @example @c file eg/prog/cut.awk # cut.awk --- implement cut in awk @@ -25766,7 +25766,7 @@ that processes the command-line arguments with @code{getopt()}. The @option{-i} @code{IGNORECASE} predefined variable (@pxref{Built-in Variables}): -@cindex @code{egrep.awk} program +@cindex @file{egrep.awk} program @example @c file eg/prog/egrep.awk # egrep.awk --- simulate egrep in awk @@ -26033,7 +26033,7 @@ The program is moderately straightforward. All the work is done in the It starts with explanatory comments, a list of options, and then a @code{usage()} function: -@cindex @code{id.awk} program +@cindex @file{id.awk} program @example @c file eg/prog/id.awk # id.awk --- implement id in awk @@ -26434,7 +26434,7 @@ a @code{usage()} function describing the options. The variable @code{common} keeps the function's lines short so that they look nice on the page: -@cindex @code{split.awk} program +@cindex @file{split.awk} program @example @c file eg/prog/split.awk # split.awk --- do split in awk @@ -26752,7 +26752,7 @@ If the first argument is @option{-a}, then the flag variable Finally, @command{awk} is forced to read the standard input by setting @code{ARGV[1]} to @code{"-"} and @code{ARGC} to two: -@cindex @code{tee.awk} program +@cindex @file{tee.awk} program @example @c file eg/prog/tee.awk # tee.awk --- tee in awk @@ -26901,7 +26901,7 @@ and the @code{join()} library function The program begins with a @code{usage()} function and then a brief outline of the options and their meanings in comments: -@cindex @code{uniq.awk} program +@cindex @file{uniq.awk} program @example @c file eg/prog/uniq.awk @group @@ -27249,7 +27249,7 @@ The @code{BEGIN} rule does the argument processing. The variable @code{print_total} is true if more than one file is named on the command line: -@cindex @code{wc.awk} program +@cindex @file{wc.awk} program @example @c file eg/prog/wc.awk # wc.awk --- count lines, words, characters, bytes @@ -27446,7 +27446,7 @@ If there are no fields left after removing all the punctuation, the current record is skipped. Otherwise, the program loops through each word, comparing it to the previous one: -@cindex @code{dupword.awk} program +@cindex @file{dupword.awk} program @example @c file eg/prog/dupword.awk # dupword.awk --- find duplicate words in text @@ -27538,7 +27538,7 @@ Just for a change, this program uses a @code{switch} statement @code{if}-@code{else} statements instead. Here is the program: -@cindex @code{alarm.awk} program +@cindex @file{alarm.awk} program @example @c file eg/prog/alarm.awk # alarm.awk --- set an alarm @@ -27734,7 +27734,7 @@ as the target. The main program sets two global variables, @code{FROM} and Finally, the processing rule simply calls @code{translate()} for each record: -@cindex @code{translate.awk} program +@cindex @file{translate.awk} program @example @c file eg/prog/translate.awk # translate.awk --- do tr-like stuff @@ -27887,7 +27887,7 @@ that there are two blank lines at the top and two blank lines at the bottom. The @code{END} rule arranges to flush the final page of labels; there may not have been an even multiple of 20 labels in the data: -@cindex @code{labels.awk} program +@cindex @file{labels.awk} program @example @c file eg/prog/labels.awk # labels.awk --- print mailing labels @@ -28018,7 +28018,7 @@ to remove punctuation characters. Finally, we solve the third problem by using the system @command{sort} utility to process the output of the @command{awk} script. Here is the new version of the program: -@cindex @code{wordfreq.awk} program +@cindex @file{wordfreq.awk} program @example @c file eg/prog/wordfreq.awk # wordfreq.awk --- print list of word frequencies @@ -28110,7 +28110,7 @@ Each element of @code{lines} is a unique command, and the indices of The @code{END} rule simply prints out the lines, in order: @cindex Rakitzis, Byron -@cindex @code{histsort.awk} program +@cindex @file{histsort.awk} program @example @c file eg/prog/histsort.awk # histsort.awk --- compact a shell history file @@ -28280,7 +28280,7 @@ The first rule handles calling @code{system()}, checking that a command is given (@code{NF} is at least three) and also checking that the command exits with a zero exit status, signifying OK: -@cindex @code{extract.awk} program +@cindex @file{extract.awk} program @example @c file eg/prog/extract.awk # extract.awk --- extract files and run programs from Texinfo files @@ -29022,7 +29022,7 @@ The following program uses arrays of arrays to bring together words with the same signature and array sorting to print the words in sorted order: -@cindex @code{anagram.awk} program +@cindex @file{anagram.awk} program @example @c file eg/prog/anagram.awk # anagram.awk --- An implementation of the anagram-finding algorithm @@ -29306,7 +29306,7 @@ information is printed. Modify the @command{awk} version same way. @item -The @code{split.awk} program (@pxref{Split Program}) assumes +The @file{split.awk} program (@pxref{Split Program}) assumes that letters are contiguous in the character set, which isn't true for EBCDIC systems. Fix this problem. @@ -29567,9 +29567,9 @@ Because it is common to have decimal data with leading zeros, and because using this facility could lead to surprising results, the default is to leave it disabled. If you want it, you must explicitly request it. -@cindex programming conventions @subentry @code{--non-decimal-data} option +@cindex programming conventions @subentry @option{--non-decimal-data} option @cindex @option{--non-decimal-data} option @subentry @code{strtonum()} function and -@cindex @code{strtonum()} function (@command{gawk}) @subentry @code{--non-decimal-data} option and +@cindex @code{strtonum()} function (@command{gawk}) @subentry @option{--non-decimal-data} option and @quotation CAUTION @emph{Use of this option is not recommended.} It can break old programs very badly. @@ -31440,7 +31440,7 @@ the initial @file{.pot} file: gawk --gen-pot -f guide.awk > guide.pot @end example -@cindex @code{xgettext} utility +@cindex @command{xgettext} utility When run with @option{--gen-pot}, @command{gawk} does not execute your program. Instead, it parses it as usual and prints all marked strings to standard output in the format of a GNU @command{gettext} Portable Object @@ -37200,7 +37200,7 @@ variables (such as @code{ARGC} or @code{NF}). @item awk_bool_t sym_update_ns(const char *name_space, const char *name, awk_value_t *value); This is like @code{sym_update()}, but the @code{name_space} parameter allows you to specify which namespace @code{name} is part of. @code{name_space} cannot be -@code{NULL}. If it is @code{""} or @code{"awk}, then @code{name} is searched +@code{NULL}. If it is @code{""} or @code{"awk"}, then @code{name} is searched for in the default @code{awk} namespace. @end table @@ -39874,7 +39874,7 @@ Next, go to @url{https://sourceforge.net/projects/gawkextlib/files} to download @code{gawkextlib} and any extensions that you would like to build. The @file{README} file at that site explains how to build the code. If you installed @command{gawk} in a non-standard location, you will need to -specify @code{./configure --with-gawk=@var{/path/to/gawk}} to find it. +specify @samp{./configure --with-gawk=@var{/path/to/gawk}} to find it. You may need to use the @command{sudo} utility to install both @command{gawk} and @code{gawkextlib}, depending upon how your system works. @@ -42036,7 +42036,7 @@ you are using the one compressed with the GNU Gzip program (@command{gzip}). Once you have the distribution (e.g., @file{gawk-@value{VERSION}.@value{PATCHLEVEL}.tar.gz}), -use @code{gzip} to expand the +use @command{gzip} to expand the file and then use @command{tar} to extract it. You can use the following pipeline to produce the @command{gawk} distribution: @@ -42119,11 +42119,12 @@ There are similar files in all of the subdirectories. @item NEWS A list of changes to @command{gawk} since the last release or patch. +There may be similar files in other subdirectories. @item NEWS.0 @itemx NEWS.1 Older lists of changes to @command{gawk}. -There are similar files in all of the subdirectories. +There may be similar files in other subdirectories. @item COPYING The GNU General Public License. @@ -42469,7 +42470,7 @@ command line when compiling @command{gawk} from scratch, including: @table @code @cindex @option{--disable-extensions} configuration option -@cindex configuration option @subentry @code{--disable-extensions} +@cindex configuration option @subentry @option{--disable-extensions} @item --disable-extensions Disable the extension mechanism within @command{gawk}. With this option, it is not possible to use dynamic extensions. This also @@ -42481,7 +42482,7 @@ The default action is to dynamically check if the extensions can be configured and compiled. @cindex @option{--disable-lint} configuration option -@cindex configuration option @subentry @code{--disable-lint} +@cindex configuration option @subentry @option{--disable-lint} @item --disable-lint Disable all lint checking within @command{gawk}. The @option{--lint} and @option{--lint-old} options @@ -42504,21 +42505,21 @@ to fail. This option may be removed at a later date. @end quotation @cindex @option{--disable-mpfr} configuration option -@cindex configuration option @subentry @code{--disable-mpfr} +@cindex configuration option @subentry @option{--disable-mpfr} @item --disable-mpfr Skip checking for the MPFR and GMP libraries. This is useful mainly for the developers, to make sure nothing breaks if MPFR support is not available. @cindex @option{--disable-nls} configuration option -@cindex configuration option @subentry @code{--disable-nls} +@cindex configuration option @subentry @option{--disable-nls} @item --disable-nls Disable all message-translation facilities. This is usually not desirable, but it may bring you some slight performance improvement. @cindex @option{--enable-versioned-extension-dir} configuration option -@cindex configuration option @subentry @code{--enable-versioned-extension-dir} +@cindex configuration option @subentry @option{--enable-versioned-extension-dir} @item --enable-versioned-extension-dir Use a versioned directory for extensions. The directory name will include the major and minor API versions in it. This makes it possible @@ -43365,9 +43366,9 @@ not (or not exclusively) in HTML. understood in common by all the maintainers.} @end enumerate -@cindex @code{bug-gawk@@gnu.org} bug reporting address -@cindex email address for bug reports, @code{bug-gawk@@gnu.org} -@cindex bug reports, email address, @code{bug-gawk@@gnu.org} +@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 @EMAIL{bug-gawk@@gnu.org,bug dash gawk at gnu dot org}. @@ -44188,7 +44189,7 @@ submit your changes. information.) Using this format makes it easy for me to apply your changes to the -master version of the @command{gawk} source code (using @code{patch}). +master version of the @command{gawk} source code (using @command{patch}). If I have to apply the changes manually, using a text editor, I may not do so, particularly if there are lots of changes. diff --git a/doc/gawktexi.in b/doc/gawktexi.in index 9dd7479a..110e090c 100644 --- a/doc/gawktexi.in +++ b/doc/gawktexi.in @@ -3775,7 +3775,7 @@ The following list describes options mandated by the POSIX standard: @itemx --field-separator @var{fs} @cindex @option{-F} option @cindex @option{--field-separator} option -@cindex @code{FS} variable @subentry @code{--field-separator} option and +@cindex @code{FS} variable @subentry @option{--field-separator} option and Set the @code{FS} variable to @var{fs} (@pxref{Field Separators}). @@ -4110,7 +4110,7 @@ if @command{gawk} is not compiled to use the GNU MPFR and MP libraries @cindex @option{--non-decimal-data} option @cindex hexadecimal values, enabling interpretation of @cindex octal values, enabling interpretation of -@cindex troubleshooting @subentry @code{--non-decimal-data} option +@cindex troubleshooting @subentry @option{--non-decimal-data} option Enable automatic interpretation of octal and hexadecimal values in input data (@pxref{Nondecimal Data}). @@ -4215,8 +4215,8 @@ data (@pxref{Locales}). @c @cindex automatic warnings @c @cindex warnings, automatic -@cindex @option{--traditional} option @subentry @code{--posix} option and -@cindex @option{--posix} option @subentry @code{--traditional} option and +@cindex @option{--traditional} option @subentry @option{--posix} option and +@cindex @option{--posix} option @subentry @option{--traditional} option and If you supply both @option{--traditional} and @option{--posix} on the command line, @option{--posix} takes precedence. @command{gawk} issues a warning if both options are supplied. @@ -6353,13 +6353,13 @@ in @ref{Regexp Operators}. @end ifnotdocbook @end ifnottex -@item @code{--posix} +@item @option{--posix} Match only POSIX regexps; the GNU operators are not special (e.g., @samp{\w} matches a literal @samp{w}). Interval expressions are allowed. @cindex Brian Kernighan's @command{awk} -@item @code{--traditional} +@item @option{--traditional} Match traditional Unix @command{awk} regexps. The GNU operators are not special, and interval expressions are not available. Because BWK @command{awk} supports them, @@ -6367,7 +6367,7 @@ the POSIX character classes (@samp{[[:alnum:]]}, etc.) are available. Characters described by octal and hexadecimal escape sequences are treated literally, even if they represent regexp metacharacters. -@item @code{--re-interval} +@item @option{--re-interval} Allow interval expressions in regexps, if @option{--traditional} has been provided. Otherwise, interval expressions are available by default. @@ -13330,8 +13330,8 @@ Field reference. @cindex @code{+} (plus sign) @subentry @code{++} operator @cindex plus sign (@code{+}) @subentry @code{++} operator -@cindex @code{-} (hyphen) @subentry @code{--} operator -@cindex hyphen (@code{-}) @subentry @code{--} operator +@cindex @code{-} (hyphen) @subentry @option{--} operator +@cindex hyphen (@code{-}) @subentry @option{--} operator @item @code{++ --} Increment, decrement. @@ -19708,7 +19708,7 @@ that illustrates the use of these functions: @cindex @code{bits2str()} user-defined function @cindex user-defined @subentry function @subentry @code{bits2str()} -@cindex @code{testbits.awk} program +@cindex @file{testbits.awk} program @example @group @c file eg/lib/bits2str.awk @@ -22537,7 +22537,7 @@ mechanism for dealing with files that can't be opened. However, the code here provides a portable solution.} You can do this by prepending the following program to your @command{awk} program: -@cindex @code{readable.awk} program +@cindex @file{readable.awk} program @example @c file eg/lib/readable.awk # readable.awk --- library file to skip over unreadable files @@ -22595,7 +22595,7 @@ in @ref{Filetrans Function}, the following library file calls a function named @code{zerofile()} that the user must provide. The arguments passed are the @value{FN} and the position in @code{ARGV} where it was found: -@cindex @code{zerofile.awk} program +@cindex @file{zerofile.awk} program @example @c file eg/lib/zerofile.awk # zerofile.awk --- library file to process empty input files @@ -22655,7 +22655,7 @@ Some users have suggested an additional command-line option for @command{gawk} to disable command-line assignments. However, some simple programming with a library file does the trick: -@cindex @code{noassign.awk} program +@cindex @file{noassign.awk} program @example @c file eg/lib/noassign.awk # noassign.awk --- library file to avoid the need for a @@ -24293,7 +24293,7 @@ functions needed, and a @code{usage()} function that prints out a usage message and exits. @code{usage()} is called if invalid arguments are supplied: -@cindex @code{cut.awk} program +@cindex @file{cut.awk} program @example @c file eg/prog/cut.awk # cut.awk --- implement cut in awk @@ -24648,7 +24648,7 @@ that processes the command-line arguments with @code{getopt()}. The @option{-i} @code{IGNORECASE} predefined variable (@pxref{Built-in Variables}): -@cindex @code{egrep.awk} program +@cindex @file{egrep.awk} program @example @c file eg/prog/egrep.awk # egrep.awk --- simulate egrep in awk @@ -24915,7 +24915,7 @@ The program is moderately straightforward. All the work is done in the It starts with explanatory comments, a list of options, and then a @code{usage()} function: -@cindex @code{id.awk} program +@cindex @file{id.awk} program @example @c file eg/prog/id.awk # id.awk --- implement id in awk @@ -25316,7 +25316,7 @@ a @code{usage()} function describing the options. The variable @code{common} keeps the function's lines short so that they look nice on the page: -@cindex @code{split.awk} program +@cindex @file{split.awk} program @example @c file eg/prog/split.awk # split.awk --- do split in awk @@ -25634,7 +25634,7 @@ If the first argument is @option{-a}, then the flag variable Finally, @command{awk} is forced to read the standard input by setting @code{ARGV[1]} to @code{"-"} and @code{ARGC} to two: -@cindex @code{tee.awk} program +@cindex @file{tee.awk} program @example @c file eg/prog/tee.awk # tee.awk --- tee in awk @@ -25783,7 +25783,7 @@ and the @code{join()} library function The program begins with a @code{usage()} function and then a brief outline of the options and their meanings in comments: -@cindex @code{uniq.awk} program +@cindex @file{uniq.awk} program @example @c file eg/prog/uniq.awk @group @@ -26131,7 +26131,7 @@ The @code{BEGIN} rule does the argument processing. The variable @code{print_total} is true if more than one file is named on the command line: -@cindex @code{wc.awk} program +@cindex @file{wc.awk} program @example @c file eg/prog/wc.awk # wc.awk --- count lines, words, characters, bytes @@ -26328,7 +26328,7 @@ If there are no fields left after removing all the punctuation, the current record is skipped. Otherwise, the program loops through each word, comparing it to the previous one: -@cindex @code{dupword.awk} program +@cindex @file{dupword.awk} program @example @c file eg/prog/dupword.awk # dupword.awk --- find duplicate words in text @@ -26420,7 +26420,7 @@ Just for a change, this program uses a @code{switch} statement @code{if}-@code{else} statements instead. Here is the program: -@cindex @code{alarm.awk} program +@cindex @file{alarm.awk} program @example @c file eg/prog/alarm.awk # alarm.awk --- set an alarm @@ -26616,7 +26616,7 @@ as the target. The main program sets two global variables, @code{FROM} and Finally, the processing rule simply calls @code{translate()} for each record: -@cindex @code{translate.awk} program +@cindex @file{translate.awk} program @example @c file eg/prog/translate.awk # translate.awk --- do tr-like stuff @@ -26769,7 +26769,7 @@ that there are two blank lines at the top and two blank lines at the bottom. The @code{END} rule arranges to flush the final page of labels; there may not have been an even multiple of 20 labels in the data: -@cindex @code{labels.awk} program +@cindex @file{labels.awk} program @example @c file eg/prog/labels.awk # labels.awk --- print mailing labels @@ -26900,7 +26900,7 @@ to remove punctuation characters. Finally, we solve the third problem by using the system @command{sort} utility to process the output of the @command{awk} script. Here is the new version of the program: -@cindex @code{wordfreq.awk} program +@cindex @file{wordfreq.awk} program @example @c file eg/prog/wordfreq.awk # wordfreq.awk --- print list of word frequencies @@ -26992,7 +26992,7 @@ Each element of @code{lines} is a unique command, and the indices of The @code{END} rule simply prints out the lines, in order: @cindex Rakitzis, Byron -@cindex @code{histsort.awk} program +@cindex @file{histsort.awk} program @example @c file eg/prog/histsort.awk # histsort.awk --- compact a shell history file @@ -27162,7 +27162,7 @@ The first rule handles calling @code{system()}, checking that a command is given (@code{NF} is at least three) and also checking that the command exits with a zero exit status, signifying OK: -@cindex @code{extract.awk} program +@cindex @file{extract.awk} program @example @c file eg/prog/extract.awk # extract.awk --- extract files and run programs from Texinfo files @@ -27904,7 +27904,7 @@ The following program uses arrays of arrays to bring together words with the same signature and array sorting to print the words in sorted order: -@cindex @code{anagram.awk} program +@cindex @file{anagram.awk} program @example @c file eg/prog/anagram.awk # anagram.awk --- An implementation of the anagram-finding algorithm @@ -28188,7 +28188,7 @@ information is printed. Modify the @command{awk} version same way. @item -The @code{split.awk} program (@pxref{Split Program}) assumes +The @file{split.awk} program (@pxref{Split Program}) assumes that letters are contiguous in the character set, which isn't true for EBCDIC systems. Fix this problem. @@ -28449,9 +28449,9 @@ Because it is common to have decimal data with leading zeros, and because using this facility could lead to surprising results, the default is to leave it disabled. If you want it, you must explicitly request it. -@cindex programming conventions @subentry @code{--non-decimal-data} option +@cindex programming conventions @subentry @option{--non-decimal-data} option @cindex @option{--non-decimal-data} option @subentry @code{strtonum()} function and -@cindex @code{strtonum()} function (@command{gawk}) @subentry @code{--non-decimal-data} option and +@cindex @code{strtonum()} function (@command{gawk}) @subentry @option{--non-decimal-data} option and @quotation CAUTION @emph{Use of this option is not recommended.} It can break old programs very badly. @@ -30322,7 +30322,7 @@ the initial @file{.pot} file: gawk --gen-pot -f guide.awk > guide.pot @end example -@cindex @code{xgettext} utility +@cindex @command{xgettext} utility When run with @option{--gen-pot}, @command{gawk} does not execute your program. Instead, it parses it as usual and prints all marked strings to standard output in the format of a GNU @command{gettext} Portable Object @@ -36043,7 +36043,7 @@ variables (such as @code{ARGC} or @code{NF}). @item awk_bool_t sym_update_ns(const char *name_space, const char *name, awk_value_t *value); This is like @code{sym_update()}, but the @code{name_space} parameter allows you to specify which namespace @code{name} is part of. @code{name_space} cannot be -@code{NULL}. If it is @code{""} or @code{"awk}, then @code{name} is searched +@code{NULL}. If it is @code{""} or @code{"awk"}, then @code{name} is searched for in the default @code{awk} namespace. @end table @@ -38717,7 +38717,7 @@ Next, go to @url{https://sourceforge.net/projects/gawkextlib/files} to download @code{gawkextlib} and any extensions that you would like to build. The @file{README} file at that site explains how to build the code. If you installed @command{gawk} in a non-standard location, you will need to -specify @code{./configure --with-gawk=@var{/path/to/gawk}} to find it. +specify @samp{./configure --with-gawk=@var{/path/to/gawk}} to find it. You may need to use the @command{sudo} utility to install both @command{gawk} and @code{gawkextlib}, depending upon how your system works. @@ -40879,7 +40879,7 @@ you are using the one compressed with the GNU Gzip program (@command{gzip}). Once you have the distribution (e.g., @file{gawk-@value{VERSION}.@value{PATCHLEVEL}.tar.gz}), -use @code{gzip} to expand the +use @command{gzip} to expand the file and then use @command{tar} to extract it. You can use the following pipeline to produce the @command{gawk} distribution: @@ -40962,11 +40962,12 @@ There are similar files in all of the subdirectories. @item NEWS A list of changes to @command{gawk} since the last release or patch. +There may be similar files in other subdirectories. @item NEWS.0 @itemx NEWS.1 Older lists of changes to @command{gawk}. -There are similar files in all of the subdirectories. +There may be similar files in other subdirectories. @item COPYING The GNU General Public License. @@ -41312,7 +41313,7 @@ command line when compiling @command{gawk} from scratch, including: @table @code @cindex @option{--disable-extensions} configuration option -@cindex configuration option @subentry @code{--disable-extensions} +@cindex configuration option @subentry @option{--disable-extensions} @item --disable-extensions Disable the extension mechanism within @command{gawk}. With this option, it is not possible to use dynamic extensions. This also @@ -41324,7 +41325,7 @@ The default action is to dynamically check if the extensions can be configured and compiled. @cindex @option{--disable-lint} configuration option -@cindex configuration option @subentry @code{--disable-lint} +@cindex configuration option @subentry @option{--disable-lint} @item --disable-lint Disable all lint checking within @command{gawk}. The @option{--lint} and @option{--lint-old} options @@ -41347,21 +41348,21 @@ to fail. This option may be removed at a later date. @end quotation @cindex @option{--disable-mpfr} configuration option -@cindex configuration option @subentry @code{--disable-mpfr} +@cindex configuration option @subentry @option{--disable-mpfr} @item --disable-mpfr Skip checking for the MPFR and GMP libraries. This is useful mainly for the developers, to make sure nothing breaks if MPFR support is not available. @cindex @option{--disable-nls} configuration option -@cindex configuration option @subentry @code{--disable-nls} +@cindex configuration option @subentry @option{--disable-nls} @item --disable-nls Disable all message-translation facilities. This is usually not desirable, but it may bring you some slight performance improvement. @cindex @option{--enable-versioned-extension-dir} configuration option -@cindex configuration option @subentry @code{--enable-versioned-extension-dir} +@cindex configuration option @subentry @option{--enable-versioned-extension-dir} @item --enable-versioned-extension-dir Use a versioned directory for extensions. The directory name will include the major and minor API versions in it. This makes it possible @@ -42208,9 +42209,9 @@ not (or not exclusively) in HTML. understood in common by all the maintainers.} @end enumerate -@cindex @code{bug-gawk@@gnu.org} bug reporting address -@cindex email address for bug reports, @code{bug-gawk@@gnu.org} -@cindex bug reports, email address, @code{bug-gawk@@gnu.org} +@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 @EMAIL{bug-gawk@@gnu.org,bug dash gawk at gnu dot org}. @@ -43031,7 +43032,7 @@ submit your changes. information.) Using this format makes it easy for me to apply your changes to the -master version of the @command{gawk} source code (using @code{patch}). +master version of the @command{gawk} source code (using @command{patch}). If I have to apply the changes manually, using a text editor, I may not do so, particularly if there are lots of changes. |