diff options
author | Arnold D. Robbins <arnold@skeeve.com> | 2015-02-20 14:10:36 +0200 |
---|---|---|
committer | Arnold D. Robbins <arnold@skeeve.com> | 2015-02-20 14:10:36 +0200 |
commit | 4c4c0d3820bfc6ac3dce47a51e26ee2a9b593466 (patch) | |
tree | 962d49586b98b323bb523037d4e8948632ebcd9e | |
parent | c116a3b0b2b2731fe44372b1c3aa6535717b4dc1 (diff) | |
download | egawk-4c4c0d3820bfc6ac3dce47a51e26ee2a9b593466.tar.gz egawk-4c4c0d3820bfc6ac3dce47a51e26ee2a9b593466.tar.bz2 egawk-4c4c0d3820bfc6ac3dce47a51e26ee2a9b593466.zip |
Last review items!
-rw-r--r-- | doc/ChangeLog | 4 | ||||
-rw-r--r-- | doc/gawk.info | 304 | ||||
-rw-r--r-- | doc/gawk.texi | 74 | ||||
-rw-r--r-- | doc/gawktexi.in | 74 |
4 files changed, 236 insertions, 220 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog index 42508ab1..619ceb06 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,7 @@ +2015-02-20 Arnold D. Robbins <arnold@skeeve.com> + + * gawktexi.in: More O'Reilly fixes. I think it's done! + 2015-02-19 Arnold D. Robbins <arnold@skeeve.com> * gawktexi.in: More O'Reilly fixes. diff --git a/doc/gawk.info b/doc/gawk.info index 717e6659..50627888 100644 --- a/doc/gawk.info +++ b/doc/gawk.info @@ -1873,7 +1873,7 @@ file surrounded by double quotes: File: gawk.info, Node: Sample Data Files, Next: Very Simple, Prev: Running gawk, Up: Getting Started -1.2 Data Files for the Examples +1.2 Data files for the Examples =============================== Many of the examples in this Info file take their input from two sample @@ -6957,7 +6957,7 @@ option (*note Options::). File: gawk.info, Node: Special Files, Next: Close Files And Pipes, Prev: Special FD, Up: Printing -5.8 Special File Names in `gawk' +5.8 Special File names in `gawk' ================================ Besides access to standard input, standard output, and standard error, @@ -7018,7 +7018,7 @@ mentioned here only for completeness. Full discussion is delayed until File: gawk.info, Node: Special Caveats, Prev: Special Network, Up: Special Files -5.8.3 Special File Name Caveats +5.8.3 Special File name Caveats ------------------------------- Here are some things to bear in mind when using the special file names @@ -15155,7 +15155,7 @@ three-character string `"\"'\""': File: gawk.info, Node: Data File Management, Next: Getopt Function, Prev: General Functions, Up: Library Functions -10.3 Data File Management +10.3 Data file Management ========================= This minor node presents functions that are useful for managing @@ -15172,7 +15172,7 @@ command-line data files. File: gawk.info, Node: Filetrans Function, Next: Rewind Function, Up: Data File Management -10.3.1 Noting Data File Boundaries +10.3.1 Noting Data file Boundaries ---------------------------------- The `BEGIN' and `END' rules are each executed exactly once, at the @@ -15310,7 +15310,7 @@ rule finishes!) File: gawk.info, Node: File Checking, Next: Empty Files, Prev: Rewind Function, Up: Data File Management -10.3.3 Checking for Readable Data Files +10.3.3 Checking for Readable Data files --------------------------------------- Normally, if you give `awk' a data file that isn't readable, it stops @@ -15400,7 +15400,7 @@ of the `for' loop uses the `<=' operator, not `<'. File: gawk.info, Node: Ignoring Assigns, Prev: Empty Files, Up: Data File Management -10.3.5 Treating Assignments as File Names +10.3.5 Treating Assignments as File names ----------------------------------------- Occasionally, you might not want `awk' to process command-line variable @@ -22576,9 +22576,9 @@ File: gawk.info, Node: Floating point summary, Prev: POSIX Floating Point Prob using the GMP library. This is faster and more space-efficient than using MPFR for the same calculations. - * There are several "dark corners" with respect to floating-point - numbers where `gawk' disagrees with the POSIX standard. It pays - to be aware of them. + * There are several areas with respect to floating-point numbers + where `gawk' disagrees with the POSIX standard. It pays to be + aware of them. * Overall, there is no need to be unduly suspicious about the results from floating-point arithmetic. The lesson to remember is @@ -34900,147 +34900,147 @@ Ref: Arbitrary Precision Integers-Footnote-1906257 Node: POSIX Floating Point Problems906406 Ref: POSIX Floating Point Problems-Footnote-1910285 Node: Floating point summary910323 -Node: Dynamic Extensions912519 -Node: Extension Intro914071 -Node: Plugin License915336 -Node: Extension Mechanism Outline916133 -Ref: figure-load-extension916561 -Ref: figure-register-new-function918041 -Ref: figure-call-new-function919045 -Node: Extension API Description921032 -Node: Extension API Functions Introduction922482 -Node: General Data Types927303 -Ref: General Data Types-Footnote-1933203 -Node: Memory Allocation Functions933502 -Ref: Memory Allocation Functions-Footnote-1936341 -Node: Constructor Functions936440 -Node: Registration Functions938179 -Node: Extension Functions938864 -Node: Exit Callback Functions941161 -Node: Extension Version String942409 -Node: Input Parsers943072 -Node: Output Wrappers952947 -Node: Two-way processors957460 -Node: Printing Messages959723 -Ref: Printing Messages-Footnote-1960799 -Node: Updating `ERRNO'960951 -Node: Requesting Values961691 -Ref: table-value-types-returned962418 -Node: Accessing Parameters963375 -Node: Symbol Table Access964609 -Node: Symbol table by name965123 -Node: Symbol table by cookie967143 -Ref: Symbol table by cookie-Footnote-1971288 -Node: Cached values971351 -Ref: Cached values-Footnote-1974847 -Node: Array Manipulation974938 -Ref: Array Manipulation-Footnote-1976036 -Node: Array Data Types976073 -Ref: Array Data Types-Footnote-1978728 -Node: Array Functions978820 -Node: Flattening Arrays982679 -Node: Creating Arrays989581 -Node: Extension API Variables994352 -Node: Extension Versioning994988 -Node: Extension API Informational Variables996879 -Node: Extension API Boilerplate997944 -Node: Finding Extensions1001753 -Node: Extension Example1002313 -Node: Internal File Description1003085 -Node: Internal File Ops1007152 -Ref: Internal File Ops-Footnote-11018903 -Node: Using Internal File Ops1019043 -Ref: Using Internal File Ops-Footnote-11021426 -Node: Extension Samples1021699 -Node: Extension Sample File Functions1023227 -Node: Extension Sample Fnmatch1030908 -Node: Extension Sample Fork1032396 -Node: Extension Sample Inplace1033611 -Node: Extension Sample Ord1035287 -Node: Extension Sample Readdir1036123 -Ref: table-readdir-file-types1037000 -Node: Extension Sample Revout1037811 -Node: Extension Sample Rev2way1038400 -Node: Extension Sample Read write array1039140 -Node: Extension Sample Readfile1041080 -Node: Extension Sample Time1042175 -Node: Extension Sample API Tests1043523 -Node: gawkextlib1044014 -Node: Extension summary1046692 -Node: Extension Exercises1050381 -Node: Language History1051103 -Node: V7/SVR3.11052759 -Node: SVR41054912 -Node: POSIX1056346 -Node: BTL1057727 -Node: POSIX/GNU1058458 -Node: Feature History1063979 -Node: Common Extensions1077077 -Node: Ranges and Locales1078449 -Ref: Ranges and Locales-Footnote-11083068 -Ref: Ranges and Locales-Footnote-21083095 -Ref: Ranges and Locales-Footnote-31083330 -Node: Contributors1083551 -Node: History summary1089091 -Node: Installation1090470 -Node: Gawk Distribution1091416 -Node: Getting1091900 -Node: Extracting1092723 -Node: Distribution contents1094360 -Node: Unix Installation1100114 -Node: Quick Installation1100731 -Node: Additional Configuration Options1103155 -Node: Configuration Philosophy1104958 -Node: Non-Unix Installation1107327 -Node: PC Installation1107785 -Node: PC Binary Installation1109105 -Node: PC Compiling1110953 -Ref: PC Compiling-Footnote-11113974 -Node: PC Testing1114083 -Node: PC Using1115259 -Node: Cygwin1119374 -Node: MSYS1120144 -Node: VMS Installation1120645 -Node: VMS Compilation1121437 -Ref: VMS Compilation-Footnote-11122666 -Node: VMS Dynamic Extensions1122724 -Node: VMS Installation Details1124408 -Node: VMS Running1126659 -Node: VMS GNV1129499 -Node: VMS Old Gawk1130234 -Node: Bugs1130704 -Node: Other Versions1134593 -Node: Installation summary1141027 -Node: Notes1142086 -Node: Compatibility Mode1142951 -Node: Additions1143733 -Node: Accessing The Source1144658 -Node: Adding Code1146093 -Node: New Ports1152250 -Node: Derived Files1156732 -Ref: Derived Files-Footnote-11162207 -Ref: Derived Files-Footnote-21162241 -Ref: Derived Files-Footnote-31162837 -Node: Future Extensions1162951 -Node: Implementation Limitations1163557 -Node: Extension Design1164805 -Node: Old Extension Problems1165959 -Ref: Old Extension Problems-Footnote-11167476 -Node: Extension New Mechanism Goals1167533 -Ref: Extension New Mechanism Goals-Footnote-11170893 -Node: Extension Other Design Decisions1171082 -Node: Extension Future Growth1173190 -Node: Old Extension Mechanism1174026 -Node: Notes summary1175788 -Node: Basic Concepts1176974 -Node: Basic High Level1177655 -Ref: figure-general-flow1177927 -Ref: figure-process-flow1178526 -Ref: Basic High Level-Footnote-11181755 -Node: Basic Data Typing1181940 -Node: Glossary1185268 -Node: Copying1217197 -Node: GNU Free Documentation License1254753 -Node: Index1279889 +Node: Dynamic Extensions912510 +Node: Extension Intro914062 +Node: Plugin License915327 +Node: Extension Mechanism Outline916124 +Ref: figure-load-extension916552 +Ref: figure-register-new-function918032 +Ref: figure-call-new-function919036 +Node: Extension API Description921023 +Node: Extension API Functions Introduction922473 +Node: General Data Types927294 +Ref: General Data Types-Footnote-1933194 +Node: Memory Allocation Functions933493 +Ref: Memory Allocation Functions-Footnote-1936332 +Node: Constructor Functions936431 +Node: Registration Functions938170 +Node: Extension Functions938855 +Node: Exit Callback Functions941152 +Node: Extension Version String942400 +Node: Input Parsers943063 +Node: Output Wrappers952938 +Node: Two-way processors957451 +Node: Printing Messages959714 +Ref: Printing Messages-Footnote-1960790 +Node: Updating `ERRNO'960942 +Node: Requesting Values961682 +Ref: table-value-types-returned962409 +Node: Accessing Parameters963366 +Node: Symbol Table Access964600 +Node: Symbol table by name965114 +Node: Symbol table by cookie967134 +Ref: Symbol table by cookie-Footnote-1971279 +Node: Cached values971342 +Ref: Cached values-Footnote-1974838 +Node: Array Manipulation974929 +Ref: Array Manipulation-Footnote-1976027 +Node: Array Data Types976064 +Ref: Array Data Types-Footnote-1978719 +Node: Array Functions978811 +Node: Flattening Arrays982670 +Node: Creating Arrays989572 +Node: Extension API Variables994343 +Node: Extension Versioning994979 +Node: Extension API Informational Variables996870 +Node: Extension API Boilerplate997935 +Node: Finding Extensions1001744 +Node: Extension Example1002304 +Node: Internal File Description1003076 +Node: Internal File Ops1007143 +Ref: Internal File Ops-Footnote-11018894 +Node: Using Internal File Ops1019034 +Ref: Using Internal File Ops-Footnote-11021417 +Node: Extension Samples1021690 +Node: Extension Sample File Functions1023218 +Node: Extension Sample Fnmatch1030899 +Node: Extension Sample Fork1032387 +Node: Extension Sample Inplace1033602 +Node: Extension Sample Ord1035278 +Node: Extension Sample Readdir1036114 +Ref: table-readdir-file-types1036991 +Node: Extension Sample Revout1037802 +Node: Extension Sample Rev2way1038391 +Node: Extension Sample Read write array1039131 +Node: Extension Sample Readfile1041071 +Node: Extension Sample Time1042166 +Node: Extension Sample API Tests1043514 +Node: gawkextlib1044005 +Node: Extension summary1046683 +Node: Extension Exercises1050372 +Node: Language History1051094 +Node: V7/SVR3.11052750 +Node: SVR41054903 +Node: POSIX1056337 +Node: BTL1057718 +Node: POSIX/GNU1058449 +Node: Feature History1063970 +Node: Common Extensions1077068 +Node: Ranges and Locales1078440 +Ref: Ranges and Locales-Footnote-11083059 +Ref: Ranges and Locales-Footnote-21083086 +Ref: Ranges and Locales-Footnote-31083321 +Node: Contributors1083542 +Node: History summary1089082 +Node: Installation1090461 +Node: Gawk Distribution1091407 +Node: Getting1091891 +Node: Extracting1092714 +Node: Distribution contents1094351 +Node: Unix Installation1100105 +Node: Quick Installation1100722 +Node: Additional Configuration Options1103146 +Node: Configuration Philosophy1104949 +Node: Non-Unix Installation1107318 +Node: PC Installation1107776 +Node: PC Binary Installation1109096 +Node: PC Compiling1110944 +Ref: PC Compiling-Footnote-11113965 +Node: PC Testing1114074 +Node: PC Using1115250 +Node: Cygwin1119365 +Node: MSYS1120135 +Node: VMS Installation1120636 +Node: VMS Compilation1121428 +Ref: VMS Compilation-Footnote-11122657 +Node: VMS Dynamic Extensions1122715 +Node: VMS Installation Details1124399 +Node: VMS Running1126650 +Node: VMS GNV1129490 +Node: VMS Old Gawk1130225 +Node: Bugs1130695 +Node: Other Versions1134584 +Node: Installation summary1141018 +Node: Notes1142077 +Node: Compatibility Mode1142942 +Node: Additions1143724 +Node: Accessing The Source1144649 +Node: Adding Code1146084 +Node: New Ports1152241 +Node: Derived Files1156723 +Ref: Derived Files-Footnote-11162198 +Ref: Derived Files-Footnote-21162232 +Ref: Derived Files-Footnote-31162828 +Node: Future Extensions1162942 +Node: Implementation Limitations1163548 +Node: Extension Design1164796 +Node: Old Extension Problems1165950 +Ref: Old Extension Problems-Footnote-11167467 +Node: Extension New Mechanism Goals1167524 +Ref: Extension New Mechanism Goals-Footnote-11170884 +Node: Extension Other Design Decisions1171073 +Node: Extension Future Growth1173181 +Node: Old Extension Mechanism1174017 +Node: Notes summary1175779 +Node: Basic Concepts1176965 +Node: Basic High Level1177646 +Ref: figure-general-flow1177918 +Ref: figure-process-flow1178517 +Ref: Basic High Level-Footnote-11181746 +Node: Basic Data Typing1181931 +Node: Glossary1185259 +Node: Copying1217188 +Node: GNU Free Documentation License1254744 +Node: Index1279880 End Tag Table diff --git a/doc/gawk.texi b/doc/gawk.texi index 2c0bf958..b21324e9 100644 --- a/doc/gawk.texi +++ b/doc/gawk.texi @@ -198,9 +198,9 @@ @ifclear FOR_PRINT @set FN file name -@set FFN File Name +@set FFN File name @set DF data file -@set DDF Data File +@set DDF Data file @set PVERSION version @end ifclear @ifset FOR_PRINT @@ -1750,15 +1750,39 @@ and how to compile and use it on different non-POSIX systems. It also describes how to report bugs in @command{gawk} and where to get other freely available @command{awk} implementations. -@end itemize @ifset FOR_PRINT -@itemize @value{MINUS} @item @ref{Copying}, presents the license that covers the @command{gawk} source code. +@end ifset + +@ifclear FOR_PRINT +@item +@ref{Notes}, +describes how to disable @command{gawk}'s extensions, as +well as how to contribute new code to @command{gawk}, +and some possible future directions for @command{gawk} development. + +@item +@ref{Basic Concepts}, +provides some very cursory background material for those who +are completely unfamiliar with computer programming. + +The @ref{Glossary}, defines most, if not all, of the significant terms used +throughout the @value{DOCUMENT}. If you find terms that you aren't familiar with, +try looking them up here. + +@item +@ref{Copying}, and +@ref{GNU Free Documentation License}, +present the licenses that cover the @command{gawk} source code +and this @value{DOCUMENT}, respectively. +@end ifclear +@end itemize @end itemize +@ifset FOR_PRINT The version of this @value{DOCUMENT} distributed with @command{gawk} contains additional appendices and other end material. To save space, we have omitted them from the @@ -1796,32 +1820,6 @@ Some of the chapters have exercise sections; these have also been omitted from the print edition but are available online. @end ifset -@ifclear FOR_PRINT -@itemize @value{MINUS} -@item -@ref{Notes}, -describes how to disable @command{gawk}'s extensions, as -well as how to contribute new code to @command{gawk}, -and some possible future directions for @command{gawk} development. - -@item -@ref{Basic Concepts}, -provides some very cursory background material for those who -are completely unfamiliar with computer programming. - -The @ref{Glossary}, defines most, if not all, of the significant terms used -throughout the @value{DOCUMENT}. If you find terms that you aren't familiar with, -try looking them up here. - -@item -@ref{Copying}, and -@ref{GNU Free Documentation License}, -present the licenses that cover the @command{gawk} source code -and this @value{DOCUMENT}, respectively. -@end itemize -@end ifclear -@end itemize - @c FULLXREF OFF @node Conventions @@ -1863,15 +1861,23 @@ $ @kbd{echo hello on stderr 1>&2} @end example @ifnotinfo -In the text, command names appear in @code{this font}, while code segments +In the text, almost anything related to programming, such as +command names, +variable and function names, and string, numeric and regexp constants +appear in @code{this font}. Code fragments appear in the same font and quoted, @samp{like this}. +Things that are replaced by the user or programmer +appear in @var{this font}. Options look like this: @option{-f}. +@value{FFN}s are indicated like this: @file{/path/to/ourfile}. +@ifclear FOR_PRINT Some things are emphasized @emph{like this}, and if a point needs to be made -strongly, it is done @strong{like this}. The first occurrence of +strongly, it is done @strong{like this}. +@end ifclear +The first occurrence of a new term is usually its @dfn{definition} and appears in the same font as the previous occurrence of ``definition'' in this sentence. -Finally, @value{FN}s are indicated like this: @file{/path/to/ourfile}. @end ifnotinfo Characters that you type at the keyboard look @kbd{like this}. In particular, @@ -31056,7 +31062,7 @@ This is faster and more space-efficient than using MPFR for the same calculations. @item -There are several ``dark corners'' with respect to floating-point +There are several areas with respect to floating-point numbers where @command{gawk} disagrees with the POSIX standard. It pays to be aware of them. diff --git a/doc/gawktexi.in b/doc/gawktexi.in index 7c13dcb1..383b5aff 100644 --- a/doc/gawktexi.in +++ b/doc/gawktexi.in @@ -193,9 +193,9 @@ @ifclear FOR_PRINT @set FN file name -@set FFN File Name +@set FFN File name @set DF data file -@set DDF Data File +@set DDF Data file @set PVERSION version @end ifclear @ifset FOR_PRINT @@ -1717,15 +1717,39 @@ and how to compile and use it on different non-POSIX systems. It also describes how to report bugs in @command{gawk} and where to get other freely available @command{awk} implementations. -@end itemize @ifset FOR_PRINT -@itemize @value{MINUS} @item @ref{Copying}, presents the license that covers the @command{gawk} source code. +@end ifset + +@ifclear FOR_PRINT +@item +@ref{Notes}, +describes how to disable @command{gawk}'s extensions, as +well as how to contribute new code to @command{gawk}, +and some possible future directions for @command{gawk} development. + +@item +@ref{Basic Concepts}, +provides some very cursory background material for those who +are completely unfamiliar with computer programming. + +The @ref{Glossary}, defines most, if not all, of the significant terms used +throughout the @value{DOCUMENT}. If you find terms that you aren't familiar with, +try looking them up here. + +@item +@ref{Copying}, and +@ref{GNU Free Documentation License}, +present the licenses that cover the @command{gawk} source code +and this @value{DOCUMENT}, respectively. +@end ifclear +@end itemize @end itemize +@ifset FOR_PRINT The version of this @value{DOCUMENT} distributed with @command{gawk} contains additional appendices and other end material. To save space, we have omitted them from the @@ -1763,32 +1787,6 @@ Some of the chapters have exercise sections; these have also been omitted from the print edition but are available online. @end ifset -@ifclear FOR_PRINT -@itemize @value{MINUS} -@item -@ref{Notes}, -describes how to disable @command{gawk}'s extensions, as -well as how to contribute new code to @command{gawk}, -and some possible future directions for @command{gawk} development. - -@item -@ref{Basic Concepts}, -provides some very cursory background material for those who -are completely unfamiliar with computer programming. - -The @ref{Glossary}, defines most, if not all, of the significant terms used -throughout the @value{DOCUMENT}. If you find terms that you aren't familiar with, -try looking them up here. - -@item -@ref{Copying}, and -@ref{GNU Free Documentation License}, -present the licenses that cover the @command{gawk} source code -and this @value{DOCUMENT}, respectively. -@end itemize -@end ifclear -@end itemize - @c FULLXREF OFF @node Conventions @@ -1830,15 +1828,23 @@ $ @kbd{echo hello on stderr 1>&2} @end example @ifnotinfo -In the text, command names appear in @code{this font}, while code segments +In the text, almost anything related to programming, such as +command names, +variable and function names, and string, numeric and regexp constants +appear in @code{this font}. Code fragments appear in the same font and quoted, @samp{like this}. +Things that are replaced by the user or programmer +appear in @var{this font}. Options look like this: @option{-f}. +@value{FFN}s are indicated like this: @file{/path/to/ourfile}. +@ifclear FOR_PRINT Some things are emphasized @emph{like this}, and if a point needs to be made -strongly, it is done @strong{like this}. The first occurrence of +strongly, it is done @strong{like this}. +@end ifclear +The first occurrence of a new term is usually its @dfn{definition} and appears in the same font as the previous occurrence of ``definition'' in this sentence. -Finally, @value{FN}s are indicated like this: @file{/path/to/ourfile}. @end ifnotinfo Characters that you type at the keyboard look @kbd{like this}. In particular, @@ -30147,7 +30153,7 @@ This is faster and more space-efficient than using MPFR for the same calculations. @item -There are several ``dark corners'' with respect to floating-point +There are several areas with respect to floating-point numbers where @command{gawk} disagrees with the POSIX standard. It pays to be aware of them. |