diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ChangeLog | 9 | ||||
| -rw-r--r-- | doc/awkcard.in | 5 | ||||
| -rw-r--r-- | doc/gawk.1 | 11 | ||||
| -rw-r--r-- | doc/gawk.info | 148 | ||||
| -rw-r--r-- | doc/gawk.texi | 27 | ||||
| -rw-r--r-- | doc/gawktexi.in | 27 |
6 files changed, 148 insertions, 79 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog index ac48a973..0b34c55f 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,12 @@ +2014-03-10 Arnold D. Robbins <arnold@skeeve.com> + + * gawktexi.in: Finish indexing improvements. (For now, anyway.) + + Unrelated: + + * gawk.1: Document the quote flag! (Better late than never.) + * awkcard.in: Update documentation of quote flag. + 2014-03-08 Arnold D. Robbins <arnold@skeeve.com> * gawktexi.in: Minor edits to the discussion of the memory allocation diff --git a/doc/awkcard.in b/doc/awkcard.in index 610032b7..5f3a9735 100644 --- a/doc/awkcard.in +++ b/doc/awkcard.in @@ -1,7 +1,7 @@ .\" AWK Reference Card --- Arnold Robbins, arnold@skeeve.com .\" .\" Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, -.\" 2003, 2004, 2005, 2007, 2009, 2010, 2011, 2012, 2013 +.\" 2003, 2004, 2005, 2007, 2009, 2010, 2011, 2012, 2013, 2014 .\" Free Software Foundation, Inc. .\" .\" Permission is granted to make and distribute verbatim copies of @@ -1493,7 +1493,8 @@ Only has an effect when the field width is wider than the value to be printed. T} \*(CB\*(FC'\*(FR T{ -Use the locale's thousands separator for \*(FC%d\fP, \*(FC%i\fP, and \*(FC%u\fP.\*(CD +Use the locale's thousands separator and decimal +point characters.\*(CD T} \*(FIwidth\fP T{ Pad the field to this width. The field is normally @@ -13,7 +13,7 @@ . if \w'\(rq' .ds rq "\(rq . \} .\} -.TH GAWK 1 "Jan 28 2014" "Free Software Foundation" "Utility Commands" +.TH GAWK 1 "Mar 08 2014" "Free Software Foundation" "Utility Commands" .SH NAME gawk \- pattern scanning and processing language .SH SYNOPSIS @@ -2454,6 +2454,15 @@ This applies only to the numeric output formats. This flag only has an effect when the field width is wider than the value to be printed. .TP +.B ' +A single quote character instructs +.I gawk +to insert the locale's thousands-separator character +into decimal numbers, and to also use the locale's +decimal point character with floating point formats. +This requires correct locale support in the C library +and in the definition of the current locale. +.TP .I width The field should be padded to this width. The field is normally padded with spaces. With the diff --git a/doc/gawk.info b/doc/gawk.info index 74773fcb..13f5ea77 100644 --- a/doc/gawk.info +++ b/doc/gawk.info @@ -25937,6 +25937,9 @@ Info file, in approximate chronological order: * Anders Wallin helped keep the VMS port going for several years. + * Assaf Gordon contributed the code to implement the `--sandbox' + option. + * John Haque made the following contributions: - The modifications to convert `gawk' into a byte-code @@ -31301,12 +31304,12 @@ Index * for statement, looping over arrays: Scanning an Array. (line 20) * fork() extension function: Extension Sample Fork. (line 11) +* format specifiers: Basic Printf. (line 15) * format specifiers, mixing regular with positional specifiers: Printf Ordering. (line 57) * format specifiers, printf statement: Control Letters. (line 6) * format specifiers, strftime() function (gawk): Time Functions. (line 88) -* format strings: Basic Printf. (line 15) * formats, numeric output: OFMT. (line 6) * formatting output: Printf. (line 6) * forward slash (/): Regexp. (line 10) @@ -31531,6 +31534,12 @@ Index * gettext() function (C library): Explaining gettext. (line 62) * gettimeofday() extension function: Extension Sample Time. (line 13) +* git utility <1>: Adding Code. (line 111) +* git utility <2>: Accessing The Source. + (line 10) +* git utility <3>: Other Versions. (line 29) +* git utility: gawkextlib. (line 29) +* git, use of for gawk source code: Derived Files. (line 6) * GMP: Arbitrary Precision Arithmetic. (line 6) * GNITS mailing list: Acknowledgments. (line 52) @@ -31547,6 +31556,7 @@ Index * GNU/Linux <1>: Glossary. (line 624) * GNU/Linux <2>: I18N Example. (line 55) * GNU/Linux: Manual History. (line 28) +* Gordon, Assaf: Contributors. (line 105) * GPL (General Public License) <1>: Glossary. (line 314) * GPL (General Public License): Manual History. (line 11) * GPL (General Public License), printing: Options. (line 88) @@ -31564,7 +31574,7 @@ Index (line 66) * Hankerson, Darrel <1>: Contributors. (line 60) * Hankerson, Darrel: Acknowledgments. (line 60) -* Haque, John: Contributors. (line 105) +* Haque, John: Contributors. (line 108) * Hartholz, Elaine: Acknowledgments. (line 38) * Hartholz, Marshall: Acknowledgments. (line 38) * Hasegawa, Isamu: Contributors. (line 94) @@ -31652,9 +31662,9 @@ Index * installing gawk: Installation. (line 6) * INT signal (MS-Windows): Profiling. (line 214) * int() function: Numeric Functions. (line 23) -* integer, arbitrary precision: Arbitrary Precision Integers. - (line 6) * integers: General Arithmetic. (line 6) +* integers, arbitrary precision: Arbitrary Precision Integers. + (line 6) * integers, unsigned: General Arithmetic. (line 15) * interacting with other programs: I/O Functions. (line 72) * internationalization <1>: I18N and L10N. (line 6) @@ -31800,10 +31810,15 @@ Index * login information: Passwd Functions. (line 16) * long options: Command Line. (line 13) * loops: While Statement. (line 6) +* loops, break statement and: Break Statement. (line 6) * loops, continue statements and: For Statement. (line 64) * loops, count for header: Profiling. (line 131) +* loops, do-while: Do Statement. (line 6) * loops, exiting: Break Statement. (line 6) +* loops, for, array scanning: Scanning an Array. (line 6) +* loops, for, iterative: For Statement. (line 6) * loops, See Also while statement: While Statement. (line 6) +* loops, while: While Statement. (line 6) * ls utility: More Complex. (line 15) * lshift() function (gawk): Bitwise Functions. (line 46) * lvalues/rvalues: Assignment Ops. (line 32) @@ -32200,10 +32215,10 @@ Index * programming conventions, private variable names: Library Names. (line 23) * programming language, recipe for: History. (line 6) -* Programming languages, Ada: Glossary. (line 20) +* programming languages, Ada: Glossary. (line 20) * programming languages, data-driven vs. procedural: Getting Started. (line 12) -* Programming languages, Java: Glossary. (line 388) +* programming languages, Java: Glossary. (line 388) * programming, basic steps: Basic High Level. (line 20) * programming, concepts: Basic Concepts. (line 6) * pwcat program: Passwd Functions. (line 23) @@ -32340,7 +32355,7 @@ Index * RLENGTH variable, match() function and: String Functions. (line 220) * Robbins, Arnold <1>: Future Extensions. (line 6) * Robbins, Arnold <2>: Bugs. (line 32) -* Robbins, Arnold <3>: Contributors. (line 132) +* Robbins, Arnold <3>: Contributors. (line 135) * Robbins, Arnold <4>: General Data Types. (line 6) * Robbins, Arnold <5>: Alarm Program. (line 6) * Robbins, Arnold <6>: Passwd Functions. (line 90) @@ -32381,7 +32396,7 @@ Index (line 68) * sandbox mode: Options. (line 279) * scalar values: Basic Data Typing. (line 13) -* Schorr, Andrew <1>: Contributors. (line 128) +* Schorr, Andrew <1>: Contributors. (line 131) * Schorr, Andrew: Acknowledgments. (line 60) * Schreiber, Bert: Acknowledgments. (line 38) * Schreiber, Rita: Acknowledgments. (line 38) @@ -32516,6 +32531,7 @@ Index * source code, mawk: Other Versions. (line 44) * source code, mixing: Options. (line 117) * source code, pawk: Other Versions. (line 78) +* source code, pawk (Python version): Other Versions. (line 124) * source code, QSE Awk: Other Versions. (line 130) * source code, QuikTrim Awk: Other Versions. (line 134) * source code, Solaris awk: Other Versions. (line 96) @@ -32816,7 +32832,7 @@ Index * xgettext utility: String Extraction. (line 13) * XOR bitwise operation: Bitwise Functions. (line 6) * xor() function (gawk): Bitwise Functions. (line 55) -* Yawitz, Efraim: Contributors. (line 126) +* Yawitz, Efraim: Contributors. (line 129) * Zaretskii, Eli <1>: Bugs. (line 70) * Zaretskii, Eli <2>: Contributors. (line 55) * Zaretskii, Eli: Acknowledgments. (line 60) @@ -33317,62 +33333,62 @@ Ref: Ranges and Locales-Footnote-11034931 Ref: Ranges and Locales-Footnote-21034958 Ref: Ranges and Locales-Footnote-31035192 Node: Contributors1035413 -Node: Installation1040558 -Node: Gawk Distribution1041452 -Node: Getting1041936 -Node: Extracting1042762 -Node: Distribution contents1044454 -Node: Unix Installation1050159 -Node: Quick Installation1050776 -Node: Additional Configuration Options1053222 -Node: Configuration Philosophy1054958 -Node: Non-Unix Installation1057312 -Node: PC Installation1057770 -Node: PC Binary Installation1059069 -Node: PC Compiling1060917 -Node: PC Testing1063861 -Node: PC Using1065037 -Node: Cygwin1069205 -Node: MSYS1070014 -Node: VMS Installation1070528 -Node: VMS Compilation1071292 -Ref: VMS Compilation-Footnote-11072544 -Node: VMS Dynamic Extensions1072602 -Node: VMS Installation Details1073975 -Node: VMS Running1076226 -Node: VMS GNV1079060 -Node: VMS Old Gawk1079783 -Node: Bugs1080253 -Node: Other Versions1084171 -Node: Notes1090255 -Node: Compatibility Mode1091055 -Node: Additions1091838 -Node: Accessing The Source1092765 -Node: Adding Code1094205 -Node: New Ports1100250 -Node: Derived Files1104385 -Ref: Derived Files-Footnote-11109706 -Ref: Derived Files-Footnote-21109740 -Ref: Derived Files-Footnote-31110340 -Node: Future Extensions1110438 -Node: Implementation Limitations1111021 -Node: Extension Design1112273 -Node: Old Extension Problems1113427 -Ref: Old Extension Problems-Footnote-11114935 -Node: Extension New Mechanism Goals1114992 -Ref: Extension New Mechanism Goals-Footnote-11118357 -Node: Extension Other Design Decisions1118543 -Node: Extension Future Growth1120649 -Node: Old Extension Mechanism1121485 -Node: Basic Concepts1123225 -Node: Basic High Level1123906 -Ref: figure-general-flow1124177 -Ref: figure-process-flow1124776 -Ref: Basic High Level-Footnote-11128005 -Node: Basic Data Typing1128190 -Node: Glossary1131545 -Node: Copying1157007 -Node: GNU Free Documentation License1194564 -Node: Index1219701 +Node: Installation1040640 +Node: Gawk Distribution1041534 +Node: Getting1042018 +Node: Extracting1042844 +Node: Distribution contents1044536 +Node: Unix Installation1050241 +Node: Quick Installation1050858 +Node: Additional Configuration Options1053304 +Node: Configuration Philosophy1055040 +Node: Non-Unix Installation1057394 +Node: PC Installation1057852 +Node: PC Binary Installation1059151 +Node: PC Compiling1060999 +Node: PC Testing1063943 +Node: PC Using1065119 +Node: Cygwin1069287 +Node: MSYS1070096 +Node: VMS Installation1070610 +Node: VMS Compilation1071374 +Ref: VMS Compilation-Footnote-11072626 +Node: VMS Dynamic Extensions1072684 +Node: VMS Installation Details1074057 +Node: VMS Running1076308 +Node: VMS GNV1079142 +Node: VMS Old Gawk1079865 +Node: Bugs1080335 +Node: Other Versions1084253 +Node: Notes1090337 +Node: Compatibility Mode1091137 +Node: Additions1091920 +Node: Accessing The Source1092847 +Node: Adding Code1094287 +Node: New Ports1100332 +Node: Derived Files1104467 +Ref: Derived Files-Footnote-11109788 +Ref: Derived Files-Footnote-21109822 +Ref: Derived Files-Footnote-31110422 +Node: Future Extensions1110520 +Node: Implementation Limitations1111103 +Node: Extension Design1112355 +Node: Old Extension Problems1113509 +Ref: Old Extension Problems-Footnote-11115017 +Node: Extension New Mechanism Goals1115074 +Ref: Extension New Mechanism Goals-Footnote-11118439 +Node: Extension Other Design Decisions1118625 +Node: Extension Future Growth1120731 +Node: Old Extension Mechanism1121567 +Node: Basic Concepts1123307 +Node: Basic High Level1123988 +Ref: figure-general-flow1124259 +Ref: figure-process-flow1124858 +Ref: Basic High Level-Footnote-11128087 +Node: Basic Data Typing1128272 +Node: Glossary1131627 +Node: Copying1157089 +Node: GNU Free Documentation License1194646 +Node: Index1219783 End Tag Table diff --git a/doc/gawk.texi b/doc/gawk.texi index b9bf2170..1b610c42 100644 --- a/doc/gawk.texi +++ b/doc/gawk.texi @@ -8359,7 +8359,7 @@ parentheses are necessary if any of the item expressions use the @samp{>} relational operator; otherwise, it can be confused with an output redirection (@pxref{Redirection}). -@cindex format strings +@cindex format specifiers The difference between @code{printf} and @code{print} is the @var{format} argument. This is an expression whose value is taken as a string; it specifies how to output each of the other arguments. It is called the @@ -12706,6 +12706,7 @@ the first thing on its line. @subsection The @code{while} Statement @cindex @code{while} statement @cindex loops +@cindex loops, @code{while} @cindex loops, See Also @code{while} statement In programming, a @dfn{loop} is a part of a program that can @@ -12766,6 +12767,7 @@ program is harder to read without it. @node Do Statement @subsection The @code{do}-@code{while} Statement @cindex @code{do}-@code{while} statement +@cindex loops, @code{do}-@code{while} The @code{do} loop is a variation of the @code{while} looping statement. The @code{do} loop executes the @var{body} once and then repeats the @@ -12811,6 +12813,7 @@ occasionally is there a real use for a @code{do} statement. @node For Statement @subsection The @code{for} Statement @cindex @code{for} statement +@cindex loops, @code{for}, iterative The @code{for} statement makes it more convenient to count iterations of a loop. The general form of the @code{for} statement looks like this: @@ -12983,6 +12986,7 @@ it is not available. @subsection The @code{break} Statement @cindex @code{break} statement @cindex loops, exiting +@cindex loops, @code{break} statement and The @code{break} statement jumps out of the innermost @code{for}, @code{while}, or @code{do} loop that encloses it. The following example @@ -14628,6 +14632,7 @@ END @{ @subsection Scanning All Elements of an Array @cindex elements in arrays, scanning @cindex arrays, scanning +@cindex loops, @code{for}, array scanning In programs that use arrays, it is often necessary to use a loop that executes once for each element of an array. In other languages, where @@ -29318,7 +29323,7 @@ the problem at hand is often the correct approach in such situations. @node Arbitrary Precision Integers @section Arbitrary Precision Integer Arithmetic with @command{gawk} -@cindex integer, arbitrary precision +@cindex integers, arbitrary precision If one of the options @option{--bignum} or @option{-M} is specified, @command{gawk} performs all @@ -33068,6 +33073,7 @@ The @code{time} extension described earlier (@pxref{Extension Sample Time}) was originally from this project but has been moved in to the main @command{gawk} distribution. +@cindex @command{git} utility You can check out the code for the @code{gawkextlib} project using the @uref{http://git-scm.com, GIT} distributed source code control system. The command is as follows: @@ -34698,6 +34704,11 @@ environments. Anders Wallin helped keep the VMS port going for several years. @item +@cindex Gordon, Assaf +Assaf Gordon contributed the code to implement the +@option{--sandbox} option. + +@item @cindex Haque, John John Haque made the following contributions: @@ -36110,6 +36121,7 @@ It is available in several archive formats: @uref{http://www.cs.princeton.edu/~bwk/btl.mirror/awk.zip} @end table +@cindex @command{git} utility You can also retrieve it from Git Hub: @example @@ -36238,6 +36250,7 @@ This is an embeddable @command{awk} interpreter derived from @uref{http://repo.hu/projects/libmawk/}. @item @code{pawk} +@cindex source code, @command{pawk} (Python version) @cindex @code{pawk}, @command{awk}-like facilities for Python This is a Python module that claims to bring @command{awk}-like features to Python. See @uref{https://github.com/alecthomas/pawk} @@ -36343,6 +36356,7 @@ As @command{gawk} is Free Software, the source code is always available. @ref{Gawk Distribution}, describes how to get and build the formal, released versions of @command{gawk}. +@cindex @command{git} utility However, if you want to modify @command{gawk} and contribute back your changes, you will probably wish to work with the development version. To do so, you will need to access the @command{gawk} source code @@ -36518,6 +36532,7 @@ If possible, please update the @command{man} page as well. You will also have to sign paperwork for your documentation changes. +@cindex @command{git} utility @item Submit changes as unified diffs. Use @samp{diff -u -r -N} to compare @@ -36651,6 +36666,8 @@ coding style and brace layout that suits your taste. @node Derived Files @appendixsubsec Why Generated Files Are Kept In @command{git} +@c STARTOFRANGE gawkgit +@cindex @command{git}, use of for @command{gawk} source code @c From emails written March 22, 2012, to the gawk developers list. If you look at the @command{gawk} source in the @command{git} @@ -36830,7 +36847,7 @@ wget http://git.savannah.gnu.org/cgit/gawk.git/snapshot/gawk-@var{branchname}.ta @noindent to retrieve a snapshot of the given branch. - +@c ENDOFRANGE gawkgit @node Future Extensions @appendixsec Probable Future Extensions @@ -37409,7 +37426,7 @@ better written in another language. You can get it from @uref{http://awk.info/?awk100/aaa}. @cindex Ada programming language -@cindex Programming languages, Ada +@cindex programming languages, Ada @item Ada A programming language originally defined by the U.S.@: Department of Defense for embedded programming. It was designed to enforce good @@ -37892,7 +37909,7 @@ information about the name of the organization and its language-independent three-letter acronym. @cindex Java programming language -@cindex Programming languages, Java +@cindex programming languages, Java @item Java A modern programming language originally developed by Sun Microsystems (now Oracle) supporting Object-Oriented programming. Although usually diff --git a/doc/gawktexi.in b/doc/gawktexi.in index 6054ed40..e9a31935 100644 --- a/doc/gawktexi.in +++ b/doc/gawktexi.in @@ -7977,7 +7977,7 @@ parentheses are necessary if any of the item expressions use the @samp{>} relational operator; otherwise, it can be confused with an output redirection (@pxref{Redirection}). -@cindex format strings +@cindex format specifiers The difference between @code{printf} and @code{print} is the @var{format} argument. This is an expression whose value is taken as a string; it specifies how to output each of the other arguments. It is called the @@ -12083,6 +12083,7 @@ the first thing on its line. @subsection The @code{while} Statement @cindex @code{while} statement @cindex loops +@cindex loops, @code{while} @cindex loops, See Also @code{while} statement In programming, a @dfn{loop} is a part of a program that can @@ -12143,6 +12144,7 @@ program is harder to read without it. @node Do Statement @subsection The @code{do}-@code{while} Statement @cindex @code{do}-@code{while} statement +@cindex loops, @code{do}-@code{while} The @code{do} loop is a variation of the @code{while} looping statement. The @code{do} loop executes the @var{body} once and then repeats the @@ -12188,6 +12190,7 @@ occasionally is there a real use for a @code{do} statement. @node For Statement @subsection The @code{for} Statement @cindex @code{for} statement +@cindex loops, @code{for}, iterative The @code{for} statement makes it more convenient to count iterations of a loop. The general form of the @code{for} statement looks like this: @@ -12360,6 +12363,7 @@ it is not available. @subsection The @code{break} Statement @cindex @code{break} statement @cindex loops, exiting +@cindex loops, @code{break} statement and The @code{break} statement jumps out of the innermost @code{for}, @code{while}, or @code{do} loop that encloses it. The following example @@ -13959,6 +13963,7 @@ END @{ @subsection Scanning All Elements of an Array @cindex elements in arrays, scanning @cindex arrays, scanning +@cindex loops, @code{for}, array scanning In programs that use arrays, it is often necessary to use a loop that executes once for each element of an array. In other languages, where @@ -28459,7 +28464,7 @@ the problem at hand is often the correct approach in such situations. @node Arbitrary Precision Integers @section Arbitrary Precision Integer Arithmetic with @command{gawk} -@cindex integer, arbitrary precision +@cindex integers, arbitrary precision If one of the options @option{--bignum} or @option{-M} is specified, @command{gawk} performs all @@ -32209,6 +32214,7 @@ The @code{time} extension described earlier (@pxref{Extension Sample Time}) was originally from this project but has been moved in to the main @command{gawk} distribution. +@cindex @command{git} utility You can check out the code for the @code{gawkextlib} project using the @uref{http://git-scm.com, GIT} distributed source code control system. The command is as follows: @@ -33839,6 +33845,11 @@ environments. Anders Wallin helped keep the VMS port going for several years. @item +@cindex Gordon, Assaf +Assaf Gordon contributed the code to implement the +@option{--sandbox} option. + +@item @cindex Haque, John John Haque made the following contributions: @@ -35251,6 +35262,7 @@ It is available in several archive formats: @uref{http://www.cs.princeton.edu/~bwk/btl.mirror/awk.zip} @end table +@cindex @command{git} utility You can also retrieve it from Git Hub: @example @@ -35379,6 +35391,7 @@ This is an embeddable @command{awk} interpreter derived from @uref{http://repo.hu/projects/libmawk/}. @item @code{pawk} +@cindex source code, @command{pawk} (Python version) @cindex @code{pawk}, @command{awk}-like facilities for Python This is a Python module that claims to bring @command{awk}-like features to Python. See @uref{https://github.com/alecthomas/pawk} @@ -35484,6 +35497,7 @@ As @command{gawk} is Free Software, the source code is always available. @ref{Gawk Distribution}, describes how to get and build the formal, released versions of @command{gawk}. +@cindex @command{git} utility However, if you want to modify @command{gawk} and contribute back your changes, you will probably wish to work with the development version. To do so, you will need to access the @command{gawk} source code @@ -35659,6 +35673,7 @@ If possible, please update the @command{man} page as well. You will also have to sign paperwork for your documentation changes. +@cindex @command{git} utility @item Submit changes as unified diffs. Use @samp{diff -u -r -N} to compare @@ -35792,6 +35807,8 @@ coding style and brace layout that suits your taste. @node Derived Files @appendixsubsec Why Generated Files Are Kept In @command{git} +@c STARTOFRANGE gawkgit +@cindex @command{git}, use of for @command{gawk} source code @c From emails written March 22, 2012, to the gawk developers list. If you look at the @command{gawk} source in the @command{git} @@ -35971,7 +35988,7 @@ wget http://git.savannah.gnu.org/cgit/gawk.git/snapshot/gawk-@var{branchname}.ta @noindent to retrieve a snapshot of the given branch. - +@c ENDOFRANGE gawkgit @node Future Extensions @appendixsec Probable Future Extensions @@ -36550,7 +36567,7 @@ better written in another language. You can get it from @uref{http://awk.info/?awk100/aaa}. @cindex Ada programming language -@cindex Programming languages, Ada +@cindex programming languages, Ada @item Ada A programming language originally defined by the U.S.@: Department of Defense for embedded programming. It was designed to enforce good @@ -37033,7 +37050,7 @@ information about the name of the organization and its language-independent three-letter acronym. @cindex Java programming language -@cindex Programming languages, Java +@cindex programming languages, Java @item Java A modern programming language originally developed by Sun Microsystems (now Oracle) supporting Object-Oriented programming. Although usually |