diff options
| -rw-r--r-- | doc/ChangeLog | 7 | ||||
| -rw-r--r-- | doc/gawk.info | 184 | ||||
| -rw-r--r-- | doc/gawk.texi | 74 | ||||
| -rw-r--r-- | doc/gawktexi.in | 74 |
4 files changed, 234 insertions, 105 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog index 8d15d5a6..a4f61ad1 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,10 @@ +2021-09-24 Arnold D. Robbins <arnold@skeeve.com> + + * gawktexi.in (Building the Documentation): Improve the text, + add info on building the HTML doc. Thanks to Antonio Columbo + for the encouragement. + (Distribution Contents): Update with more files. + 2021-09-23 Arnold D. Robbins <arnold@skeeve.com> * gawktexi.in (Strong Regexp Constants): Document that they diff --git a/doc/gawk.info b/doc/gawk.info index 8aa0d9c2..c393a247 100644 --- a/doc/gawk.info +++ b/doc/gawk.info @@ -30556,16 +30556,21 @@ Various '.c', '.y', and '.h' files 'ChangeLog' A detailed list of source code changes as bugs are fixed or - improvements made. + improvements made. There are similar files in all of the + subdirectories. 'ChangeLog.0' - An older list of source code changes. +'ChangeLog.1' + Older lists of source code changes. There are similar files in all + of the subdirectories. 'NEWS' A list of changes to 'gawk' since the last release or patch. 'NEWS.0' - An older list of changes to 'gawk'. +'NEWS.1' + Older lists of changes to 'gawk'. There are similar files in all + of the subdirectories. 'COPYING' The GNU General Public License. @@ -30626,6 +30631,16 @@ Various '.c', '.y', and '.h' files 'doc/gawkinet.info' The generated Info file for 'TCP/IP Internetworking with 'gawk''. +'doc/gawkworkflow.texi' + The Texinfo source file for *note (General Introduction, + gawkworkflow, Participating in 'gawk' Development)Top::. It should + be processed with TeX (via 'texi2dvi' or 'texi2pdf') to produce a + printed document and with 'makeinfo' to produce an Info or HTML + file. + +'doc/gawkorkflow.info' + The generated Info file for 'Participating in 'gawk' Development'. + 'doc/igawk.1' The 'troff' source for a manual page describing the 'igawk' program presented in *note Igawk Program::. (Since 'gawk' can do its own @@ -30960,17 +30975,18 @@ File: gawk.info, Node: Building the Documentation, Prev: Compiling from Git, B.2.6 Building the Documentation -------------------------------- -The Info documentation is included in the distribution tar files and in -Git; you should not need to rebuild it. However, if it needs to be -done, simply running 'make' will do it, assuming that you have a recent -enough version of 'makeinfo' installed. +The generated Info documentation is included in the distribution 'tar' +files and in the Git source code repository; you should not need to +rebuild it. However, if it needs to be done, simply running 'make' will +do it, assuming that you have a recent enough version of 'makeinfo' +installed. - If you wish to build the PDF version of the manual, you will need to + If you wish to build the PDF version of the manuals, you will need to have TeX installed, and possibly additional packages that provide the -necessary fonts and tools, such as 'ps2pdf'. You will also need GNU -Troff ('groff') installed in order to format the reference card and the -manual page. Managing this process is beyond the scope of this Info -file. +necessary fonts and tools, such as 'dvi2pdf' and 'ps2pdf'. You will +also need GNU Troff ('groff') installed in order to format the reference +card and the manual page (*note Distribution contents::). Managing this +process is beyond the scope of this Info file. Assuming you have all you need, then the following commands produce the PDF versions of the documentation: @@ -30978,6 +30994,18 @@ the PDF versions of the documentation: cd doc make pdf +This creates PDF versions of all three Texinfo documents included in the +distribution, as well as of the manual page and the reference card. + + Similarly, if you have a recent enough version of 'makeinfo', you can +make the HTML version of the manuals with: + + cd doc + make html + +This creates HTML versions of all three Texinfo documents included in +the distribution. + File: gawk.info, Node: Non-Unix Installation, Next: Bugs, Prev: Unix Installation, Up: Installation @@ -35400,7 +35428,7 @@ Index * arrays, sorting, IGNORECASE variable and: Array Sorting Functions. (line 88) * artificial intelligence, gawk and: Distribution contents. - (line 58) + (line 63) * ASCII: Escape Sequences. (line 31) * ASCII <1>: Bracket Expressions. (line 79) * ASCII <2>: Scalar Constants. (line 20) @@ -36266,6 +36294,12 @@ Index * do-while statement: Do Statement. (line 6) * documentation, online: Manual History. (line 11) * documentation, of awk programs: Library Names. (line 6) +* documentation, building, Info files: Building the Documentation. + (line 6) +* documentation, building, PDF: Building the Documentation. + (line 12) +* documentation, building, HTML: Building the Documentation. + (line 28) * documents, searching: Dupword Program. (line 6) * dollar sign ($), regexp operator: Regexp Operator Details. (line 31) @@ -38190,7 +38224,7 @@ Index (line 6) * Texinfo <3>: Extract Program. (line 12) * Texinfo <4>: Distribution contents. - (line 83) + (line 88) * Texinfo <5>: Adding Code. (line 100) * text, printing: Print. (line 22) * text, printing, unduplicated lines of: Uniq Program. (line 6) @@ -38997,67 +39031,67 @@ Node: Gawk Distribution1227129 Node: Getting1227613 Node: Extracting1228576 Node: Distribution contents1230214 -Node: Unix Installation1236694 -Node: Quick Installation1237498 -Node: Compiling with MPFR1239974 -Node: Shell Startup Files1240666 -Node: Additional Configuration Options1241755 -Node: Configuration Philosophy1244070 -Node: Compiling from Git1246466 -Node: Building the Documentation1247021 -Node: Non-Unix Installation1247943 -Node: PC Installation1248403 -Node: PC Binary Installation1249241 -Node: PC Compiling1249676 -Node: PC Using1250793 -Node: Cygwin1254346 -Node: MSYS1255570 -Node: VMS Installation1256172 -Node: VMS Compilation1256891 -Ref: VMS Compilation-Footnote-11258120 -Node: VMS Dynamic Extensions1258178 -Node: VMS Installation Details1259863 -Node: VMS Running1262125 -Node: VMS GNV1266404 -Node: Bugs1267118 -Node: Bug definition1268030 -Node: Bug address1270534 -Node: Usenet1273922 -Node: Performance bugs1274931 -Node: Asking for help1277852 -Node: Maintainers1279814 -Node: Other Versions1281008 -Node: Installation summary1288860 -Node: Notes1290224 -Node: Compatibility Mode1291018 -Node: Additions1291800 -Node: Accessing The Source1292725 -Node: Adding Code1294162 -Node: New Ports1300381 -Node: Derived Files1304756 -Ref: Derived Files-Footnote-11310416 -Ref: Derived Files-Footnote-21310451 -Ref: Derived Files-Footnote-31311049 -Node: Future Extensions1311163 -Node: Implementation Limitations1311821 -Node: Extension Design1313031 -Node: Old Extension Problems1314175 -Ref: Old Extension Problems-Footnote-11315693 -Node: Extension New Mechanism Goals1315750 -Ref: Extension New Mechanism Goals-Footnote-11319114 -Node: Extension Other Design Decisions1319303 -Node: Extension Future Growth1321416 -Node: Notes summary1322022 -Node: Basic Concepts1323180 -Node: Basic High Level1323861 -Ref: figure-general-flow1324143 -Ref: figure-process-flow1324828 -Ref: Basic High Level-Footnote-11328129 -Node: Basic Data Typing1328314 -Node: Glossary1331642 -Node: Copying1363527 -Node: GNU Free Documentation License1401070 -Node: Index1426190 +Node: Unix Installation1237300 +Node: Quick Installation1238104 +Node: Compiling with MPFR1240580 +Node: Shell Startup Files1241272 +Node: Additional Configuration Options1242361 +Node: Configuration Philosophy1244676 +Node: Compiling from Git1247072 +Node: Building the Documentation1247627 +Node: Non-Unix Installation1249011 +Node: PC Installation1249471 +Node: PC Binary Installation1250309 +Node: PC Compiling1250744 +Node: PC Using1251861 +Node: Cygwin1255414 +Node: MSYS1256638 +Node: VMS Installation1257240 +Node: VMS Compilation1257959 +Ref: VMS Compilation-Footnote-11259188 +Node: VMS Dynamic Extensions1259246 +Node: VMS Installation Details1260931 +Node: VMS Running1263193 +Node: VMS GNV1267472 +Node: Bugs1268186 +Node: Bug definition1269098 +Node: Bug address1271602 +Node: Usenet1274990 +Node: Performance bugs1275999 +Node: Asking for help1278920 +Node: Maintainers1280882 +Node: Other Versions1282076 +Node: Installation summary1289928 +Node: Notes1291292 +Node: Compatibility Mode1292086 +Node: Additions1292868 +Node: Accessing The Source1293793 +Node: Adding Code1295230 +Node: New Ports1301449 +Node: Derived Files1305824 +Ref: Derived Files-Footnote-11311484 +Ref: Derived Files-Footnote-21311519 +Ref: Derived Files-Footnote-31312117 +Node: Future Extensions1312231 +Node: Implementation Limitations1312889 +Node: Extension Design1314099 +Node: Old Extension Problems1315243 +Ref: Old Extension Problems-Footnote-11316761 +Node: Extension New Mechanism Goals1316818 +Ref: Extension New Mechanism Goals-Footnote-11320182 +Node: Extension Other Design Decisions1320371 +Node: Extension Future Growth1322484 +Node: Notes summary1323090 +Node: Basic Concepts1324248 +Node: Basic High Level1324929 +Ref: figure-general-flow1325211 +Ref: figure-process-flow1325896 +Ref: Basic High Level-Footnote-11329197 +Node: Basic Data Typing1329382 +Node: Glossary1332710 +Node: Copying1364595 +Node: GNU Free Documentation License1402138 +Node: Index1427258 End Tag Table diff --git a/doc/gawk.texi b/doc/gawk.texi index 5e2ec5dd..d11f9045 100644 --- a/doc/gawk.texi +++ b/doc/gawk.texi @@ -64,6 +64,7 @@ @set PATCHLEVEL 1 @set GAWKINETTITLE TCP/IP Internetworking with @command{gawk} +@set GAWKWORKFLOWTITLE Participating in @command{gawk} Development @ifset FOR_PRINT @set TITLE Effective awk Programming @end ifset @@ -41696,7 +41697,7 @@ Git repository; for more information see @ref{Accessing The Source}. @node Extracting @appendixsubsec Extracting the Distribution -@command{gawk} is distributed as several @code{tar} files compressed with +@command{gawk} is distributed as several @command{tar} files compressed with different compression programs: @command{gzip}, @command{bzip2}, and @command{xz}. For simplicity, the rest of these instructions assume you are using the one compressed with the GNU Gzip program (@command{gzip}). @@ -41704,7 +41705,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 -file and then use @code{tar} to extract it. You can use the following +file and then use @command{tar} to extract it. You can use the following pipeline to produce the @command{gawk} distribution: @example @@ -41777,15 +41778,20 @@ A file providing an overview of the configuration and installation process. @item ChangeLog A detailed list of source code changes as bugs are fixed or improvements made. +There are similar files in all of the subdirectories. @item ChangeLog.0 -An older list of source code changes. +@itemx ChangeLog.1 +Older lists of source code changes. +There are similar files in all of the subdirectories. @item NEWS A list of changes to @command{gawk} since the last release or patch. @item NEWS.0 -An older list of changes to @command{gawk}. +@itemx NEWS.1 +Older lists of changes to @command{gawk}. +There are similar files in all of the subdirectories. @item COPYING The GNU General Public License. @@ -41856,6 +41862,23 @@ with @command{makeinfo} to produce an Info or HTML file. The generated Info file for @cite{@value{GAWKINETTITLE}}. +@item doc/gawkworkflow.texi +The Texinfo source file for +@ifinfo +@inforef{Top, , General Introduction, gawkworkflow, @value{GAWKWORKFLOWTITLE}}. +@end ifinfo +@ifnotinfo +@cite{@value{GAWKWORKFLOWTITLE}}. +@end ifnotinfo +It should be processed with @TeX{} +(via @command{texi2dvi} or @command{texi2pdf}) +to produce a printed document and +with @command{makeinfo} to produce an Info or HTML file. + +@item doc/gawkorkflow.info +The generated Info file for +@cite{@value{GAWKWORKFLOWTITLE}}. + @item doc/igawk.1 The @command{troff} source for a manual page describing the @command{igawk} program presented in @@ -42241,17 +42264,21 @@ cd gawk @node Building the Documentation @appendixsubsec Building the Documentation -The Info documentation is included in the distribution tar files and in -Git; you should not need to rebuild it. However, if it needs to be done, -simply running @command{make} will do it, assuming that you have a recent -enough version of @command{makeinfo} installed. - -If you wish to build the PDF version of the manual, you will need to -have @TeX{} installed, and possibly additional packages that provide the -necessary fonts and tools, such as @command{ps2pdf}. You will also need -GNU Troff (@command{groff}) installed in order to format the reference -card and the manual page. Managing this process is beyond the scope of -this @value{DOCUMENT}. +@cindex documentation @subentry building @subentry Info files +The generated Info documentation is included in the distribution +@command{tar} files and in the Git source code repository; you should +not need to rebuild it. However, if it needs to be done, simply running +@command{make} will do it, assuming that you have a recent enough version +of @command{makeinfo} installed. + +@cindex documentation @subentry building @subentry PDF +If you wish to build the PDF version of the manuals, you will need +to have @TeX{} installed, and possibly additional packages that +provide the necessary fonts and tools, such as @command{dvi2pdf} +and @command{ps2pdf}. You will also need GNU Troff (@command{groff}) +installed in order to format the reference card and the manual page +(@pxref{Distribution contents}). Managing this process is beyond the +scope of this @value{DOCUMENT}. Assuming you have all you need, then the following commands produce the PDF versions of the documentation: @@ -42261,6 +42288,23 @@ cd doc make pdf @end example +@noindent +This creates PDF versions of all three Texinfo documents included +in the distribution, as well as of the manual page and the reference card. + +@cindex documentation @subentry building @subentry HTML +Similarly, if you have a recent enough version of @command{makeinfo}, +you can make the HTML version of the manuals with: + +@example +cd doc +make html +@end example + +@noindent +This creates HTML versions of all three Texinfo documents included +in the distribution. + @node Non-Unix Installation @appendixsec Installation on Other Operating Systems diff --git a/doc/gawktexi.in b/doc/gawktexi.in index b5ce6cd3..4b69f12d 100644 --- a/doc/gawktexi.in +++ b/doc/gawktexi.in @@ -59,6 +59,7 @@ @set PATCHLEVEL 1 @set GAWKINETTITLE TCP/IP Internetworking with @command{gawk} +@set GAWKWORKFLOWTITLE Participating in @command{gawk} Development @ifset FOR_PRINT @set TITLE Effective awk Programming @end ifset @@ -40539,7 +40540,7 @@ Git repository; for more information see @ref{Accessing The Source}. @node Extracting @appendixsubsec Extracting the Distribution -@command{gawk} is distributed as several @code{tar} files compressed with +@command{gawk} is distributed as several @command{tar} files compressed with different compression programs: @command{gzip}, @command{bzip2}, and @command{xz}. For simplicity, the rest of these instructions assume you are using the one compressed with the GNU Gzip program (@command{gzip}). @@ -40547,7 +40548,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 -file and then use @code{tar} to extract it. You can use the following +file and then use @command{tar} to extract it. You can use the following pipeline to produce the @command{gawk} distribution: @example @@ -40620,15 +40621,20 @@ A file providing an overview of the configuration and installation process. @item ChangeLog A detailed list of source code changes as bugs are fixed or improvements made. +There are similar files in all of the subdirectories. @item ChangeLog.0 -An older list of source code changes. +@itemx ChangeLog.1 +Older lists of source code changes. +There are similar files in all of the subdirectories. @item NEWS A list of changes to @command{gawk} since the last release or patch. @item NEWS.0 -An older list of changes to @command{gawk}. +@itemx NEWS.1 +Older lists of changes to @command{gawk}. +There are similar files in all of the subdirectories. @item COPYING The GNU General Public License. @@ -40699,6 +40705,23 @@ with @command{makeinfo} to produce an Info or HTML file. The generated Info file for @cite{@value{GAWKINETTITLE}}. +@item doc/gawkworkflow.texi +The Texinfo source file for +@ifinfo +@inforef{Top, , General Introduction, gawkworkflow, @value{GAWKWORKFLOWTITLE}}. +@end ifinfo +@ifnotinfo +@cite{@value{GAWKWORKFLOWTITLE}}. +@end ifnotinfo +It should be processed with @TeX{} +(via @command{texi2dvi} or @command{texi2pdf}) +to produce a printed document and +with @command{makeinfo} to produce an Info or HTML file. + +@item doc/gawkorkflow.info +The generated Info file for +@cite{@value{GAWKWORKFLOWTITLE}}. + @item doc/igawk.1 The @command{troff} source for a manual page describing the @command{igawk} program presented in @@ -41084,17 +41107,21 @@ cd gawk @node Building the Documentation @appendixsubsec Building the Documentation -The Info documentation is included in the distribution tar files and in -Git; you should not need to rebuild it. However, if it needs to be done, -simply running @command{make} will do it, assuming that you have a recent -enough version of @command{makeinfo} installed. - -If you wish to build the PDF version of the manual, you will need to -have @TeX{} installed, and possibly additional packages that provide the -necessary fonts and tools, such as @command{ps2pdf}. You will also need -GNU Troff (@command{groff}) installed in order to format the reference -card and the manual page. Managing this process is beyond the scope of -this @value{DOCUMENT}. +@cindex documentation @subentry building @subentry Info files +The generated Info documentation is included in the distribution +@command{tar} files and in the Git source code repository; you should +not need to rebuild it. However, if it needs to be done, simply running +@command{make} will do it, assuming that you have a recent enough version +of @command{makeinfo} installed. + +@cindex documentation @subentry building @subentry PDF +If you wish to build the PDF version of the manuals, you will need +to have @TeX{} installed, and possibly additional packages that +provide the necessary fonts and tools, such as @command{dvi2pdf} +and @command{ps2pdf}. You will also need GNU Troff (@command{groff}) +installed in order to format the reference card and the manual page +(@pxref{Distribution contents}). Managing this process is beyond the +scope of this @value{DOCUMENT}. Assuming you have all you need, then the following commands produce the PDF versions of the documentation: @@ -41104,6 +41131,23 @@ cd doc make pdf @end example +@noindent +This creates PDF versions of all three Texinfo documents included +in the distribution, as well as of the manual page and the reference card. + +@cindex documentation @subentry building @subentry HTML +Similarly, if you have a recent enough version of @command{makeinfo}, +you can make the HTML version of the manuals with: + +@example +cd doc +make html +@end example + +@noindent +This creates HTML versions of all three Texinfo documents included +in the distribution. + @node Non-Unix Installation @appendixsec Installation on Other Operating Systems |