diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/CMakeLists.txt | 95 | ||||
| -rw-r--r-- | doc/ChangeLog | 53 | ||||
| -rw-r--r-- | doc/Makefile.am | 14 | ||||
| -rw-r--r-- | doc/Makefile.in | 14 | ||||
| -rw-r--r-- | doc/awkcard.in | 3 | ||||
| -rw-r--r-- | doc/gawk.1 | 25 | ||||
| -rw-r--r-- | doc/gawk.info | 1586 | ||||
| -rw-r--r-- | doc/gawk.texi | 270 | ||||
| -rw-r--r-- | doc/gawktexi.in | 270 |
9 files changed, 1525 insertions, 805 deletions
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt new file mode 100644 index 00000000..e12f5de0 --- /dev/null +++ b/doc/CMakeLists.txt @@ -0,0 +1,95 @@ +# +# doc/CMakeLists.txt --- CMake input file for gawk +# +# Copyright (C) 2013 +# the Free Software Foundation, Inc. +# +# This file is part of GAWK, the GNU implementation of the +# AWK Programming Language. +# +# GAWK is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 3 of the License, or +# (at your option) any later version. +# +# GAWK is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA +# + +## process this file with CMake to produce Makefile + +MACRO(DocDependency outfile) + add_dependencies(doc ${outfile}) + add_custom_target( + ${outfile} + DEPENDS ${ARGN} + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} + COMMAND ${CMAKE_SOURCE_DIR}/cmake/docmaker ${outfile} ${ARGN} + ) +ENDMACRO(DocDependency) + +find_program(TEXI2DVI_CONVERTER texi2dvi) +if (TEXI2DVI_CONVERTER) + add_custom_target(doc) + DocDependency(gawk.texi gawktexi.in rflashlight.eps api-figure1.fig api-figure2.fig api-figure3.fig general-program.fig process-flow.fig) + DocDependency(rflashlight.eps) + DocDependency(api-figure1.fig) + DocDependency(api-figure2.fig) + DocDependency(api-figure3.fig) + DocDependency(general-program.fig) + DocDependency(process-flow.fig) + DocDependency(gawk.dvi gawk.texi) + DocDependency(gawk.info gawk.texi) + DocDependency(gawkinet.dvi gawkinet.texi) + DocDependency(gawkinet.info gawkinet.texi) + DocDependency(gawkinet.texi statist.eps) + DocDependency(gawk.1.ps gawk.1) + DocDependency(igawk.1.ps igawk.1) + find_program(DVIPS_CONVERTER dvips) + if (DVIPS_CONVERTER) + DocDependency(gawk.ps gawk.dvi) + DocDependency(gawkinet.ps gawkinet.dvi) + find_program(PS2PDF_CONVERTER ps2pdf) + if (PS2PDF_CONVERTER) + DocDependency(gawk.1.pdf gawk.1.ps) + DocDependency(igawk.1.pdf igawk.1.ps) + DocDependency(gawk.pdf gawk.ps) + DocDependency(gawkinet.pdf gawkinet.ps) + install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/gawk.1.pdf DESTINATION doc) + install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/igawk.1.pdf DESTINATION doc) + install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/gawk.info DESTINATION doc) + install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/gawk.pdf DESTINATION doc) + install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/gawkinet.info DESTINATION doc) + install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/gawkinet.pdf DESTINATION doc) + + set(CARDSRC macros cardfonts colors awkcard.tr) + set(CARDSRC_N macros cardfonts no.colors awkcard.tr) + set(CARDFILES ${CARDSRC} ad.block awkcard.in setter.outline) + DocDependency(awkcard.tr awkcard.in) + DocDependency(awkcard.nc ${CARDFILES}) + DocDependency(awkcard.ps ${CARDFILES}) + DocDependency(awkcard.pdf awkcard.ps) + install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/awkcard.pdf DESTINATION doc) + + else() + message(WARNING "Found no ps2pdf tool; no doc will be generated") + install(CODE "MESSAGE(\"doc generated only in .ps files\")") + endif() + else() + message(WARNING "Found no dvips tool; no doc will be generated") + install(CODE "MESSAGE(\"doc generated only in .dvi files and man pages in .ps files\")") + endif() +else() + message(WARNING "Found no texi2dvi tool; no doc will be generated") + add_custom_command( + TARGET doc + COMMAND echo no doc generated because of missing texi2dvi + ) +endif() + diff --git a/doc/ChangeLog b/doc/ChangeLog index 8460104e..7725061b 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,8 @@ +2014-10-29 Andrew J. Schorr <aschorr@telemetry-investments.com> + + * gawktexi.in: Document new extras directory containing shell startup + files to manipulate AWKPATH and AWKLIBPATH environment variables. + 2014-10-28 Arnold D. Robbins <arnold@skeeve.com> * gawk.1: Clarification that debugger reads stdin. @@ -11,6 +16,7 @@ 2014-10-25 Arnold D. Robbins <arnold@skeeve.com> * gawktexi.in: Minor typo fixes. + Fix discussion of \x, per note from Antonio Colombo. 2014-10-17 Arnold D. Robbins <arnold@skeeve.com> @@ -52,10 +58,25 @@ * gawktexi.in: Pretty much done! + Unrelated: + + * gawktexi.in: Fix braino in awk version of div function. + Thanks to Katie Wasserman for the catch. + 2014-10-01 Arnold D. Robbins <arnold@skeeve.com> * gawktexi.in: More fixes after reading through the MS. + Unrelated: + + * gawktexi.in: Add Katie Wasserman's program to compute + the digits of PI. + + Unrelated: + + * gawktexi.in: Document the differences between profiling + and pretty printing. + 2014-09-30 Arnold D. Robbins <arnold@skeeve.com> * gawktexi.in: More fixes after reading through the MS. @@ -151,6 +172,10 @@ exercises. Remove use of LC_ALL in an example; doesn't seem to be needed anymore. + Unrelated: + + * gawktexi.in: Document that MirBSD is no longer supported. + 2014-08-25 Arnold D. Robbins <arnold@skeeve.com> * gawktexi.in: Exercises are excluded from print edition. @@ -184,6 +209,10 @@ * gawktexi.in: Starting on reviewer comments. Update acknowledgements. +2014-08-12 Arnold D. Robbins <arnold@skeeve.com> + + * gawktexi.in: Cause div.awk to get into the example files. + 2014-08-06 Arnold D. Robbins <arnold@skeeve.com> * gawktexi.in: Misc minor additions. @@ -198,6 +227,18 @@ * gawktexi.in: Fix doc for API get_record - errcode needs to be greater than zero. +2014-07-24 Arnold D. Robbins <arnold@skeeve.com> + + * gawktexi.in (Numeric Functions): For `div()', clarify + truncation is towards zero. Thanks to Michal Jaegermann + for pointing out the need to clarify this. + +2014-07-10 Arnold D. Robbins <arnold@skeeve.com> + + * gawktexi.in (Numeric Functions): Document new `div()' function. + (Arbitrary Precision Integers): Document raison d'etre for div(). + * gawk.1, awkcard.in: Document `div()'. + 2014-07-04 Arnold D. Robbins <arnold@skeeve.com> * gawktexi.in (Bracket Expressions): Add a note about how to @@ -208,6 +249,11 @@ * gawktexi.in: Update permissions on copyright page per latest maintain.texi. Add GPL to print version of book. +2014-06-24 Arnold D. Robbins <arnold@skeeve.com> + + * gawktexi.in: Document that --pretty-print no longer runs the + program. Remove mention of GAWK_NO_PP_RUN env var. + 2014-06-22 Arnold D. Robbins <arnold@skeeve.com> * gawktexi.in: Typo fixes and minor corrections. @@ -504,7 +550,7 @@ 2013-12-26 Arnold D. Robbins <arnold@skeeve.com> * gawktexi.in: More minor additions / fixes. - (Bugs): Add John Malmberg for VMS. + (Bugs): Add John Malmberg for VMS. Other minor edits. 2013-12-25 Arnold D. Robbins <arnold@skeeve.com> @@ -578,6 +624,11 @@ * gawktexi.in (FN, FFN, DF,DDF, PVERSION, CTL): Remove macros. They have no alternate versions and are just in the way. +2013-08-15 Arnold D. Robbins <arnold@skeeve.com> + + * gawk.1: Document that ENVIRON updates affect the environment. + * gawktexi.in: Ditto. + 2013-06-27 Arnold D. Robbins <arnold@skeeve.com> * texinfo.tex: Update from Karl, fixes a formating problem. diff --git a/doc/Makefile.am b/doc/Makefile.am index 86321bbc..8a0442a7 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -26,7 +26,7 @@ info_TEXINFOS = gawk.texi gawkinet.texi -man_MANS = gawk.1 igawk.1 +man_MANS = gawk.1 EXTRA_DIST = ChangeLog ChangeLog.0 README.card ad.block setter.outline \ awkcard.in awkforai.txt texinfo.tex cardfonts \ @@ -50,7 +50,7 @@ EXTRA_DIST = ChangeLog ChangeLog.0 README.card ad.block setter.outline \ bc_notes # Get rid of generated files when cleaning -CLEANFILES = *.ps *.html *.dvi *~ awkcard.nc awkcard.tr gawk.pdf gawkinet.pdf awkcard.pdf gawk.1.pdf igawk.1.pdf +CLEANFILES = *.ps *.html *.dvi *~ awkcard.nc awkcard.tr gawk.pdf gawkinet.pdf awkcard.pdf gawk.1.pdf MAKEINFO = @MAKEINFO@ --no-split --force @@ -75,9 +75,9 @@ AWKCARD = awkcard.ps gawk.texi: $(srcdir)/gawktexi.in $(srcdir)/sidebar.awk awk -f $(srcdir)/sidebar.awk < $(srcdir)/gawktexi.in > gawk.texi -postscript: gawk.ps gawkinet.ps gawk.1.ps igawk.1.ps $(AWKCARD) +postscript: gawk.ps gawkinet.ps gawk.1.ps $(AWKCARD) -pdf: postscript gawk.pdf gawkinet.pdf awkcard.pdf gawk.1.pdf igawk.1.pdf +pdf: postscript gawk.pdf gawkinet.pdf awkcard.pdf gawk.1.pdf gawk.ps: gawk.dvi TEXINPUTS=$(srcdir): dvips -o gawk.ps gawk.dvi @@ -91,12 +91,6 @@ gawk.1.ps: gawk.1 gawk.1.pdf: gawk.1.ps ps2pdf gawk.1.ps gawk.1.pdf -igawk.1.ps: igawk.1 - -groff -man $(srcdir)/igawk.1 > igawk.1.ps - -igawk.1.pdf: igawk.1.ps - ps2pdf igawk.1.ps igawk.1.pdf - awkcard.tr: awkcard.in sed 's:SRCDIR:$(srcdir):' < $(srcdir)/awkcard.in > awkcard.tr diff --git a/doc/Makefile.in b/doc/Makefile.in index abaf5601..d89beffd 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -341,7 +341,7 @@ top_build_prefix = @top_build_prefix@ top_builddir = @top_builddir@ top_srcdir = @top_srcdir@ info_TEXINFOS = gawk.texi gawkinet.texi -man_MANS = gawk.1 igawk.1 +man_MANS = gawk.1 EXTRA_DIST = ChangeLog ChangeLog.0 README.card ad.block setter.outline \ awkcard.in awkforai.txt texinfo.tex cardfonts \ api-figure1.eps api-figure1.fig api-figure1.pdf \ @@ -365,7 +365,7 @@ EXTRA_DIST = ChangeLog ChangeLog.0 README.card ad.block setter.outline \ # Get rid of generated files when cleaning -CLEANFILES = *.ps *.html *.dvi *~ awkcard.nc awkcard.tr gawk.pdf gawkinet.pdf awkcard.pdf gawk.1.pdf igawk.1.pdf +CLEANFILES = *.ps *.html *.dvi *~ awkcard.nc awkcard.tr gawk.pdf gawkinet.pdf awkcard.pdf gawk.1.pdf TROFF = groff -t -Tps -U SEDME = sed -e "s/^level0 restore/level0 restore flashme 100 72 moveto (Copyright `date '+%m-%d-%y %T'`, FSF, Inc. (all)) show/" \ -e "s/^\/level0 save def/\/level0 save def 30 -48 translate/" @@ -869,9 +869,9 @@ uninstall-man: uninstall-man1 gawk.texi: $(srcdir)/gawktexi.in $(srcdir)/sidebar.awk awk -f $(srcdir)/sidebar.awk < $(srcdir)/gawktexi.in > gawk.texi -postscript: gawk.ps gawkinet.ps gawk.1.ps igawk.1.ps $(AWKCARD) +postscript: gawk.ps gawkinet.ps gawk.1.ps $(AWKCARD) -pdf: postscript gawk.pdf gawkinet.pdf awkcard.pdf gawk.1.pdf igawk.1.pdf +pdf: postscript gawk.pdf gawkinet.pdf awkcard.pdf gawk.1.pdf gawk.ps: gawk.dvi TEXINPUTS=$(srcdir): dvips -o gawk.ps gawk.dvi @@ -885,12 +885,6 @@ gawk.1.ps: gawk.1 gawk.1.pdf: gawk.1.ps ps2pdf gawk.1.ps gawk.1.pdf -igawk.1.ps: igawk.1 - -groff -man $(srcdir)/igawk.1 > igawk.1.ps - -igawk.1.pdf: igawk.1.ps - ps2pdf igawk.1.ps igawk.1.pdf - awkcard.tr: awkcard.in sed 's:SRCDIR:$(srcdir):' < $(srcdir)/awkcard.in > awkcard.tr diff --git a/doc/awkcard.in b/doc/awkcard.in index ca28f0a7..556bdc1e 100644 --- a/doc/awkcard.in +++ b/doc/awkcard.in @@ -1609,6 +1609,9 @@ expand; l lw(2i). \*(CD\*(FCatan2(\*(FIy\*(FC, \*(FIx\*(FC)\*(FR The arctangent of \*(FIy/x\fP in radians. \*(FCcos(\*(FIexpr\*(FC)\*(FR The cosine of \*(FIexpr\fP, which is in radians. +\*(CB\*(FCdiv(\*(FIn\*(FR\*(FC,\*(FI d\*(FR\*(FC,\*(FI res\*(FR\*(FC)\*(FR T{ +Return the result of integer division in \*(FIres\*(FR.\*(CD +T} \*(FCexp(\*(FIexpr\*(FC)\*(FR The exponential function (\*(FIe \*(FC^ \*(FIx\*(FR). \*(FCint(\*(FIexpr\*(FC)\*(FR Truncate to integer. \*(FClog(\*(FIexpr\*(FC)\*(FR The natural logarithm function (base \*(FIe\^\*(FR). @@ -918,11 +918,17 @@ An array containing the values of the current environment. The array is indexed by the environment variables, each element being the value of that variable (e.g., \fBENVIRON["HOME"]\fP might be \fB"/home/arnold"\fR). -Changing this array does not affect the environment seen by programs which +.sp +In POSIX mode, +changing this array does not affect the environment seen by programs which .I gawk spawns via redirection or the .B system() function. +Otherwise, +.I gawk +updates its real environment so that programs it spawns see +the changes. .TP .B ERRNO If a system error occurs either doing a redirection for @@ -2629,6 +2635,23 @@ Return the cosine of .IR expr , which is in radians. .TP +.BI div( num ", " denom ", " result ) +Truncate +.I num +and +.I denom +to integers. Return the quotient of +.I num +divided by +.I denom +in \fIresult\fB["quotient"]\fR +and the remainder in +in \fIresult\fB["remainder"]\fR. +This is a +.I gawk +extension, primarily of value when working with +arbitrarily large integers. +.TP .BI exp( expr ) The exponential function. .TP diff --git a/doc/gawk.info b/doc/gawk.info index 6b851441..ae3c6f8c 100644 --- a/doc/gawk.info +++ b/doc/gawk.info @@ -615,6 +615,7 @@ entitled "GNU Free Documentation License". * Unix Installation:: Installing `gawk' under various versions of Unix. * Quick Installation:: Compiling `gawk' under Unix. +* Shell Startup Files:: Shell convenience functions. * Additional Configuration Options:: Other compile-time options. * Configuration Philosophy:: How it's all supposed to work. * Non-Unix Installation:: Installation on Other Operating @@ -2623,10 +2624,8 @@ The following list describes options mandated by the POSIX standard: different file name for the output. No space is allowed between the `-o' and FILE, if FILE is supplied. - NOTE: Due to the way `gawk' has evolved, with this option - your program is still executed. This will change in the next - major release such that `gawk' will only pretty-print the - program and not run it. + NOTE: In the past, this option would also execute your + program. This is no longer the case. `-O' `--optimize' @@ -2920,6 +2919,9 @@ Since `.' is included at the beginning, `gawk' searches first in the current directory and then in `/usr/local/share/awk'. In practice, this means that you will rarely need to change the value of `AWKPATH'. + *Note Shell Startup Files::, for information on functions that help +to manipulate the `AWKPATH' variable. + `gawk' places the value of the search path that it used into `ENVIRON["AWKPATH"]'. This provides access to the actual search path value from within an `awk' program. @@ -2959,6 +2961,9 @@ empty value, `gawk' uses a default path; this is typically `/usr/local/lib/gawk', although it can vary depending upon how `gawk' was built. + *Note Shell Startup Files::, for information on functions that help +to manipulate the `AWKLIBPATH' variable. + `gawk' places the value of the search path that it used into `ENVIRON["AWKLIBPATH"]'. This provides access to the actual search path value from within an `awk' program. @@ -3030,13 +3035,6 @@ change. The variables are: supposed to be differences, but occasionally theory and practice don't coordinate with each other.) -`GAWK_NO_PP_RUN' - If this variable exists, then when invoked with the - `--pretty-print' option, `gawk' skips running the program. - - CAUTION: This variable will not survive into the next major - release. - `GAWK_STACKSIZE' This specifies the amount by which `gawk' should grow its internal evaluation stack, when needed. @@ -3428,15 +3426,18 @@ sequences apply to both string constants and regexp constants: `\xHH...' The hexadecimal value HH, where HH stands for a sequence of - hexadecimal digits (`0'-`9', and either `A'-`F' or `a'-`f'). Like - the same construct in ISO C, the escape sequence continues until - the first nonhexadecimal digit is seen. (c.e.) However, using - more than two hexadecimal digits produces undefined results. (The - `\x' escape sequence is not allowed in POSIX `awk'.) - - CAUTION: The next major relase of `gawk' will change, such - that a maximum of two hexadecimal digits following the `\x' - will be used. + hexadecimal digits (`0'-`9', and either `A'-`F' or `a'-`f'). A + maximum of two digts are allowed after the `\x'. Any further + hexadecimal digits are treated as simple letters or numbers. + (c.e.) (The `\x' escape sequence is not allowed in POSIX awk.) + + CAUTION: In ISO C, the escape sequence continues until the + first nonhexadecimal digit is seen. For many years, `gawk' + would continue incorporating hexadecimal digits into the + value until a non-hexadecimal digit or the end of the string + was encountered. However, using more than two hexadecimal + digits produced undefined results. As of version *FIXME:* + 4.3.0, only two digits are processed. `\/' A literal slash (necessary for regexp constants only). This @@ -10309,10 +10310,18 @@ Options::), they are not special. An associative array containing the values of the environment. The array indices are the environment variable names; the elements are the values of the particular environment variables. For - example, `ENVIRON["HOME"]' might be `"/home/arnold"'. Changing - this array does not affect the environment passed on to any - programs that `awk' may spawn via redirection or the `system()' - function. (In a future version of `gawk', it may do so.) + example, `ENVIRON["HOME"]' might be `/home/arnold'. + + For POSIX `awk', changing this array does not affect the + environment passed on to any programs that `awk' may spawn via + redirection or the `system()' function. + + However, beginning with version 4.2, if not in POSIX compatibility + mode, `gawk' does update its own environment when `ENVIRON' is + changed, thus changing the environment seen by programs that it + creates. You should therefore be especially careful if you modify + `ENVIRON["PATH"]"', which is the search path for finding + executable programs. Some operating systems may not have environment variables. On such systems, the `ENVIRON' array is empty (except for @@ -11862,6 +11871,21 @@ brackets ([ ]): `cos(X)' Return the cosine of X, with X in radians. +`div(NUMERATOR, DENOMINATOR, RESULT)' + Perform integer division, similar to the standard C function of the + same name. First, truncate `numerator' and `denominator' towards + zero, creating integer values. Clear the `result' array, and then + set `result["quotient"]' to the result of `numerator / + denominator', truncated towards zero to an integer, and set + `result["remainder"]' to the result of `numerator % denominator', + truncated towards zero to an integer. This function is primarily + intended for use with arbitrary length integers; it avoids + creating MPFR arbitrary precision floating-point values (*note + Arbitrary Precision Integers::). + + This function is a `gawk' extension. It is not available in + compatibility mode (*note Options::). + `exp(X)' Return the exponential of X (`e ^ X') or report an error if X is out of range. The range of values X can have depends on your @@ -19852,8 +19876,7 @@ output. They are as follows: you typed when you wrote it. This is because `gawk' creates the profiled version by "pretty printing" its internal representation of the program. The advantage to this is that `gawk' can produce a -standard representation. The disadvantage is that all source-code -comments are lost. Also, things such as: +standard representation. Also, things such as: /foo/ @@ -19912,8 +19935,24 @@ by the `Ctrl-<\>' key. called this way, `gawk' "pretty prints" the program into `awkprof.out', without any execution counts. - NOTE: The `--pretty-print' option still runs your program. This - will change in the next major release. + NOTE: Once upon a time, the `--pretty-print' option would also run + your program. This is is no longer the case. + + There is a significant difference between the output created when +profiling, and that created when pretty-printing. Pretty-printed output +preserves the original comments that were in the program, although their +placement may not correspond exactly to their original locations in the +source code. + + However, as a deliberate design decision, profiling output _omits_ +the original program's comments. This allows you to focus on the +execution count data and helps you avoid the temptation to use the +profiler for pretty-printing. + + Additionally, pretty-printed output does not have the leading +indentation that the profiling output does. This makes it easy to +pretty-print your code once development is completed, and then use the +result as the final version of your program. File: gawk.info, Node: Advanced Features Summary, Prev: Profiling, Up: Advanced Features @@ -22398,6 +22437,62 @@ just use the following: gawk -M 'BEGIN { n = 13; print n % 2 }' + When dividing two arbitrary precision integers with either `/' or +`%', the result is typically an arbitrary precision floating point +value (unless the denominator evenly divides into the numerator). In +order to do integer division or remainder with arbitrary precision +integers, use the built-in `div()' function (*note Numeric Functions::). + + You can simulate the `div()' function in standard `awk' using this +user-defined function: + + # div --- do integer division + + function div(numerator, denominator, result) + { + split("", result) + + numerator = int(numerator) + denominator = int(denominator) + result["quotient"] = int(numerator / denominator) + result["remainder"] = int(numerator % denominator) + + return 0.0 + } + + The following example program, contributed by Katie Wasserman, uses +`div()' to compute the digits of pi to as many places as you choose to +set: + + # pi.awk --- compute the digits of pi + + BEGIN { + digits = 100000 + two = 2 * 10 ^ digits + pi = two + for (m = digits * 4; m > 0; --m) { + d = m * 2 + 1 + x = pi * m + div(x, d, result) + pi = result["quotient"] + pi = pi + two + } + print pi + } + + When asked about the algorithm used, Katie replied: + + It's not that well known but it's not that obscure either. It's + Euler's modification to Newton's method for calculating pi. Take + a look at lines (23) - (25) here: + `http://mathworld.wolfram.com/PiFormulas.htm'. + + The algorithm I wrote simply expands the multiply by 2 and works + from the innermost expression outwards. I used this to program HP + calculators because it's quite easy to modify for tiny memory + devices with smallish word sizes. See + `http://www.hpmuseum.org/cgi-sys/cgiwrap/hpmuseum/articles.cgi?read=899'. + ---------- Footnotes ---------- (1) Weisstein, Eric W. `Sylvester's Sequence'. From MathWorld--A @@ -26422,6 +26517,8 @@ the current version of `gawk'. - Ultrix + * Support for MirBSD was removed at `gawk' version 4.2. + File: gawk.info, Node: Feature History, Next: Common Extensions, Prev: POSIX/GNU, Up: Language History @@ -27324,7 +27421,9 @@ Various `.c', `.y', and `.h' files `doc/igawk.1' The `troff' source for a manual page describing the `igawk' - program presented in *note Igawk Program::. + program presented in *note Igawk Program::. (Since `gawk' can do + its own `@include' processing, neither `igawk' nor `igawk.1' are + installed.) `doc/Makefile.in' The input file used during the configuration process to generate @@ -27366,17 +27465,23 @@ Various `.c', `.y', and `.h' files contains a `Makefile.in' file, which `configure' uses to generate a `Makefile'. `Makefile.am' is used by GNU Automake to create `Makefile.in'. The library functions from *note Library - Functions::, and the `igawk' program from *note Igawk Program::, - are included as ready-to-use files in the `gawk' distribution. - They are installed as part of the installation process. The rest - of the programs in this Info file are available in appropriate - subdirectories of `awklib/eg'. + Functions::, are included as ready-to-use files in the `gawk' + distribution. They are installed as part of the installation + process. The rest of the programs in this Info file are available + in appropriate subdirectories of `awklib/eg'. `extension/*' The source code, manual pages, and infrastructure files for the sample extensions included with `gawk'. *Note Dynamic Extensions::, for more information. +`extras/*' + Additional non-essential files. Currently, this directory + contains some shell startup files to be installed in + `/etc/profile.d' to aid in manipulating the `AWKPATH' and + `AWKLIBPATH' environment variables. *Note Shell Startup Files::, + for more information. + `posix/*' Files needed for building `gawk' on POSIX-compliant systems. @@ -27407,11 +27512,12 @@ configure `gawk' for your system yourself. * Menu: * Quick Installation:: Compiling `gawk' under Unix. +* Shell Startup Files:: Shell convenience functions. * Additional Configuration Options:: Other compile-time options. * Configuration Philosophy:: How it's all supposed to work. -File: gawk.info, Node: Quick Installation, Next: Additional Configuration Options, Up: Unix Installation +File: gawk.info, Node: Quick Installation, Next: Shell Startup Files, Up: Unix Installation B.2.1 Compiling `gawk' for Unix-like Systems -------------------------------------------- @@ -27468,9 +27574,43 @@ will be asked for your password, and you will have to have been set up previously as a user who is allowed to run the `sudo' command. -File: gawk.info, Node: Additional Configuration Options, Next: Configuration Philosophy, Prev: Quick Installation, Up: Unix Installation +File: gawk.info, Node: Shell Startup Files, Next: Additional Configuration Options, Prev: Quick Installation, Up: Unix Installation + +B.2.2 Shell Startup Files +------------------------- + +The distribution contains shell startup files `gawk.sh' and `gawk.csh' +containing functions to aid in manipulating the `AWKPATH' and +`AWKLIBPATH' environment variables. On a Fedora system, these files +should be installed in `/etc/profile.d'; on other platforms, the +appropriate location may be different. + +`gawkpath_default' + Reset the `AWKPATH' environment variable to its default value. + +`gawkpath_prepend' + Add the argument to the front of the `AWKPATH' environment + variable. + +`gawkpath_append' + Add the argument to the end of the `AWKPATH' environment variable. + +`gawklibpath_default' + Reset the `AWKLIBPATH' environment variable to its default value. + +`gawklibpath_prepend' + Add the argument to the front of the `AWKLIBPATH' environment + variable. + +`gawklibpath_append' + Add the argument to the end of the `AWKLIBPATH' environment + variable. + + + +File: gawk.info, Node: Additional Configuration Options, Next: Configuration Philosophy, Prev: Shell Startup Files, Up: Unix Installation -B.2.2 Additional Configuration Options +B.2.3 Additional Configuration Options -------------------------------------- There are several additional options you may use on the `configure' @@ -27512,7 +27652,7 @@ that `configure' supplies. File: gawk.info, Node: Configuration Philosophy, Prev: Additional Configuration Options, Up: Unix Installation -B.2.3 The Configuration Process +B.2.4 The Configuration Process ------------------------------- This minor node is of interest only if you know something about using @@ -31316,20 +31456,20 @@ Index * --include option: Options. (line 159) * --lint option <1>: Options. (line 185) * --lint option: Command Line. (line 20) -* --lint-old option: Options. (line 297) +* --lint-old option: Options. (line 295) * --load option: Options. (line 173) * --non-decimal-data option <1>: Nondecimal Data. (line 6) * --non-decimal-data option: Options. (line 211) * --non-decimal-data option, strtonum() function and: Nondecimal Data. (line 35) -* --optimize option: Options. (line 239) -* --posix option: Options. (line 256) -* --posix option, --traditional option and: Options. (line 275) +* --optimize option: Options. (line 237) +* --posix option: Options. (line 254) +* --posix option, --traditional option and: Options. (line 273) * --pretty-print option: Options. (line 226) * --profile option <1>: Profiling. (line 12) -* --profile option: Options. (line 244) -* --re-interval option: Options. (line 281) -* --sandbox option: Options. (line 288) +* --profile option: Options. (line 242) +* --re-interval option: Options. (line 279) +* --sandbox option: Options. (line 286) * --sandbox option, disabling system() function: I/O Functions. (line 96) * --sandbox option, input redirection with getline: Getline. (line 19) @@ -31337,9 +31477,9 @@ Index (line 6) * --source option: Options. (line 117) * --traditional option: Options. (line 81) -* --traditional option, --posix option and: Options. (line 275) +* --traditional option, --posix option and: Options. (line 273) * --use-lc-numeric option: Options. (line 221) -* --version option: Options. (line 302) +* --version option: Options. (line 300) * --with-whiny-user-strftime configuration option: Additional Configuration Options. (line 35) * -b option: Options. (line 68) @@ -31347,32 +31487,32 @@ Index * -c option: Options. (line 81) * -D option: Options. (line 108) * -d option: Options. (line 93) -* -e option: Options. (line 338) +* -e option: Options. (line 336) * -E option: Options. (line 125) * -e option: Options. (line 117) * -f option: Options. (line 25) * -F option: Options. (line 21) * -f option: Long. (line 12) -* -F option, -Ft sets FS to TAB: Options. (line 310) +* -F option, -Ft sets FS to TAB: Options. (line 308) * -F option, command-line: Command Line Field Separator. (line 6) -* -f option, multiple uses: Options. (line 315) +* -f option, multiple uses: Options. (line 313) * -g option: Options. (line 147) * -h option: Options. (line 154) * -i option: Options. (line 159) -* -L option: Options. (line 297) +* -L option: Options. (line 295) * -l option: Options. (line 173) * -M option: Options. (line 205) * -N option: Options. (line 221) * -n option: Options. (line 211) -* -O option: Options. (line 239) +* -O option: Options. (line 237) * -o option: Options. (line 226) -* -P option: Options. (line 256) -* -p option: Options. (line 244) -* -r option: Options. (line 281) -* -S option: Options. (line 288) +* -P option: Options. (line 254) +* -p option: Options. (line 242) +* -r option: Options. (line 279) +* -S option: Options. (line 286) * -v option: Assignment Options. (line 12) -* -V option: Options. (line 302) +* -V option: Options. (line 300) * -v option: Options. (line 32) * -W option: Options. (line 46) * . (period), regexp operator: Regexp Operators. (line 44) @@ -31434,10 +31574,10 @@ Index (line 8) * [] (square brackets), regexp operator: Regexp Operators. (line 56) * \ (backslash): Comments. (line 50) -* \ (backslash), \" escape sequence: Escape Sequences. (line 82) +* \ (backslash), \" escape sequence: Escape Sequences. (line 85) * \ (backslash), \' operator (gawk): GNU Regexp Operators. (line 56) -* \ (backslash), \/ escape sequence: Escape Sequences. (line 73) +* \ (backslash), \/ escape sequence: Escape Sequences. (line 76) * \ (backslash), \< operator (gawk): GNU Regexp Operators. (line 30) * \ (backslash), \> operator (gawk): GNU Regexp Operators. @@ -31477,7 +31617,7 @@ Index * \ (backslash), in bracket expressions: Bracket Expressions. (line 17) * \ (backslash), in escape sequences: Escape Sequences. (line 6) * \ (backslash), in escape sequences, POSIX and: Escape Sequences. - (line 118) + (line 121) * \ (backslash), in regexp constants: Computed Regexps. (line 29) * \ (backslash), in shell commands: Quoting. (line 48) * \ (backslash), regexp operator: Regexp Operators. (line 18) @@ -31645,7 +31785,7 @@ Index * awf (amazingly workable formatter) program: Glossary. (line 24) * awk debugging, enabling: Options. (line 108) * awk language, POSIX version: Assignment Ops. (line 137) -* awk profiling, enabling: Options. (line 244) +* awk profiling, enabling: Options. (line 242) * awk programs <1>: Two Rules. (line 6) * awk programs <2>: Executable Scripts. (line 6) * awk programs: Getting Started. (line 12) @@ -31703,10 +31843,10 @@ Index * awkvars.out file: Options. (line 93) * b debugger command (alias for break): Breakpoint Control. (line 11) * backslash (\): Comments. (line 50) -* backslash (\), \" escape sequence: Escape Sequences. (line 82) +* backslash (\), \" escape sequence: Escape Sequences. (line 85) * backslash (\), \' operator (gawk): GNU Regexp Operators. (line 56) -* backslash (\), \/ escape sequence: Escape Sequences. (line 73) +* backslash (\), \/ escape sequence: Escape Sequences. (line 76) * backslash (\), \< operator (gawk): GNU Regexp Operators. (line 30) * backslash (\), \> operator (gawk): GNU Regexp Operators. @@ -31746,7 +31886,7 @@ Index * backslash (\), in bracket expressions: Bracket Expressions. (line 17) * backslash (\), in escape sequences: Escape Sequences. (line 6) * backslash (\), in escape sequences, POSIX and: Escape Sequences. - (line 118) + (line 121) * backslash (\), in regexp constants: Computed Regexps. (line 29) * backslash (\), in shell commands: Quoting. (line 48) * backslash (\), regexp operator: Regexp Operators. (line 18) @@ -31852,7 +31992,7 @@ Index (line 67) * Brian Kernighan's awk <12>: GNU Regexp Operators. (line 83) -* Brian Kernighan's awk <13>: Escape Sequences. (line 122) +* Brian Kernighan's awk <13>: Escape Sequences. (line 125) * Brian Kernighan's awk: When. (line 21) * Brian Kernighan's awk, extensions: BTL. (line 6) * Brian Kernighan's awk, source code: Other Versions. (line 13) @@ -32046,7 +32186,7 @@ Index * cosine: Numeric Functions. (line 15) * counting: Wc Program. (line 6) * csh utility: Statements/Lines. (line 44) -* csh utility, POSIXLY_CORRECT environment variable: Options. (line 356) +* csh utility, POSIXLY_CORRECT environment variable: Options. (line 354) * csh utility, |& operator, comparison with: Two-way I/O. (line 25) * ctime() user-defined function: Function Example. (line 74) * currency symbols, localization: Explaining gettext. (line 104) @@ -32077,13 +32217,13 @@ Index * dark corner, CONVFMT variable: Strings And Numbers. (line 40) * dark corner, escape sequences: Other Arguments. (line 38) * dark corner, escape sequences, for metacharacters: Escape Sequences. - (line 140) + (line 143) * dark corner, exit statement: Exit Statement. (line 30) * dark corner, field separators: Field Splitting Summary. (line 46) -* dark corner, FILENAME variable <1>: Auto-set. (line 90) +* dark corner, FILENAME variable <1>: Auto-set. (line 98) * dark corner, FILENAME variable: Getline Notes. (line 19) -* dark corner, FNR/NR variables: Auto-set. (line 313) +* dark corner, FNR/NR variables: Auto-set. (line 321) * dark corner, format-control characters: Control Letters. (line 18) * dark corner, FS as null string: Single Character Fields. (line 20) @@ -32233,7 +32373,7 @@ Index * debugger, read commands from a file: Debugger Info. (line 96) * debugging awk programs: Debugger. (line 6) * debugging gawk, bug reports: Bugs. (line 9) -* decimal point character, locale specific: Options. (line 272) +* decimal point character, locale specific: Options. (line 270) * decrement operators: Increment Ops. (line 35) * default keyword: Switch Statement. (line 6) * Deifik, Scott <1>: Bugs. (line 72) @@ -32272,12 +32412,12 @@ Index (line 81) * differences in awk and gawk, command-line directories: Command-line directories. (line 6) -* differences in awk and gawk, ERRNO variable: Auto-set. (line 74) +* differences in awk and gawk, ERRNO variable: Auto-set. (line 82) * differences in awk and gawk, error messages: Special FD. (line 19) * differences in awk and gawk, FIELDWIDTHS variable: User-modified. (line 37) * differences in awk and gawk, FPAT variable: User-modified. (line 43) -* differences in awk and gawk, FUNCTAB variable: Auto-set. (line 115) +* differences in awk and gawk, FUNCTAB variable: Auto-set. (line 123) * differences in awk and gawk, function arguments (gawk): Calling Built-in. (line 16) * differences in awk and gawk, getline command: Getline. (line 19) @@ -32300,7 +32440,7 @@ Index (line 262) * differences in awk and gawk, print/printf statements: Format Modifiers. (line 13) -* differences in awk and gawk, PROCINFO array: Auto-set. (line 129) +* differences in awk and gawk, PROCINFO array: Auto-set. (line 137) * differences in awk and gawk, read timeouts: Read Timeout. (line 6) * differences in awk and gawk, record separators: awk split records. (line 125) @@ -32310,7 +32450,7 @@ Index (line 26) * differences in awk and gawk, RS/RT variables: gawk split records. (line 58) -* differences in awk and gawk, RT variable: Auto-set. (line 264) +* differences in awk and gawk, RT variable: Auto-set. (line 272) * differences in awk and gawk, single-character fields: Single Character Fields. (line 6) * differences in awk and gawk, split() function: String Functions. @@ -32318,7 +32458,7 @@ Index * differences in awk and gawk, strings: Scalar Constants. (line 20) * differences in awk and gawk, strings, storing: gawk split records. (line 77) -* differences in awk and gawk, SYMTAB variable: Auto-set. (line 268) +* differences in awk and gawk, SYMTAB variable: Auto-set. (line 276) * differences in awk and gawk, TEXTDOMAIN variable: User-modified. (line 151) * differences in awk and gawk, trunc-mod operation: Arithmetic Ops. @@ -32334,6 +32474,7 @@ Index * display debugger command: Viewing And Changing Data. (line 8) * display debugger options: Debugger Info. (line 57) +* div: Numeric Functions. (line 18) * division: Arithmetic Ops. (line 44) * do-while statement: Do Statement. (line 6) * do-while statement, use of regexps in: Regexp Usage. (line 19) @@ -32354,12 +32495,12 @@ Index * dump debugger command: Miscellaneous Debugger Commands. (line 9) * dupword.awk program: Dupword Program. (line 31) -* dynamic profiling: Profiling. (line 179) +* dynamic profiling: Profiling. (line 178) * dynamically loaded extensions: Dynamic Extensions. (line 6) * e debugger command (alias for enable): Breakpoint Control. (line 73) * EBCDIC: Ordinal Functions. (line 45) -* effective group ID of gawk user: Auto-set. (line 134) -* effective user ID of gawk user: Auto-set. (line 138) +* effective group ID of gawk user: Auto-set. (line 142) +* effective user ID of gawk user: Auto-set. (line 146) * egrep utility <1>: Egrep Program. (line 6) * egrep utility: Bracket Expressions. (line 26) * egrep.awk program: Egrep Program. (line 54) @@ -32414,13 +32555,13 @@ Index (line 11) * EREs (Extended Regular Expressions): Bracket Expressions. (line 26) * ERRNO variable <1>: TCP/IP Networking. (line 54) -* ERRNO variable: Auto-set. (line 74) +* ERRNO variable: Auto-set. (line 82) * ERRNO variable, with BEGINFILE pattern: BEGINFILE/ENDFILE. (line 26) * ERRNO variable, with close() function: Close Files And Pipes. (line 140) * ERRNO variable, with getline command: Getline. (line 19) * error handling: Special FD. (line 19) -* error handling, ERRNO variable and: Auto-set. (line 74) +* error handling, ERRNO variable and: Auto-set. (line 82) * error output: Special FD. (line 6) * escape processing, gsub()/gensub()/sub() functions: Gory Details. (line 6) @@ -32453,10 +32594,10 @@ Index * exit status, of VMS: VMS Running. (line 29) * exit the debugger: Miscellaneous Debugger Commands. (line 99) -* exp: Numeric Functions. (line 18) +* exp: Numeric Functions. (line 33) * expand utility: Very Simple. (line 72) * Expat XML parser library: gawkextlib. (line 31) -* exponent: Numeric Functions. (line 18) +* exponent: Numeric Functions. (line 33) * expressions: Expressions. (line 6) * expressions, as patterns: Expression Patterns. (line 6) * expressions, assignment: Assignment Ops. (line 6) @@ -32474,7 +32615,7 @@ Index (line 6) * extension API version: Extension Versioning. (line 6) -* extension API, version number: Auto-set. (line 231) +* extension API, version number: Auto-set. (line 239) * extension example: Extension Example. (line 6) * extension registration: Registration Functions. (line 6) @@ -32556,7 +32697,7 @@ Index * file names, distinguishing: Auto-set. (line 56) * file names, in compatibility mode: Special Caveats. (line 9) * file names, standard streams in gawk: Special FD. (line 48) -* FILENAME variable <1>: Auto-set. (line 90) +* FILENAME variable <1>: Auto-set. (line 98) * FILENAME variable: Reading Files. (line 6) * FILENAME variable, getline, setting with: Getline Notes. (line 19) * filenames, assignments as: Ignoring Assigns. (line 6) @@ -32624,9 +32765,9 @@ Index * flush buffered output: I/O Functions. (line 28) * fnmatch() extension function: Extension Sample Fnmatch. (line 12) -* FNR variable <1>: Auto-set. (line 99) +* FNR variable <1>: Auto-set. (line 107) * FNR variable: Records. (line 6) -* FNR variable, changing: Auto-set. (line 313) +* FNR variable, changing: Auto-set. (line 321) * for statement: For Statement. (line 6) * for statement, looping over arrays: Scanning an Array. (line 20) * fork() extension function: Extension Sample Fork. @@ -32663,7 +32804,7 @@ Index * FS variable, --field-separator option and: Options. (line 21) * FS variable, as null string: Single Character Fields. (line 20) -* FS variable, as TAB character: Options. (line 268) +* FS variable, as TAB character: Options. (line 266) * FS variable, changing value of: Field Separators. (line 35) * FS variable, running awk programs and: Cut Program. (line 63) * FS variable, setting from command line: Command Line Field Separator. @@ -32676,7 +32817,7 @@ Index * FSF (Free Software Foundation): Manual History. (line 6) * fts() extension function: Extension Sample File Functions. (line 61) -* FUNCTAB array: Auto-set. (line 115) +* FUNCTAB array: Auto-set. (line 123) * function calls: Function Calls. (line 6) * function calls, indirect: Indirect Calls. (line 6) * function calls, indirect, @-notation for: Indirect Calls. (line 47) @@ -32725,8 +32866,8 @@ Index (line 44) * G-d: Acknowledgments. (line 94) * Garfinkle, Scott: Contributors. (line 34) -* gawk program, dynamic profiling: Profiling. (line 179) -* gawk version: Auto-set. (line 206) +* gawk program, dynamic profiling: Profiling. (line 178) +* gawk version: Auto-set. (line 214) * gawk, ARGIND variable in: Other Arguments. (line 15) * gawk, awk and <1>: This Manual. (line 14) * gawk, awk and: Preface. (line 21) @@ -32744,13 +32885,13 @@ Index * gawk, distribution: Distribution contents. (line 6) * gawk, ERRNO variable in <1>: TCP/IP Networking. (line 54) -* gawk, ERRNO variable in <2>: Auto-set. (line 74) +* gawk, ERRNO variable in <2>: Auto-set. (line 82) * gawk, ERRNO variable in <3>: BEGINFILE/ENDFILE. (line 26) * gawk, ERRNO variable in <4>: Close Files And Pipes. (line 140) * gawk, ERRNO variable in: Getline. (line 19) -* gawk, escape sequences: Escape Sequences. (line 130) -* gawk, extensions, disabling: Options. (line 256) +* gawk, escape sequences: Escape Sequences. (line 133) +* gawk, extensions, disabling: Options. (line 254) * gawk, features, adding: Adding Code. (line 6) * gawk, features, advanced: Advanced Features. (line 6) * gawk, field separators and: User-modified. (line 71) @@ -32761,7 +32902,7 @@ Index * gawk, FPAT variable in <1>: User-modified. (line 43) * gawk, FPAT variable in: Splitting By Content. (line 27) -* gawk, FUNCTAB array in: Auto-set. (line 115) +* gawk, FUNCTAB array in: Auto-set. (line 123) * gawk, function arguments and: Calling Built-in. (line 16) * gawk, hexadecimal numbers and: Nondecimal-numbers. (line 42) * gawk, IGNORECASE variable in <1>: Array Sorting Functions. @@ -32793,7 +32934,7 @@ Index * gawk, predefined variables and: Built-in Variables. (line 14) * gawk, PROCINFO array in <1>: Two-way I/O. (line 99) * gawk, PROCINFO array in <2>: Time Functions. (line 47) -* gawk, PROCINFO array in: Auto-set. (line 129) +* gawk, PROCINFO array in: Auto-set. (line 137) * gawk, regexp constants and: Using Constant Regexps. (line 28) * gawk, regular expressions, case sensitivity: Case-sensitivity. @@ -32801,23 +32942,29 @@ Index * gawk, regular expressions, operators: GNU Regexp Operators. (line 6) * gawk, regular expressions, precedence: Regexp Operators. (line 161) -* gawk, RT variable in <1>: Auto-set. (line 264) +* gawk, RT variable in <1>: Auto-set. (line 272) * gawk, RT variable in <2>: Multiple Line. (line 129) * gawk, RT variable in: awk split records. (line 125) * gawk, See Also awk: Preface. (line 34) * gawk, source code, obtaining: Getting. (line 6) * gawk, splitting fields and: Constant Size. (line 88) * gawk, string-translation functions: I18N Functions. (line 6) -* gawk, SYMTAB array in: Auto-set. (line 268) +* gawk, SYMTAB array in: Auto-set. (line 276) * gawk, TEXTDOMAIN variable in: User-modified. (line 151) * gawk, timestamps: Time Functions. (line 6) * gawk, uses for: Preface. (line 34) -* gawk, versions of, information about, printing: Options. (line 302) +* gawk, versions of, information about, printing: Options. (line 300) * gawk, VMS version of: VMS Installation. (line 6) * gawk, word-boundary operator: GNU Regexp Operators. (line 63) * gawkextlib: gawkextlib. (line 6) * gawkextlib project: gawkextlib. (line 6) +* gawklibpath_append shell function: Shell Startup Files. (line 29) +* gawklibpath_default shell function: Shell Startup Files. (line 22) +* gawklibpath_prepend shell function: Shell Startup Files. (line 25) +* gawkpath_append shell function: Shell Startup Files. (line 19) +* gawkpath_default shell function: Shell Startup Files. (line 12) +* gawkpath_prepend shell function: Shell Startup Files. (line 15) * General Public License (GPL): Glossary. (line 305) * General Public License, See GPL: Manual History. (line 11) * generate time values: Time Functions. (line 25) @@ -32894,7 +33041,7 @@ Index * Grigera, Juan: Contributors. (line 57) * group database, reading: Group Functions. (line 6) * group file: Group Functions. (line 6) -* group ID of gawk user: Auto-set. (line 179) +* group ID of gawk user: Auto-set. (line 187) * groups, information about: Group Functions. (line 6) * gsub <1>: String Functions. (line 139) * gsub: Using Constant Regexps. @@ -32916,7 +33063,7 @@ Index * history expansion, in debugger: Readline Support. (line 6) * histsort.awk program: History Sorting. (line 25) * Hughes, Phil: Acknowledgments. (line 43) -* HUP signal, for dynamic profiling: Profiling. (line 211) +* HUP signal, for dynamic profiling: Profiling. (line 210) * hyphen (-), - operator: Precedence. (line 52) * hyphen (-), -- operator <1>: Precedence. (line 46) * hyphen (-), -- operator: Increment Ops. (line 48) @@ -32995,8 +33142,8 @@ Index * installation, VMS: VMS Installation. (line 6) * installing gawk: Installation. (line 6) * instruction tracing, in debugger: Debugger Info. (line 89) -* int: Numeric Functions. (line 23) -* INT signal (MS-Windows): Profiling. (line 214) +* int: Numeric Functions. (line 38) +* INT signal (MS-Windows): Profiling. (line 213) * integer array indices: Numeric Array Subscripts. (line 31) * integers, arbitrary precision: Arbitrary Precision Integers. @@ -33052,7 +33199,7 @@ Index * Kernighan, Brian <9>: Acknowledgments. (line 78) * Kernighan, Brian <10>: Conventions. (line 38) * Kernighan, Brian: History. (line 17) -* kill command, dynamic profiling: Profiling. (line 188) +* kill command, dynamic profiling: Profiling. (line 187) * Knights, jedi: Undocumented. (line 6) * Kwok, Conrad: Contributors. (line 34) * l debugger command (alias for list): Miscellaneous Debugger Commands. @@ -33124,7 +33271,7 @@ Index * lint checking, empty programs: Command Line. (line 16) * lint checking, issuing warnings: Options. (line 185) * lint checking, POSIXLY_CORRECT environment variable: Options. - (line 341) + (line 339) * lint checking, undefined functions: Pass By Value/Reference. (line 88) * LINT variable: User-modified. (line 88) @@ -33140,14 +33287,14 @@ Index * loading, extensions: Options. (line 173) * local variables, in a function: Variable Scope. (line 6) * locale categories: Explaining gettext. (line 81) -* locale decimal point character: Options. (line 272) +* locale decimal point character: Options. (line 270) * locale, definition of: Locales. (line 6) * localization: I18N and L10N. (line 6) * localization, See internationalization, localization: I18N and L10N. (line 6) -* log: Numeric Functions. (line 30) +* log: Numeric Functions. (line 45) * log files, timestamps in: Time Functions. (line 6) -* logarithm: Numeric Functions. (line 30) +* logarithm: Numeric Functions. (line 45) * logical false/true: Truth Values. (line 6) * logical operators, See Boolean expressions: Boolean Ops. (line 6) * login information: Passwd Functions. (line 16) @@ -33188,8 +33335,8 @@ Index * mawk utility <2>: Nextfile Statement. (line 47) * mawk utility <3>: Concatenation. (line 36) * mawk utility <4>: Getline/Pipe. (line 62) -* mawk utility: Escape Sequences. (line 130) -* maximum precision supported by MPFR library: Auto-set. (line 220) +* mawk utility: Escape Sequences. (line 133) +* maximum precision supported by MPFR library: Auto-set. (line 228) * McIlroy, Doug: Glossary. (line 149) * McPhee, Patrick: Contributors. (line 100) * message object files: Explaining gettext. (line 42) @@ -33201,8 +33348,8 @@ Index (line 54) * messages from extensions: Printing Messages. (line 6) * metacharacters in regular expressions: Regexp Operators. (line 6) -* metacharacters, escape sequences for: Escape Sequences. (line 136) -* minimum precision supported by MPFR library: Auto-set. (line 223) +* metacharacters, escape sequences for: Escape Sequences. (line 139) +* minimum precision supported by MPFR library: Auto-set. (line 231) * mktime: Time Functions. (line 25) * modifiers, in format specifiers: Format Modifiers. (line 6) * monetary information, localization: Explaining gettext. (line 104) @@ -33222,7 +33369,7 @@ Index * networks, programming: TCP/IP Networking. (line 6) * networks, support for: Special Network. (line 6) * newlines <1>: Boolean Ops. (line 69) -* newlines <2>: Options. (line 262) +* newlines <2>: Options. (line 260) * newlines: Statements/Lines. (line 6) * newlines, as field separators: Default Field Splitting. (line 6) @@ -33251,7 +33398,7 @@ Index (line 47) * nexti debugger command: Debugger Execution Control. (line 49) -* NF variable <1>: Auto-set. (line 104) +* NF variable <1>: Auto-set. (line 112) * NF variable: Fields. (line 33) * NF variable, decrementing: Changing Fields. (line 107) * ni debugger command (alias for nexti): Debugger Execution Control. @@ -33260,9 +33407,9 @@ Index * non-existent array elements: Reference to Elements. (line 23) * not Boolean-logic operator: Boolean Ops. (line 6) -* NR variable <1>: Auto-set. (line 124) +* NR variable <1>: Auto-set. (line 132) * NR variable: Records. (line 6) -* NR variable, changing: Auto-set. (line 313) +* NR variable, changing: Auto-set. (line 321) * null strings <1>: Basic Data Typing. (line 26) * null strings <2>: Truth Values. (line 6) * null strings <3>: Regexp Field Splitting. @@ -33376,7 +33523,7 @@ Index * p debugger command (alias for print): Viewing And Changing Data. (line 36) * Papadopoulos, Panos: Contributors. (line 128) -* parent process ID of gawk process: Auto-set. (line 188) +* parent process ID of gawk process: Auto-set. (line 196) * parentheses (), in a profile: Profiling. (line 146) * parentheses (), regexp operator: Regexp Operators. (line 81) * password file: Passwd Functions. (line 16) @@ -33418,14 +33565,14 @@ Index * plus sign (+), += operator: Assignment Ops. (line 82) * plus sign (+), regexp operator: Regexp Operators. (line 105) * pointers to functions: Indirect Calls. (line 6) -* portability: Escape Sequences. (line 100) +* portability: Escape Sequences. (line 103) * portability, #! (executable scripts): Executable Scripts. (line 33) * portability, ** operator and: Arithmetic Ops. (line 81) * portability, **= operator and: Assignment Ops. (line 143) * portability, ARGV variable: Executable Scripts. (line 59) * portability, backslash continuation and: Statements/Lines. (line 30) * portability, backslash in escape sequences: Escape Sequences. - (line 118) + (line 121) * portability, close() function and: Close Files And Pipes. (line 81) * portability, data files as single record: gawk split records. @@ -33443,7 +33590,7 @@ Index * portability, NF variable, decrementing: Changing Fields. (line 115) * portability, operators: Increment Ops. (line 60) * portability, operators, not in POSIX awk: Precedence. (line 98) -* portability, POSIXLY_CORRECT environment variable: Options. (line 361) +* portability, POSIXLY_CORRECT environment variable: Options. (line 359) * portability, substr() function: String Functions. (line 511) * portable object files <1>: Translator i18n. (line 6) * portable object files: Explaining gettext. (line 37) @@ -33464,7 +33611,7 @@ Index * POSIX awk, < operator and: Getline/File. (line 26) * POSIX awk, arithmetic operators and: Arithmetic Ops. (line 30) * POSIX awk, backslashes in string constants: Escape Sequences. - (line 118) + (line 121) * POSIX awk, BEGIN/END patterns: I/O And BEGIN/END. (line 16) * POSIX awk, bracket expressions and: Bracket Expressions. (line 26) * POSIX awk, bracket expressions and, character classes: Bracket Expressions. @@ -33492,11 +33639,11 @@ Index * POSIX awk, regular expressions and: Regexp Operators. (line 161) * POSIX awk, timestamps and: Time Functions. (line 6) * POSIX awk, | I/O operator and: Getline/Pipe. (line 55) -* POSIX mode: Options. (line 256) +* POSIX mode: Options. (line 254) * POSIX, awk and: Preface. (line 21) * POSIX, gawk extensions not included in: POSIX/GNU. (line 6) * POSIX, programs, implementing in awk: Clones. (line 6) -* POSIXLY_CORRECT environment variable: Options. (line 341) +* POSIXLY_CORRECT environment variable: Options. (line 339) * PREC variable: User-modified. (line 123) * precedence <1>: Precedence. (line 6) * precedence: Increment Ops. (line 60) @@ -33543,24 +33690,24 @@ Index * printing, unduplicated lines of text: Uniq Program. (line 6) * printing, user information: Id Program. (line 6) * private variables: Library Names. (line 11) -* process group idIDof gawk process: Auto-set. (line 182) -* process ID of gawk process: Auto-set. (line 185) +* process group idIDof gawk process: Auto-set. (line 190) +* process ID of gawk process: Auto-set. (line 193) * processes, two-way communications with: Two-way I/O. (line 6) * processing data: Basic High Level. (line 6) * PROCINFO array <1>: Passwd Functions. (line 6) * PROCINFO array <2>: Time Functions. (line 47) -* PROCINFO array: Auto-set. (line 129) +* PROCINFO array: Auto-set. (line 137) * PROCINFO array, and communications via ptys: Two-way I/O. (line 99) * PROCINFO array, and group membership: Group Functions. (line 6) * PROCINFO array, and user and group ID numbers: Id Program. (line 15) * PROCINFO array, testing the field splitting: Passwd Functions. (line 154) -* PROCINFO array, uses: Auto-set. (line 241) +* PROCINFO array, uses: Auto-set. (line 249) * PROCINFO, values of sorted_in: Controlling Scanning. (line 26) * profiling awk programs: Profiling. (line 6) -* profiling awk programs, dynamically: Profiling. (line 179) -* program identifiers: Auto-set. (line 147) +* profiling awk programs, dynamically: Profiling. (line 178) +* program identifiers: Auto-set. (line 155) * program, definition of: Getting Started. (line 21) * programming conventions, --non-decimal-data option: Nondecimal Data. (line 35) @@ -33595,7 +33742,7 @@ Index * QuikTrim Awk: Other Versions. (line 135) * quit debugger command: Miscellaneous Debugger Commands. (line 99) -* QUIT signal (MS-Windows): Profiling. (line 214) +* QUIT signal (MS-Windows): Profiling. (line 213) * quoting in gawk command lines: Long. (line 26) * quoting in gawk command lines, tricks for: Quoting. (line 91) * quoting, for small awk programs: Comments. (line 27) @@ -33604,12 +33751,12 @@ Index * Rakitzis, Byron: History Sorting. (line 25) * Ramey, Chet <1>: General Data Types. (line 6) * Ramey, Chet: Acknowledgments. (line 60) -* rand: Numeric Functions. (line 35) +* rand: Numeric Functions. (line 50) * random numbers, Cliff: Cliff Random Function. (line 6) * random numbers, rand()/srand() functions: Numeric Functions. - (line 35) -* random numbers, seed of: Numeric Functions. (line 65) + (line 50) +* random numbers, seed of: Numeric Functions. (line 80) * range expressions (regexps): Bracket Expressions. (line 6) * range patterns: Ranges. (line 6) * range patterns, line continuation and: Ranges. (line 65) @@ -33678,7 +33825,7 @@ Index (line 59) * regular expressions, gawk, command-line options: GNU Regexp Operators. (line 70) -* regular expressions, interval expressions and: Options. (line 281) +* regular expressions, interval expressions and: Options. (line 279) * regular expressions, leftmost longest match: Leftmost Longest. (line 6) * regular expressions, operators <1>: Regexp Operators. (line 6) @@ -33718,7 +33865,7 @@ Index * right shift: Bitwise Functions. (line 53) * right shift, bitwise: Bitwise Functions. (line 32) * Ritchie, Dennis: Basic Data Typing. (line 54) -* RLENGTH variable: Auto-set. (line 251) +* RLENGTH variable: Auto-set. (line 259) * RLENGTH variable, match() function and: String Functions. (line 227) * Robbins, Arnold <1>: Future Extensions. (line 6) * Robbins, Arnold <2>: Bugs. (line 72) @@ -33736,7 +33883,7 @@ Index * Robbins, Miriam <2>: Getline/Pipe. (line 39) * Robbins, Miriam: Acknowledgments. (line 94) * Rommel, Kai Uwe: Contributors. (line 42) -* round to nearest integer: Numeric Functions. (line 23) +* round to nearest integer: Numeric Functions. (line 38) * round() user-defined function: Round Function. (line 16) * rounding numbers: Round Function. (line 6) * ROUNDMODE variable: User-modified. (line 127) @@ -33744,9 +33891,9 @@ Index * RS variable: awk split records. (line 12) * RS variable, multiline records and: Multiple Line. (line 17) * rshift: Bitwise Functions. (line 53) -* RSTART variable: Auto-set. (line 257) +* RSTART variable: Auto-set. (line 265) * RSTART variable, match() function and: String Functions. (line 227) -* RT variable <1>: Auto-set. (line 264) +* RT variable <1>: Auto-set. (line 272) * RT variable <2>: Multiple Line. (line 129) * RT variable: awk split records. (line 125) * Rubin, Paul <1>: Contributors. (line 15) @@ -33759,14 +33906,14 @@ Index (line 68) * sample debugging session: Sample Debugging Session. (line 6) -* sandbox mode: Options. (line 288) +* sandbox mode: Options. (line 286) * save debugger options: Debugger Info. (line 84) * scalar or array: Type Functions. (line 11) * scalar values: Basic Data Typing. (line 13) * scanning arrays: Scanning an Array. (line 6) * scanning multidimensional arrays: Multiscanning. (line 11) * Schorr, Andrew <1>: Contributors. (line 133) -* Schorr, Andrew <2>: Auto-set. (line 296) +* Schorr, Andrew <2>: Auto-set. (line 304) * Schorr, Andrew: Acknowledgments. (line 60) * Schreiber, Bert: Acknowledgments. (line 38) * Schreiber, Rita: Acknowledgments. (line 38) @@ -33786,7 +33933,7 @@ Index * sed utility <2>: Simple Sed. (line 6) * sed utility: Field Splitting Summary. (line 46) -* seeding random number generator: Numeric Functions. (line 65) +* seeding random number generator: Numeric Functions. (line 80) * semicolon (;), AWKPATH variable and: PC Using. (line 10) * semicolon (;), separating statements in actions <1>: Statements. (line 10) @@ -33847,14 +33994,14 @@ Index * sidebar, A Constant's Base Does Not Affect Its Value: Nondecimal-numbers. (line 64) * sidebar, Backslash Before Regular Characters: Escape Sequences. - (line 116) + (line 119) * sidebar, Changing FS Does Not Affect the Fields: Field Splitting Summary. (line 38) -* sidebar, Changing NR and FNR: Auto-set. (line 311) +* sidebar, Changing NR and FNR: Auto-set. (line 319) * sidebar, Controlling Output Buffering with system(): I/O Functions. (line 137) * sidebar, Escape Sequences for Metacharacters: Escape Sequences. - (line 134) + (line 137) * sidebar, FS and IGNORECASE: Field Splitting Summary. (line 64) * sidebar, Interactive Versus Noninteractive Buffering: I/O Functions. @@ -33876,19 +34023,19 @@ Index (line 57) * sidebar, Using close()'s Return Value: Close Files And Pipes. (line 130) -* SIGHUP signal, for dynamic profiling: Profiling. (line 211) -* SIGINT signal (MS-Windows): Profiling. (line 214) -* signals, HUP/SIGHUP, for profiling: Profiling. (line 211) -* signals, INT/SIGINT (MS-Windows): Profiling. (line 214) -* signals, QUIT/SIGQUIT (MS-Windows): Profiling. (line 214) -* signals, USR1/SIGUSR1, for profiling: Profiling. (line 188) +* SIGHUP signal, for dynamic profiling: Profiling. (line 210) +* SIGINT signal (MS-Windows): Profiling. (line 213) +* signals, HUP/SIGHUP, for profiling: Profiling. (line 210) +* signals, INT/SIGINT (MS-Windows): Profiling. (line 213) +* signals, QUIT/SIGQUIT (MS-Windows): Profiling. (line 213) +* signals, USR1/SIGUSR1, for profiling: Profiling. (line 187) * signature program: Signature Program. (line 6) -* SIGQUIT signal (MS-Windows): Profiling. (line 214) -* SIGUSR1 signal, for dynamic profiling: Profiling. (line 188) +* SIGQUIT signal (MS-Windows): Profiling. (line 213) +* SIGUSR1 signal, for dynamic profiling: Profiling. (line 187) * silent debugger command: Debugger Execution Control. (line 10) -* sin: Numeric Functions. (line 76) -* sine: Numeric Functions. (line 76) +* sin: Numeric Functions. (line 91) +* sine: Numeric Functions. (line 91) * single quote ('): One-shot. (line 15) * single quote (') in gawk command lines: Long. (line 35) * single quote ('), in shell commands: Quoting. (line 48) @@ -33938,10 +34085,10 @@ Index * sprintf() function, OFMT variable and: User-modified. (line 113) * sprintf() function, print/printf statements and: Round Function. (line 6) -* sqrt: Numeric Functions. (line 79) +* sqrt: Numeric Functions. (line 94) * square brackets ([]), regexp operator: Regexp Operators. (line 56) -* square root: Numeric Functions. (line 79) -* srand: Numeric Functions. (line 83) +* square root: Numeric Functions. (line 94) +* srand: Numeric Functions. (line 98) * stack frame: Debugging Terms. (line 10) * Stallman, Richard <1>: Glossary. (line 296) * Stallman, Richard <2>: Contributors. (line 23) @@ -34013,9 +34160,9 @@ Index * substr: String Functions. (line 480) * substring: String Functions. (line 480) * Sumner, Andrew: Other Versions. (line 64) -* supplementary groups of gawk process: Auto-set. (line 236) +* supplementary groups of gawk process: Auto-set. (line 244) * switch statement: Switch Statement. (line 6) -* SYMTAB array: Auto-set. (line 268) +* SYMTAB array: Auto-set. (line 276) * syntactic ambiguity: /= operator vs. /=.../ regexp constant: Assignment Ops. (line 148) * system: I/O Functions. (line 74) @@ -34082,7 +34229,7 @@ Index (line 37) * troubleshooting, awk uses FS not IFS: Field Separators. (line 30) * troubleshooting, backslash before nonspecial character: Escape Sequences. - (line 118) + (line 121) * troubleshooting, division: Arithmetic Ops. (line 44) * troubleshooting, fatal errors, field widths, specifying: Constant Size. (line 23) @@ -34138,7 +34285,7 @@ Index * uniq.awk program: Uniq Program. (line 65) * Unix: Glossary. (line 611) * Unix awk, backslashes in escape sequences: Escape Sequences. - (line 130) + (line 133) * Unix awk, close() function and: Close Files And Pipes. (line 132) * Unix awk, password files, field separators and: Command Line Field Separator. @@ -34158,7 +34305,7 @@ Index * user-modifiable variables: User-modified. (line 6) * users, information about, printing: Id Program. (line 6) * users, information about, retrieving: Passwd Functions. (line 16) -* USR1 signal, for dynamic profiling: Profiling. (line 188) +* USR1 signal, for dynamic profiling: Profiling. (line 187) * values, numeric: Basic Data Typing. (line 13) * values, string: Basic Data Typing. (line 13) * variable assignments and input files: Other Arguments. (line 26) @@ -34192,10 +34339,10 @@ Index * variables, uninitialized, as array subscripts: Uninitialized Subscripts. (line 6) * variables, user-defined: Variables. (line 6) -* version of gawk: Auto-set. (line 206) -* version of gawk extension API: Auto-set. (line 231) -* version of GNU MP library: Auto-set. (line 217) -* version of GNU MPFR library: Auto-set. (line 213) +* version of gawk: Auto-set. (line 214) +* version of gawk extension API: Auto-set. (line 239) +* version of GNU MP library: Auto-set. (line 225) +* version of GNU MPFR library: Auto-set. (line 221) * vertical bar (|): Regexp Operators. (line 70) * vertical bar (|), | operator (I/O) <1>: Precedence. (line 65) * vertical bar (|), | operator (I/O): Getline/Pipe. (line 9) @@ -34232,7 +34379,7 @@ Index * whitespace, as field separators: Default Field Splitting. (line 6) * whitespace, functions, calling: Calling Built-in. (line 10) -* whitespace, newlines as: Options. (line 262) +* whitespace, newlines as: Options. (line 260) * Williams, Kent: Contributors. (line 34) * Woehlke, Matthew: Contributors. (line 79) * Woods, John: Contributors. (line 27) @@ -34285,558 +34432,559 @@ Index Tag Table: Node: Top1204 -Node: Foreword342156 -Node: Foreword446548 -Node: Preface47982 -Ref: Preface-Footnote-150853 -Ref: Preface-Footnote-250960 -Ref: Preface-Footnote-351193 -Node: History51335 -Node: Names53683 -Ref: Names-Footnote-154777 -Node: This Manual54923 -Ref: This Manual-Footnote-160752 -Node: Conventions60852 -Node: Manual History63192 -Ref: Manual History-Footnote-166183 -Ref: Manual History-Footnote-266224 -Node: How To Contribute66298 -Node: Acknowledgments67537 -Node: Getting Started72345 -Node: Running gawk74779 -Node: One-shot75969 -Node: Read Terminal77194 -Node: Long79221 -Node: Executable Scripts80737 -Ref: Executable Scripts-Footnote-183526 -Node: Comments83628 -Node: Quoting86101 -Node: DOS Quoting91607 -Node: Sample Data Files92282 -Node: Very Simple94875 -Node: Two Rules99766 -Node: More Complex101652 -Node: Statements/Lines104514 -Ref: Statements/Lines-Footnote-1108970 -Node: Other Features109235 -Node: When110166 -Ref: When-Footnote-1111922 -Node: Intro Summary111987 -Node: Invoking Gawk112870 -Node: Command Line114385 -Node: Options115176 -Ref: Options-Footnote-1131088 -Node: Other Arguments131113 -Node: Naming Standard Input134074 -Node: Environment Variables135167 -Node: AWKPATH Variable135725 -Ref: AWKPATH Variable-Footnote-1139025 -Ref: AWKPATH Variable-Footnote-2139070 -Node: AWKLIBPATH Variable139330 -Node: Other Environment Variables140473 -Node: Exit Status144193 -Node: Include Files144868 -Node: Loading Shared Libraries148456 -Node: Obsolete149883 -Node: Undocumented150580 -Node: Invoking Summary150847 -Node: Regexp152513 -Node: Regexp Usage153972 -Node: Escape Sequences156005 -Node: Regexp Operators162022 -Ref: Regexp Operators-Footnote-1169456 -Ref: Regexp Operators-Footnote-2169603 -Node: Bracket Expressions169701 -Ref: table-char-classes171718 -Node: Leftmost Longest174658 -Node: Computed Regexps175960 -Node: GNU Regexp Operators179357 -Node: Case-sensitivity183059 -Ref: Case-sensitivity-Footnote-1185949 -Ref: Case-sensitivity-Footnote-2186184 -Node: Regexp Summary186292 -Node: Reading Files187761 -Node: Records189855 -Node: awk split records190587 -Node: gawk split records195501 -Ref: gawk split records-Footnote-1200040 -Node: Fields200077 -Ref: Fields-Footnote-1202875 -Node: Nonconstant Fields202961 -Ref: Nonconstant Fields-Footnote-1205197 -Node: Changing Fields205399 -Node: Field Separators211331 -Node: Default Field Splitting214035 -Node: Regexp Field Splitting215152 -Node: Single Character Fields218502 -Node: Command Line Field Separator219561 -Node: Full Line Fields222773 -Ref: Full Line Fields-Footnote-1223281 -Node: Field Splitting Summary223327 -Ref: Field Splitting Summary-Footnote-1226458 -Node: Constant Size226559 -Node: Splitting By Content231165 -Ref: Splitting By Content-Footnote-1235238 -Node: Multiple Line235278 -Ref: Multiple Line-Footnote-1241167 -Node: Getline241346 -Node: Plain Getline243557 -Node: Getline/Variable246197 -Node: Getline/File247344 -Node: Getline/Variable/File248728 -Ref: Getline/Variable/File-Footnote-1250329 -Node: Getline/Pipe250416 -Node: Getline/Variable/Pipe253099 -Node: Getline/Coprocess254230 -Node: Getline/Variable/Coprocess255482 -Node: Getline Notes256221 -Node: Getline Summary259013 -Ref: table-getline-variants259425 -Node: Read Timeout260254 -Ref: Read Timeout-Footnote-1264068 -Node: Command-line directories264126 -Node: Input Summary265030 -Node: Input Exercises268282 -Node: Printing269010 -Node: Print270787 -Node: Print Examples272244 -Node: Output Separators275023 -Node: OFMT277041 -Node: Printf278395 -Node: Basic Printf279180 -Node: Control Letters280751 -Node: Format Modifiers284735 -Node: Printf Examples290742 -Node: Redirection293224 -Node: Special FD300063 -Ref: Special FD-Footnote-1303220 -Node: Special Files303294 -Node: Other Inherited Files303910 -Node: Special Network304910 -Node: Special Caveats305771 -Node: Close Files And Pipes306722 -Ref: Close Files And Pipes-Footnote-1313901 -Ref: Close Files And Pipes-Footnote-2314049 -Node: Output Summary314199 -Node: Output Exercises315195 -Node: Expressions315875 -Node: Values317060 -Node: Constants317736 -Node: Scalar Constants318416 -Ref: Scalar Constants-Footnote-1319275 -Node: Nondecimal-numbers319525 -Node: Regexp Constants322525 -Node: Using Constant Regexps323050 -Node: Variables326188 -Node: Using Variables326843 -Node: Assignment Options328753 -Node: Conversion330628 -Node: Strings And Numbers331152 -Ref: Strings And Numbers-Footnote-1334216 -Node: Locale influences conversions334325 -Ref: table-locale-affects337070 -Node: All Operators337658 -Node: Arithmetic Ops338288 -Node: Concatenation340793 -Ref: Concatenation-Footnote-1343612 -Node: Assignment Ops343718 -Ref: table-assign-ops348701 -Node: Increment Ops349979 -Node: Truth Values and Conditions353417 -Node: Truth Values354500 -Node: Typing and Comparison355549 -Node: Variable Typing356342 -Node: Comparison Operators359994 -Ref: table-relational-ops360404 -Node: POSIX String Comparison363919 -Ref: POSIX String Comparison-Footnote-1364991 -Node: Boolean Ops365129 -Ref: Boolean Ops-Footnote-1369608 -Node: Conditional Exp369699 -Node: Function Calls371426 -Node: Precedence375306 -Node: Locales378974 -Node: Expressions Summary380605 -Node: Patterns and Actions383179 -Node: Pattern Overview384299 -Node: Regexp Patterns385978 -Node: Expression Patterns386521 -Node: Ranges390301 -Node: BEGIN/END393407 -Node: Using BEGIN/END394169 -Ref: Using BEGIN/END-Footnote-1396906 -Node: I/O And BEGIN/END397012 -Node: BEGINFILE/ENDFILE399326 -Node: Empty402227 -Node: Using Shell Variables402544 -Node: Action Overview404820 -Node: Statements407147 -Node: If Statement408995 -Node: While Statement410493 -Node: Do Statement412521 -Node: For Statement413663 -Node: Switch Statement416818 -Node: Break Statement419206 -Node: Continue Statement421247 -Node: Next Statement423072 -Node: Nextfile Statement425452 -Node: Exit Statement428082 -Node: Built-in Variables430485 -Node: User-modified431618 -Ref: User-modified-Footnote-1439298 -Node: Auto-set439360 -Ref: Auto-set-Footnote-1452390 -Ref: Auto-set-Footnote-2452595 -Node: ARGC and ARGV452651 -Node: Pattern Action Summary456855 -Node: Arrays459282 -Node: Array Basics460611 -Node: Array Intro461455 -Ref: figure-array-elements463419 -Ref: Array Intro-Footnote-1465943 -Node: Reference to Elements466071 -Node: Assigning Elements468521 -Node: Array Example469012 -Node: Scanning an Array470770 -Node: Controlling Scanning473786 -Ref: Controlling Scanning-Footnote-1478975 -Node: Numeric Array Subscripts479291 -Node: Uninitialized Subscripts481476 -Node: Delete483093 -Ref: Delete-Footnote-1485837 -Node: Multidimensional485894 -Node: Multiscanning488989 -Node: Arrays of Arrays490578 -Node: Arrays Summary495339 -Node: Functions497444 -Node: Built-in498317 -Node: Calling Built-in499395 -Node: Numeric Functions501383 -Ref: Numeric Functions-Footnote-1505405 -Ref: Numeric Functions-Footnote-2505762 -Ref: Numeric Functions-Footnote-3505810 -Node: String Functions506079 -Ref: String Functions-Footnote-1529551 -Ref: String Functions-Footnote-2529680 -Ref: String Functions-Footnote-3529928 -Node: Gory Details530015 -Ref: table-sub-escapes531796 -Ref: table-sub-proposed533316 -Ref: table-posix-sub534680 -Ref: table-gensub-escapes536220 -Ref: Gory Details-Footnote-1537052 -Node: I/O Functions537203 -Ref: I/O Functions-Footnote-1544304 -Node: Time Functions544451 -Ref: Time Functions-Footnote-1554920 -Ref: Time Functions-Footnote-2554988 -Ref: Time Functions-Footnote-3555146 -Ref: Time Functions-Footnote-4555257 -Ref: Time Functions-Footnote-5555369 -Ref: Time Functions-Footnote-6555596 -Node: Bitwise Functions555862 -Ref: table-bitwise-ops556424 -Ref: Bitwise Functions-Footnote-1560732 -Node: Type Functions560901 -Node: I18N Functions562050 -Node: User-defined563695 -Node: Definition Syntax564499 -Ref: Definition Syntax-Footnote-1569905 -Node: Function Example569974 -Ref: Function Example-Footnote-1572891 -Node: Function Caveats572913 -Node: Calling A Function573431 -Node: Variable Scope574386 -Node: Pass By Value/Reference577374 -Node: Return Statement580884 -Node: Dynamic Typing583868 -Node: Indirect Calls584797 -Ref: Indirect Calls-Footnote-1596101 -Node: Functions Summary596229 -Node: Library Functions598928 -Ref: Library Functions-Footnote-1602546 -Ref: Library Functions-Footnote-2602689 -Node: Library Names602860 -Ref: Library Names-Footnote-1606320 -Ref: Library Names-Footnote-2606540 -Node: General Functions606626 -Node: Strtonum Function607729 -Node: Assert Function610749 -Node: Round Function614073 -Node: Cliff Random Function615614 -Node: Ordinal Functions616630 -Ref: Ordinal Functions-Footnote-1619695 -Ref: Ordinal Functions-Footnote-2619947 -Node: Join Function620158 -Ref: Join Function-Footnote-1621929 -Node: Getlocaltime Function622129 -Node: Readfile Function625870 -Node: Shell Quoting627840 -Node: Data File Management629241 -Node: Filetrans Function629873 -Node: Rewind Function633932 -Node: File Checking635317 -Ref: File Checking-Footnote-1636645 -Node: Empty Files636846 -Node: Ignoring Assigns638825 -Node: Getopt Function640376 -Ref: Getopt Function-Footnote-1651836 -Node: Passwd Functions652039 -Ref: Passwd Functions-Footnote-1660890 -Node: Group Functions660978 -Ref: Group Functions-Footnote-1668881 -Node: Walking Arrays669094 -Node: Library Functions Summary670697 -Node: Library Exercises672098 -Node: Sample Programs673378 -Node: Running Examples674148 -Node: Clones674876 -Node: Cut Program676100 -Node: Egrep Program685830 -Ref: Egrep Program-Footnote-1693334 -Node: Id Program693444 -Node: Split Program697088 -Ref: Split Program-Footnote-1700534 -Node: Tee Program700662 -Node: Uniq Program703449 -Node: Wc Program710870 -Ref: Wc Program-Footnote-1715118 -Node: Miscellaneous Programs715210 -Node: Dupword Program716423 -Node: Alarm Program718454 -Node: Translate Program723258 -Ref: Translate Program-Footnote-1727822 -Node: Labels Program728092 -Ref: Labels Program-Footnote-1731441 -Node: Word Sorting731525 -Node: History Sorting735595 -Node: Extract Program737431 -Node: Simple Sed744963 -Node: Igawk Program748025 -Ref: Igawk Program-Footnote-1762351 -Ref: Igawk Program-Footnote-2762552 -Ref: Igawk Program-Footnote-3762674 -Node: Anagram Program762789 -Node: Signature Program765851 -Node: Programs Summary767098 -Node: Programs Exercises768291 -Ref: Programs Exercises-Footnote-1772422 -Node: Advanced Features772513 -Node: Nondecimal Data774461 -Node: Array Sorting776051 -Node: Controlling Array Traversal776748 -Ref: Controlling Array Traversal-Footnote-1785079 -Node: Array Sorting Functions785197 -Ref: Array Sorting Functions-Footnote-1789089 -Node: Two-way I/O789283 -Ref: Two-way I/O-Footnote-1794227 -Ref: Two-way I/O-Footnote-2794413 -Node: TCP/IP Networking794495 -Node: Profiling797367 -Node: Advanced Features Summary804911 -Node: Internationalization806844 -Node: I18N and L10N808324 -Node: Explaining gettext809010 -Ref: Explaining gettext-Footnote-1814039 -Ref: Explaining gettext-Footnote-2814223 -Node: Programmer i18n814388 -Ref: Programmer i18n-Footnote-1819254 -Node: Translator i18n819303 -Node: String Extraction820097 -Ref: String Extraction-Footnote-1821228 -Node: Printf Ordering821314 -Ref: Printf Ordering-Footnote-1824100 -Node: I18N Portability824164 -Ref: I18N Portability-Footnote-1826613 -Node: I18N Example826676 -Ref: I18N Example-Footnote-1829476 -Node: Gawk I18N829548 -Node: I18N Summary830186 -Node: Debugger831525 -Node: Debugging832547 -Node: Debugging Concepts832988 -Node: Debugging Terms834845 -Node: Awk Debugging837420 -Node: Sample Debugging Session838312 -Node: Debugger Invocation838832 -Node: Finding The Bug840216 -Node: List of Debugger Commands846691 -Node: Breakpoint Control848023 -Node: Debugger Execution Control851715 -Node: Viewing And Changing Data855079 -Node: Execution Stack858444 -Node: Debugger Info860082 -Node: Miscellaneous Debugger Commands864099 -Node: Readline Support869291 -Node: Limitations870183 -Node: Debugging Summary872280 -Node: Arbitrary Precision Arithmetic873448 -Node: Computer Arithmetic874864 -Ref: table-numeric-ranges878465 -Ref: Computer Arithmetic-Footnote-1879324 -Node: Math Definitions879381 -Ref: table-ieee-formats882668 -Ref: Math Definitions-Footnote-1883272 -Node: MPFR features883377 -Node: FP Math Caution885048 -Ref: FP Math Caution-Footnote-1886098 -Node: Inexactness of computations886467 -Node: Inexact representation887415 -Node: Comparing FP Values888770 -Node: Errors accumulate889843 -Node: Getting Accuracy891276 -Node: Try To Round893935 -Node: Setting precision894834 -Ref: table-predefined-precision-strings895518 -Node: Setting the rounding mode897312 -Ref: table-gawk-rounding-modes897676 -Ref: Setting the rounding mode-Footnote-1901130 -Node: Arbitrary Precision Integers901309 -Ref: Arbitrary Precision Integers-Footnote-1904300 -Node: POSIX Floating Point Problems904449 -Ref: POSIX Floating Point Problems-Footnote-1908325 -Node: Floating point summary908363 -Node: Dynamic Extensions910555 -Node: Extension Intro912107 -Node: Plugin License913373 -Node: Extension Mechanism Outline914170 -Ref: figure-load-extension914598 -Ref: figure-register-new-function916078 -Ref: figure-call-new-function917082 -Node: Extension API Description919068 -Node: Extension API Functions Introduction920518 -Node: General Data Types925354 -Ref: General Data Types-Footnote-1931041 -Node: Memory Allocation Functions931340 -Ref: Memory Allocation Functions-Footnote-1934170 -Node: Constructor Functions934266 -Node: Registration Functions936000 -Node: Extension Functions936685 -Node: Exit Callback Functions938981 -Node: Extension Version String940229 -Node: Input Parsers940879 -Node: Output Wrappers950694 -Node: Two-way processors955210 -Node: Printing Messages957414 -Ref: Printing Messages-Footnote-1958491 -Node: Updating `ERRNO'958643 -Node: Requesting Values959383 -Ref: table-value-types-returned960111 -Node: Accessing Parameters961069 -Node: Symbol Table Access962300 -Node: Symbol table by name962814 -Node: Symbol table by cookie964794 -Ref: Symbol table by cookie-Footnote-1968933 -Node: Cached values968996 -Ref: Cached values-Footnote-1972500 -Node: Array Manipulation972591 -Ref: Array Manipulation-Footnote-1973689 -Node: Array Data Types973728 -Ref: Array Data Types-Footnote-1976385 -Node: Array Functions976477 -Node: Flattening Arrays980331 -Node: Creating Arrays987218 -Node: Extension API Variables991985 -Node: Extension Versioning992621 -Node: Extension API Informational Variables994522 -Node: Extension API Boilerplate995610 -Node: Finding Extensions999426 -Node: Extension Example999986 -Node: Internal File Description1000758 -Node: Internal File Ops1004825 -Ref: Internal File Ops-Footnote-11016483 -Node: Using Internal File Ops1016623 -Ref: Using Internal File Ops-Footnote-11019006 -Node: Extension Samples1019279 -Node: Extension Sample File Functions1020803 -Node: Extension Sample Fnmatch1028405 -Node: Extension Sample Fork1029887 -Node: Extension Sample Inplace1031100 -Node: Extension Sample Ord1032775 -Node: Extension Sample Readdir1033611 -Ref: table-readdir-file-types1034487 -Node: Extension Sample Revout1035298 -Node: Extension Sample Rev2way1035889 -Node: Extension Sample Read write array1036630 -Node: Extension Sample Readfile1038569 -Node: Extension Sample Time1039664 -Node: Extension Sample API Tests1041013 -Node: gawkextlib1041504 -Node: Extension summary1044154 -Node: Extension Exercises1047836 -Node: Language History1048558 -Node: V7/SVR3.11050215 -Node: SVR41052396 -Node: POSIX1053841 -Node: BTL1055230 -Node: POSIX/GNU1055964 -Node: Feature History1061533 -Node: Common Extensions1074631 -Node: Ranges and Locales1075955 -Ref: Ranges and Locales-Footnote-11080594 -Ref: Ranges and Locales-Footnote-21080621 -Ref: Ranges and Locales-Footnote-31080855 -Node: Contributors1081076 -Node: History summary1086616 -Node: Installation1087985 -Node: Gawk Distribution1088941 -Node: Getting1089425 -Node: Extracting1090249 -Node: Distribution contents1091891 -Node: Unix Installation1097608 -Node: Quick Installation1098225 -Node: Additional Configuration Options1100656 -Node: Configuration Philosophy1102396 -Node: Non-Unix Installation1104747 -Node: PC Installation1105205 -Node: PC Binary Installation1106531 -Node: PC Compiling1108379 -Ref: PC Compiling-Footnote-11111400 -Node: PC Testing1111505 -Node: PC Using1112681 -Node: Cygwin1116796 -Node: MSYS1117619 -Node: VMS Installation1118117 -Node: VMS Compilation1118909 -Ref: VMS Compilation-Footnote-11120131 -Node: VMS Dynamic Extensions1120189 -Node: VMS Installation Details1121873 -Node: VMS Running1124125 -Node: VMS GNV1126966 -Node: VMS Old Gawk1127700 -Node: Bugs1128170 -Node: Other Versions1132074 -Node: Installation summary1138287 -Node: Notes1139343 -Node: Compatibility Mode1140208 -Node: Additions1140990 -Node: Accessing The Source1141915 -Node: Adding Code1143351 -Node: New Ports1149523 -Node: Derived Files1154005 -Ref: Derived Files-Footnote-11159480 -Ref: Derived Files-Footnote-21159514 -Ref: Derived Files-Footnote-31160110 -Node: Future Extensions1160224 -Node: Implementation Limitations1160830 -Node: Extension Design1162078 -Node: Old Extension Problems1163232 -Ref: Old Extension Problems-Footnote-11164749 -Node: Extension New Mechanism Goals1164806 -Ref: Extension New Mechanism Goals-Footnote-11168166 -Node: Extension Other Design Decisions1168355 -Node: Extension Future Growth1170463 -Node: Old Extension Mechanism1171299 -Node: Notes summary1173061 -Node: Basic Concepts1174247 -Node: Basic High Level1174928 -Ref: figure-general-flow1175200 -Ref: figure-process-flow1175799 -Ref: Basic High Level-Footnote-11179028 -Node: Basic Data Typing1179213 -Node: Glossary1182541 -Node: Copying1207699 -Node: GNU Free Documentation License1245255 -Node: Index1270391 +Node: Foreword342225 +Node: Foreword446617 +Node: Preface48051 +Ref: Preface-Footnote-150922 +Ref: Preface-Footnote-251029 +Ref: Preface-Footnote-351262 +Node: History51404 +Node: Names53752 +Ref: Names-Footnote-154846 +Node: This Manual54992 +Ref: This Manual-Footnote-160821 +Node: Conventions60921 +Node: Manual History63261 +Ref: Manual History-Footnote-166252 +Ref: Manual History-Footnote-266293 +Node: How To Contribute66367 +Node: Acknowledgments67606 +Node: Getting Started72414 +Node: Running gawk74848 +Node: One-shot76038 +Node: Read Terminal77263 +Node: Long79290 +Node: Executable Scripts80806 +Ref: Executable Scripts-Footnote-183595 +Node: Comments83697 +Node: Quoting86170 +Node: DOS Quoting91676 +Node: Sample Data Files92351 +Node: Very Simple94944 +Node: Two Rules99835 +Node: More Complex101721 +Node: Statements/Lines104583 +Ref: Statements/Lines-Footnote-1109039 +Node: Other Features109304 +Node: When110235 +Ref: When-Footnote-1111991 +Node: Intro Summary112056 +Node: Invoking Gawk112939 +Node: Command Line114454 +Node: Options115245 +Ref: Options-Footnote-1131028 +Node: Other Arguments131053 +Node: Naming Standard Input134014 +Node: Environment Variables135107 +Node: AWKPATH Variable135665 +Ref: AWKPATH Variable-Footnote-1139075 +Ref: AWKPATH Variable-Footnote-2139120 +Node: AWKLIBPATH Variable139380 +Node: Other Environment Variables140636 +Node: Exit Status144127 +Node: Include Files144802 +Node: Loading Shared Libraries148390 +Node: Obsolete149817 +Node: Undocumented150514 +Node: Invoking Summary150781 +Node: Regexp152447 +Node: Regexp Usage153906 +Node: Escape Sequences155939 +Node: Regexp Operators162187 +Ref: Regexp Operators-Footnote-1169621 +Ref: Regexp Operators-Footnote-2169768 +Node: Bracket Expressions169866 +Ref: table-char-classes171883 +Node: Leftmost Longest174823 +Node: Computed Regexps176125 +Node: GNU Regexp Operators179522 +Node: Case-sensitivity183224 +Ref: Case-sensitivity-Footnote-1186114 +Ref: Case-sensitivity-Footnote-2186349 +Node: Regexp Summary186457 +Node: Reading Files187926 +Node: Records190020 +Node: awk split records190752 +Node: gawk split records195666 +Ref: gawk split records-Footnote-1200205 +Node: Fields200242 +Ref: Fields-Footnote-1203040 +Node: Nonconstant Fields203126 +Ref: Nonconstant Fields-Footnote-1205362 +Node: Changing Fields205564 +Node: Field Separators211496 +Node: Default Field Splitting214200 +Node: Regexp Field Splitting215317 +Node: Single Character Fields218667 +Node: Command Line Field Separator219726 +Node: Full Line Fields222938 +Ref: Full Line Fields-Footnote-1223446 +Node: Field Splitting Summary223492 +Ref: Field Splitting Summary-Footnote-1226623 +Node: Constant Size226724 +Node: Splitting By Content231330 +Ref: Splitting By Content-Footnote-1235403 +Node: Multiple Line235443 +Ref: Multiple Line-Footnote-1241332 +Node: Getline241511 +Node: Plain Getline243722 +Node: Getline/Variable246362 +Node: Getline/File247509 +Node: Getline/Variable/File248893 +Ref: Getline/Variable/File-Footnote-1250494 +Node: Getline/Pipe250581 +Node: Getline/Variable/Pipe253264 +Node: Getline/Coprocess254395 +Node: Getline/Variable/Coprocess255647 +Node: Getline Notes256386 +Node: Getline Summary259178 +Ref: table-getline-variants259590 +Node: Read Timeout260419 +Ref: Read Timeout-Footnote-1264233 +Node: Command-line directories264291 +Node: Input Summary265195 +Node: Input Exercises268447 +Node: Printing269175 +Node: Print270952 +Node: Print Examples272409 +Node: Output Separators275188 +Node: OFMT277206 +Node: Printf278560 +Node: Basic Printf279345 +Node: Control Letters280916 +Node: Format Modifiers284900 +Node: Printf Examples290907 +Node: Redirection293389 +Node: Special FD300228 +Ref: Special FD-Footnote-1303385 +Node: Special Files303459 +Node: Other Inherited Files304075 +Node: Special Network305075 +Node: Special Caveats305936 +Node: Close Files And Pipes306887 +Ref: Close Files And Pipes-Footnote-1314066 +Ref: Close Files And Pipes-Footnote-2314214 +Node: Output Summary314364 +Node: Output Exercises315360 +Node: Expressions316040 +Node: Values317225 +Node: Constants317901 +Node: Scalar Constants318581 +Ref: Scalar Constants-Footnote-1319440 +Node: Nondecimal-numbers319690 +Node: Regexp Constants322690 +Node: Using Constant Regexps323215 +Node: Variables326353 +Node: Using Variables327008 +Node: Assignment Options328918 +Node: Conversion330793 +Node: Strings And Numbers331317 +Ref: Strings And Numbers-Footnote-1334381 +Node: Locale influences conversions334490 +Ref: table-locale-affects337235 +Node: All Operators337823 +Node: Arithmetic Ops338453 +Node: Concatenation340958 +Ref: Concatenation-Footnote-1343777 +Node: Assignment Ops343883 +Ref: table-assign-ops348866 +Node: Increment Ops350144 +Node: Truth Values and Conditions353582 +Node: Truth Values354665 +Node: Typing and Comparison355714 +Node: Variable Typing356507 +Node: Comparison Operators360159 +Ref: table-relational-ops360569 +Node: POSIX String Comparison364084 +Ref: POSIX String Comparison-Footnote-1365156 +Node: Boolean Ops365294 +Ref: Boolean Ops-Footnote-1369773 +Node: Conditional Exp369864 +Node: Function Calls371591 +Node: Precedence375471 +Node: Locales379139 +Node: Expressions Summary380770 +Node: Patterns and Actions383344 +Node: Pattern Overview384464 +Node: Regexp Patterns386143 +Node: Expression Patterns386686 +Node: Ranges390466 +Node: BEGIN/END393572 +Node: Using BEGIN/END394334 +Ref: Using BEGIN/END-Footnote-1397071 +Node: I/O And BEGIN/END397177 +Node: BEGINFILE/ENDFILE399491 +Node: Empty402392 +Node: Using Shell Variables402709 +Node: Action Overview404985 +Node: Statements407312 +Node: If Statement409160 +Node: While Statement410658 +Node: Do Statement412686 +Node: For Statement413828 +Node: Switch Statement416983 +Node: Break Statement419371 +Node: Continue Statement421412 +Node: Next Statement423237 +Node: Nextfile Statement425617 +Node: Exit Statement428247 +Node: Built-in Variables430650 +Node: User-modified431783 +Ref: User-modified-Footnote-1439463 +Node: Auto-set439525 +Ref: Auto-set-Footnote-1452892 +Ref: Auto-set-Footnote-2453097 +Node: ARGC and ARGV453153 +Node: Pattern Action Summary457357 +Node: Arrays459784 +Node: Array Basics461113 +Node: Array Intro461957 +Ref: figure-array-elements463921 +Ref: Array Intro-Footnote-1466445 +Node: Reference to Elements466573 +Node: Assigning Elements469023 +Node: Array Example469514 +Node: Scanning an Array471272 +Node: Controlling Scanning474288 +Ref: Controlling Scanning-Footnote-1479477 +Node: Numeric Array Subscripts479793 +Node: Uninitialized Subscripts481978 +Node: Delete483595 +Ref: Delete-Footnote-1486339 +Node: Multidimensional486396 +Node: Multiscanning489491 +Node: Arrays of Arrays491080 +Node: Arrays Summary495841 +Node: Functions497946 +Node: Built-in498819 +Node: Calling Built-in499897 +Node: Numeric Functions501885 +Ref: Numeric Functions-Footnote-1506709 +Ref: Numeric Functions-Footnote-2507066 +Ref: Numeric Functions-Footnote-3507114 +Node: String Functions507383 +Ref: String Functions-Footnote-1530855 +Ref: String Functions-Footnote-2530984 +Ref: String Functions-Footnote-3531232 +Node: Gory Details531319 +Ref: table-sub-escapes533100 +Ref: table-sub-proposed534620 +Ref: table-posix-sub535984 +Ref: table-gensub-escapes537524 +Ref: Gory Details-Footnote-1538356 +Node: I/O Functions538507 +Ref: I/O Functions-Footnote-1545608 +Node: Time Functions545755 +Ref: Time Functions-Footnote-1556224 +Ref: Time Functions-Footnote-2556292 +Ref: Time Functions-Footnote-3556450 +Ref: Time Functions-Footnote-4556561 +Ref: Time Functions-Footnote-5556673 +Ref: Time Functions-Footnote-6556900 +Node: Bitwise Functions557166 +Ref: table-bitwise-ops557728 +Ref: Bitwise Functions-Footnote-1562036 +Node: Type Functions562205 +Node: I18N Functions563354 +Node: User-defined564999 +Node: Definition Syntax565803 +Ref: Definition Syntax-Footnote-1571209 +Node: Function Example571278 +Ref: Function Example-Footnote-1574195 +Node: Function Caveats574217 +Node: Calling A Function574735 +Node: Variable Scope575690 +Node: Pass By Value/Reference578678 +Node: Return Statement582188 +Node: Dynamic Typing585172 +Node: Indirect Calls586101 +Ref: Indirect Calls-Footnote-1597405 +Node: Functions Summary597533 +Node: Library Functions600232 +Ref: Library Functions-Footnote-1603850 +Ref: Library Functions-Footnote-2603993 +Node: Library Names604164 +Ref: Library Names-Footnote-1607624 +Ref: Library Names-Footnote-2607844 +Node: General Functions607930 +Node: Strtonum Function609033 +Node: Assert Function612053 +Node: Round Function615377 +Node: Cliff Random Function616918 +Node: Ordinal Functions617934 +Ref: Ordinal Functions-Footnote-1620999 +Ref: Ordinal Functions-Footnote-2621251 +Node: Join Function621462 +Ref: Join Function-Footnote-1623233 +Node: Getlocaltime Function623433 +Node: Readfile Function627174 +Node: Shell Quoting629144 +Node: Data File Management630545 +Node: Filetrans Function631177 +Node: Rewind Function635236 +Node: File Checking636621 +Ref: File Checking-Footnote-1637949 +Node: Empty Files638150 +Node: Ignoring Assigns640129 +Node: Getopt Function641680 +Ref: Getopt Function-Footnote-1653140 +Node: Passwd Functions653343 +Ref: Passwd Functions-Footnote-1662194 +Node: Group Functions662282 +Ref: Group Functions-Footnote-1670185 +Node: Walking Arrays670398 +Node: Library Functions Summary672001 +Node: Library Exercises673402 +Node: Sample Programs674682 +Node: Running Examples675452 +Node: Clones676180 +Node: Cut Program677404 +Node: Egrep Program687134 +Ref: Egrep Program-Footnote-1694638 +Node: Id Program694748 +Node: Split Program698392 +Ref: Split Program-Footnote-1701838 +Node: Tee Program701966 +Node: Uniq Program704753 +Node: Wc Program712174 +Ref: Wc Program-Footnote-1716422 +Node: Miscellaneous Programs716514 +Node: Dupword Program717727 +Node: Alarm Program719758 +Node: Translate Program724562 +Ref: Translate Program-Footnote-1729126 +Node: Labels Program729396 +Ref: Labels Program-Footnote-1732745 +Node: Word Sorting732829 +Node: History Sorting736899 +Node: Extract Program738735 +Node: Simple Sed746267 +Node: Igawk Program749329 +Ref: Igawk Program-Footnote-1763655 +Ref: Igawk Program-Footnote-2763856 +Ref: Igawk Program-Footnote-3763978 +Node: Anagram Program764093 +Node: Signature Program767155 +Node: Programs Summary768402 +Node: Programs Exercises769595 +Ref: Programs Exercises-Footnote-1773726 +Node: Advanced Features773817 +Node: Nondecimal Data775765 +Node: Array Sorting777355 +Node: Controlling Array Traversal778052 +Ref: Controlling Array Traversal-Footnote-1786383 +Node: Array Sorting Functions786501 +Ref: Array Sorting Functions-Footnote-1790393 +Node: Two-way I/O790587 +Ref: Two-way I/O-Footnote-1795531 +Ref: Two-way I/O-Footnote-2795717 +Node: TCP/IP Networking795799 +Node: Profiling798671 +Node: Advanced Features Summary806945 +Node: Internationalization808878 +Node: I18N and L10N810358 +Node: Explaining gettext811044 +Ref: Explaining gettext-Footnote-1816073 +Ref: Explaining gettext-Footnote-2816257 +Node: Programmer i18n816422 +Ref: Programmer i18n-Footnote-1821288 +Node: Translator i18n821337 +Node: String Extraction822131 +Ref: String Extraction-Footnote-1823262 +Node: Printf Ordering823348 +Ref: Printf Ordering-Footnote-1826134 +Node: I18N Portability826198 +Ref: I18N Portability-Footnote-1828647 +Node: I18N Example828710 +Ref: I18N Example-Footnote-1831510 +Node: Gawk I18N831582 +Node: I18N Summary832220 +Node: Debugger833559 +Node: Debugging834581 +Node: Debugging Concepts835022 +Node: Debugging Terms836879 +Node: Awk Debugging839454 +Node: Sample Debugging Session840346 +Node: Debugger Invocation840866 +Node: Finding The Bug842250 +Node: List of Debugger Commands848725 +Node: Breakpoint Control850057 +Node: Debugger Execution Control853749 +Node: Viewing And Changing Data857113 +Node: Execution Stack860478 +Node: Debugger Info862116 +Node: Miscellaneous Debugger Commands866133 +Node: Readline Support871325 +Node: Limitations872217 +Node: Debugging Summary874314 +Node: Arbitrary Precision Arithmetic875482 +Node: Computer Arithmetic876898 +Ref: table-numeric-ranges880499 +Ref: Computer Arithmetic-Footnote-1881358 +Node: Math Definitions881415 +Ref: table-ieee-formats884702 +Ref: Math Definitions-Footnote-1885306 +Node: MPFR features885411 +Node: FP Math Caution887082 +Ref: FP Math Caution-Footnote-1888132 +Node: Inexactness of computations888501 +Node: Inexact representation889449 +Node: Comparing FP Values890804 +Node: Errors accumulate891877 +Node: Getting Accuracy893310 +Node: Try To Round895969 +Node: Setting precision896868 +Ref: table-predefined-precision-strings897552 +Node: Setting the rounding mode899346 +Ref: table-gawk-rounding-modes899710 +Ref: Setting the rounding mode-Footnote-1903164 +Node: Arbitrary Precision Integers903343 +Ref: Arbitrary Precision Integers-Footnote-1908247 +Node: POSIX Floating Point Problems908396 +Ref: POSIX Floating Point Problems-Footnote-1912272 +Node: Floating point summary912310 +Node: Dynamic Extensions914502 +Node: Extension Intro916054 +Node: Plugin License917320 +Node: Extension Mechanism Outline918117 +Ref: figure-load-extension918545 +Ref: figure-register-new-function920025 +Ref: figure-call-new-function921029 +Node: Extension API Description923015 +Node: Extension API Functions Introduction924465 +Node: General Data Types929301 +Ref: General Data Types-Footnote-1934988 +Node: Memory Allocation Functions935287 +Ref: Memory Allocation Functions-Footnote-1938117 +Node: Constructor Functions938213 +Node: Registration Functions939947 +Node: Extension Functions940632 +Node: Exit Callback Functions942928 +Node: Extension Version String944176 +Node: Input Parsers944826 +Node: Output Wrappers954641 +Node: Two-way processors959157 +Node: Printing Messages961361 +Ref: Printing Messages-Footnote-1962438 +Node: Updating `ERRNO'962590 +Node: Requesting Values963330 +Ref: table-value-types-returned964058 +Node: Accessing Parameters965016 +Node: Symbol Table Access966247 +Node: Symbol table by name966761 +Node: Symbol table by cookie968741 +Ref: Symbol table by cookie-Footnote-1972880 +Node: Cached values972943 +Ref: Cached values-Footnote-1976447 +Node: Array Manipulation976538 +Ref: Array Manipulation-Footnote-1977636 +Node: Array Data Types977675 +Ref: Array Data Types-Footnote-1980332 +Node: Array Functions980424 +Node: Flattening Arrays984278 +Node: Creating Arrays991165 +Node: Extension API Variables995932 +Node: Extension Versioning996568 +Node: Extension API Informational Variables998469 +Node: Extension API Boilerplate999557 +Node: Finding Extensions1003373 +Node: Extension Example1003933 +Node: Internal File Description1004705 +Node: Internal File Ops1008772 +Ref: Internal File Ops-Footnote-11020430 +Node: Using Internal File Ops1020570 +Ref: Using Internal File Ops-Footnote-11022953 +Node: Extension Samples1023226 +Node: Extension Sample File Functions1024750 +Node: Extension Sample Fnmatch1032352 +Node: Extension Sample Fork1033834 +Node: Extension Sample Inplace1035047 +Node: Extension Sample Ord1036722 +Node: Extension Sample Readdir1037558 +Ref: table-readdir-file-types1038434 +Node: Extension Sample Revout1039245 +Node: Extension Sample Rev2way1039836 +Node: Extension Sample Read write array1040577 +Node: Extension Sample Readfile1042516 +Node: Extension Sample Time1043611 +Node: Extension Sample API Tests1044960 +Node: gawkextlib1045451 +Node: Extension summary1048101 +Node: Extension Exercises1051783 +Node: Language History1052505 +Node: V7/SVR3.11054162 +Node: SVR41056343 +Node: POSIX1057788 +Node: BTL1059177 +Node: POSIX/GNU1059911 +Node: Feature History1065540 +Node: Common Extensions1078638 +Node: Ranges and Locales1079962 +Ref: Ranges and Locales-Footnote-11084601 +Ref: Ranges and Locales-Footnote-21084628 +Ref: Ranges and Locales-Footnote-31084862 +Node: Contributors1085083 +Node: History summary1090623 +Node: Installation1091992 +Node: Gawk Distribution1092948 +Node: Getting1093432 +Node: Extracting1094256 +Node: Distribution contents1095898 +Node: Unix Installation1101963 +Node: Quick Installation1102646 +Node: Shell Startup Files1105064 +Node: Additional Configuration Options1106143 +Node: Configuration Philosophy1107884 +Node: Non-Unix Installation1110235 +Node: PC Installation1110693 +Node: PC Binary Installation1112019 +Node: PC Compiling1113867 +Ref: PC Compiling-Footnote-11116888 +Node: PC Testing1116993 +Node: PC Using1118169 +Node: Cygwin1122284 +Node: MSYS1123107 +Node: VMS Installation1123605 +Node: VMS Compilation1124397 +Ref: VMS Compilation-Footnote-11125619 +Node: VMS Dynamic Extensions1125677 +Node: VMS Installation Details1127361 +Node: VMS Running1129613 +Node: VMS GNV1132454 +Node: VMS Old Gawk1133188 +Node: Bugs1133658 +Node: Other Versions1137562 +Node: Installation summary1143775 +Node: Notes1144831 +Node: Compatibility Mode1145696 +Node: Additions1146478 +Node: Accessing The Source1147403 +Node: Adding Code1148839 +Node: New Ports1155011 +Node: Derived Files1159493 +Ref: Derived Files-Footnote-11164968 +Ref: Derived Files-Footnote-21165002 +Ref: Derived Files-Footnote-31165598 +Node: Future Extensions1165712 +Node: Implementation Limitations1166318 +Node: Extension Design1167566 +Node: Old Extension Problems1168720 +Ref: Old Extension Problems-Footnote-11170237 +Node: Extension New Mechanism Goals1170294 +Ref: Extension New Mechanism Goals-Footnote-11173654 +Node: Extension Other Design Decisions1173843 +Node: Extension Future Growth1175951 +Node: Old Extension Mechanism1176787 +Node: Notes summary1178549 +Node: Basic Concepts1179735 +Node: Basic High Level1180416 +Ref: figure-general-flow1180688 +Ref: figure-process-flow1181287 +Ref: Basic High Level-Footnote-11184516 +Node: Basic Data Typing1184701 +Node: Glossary1188029 +Node: Copying1213187 +Node: GNU Free Documentation License1250743 +Node: Index1275879 End Tag Table diff --git a/doc/gawk.texi b/doc/gawk.texi index 9e3d63d0..3e3976f7 100644 --- a/doc/gawk.texi +++ b/doc/gawk.texi @@ -989,6 +989,7 @@ particular records in a file and perform operations upon them. * Unix Installation:: Installing @command{gawk} under various versions of Unix. * Quick Installation:: Compiling @command{gawk} under Unix. +* Shell Startup Files:: Shell convenience functions. * Additional Configuration Options:: Other compile-time options. * Configuration Philosophy:: How it's all supposed to work. * Non-Unix Installation:: Installation on Other Operating @@ -3996,10 +3997,8 @@ No space is allowed between the @option{-o} and @var{file}, if @var{file} is supplied. @quotation NOTE -Due to the way @command{gawk} has evolved, with this option -your program is still executed. This will change in the -next major release such that @command{gawk} will only -pretty-print the program and not run it. +In the past, this option would also execute your program. +This is no longer the case. @end quotation @item @option{-O} @@ -4402,6 +4401,9 @@ searches first in the current directory and then in @file{/usr/local/share/awk}. In practice, this means that you will rarely need to change the value of @env{AWKPATH}. +@xref{Shell Startup Files}, for information on functions that help to +manipulate the @env{AWKPATH} variable. + @command{gawk} places the value of the search path that it used into @code{ENVIRON["AWKPATH"]}. This provides access to the actual search path value from within an @command{awk} program. @@ -4433,6 +4435,9 @@ an empty value, @command{gawk} uses a default path; this is typically @samp{/usr/local/lib/gawk}, although it can vary depending upon how @command{gawk} was built. +@xref{Shell Startup Files}, for information on functions that help to +manipulate the @env{AWKLIBPATH} variable. + @command{gawk} places the value of the search path that it used into @code{ENVIRON["AWKLIBPATH"]}. This provides access to the actual search path value from within an @command{awk} program. @@ -4509,14 +4514,6 @@ two regexp matchers that @command{gawk} uses internally. (There aren't supposed to be differences, but occasionally theory and practice don't coordinate with each other.) -@item GAWK_NO_PP_RUN -If this variable exists, then when invoked with the @option{--pretty-print} -option, @command{gawk} skips running the program. - -@quotation CAUTION -This variable will not survive into the next major release. -@end quotation - @item GAWK_STACKSIZE This specifies the amount by which @command{gawk} should grow its internal evaluation stack, when needed. @@ -5097,17 +5094,22 @@ between @samp{0} and @samp{7}. For example, the code for the ASCII ESC @item \x@var{hh}@dots{} The hexadecimal value @var{hh}, where @var{hh} stands for a sequence of hexadecimal digits (@samp{0}--@samp{9}, and either @samp{A}--@samp{F} -or @samp{a}--@samp{f}). Like the same construct -in ISO C, the escape sequence continues until the first nonhexadecimal -digit is seen. @value{COMMONEXT} -However, using more than two hexadecimal digits produces -undefined results. (The @samp{\x} escape sequence is not allowed in -POSIX @command{awk}.) +or @samp{a}--@samp{f}). A maximum of two digts are allowed after +the @samp{\x}. Any further hexadecimal digits are treated as simple +letters or numbers. @value{COMMONEXT} +(The @samp{\x} escape sequence is not allowed in POSIX awk.) @quotation CAUTION -The next major relase of @command{gawk} will change, such -that a maximum of two hexadecimal digits following the -@samp{\x} will be used. +In ISO C, the escape sequence continues until the first nonhexadecimal +digit is seen. +@c FIXME: Add exact version here. +For many years, @command{gawk} would continue incorporating +hexadecimal digits into the value until a non-hexadecimal digit +or the end of the string was encountered. +However, using more than two hexadecimal digits produced +undefined results. +As of @value{PVERSION} @strong{FIXME:} 4.3.0, only two digits +are processed. @end quotation @cindex @code{\} (backslash), @code{\/} escape sequence @@ -14797,10 +14799,18 @@ opens the next file. An associative array containing the values of the environment. The array indices are the environment variable names; the elements are the values of the particular environment variables. For example, -@code{ENVIRON["HOME"]} might be @code{"/home/arnold"}. Changing this array -does not affect the environment passed on to any programs that -@command{awk} may spawn via redirection or the @code{system()} function. -(In a future version of @command{gawk}, it may do so.) +@code{ENVIRON["HOME"]} might be @code{/home/arnold}. + +For POSIX @command{awk}, changing this array does not affect the +environment passed on to any programs that @command{awk} may spawn via +redirection or the @code{system()} function. + +However, beginning with version 4.2, if not in POSIX +compatibility mode, @command{gawk} does update its own environment when +@code{ENVIRON} is changed, thus changing the environment seen by programs +that it creates. You should therefore be especially careful if you +modify @code{ENVIRON["PATH"]"}, which is the search path for finding +executable programs. Some operating systems may not have environment variables. On such systems, the @code{ENVIRON} array is empty (except for @@ -16911,6 +16921,23 @@ You can use @samp{pi = atan2(0, -1)} to retrieve the value of @cindex cosine Return the cosine of @var{x}, with @var{x} in radians. +@item @code{div(@var{numerator}, @var{denominator}, @var{result})} +@cindexawkfunc{div} +@cindex div +Perform integer division, similar to the standard C function of the +same name. First, truncate @code{numerator} and @code{denominator} +towards zero, creating integer values. Clear the @code{result} +array, and then set @code{result["quotient"]} to the result of +@samp{numerator / denominator}, truncated towards zero to an integer, +and set @code{result["remainder"]} to the result of @samp{numerator % +denominator}, truncated towards zero to an integer. This function is +primarily intended for use with arbitrary length integers; it avoids +creating MPFR arbitrary precision floating-point values (@pxref{Arbitrary +Precision Integers}). + +This function is a @code{gawk} extension. It is not available in +compatibility mode (@pxref{Options}). + @item @code{exp(@var{x})} @cindexawkfunc{exp} @cindex exponent @@ -27865,8 +27892,7 @@ The profiled version of your program may not look exactly like what you typed when you wrote it. This is because @command{gawk} creates the profiled version by ``pretty printing'' its internal representation of the program. The advantage to this is that @command{gawk} can produce -a standard representation. The disadvantage is that all source-code -comments are lost. +a standard representation. Also, things such as: @example @@ -27960,9 +27986,26 @@ When called this way, @command{gawk} ``pretty prints'' the program into @file{awkprof.out}, without any execution counts. @quotation NOTE -The @option{--pretty-print} option still runs your program. -This will change in the next major release. +Once upon a time, the @option{--pretty-print} option would also run +your program. This is is no longer the case. @end quotation + +There is a significant difference between the output created when +profiling, and that created when pretty-printing. Pretty-printed output +preserves the original comments that were in the program, although their +placement may not correspond exactly to their original locations in the +source code. + +However, as a deliberate design decision, profiling output @emph{omits} +the original program's comments. This allows you to focus on the +execution count data and helps you avoid the temptation to use the +profiler for pretty-printing. + +Additionally, pretty-printed output does not have the leading indentation +that the profiling output does. This makes it easy to pretty-print your +code once development is completed, and then use the result as the final +version of your program. + @c ENDOFRANGE awkp @c ENDOFRANGE proawk @@ -31026,6 +31069,119 @@ to just use the following: gawk -M 'BEGIN @{ n = 13; print n % 2 @}' @end example +When dividing two arbitrary precision integers with either +@samp{/} or @samp{%}, the result is typically an arbitrary +precision floating point value (unless the denominator evenly +divides into the numerator). In order to do integer division +or remainder with arbitrary precision integers, use the built-in +@code{div()} function (@pxref{Numeric Functions}). + +You can simulate the @code{div()} function in standard @command{awk} +using this user-defined function: + +@example +@c file eg/lib/div.awk +# div --- do integer division + +@c endfile +@ignore +@c file eg/lib/div.awk +# +# Arnold Robbins, arnold@@skeeve.com, Public Domain +# July, 2014 + +@c endfile + +@end ignore +@c file eg/lib/div.awk +function div(numerator, denominator, result) +@{ + split("", result) + + numerator = int(numerator) + denominator = int(denominator) + result["quotient"] = int(numerator / denominator) + result["remainder"] = int(numerator % denominator) + + return 0.0 +@} +@c endfile +@end example + +The following example program, contributed by Katie Wasserman, +uses @code{div()} to +compute the digits of @value{PI} to as many places as you +choose to set: + +@example +@c file eg/prog/pi.awk +# pi.awk --- compute the digits of pi +@c endfile +@c endfile +@ignore +@c file eg/prog/pi.awk +# +# Katie Wasserman, katie@@wass.net +# August 2014 +@c endfile +@end ignore +@c file eg/prog/pi.awk + +BEGIN @{ + digits = 100000 + two = 2 * 10 ^ digits + pi = two + for (m = digits * 4; m > 0; --m) @{ + d = m * 2 + 1 + x = pi * m + div(x, d, result) + pi = result["quotient"] + pi = pi + two + @} + print pi +@} +@c endfile +@end example + +@ignore +Date: Wed, 20 Aug 2014 10:19:11 -0400 +To: arnold@skeeve.com +From: Katherine Wasserman <katie@wass.net> +Subject: Re: computation of digits of pi? + +Arnold, + +>The program that you sent to compute the digits of pi using div(). Is +>that some standard algorithm that every math student knows? If so, +>what's it called? + +It's not that well known but it's not that obscure either + +It's Euler's modification to Newton's method for calculating pi. + +Take a look at lines (23) - (25) here: http://mathworld.wolfram.com/PiFormulas.htm + +The algorithm I wrote simply expands the multiply by 2 and works from the innermost expression outwards. I used this to program HP calculators because it's quite easy to modify for tiny memory devices with smallish word sizes. + +http://www.hpmuseum.org/cgi-sys/cgiwrap/hpmuseum/articles.cgi?read=899 + +-Katie +@end ignore + +When asked about the algorithm used, Katie replied: + +@quotation +It's not that well known but it's not that obscure either. +It's Euler's modification to Newton's method for calculating pi. +Take a look at lines (23) - (25) here: @uref{http://mathworld.wolfram.com/PiFormulas.htm}. + +The algorithm I wrote simply expands the multiply by 2 and works from +the innermost expression outwards. I used this to program HP calculators +because it's quite easy to modify for tiny memory devices with smallish +word sizes. See +@uref{http://www.hpmuseum.org/cgi-sys/cgiwrap/hpmuseum/articles.cgi?read=899}. +@end quotation + @node POSIX Floating Point Problems @section Standards Versus Existing Practice @@ -35852,6 +36008,10 @@ for @command{gawk} @value{PVERSION} 4.1: Ultrix @end itemize +@item +@c FIXME: Verify the version here. +Support for MirBSD was removed at @command{gawk} @value{PVERSION} 4.2. + @end itemize @c XXX ADD MORE STUFF HERE @@ -37135,6 +37295,8 @@ The generated Info file for The @command{troff} source for a manual page describing the @command{igawk} program presented in @ref{Igawk Program}. +(Since @command{gawk} can do its own @code{@@include} processing, +neither @command{igawk} nor @file{igawk.1} are installed.) @item doc/Makefile.in The input file used during the configuration process to generate the @@ -37179,8 +37341,6 @@ source file for this @value{DOCUMENT}. It also contains a @file{Makefile.in} fil @file{Makefile.am} is used by GNU Automake to create @file{Makefile.in}. The library functions from @ref{Library Functions}, -and the @command{igawk} program from -@ref{Igawk Program}, are included as ready-to-use files in the @command{gawk} distribution. They are installed as part of the installation process. The rest of the programs in this @value{DOCUMENT} are available in appropriate @@ -37191,6 +37351,12 @@ The source code, manual pages, and infrastructure files for the sample extensions included with @command{gawk}. @xref{Dynamic Extensions}, for more information. +@item extras/* +Additional non-essential files. Currently, this directory contains some shell +startup files to be installed in @file{/etc/profile.d} to aid in manipulating +the @env{AWKPATH} and @env{AWKLIBPATH} environment variables. +@xref{Shell Startup Files}, for more information. + @item posix/* Files needed for building @command{gawk} on POSIX-compliant systems. @@ -37223,6 +37389,7 @@ to configure @command{gawk} for your system yourself. @menu * Quick Installation:: Compiling @command{gawk} under Unix. +* Shell Startup Files:: Shell convenience functions. * Additional Configuration Options:: Other compile-time options. * Configuration Philosophy:: How it's all supposed to work. @end menu @@ -37303,6 +37470,44 @@ is likely that you will be asked for your password, and you will have to have been set up previously as a user who is allowed to run the @command{sudo} command. +@node Shell Startup Files +@appendixsubsec Shell Startup Files + +The distribution contains shell startup files @file{gawk.sh} and +@file{gawk.csh} containing functions to aid in manipulating +the @env{AWKPATH} and @env{AWKLIBPATH} environment variables. +On a Fedora system, these files should be installed in @file{/etc/profile.d}; +on other platforms, the appropriate location may be different. + +@table @command + +@cindex @command{gawkpath_default} shell function +@item gawkpath_default +Reset the @env{AWKPATH} environment variable to its default value. + +@cindex @command{gawkpath_prepend} shell function +@item gawkpath_prepend +Add the argument to the front of the @env{AWKPATH} environment variable. + +@cindex @command{gawkpath_append} shell function +@item gawkpath_append +Add the argument to the end of the @env{AWKPATH} environment variable. + +@cindex @command{gawklibpath_default} shell function +@item gawklibpath_default +Reset the @env{AWKLIBPATH} environment variable to its default value. + +@cindex @command{gawklibpath_prepend} shell function +@item gawklibpath_prepend +Add the argument to the front of the @env{AWKLIBPATH} environment variable. + +@cindex @command{gawklibpath_append} shell function +@item gawklibpath_append +Add the argument to the end of the @env{AWKLIBPATH} environment variable. + +@end table + + @node Additional Configuration Options @appendixsubsec Additional Configuration Options @cindex @command{gawk}, configuring, options @@ -38258,7 +38463,8 @@ The people maintaining the various @command{gawk} ports are: @end multitable If your bug is also reproducible under Unix, please send a copy of your -report to the @EMAIL{bug-gawk@@gnu.org,bug-gawk at gnu dot org} email list as well. +report to the @EMAIL{bug-gawk@@gnu.org,bug-gawk at gnu dot org} email +list as well. @c ENDOFRANGE dbugg @c ENDOFRANGE tblgawb diff --git a/doc/gawktexi.in b/doc/gawktexi.in index 2599b8ca..a9811763 100644 --- a/doc/gawktexi.in +++ b/doc/gawktexi.in @@ -984,6 +984,7 @@ particular records in a file and perform operations upon them. * Unix Installation:: Installing @command{gawk} under various versions of Unix. * Quick Installation:: Compiling @command{gawk} under Unix. +* Shell Startup Files:: Shell convenience functions. * Additional Configuration Options:: Other compile-time options. * Configuration Philosophy:: How it's all supposed to work. * Non-Unix Installation:: Installation on Other Operating @@ -3907,10 +3908,8 @@ No space is allowed between the @option{-o} and @var{file}, if @var{file} is supplied. @quotation NOTE -Due to the way @command{gawk} has evolved, with this option -your program is still executed. This will change in the -next major release such that @command{gawk} will only -pretty-print the program and not run it. +In the past, this option would also execute your program. +This is no longer the case. @end quotation @item @option{-O} @@ -4313,6 +4312,9 @@ searches first in the current directory and then in @file{/usr/local/share/awk}. In practice, this means that you will rarely need to change the value of @env{AWKPATH}. +@xref{Shell Startup Files}, for information on functions that help to +manipulate the @env{AWKPATH} variable. + @command{gawk} places the value of the search path that it used into @code{ENVIRON["AWKPATH"]}. This provides access to the actual search path value from within an @command{awk} program. @@ -4344,6 +4346,9 @@ an empty value, @command{gawk} uses a default path; this is typically @samp{/usr/local/lib/gawk}, although it can vary depending upon how @command{gawk} was built. +@xref{Shell Startup Files}, for information on functions that help to +manipulate the @env{AWKLIBPATH} variable. + @command{gawk} places the value of the search path that it used into @code{ENVIRON["AWKLIBPATH"]}. This provides access to the actual search path value from within an @command{awk} program. @@ -4420,14 +4425,6 @@ two regexp matchers that @command{gawk} uses internally. (There aren't supposed to be differences, but occasionally theory and practice don't coordinate with each other.) -@item GAWK_NO_PP_RUN -If this variable exists, then when invoked with the @option{--pretty-print} -option, @command{gawk} skips running the program. - -@quotation CAUTION -This variable will not survive into the next major release. -@end quotation - @item GAWK_STACKSIZE This specifies the amount by which @command{gawk} should grow its internal evaluation stack, when needed. @@ -5008,17 +5005,22 @@ between @samp{0} and @samp{7}. For example, the code for the ASCII ESC @item \x@var{hh}@dots{} The hexadecimal value @var{hh}, where @var{hh} stands for a sequence of hexadecimal digits (@samp{0}--@samp{9}, and either @samp{A}--@samp{F} -or @samp{a}--@samp{f}). Like the same construct -in ISO C, the escape sequence continues until the first nonhexadecimal -digit is seen. @value{COMMONEXT} -However, using more than two hexadecimal digits produces -undefined results. (The @samp{\x} escape sequence is not allowed in -POSIX @command{awk}.) +or @samp{a}--@samp{f}). A maximum of two digts are allowed after +the @samp{\x}. Any further hexadecimal digits are treated as simple +letters or numbers. @value{COMMONEXT} +(The @samp{\x} escape sequence is not allowed in POSIX awk.) @quotation CAUTION -The next major relase of @command{gawk} will change, such -that a maximum of two hexadecimal digits following the -@samp{\x} will be used. +In ISO C, the escape sequence continues until the first nonhexadecimal +digit is seen. +@c FIXME: Add exact version here. +For many years, @command{gawk} would continue incorporating +hexadecimal digits into the value until a non-hexadecimal digit +or the end of the string was encountered. +However, using more than two hexadecimal digits produced +undefined results. +As of @value{PVERSION} @strong{FIXME:} 4.3.0, only two digits +are processed. @end quotation @cindex @code{\} (backslash), @code{\/} escape sequence @@ -14127,10 +14129,18 @@ opens the next file. An associative array containing the values of the environment. The array indices are the environment variable names; the elements are the values of the particular environment variables. For example, -@code{ENVIRON["HOME"]} might be @code{"/home/arnold"}. Changing this array -does not affect the environment passed on to any programs that -@command{awk} may spawn via redirection or the @code{system()} function. -(In a future version of @command{gawk}, it may do so.) +@code{ENVIRON["HOME"]} might be @code{/home/arnold}. + +For POSIX @command{awk}, changing this array does not affect the +environment passed on to any programs that @command{awk} may spawn via +redirection or the @code{system()} function. + +However, beginning with version 4.2, if not in POSIX +compatibility mode, @command{gawk} does update its own environment when +@code{ENVIRON} is changed, thus changing the environment seen by programs +that it creates. You should therefore be especially careful if you +modify @code{ENVIRON["PATH"]"}, which is the search path for finding +executable programs. Some operating systems may not have environment variables. On such systems, the @code{ENVIRON} array is empty (except for @@ -16195,6 +16205,23 @@ You can use @samp{pi = atan2(0, -1)} to retrieve the value of @cindex cosine Return the cosine of @var{x}, with @var{x} in radians. +@item @code{div(@var{numerator}, @var{denominator}, @var{result})} +@cindexawkfunc{div} +@cindex div +Perform integer division, similar to the standard C function of the +same name. First, truncate @code{numerator} and @code{denominator} +towards zero, creating integer values. Clear the @code{result} +array, and then set @code{result["quotient"]} to the result of +@samp{numerator / denominator}, truncated towards zero to an integer, +and set @code{result["remainder"]} to the result of @samp{numerator % +denominator}, truncated towards zero to an integer. This function is +primarily intended for use with arbitrary length integers; it avoids +creating MPFR arbitrary precision floating-point values (@pxref{Arbitrary +Precision Integers}). + +This function is a @code{gawk} extension. It is not available in +compatibility mode (@pxref{Options}). + @item @code{exp(@var{x})} @cindexawkfunc{exp} @cindex exponent @@ -26959,8 +26986,7 @@ The profiled version of your program may not look exactly like what you typed when you wrote it. This is because @command{gawk} creates the profiled version by ``pretty printing'' its internal representation of the program. The advantage to this is that @command{gawk} can produce -a standard representation. The disadvantage is that all source-code -comments are lost. +a standard representation. Also, things such as: @example @@ -27054,9 +27080,26 @@ When called this way, @command{gawk} ``pretty prints'' the program into @file{awkprof.out}, without any execution counts. @quotation NOTE -The @option{--pretty-print} option still runs your program. -This will change in the next major release. +Once upon a time, the @option{--pretty-print} option would also run +your program. This is is no longer the case. @end quotation + +There is a significant difference between the output created when +profiling, and that created when pretty-printing. Pretty-printed output +preserves the original comments that were in the program, although their +placement may not correspond exactly to their original locations in the +source code. + +However, as a deliberate design decision, profiling output @emph{omits} +the original program's comments. This allows you to focus on the +execution count data and helps you avoid the temptation to use the +profiler for pretty-printing. + +Additionally, pretty-printed output does not have the leading indentation +that the profiling output does. This makes it easy to pretty-print your +code once development is completed, and then use the result as the final +version of your program. + @c ENDOFRANGE awkp @c ENDOFRANGE proawk @@ -30120,6 +30163,119 @@ to just use the following: gawk -M 'BEGIN @{ n = 13; print n % 2 @}' @end example +When dividing two arbitrary precision integers with either +@samp{/} or @samp{%}, the result is typically an arbitrary +precision floating point value (unless the denominator evenly +divides into the numerator). In order to do integer division +or remainder with arbitrary precision integers, use the built-in +@code{div()} function (@pxref{Numeric Functions}). + +You can simulate the @code{div()} function in standard @command{awk} +using this user-defined function: + +@example +@c file eg/lib/div.awk +# div --- do integer division + +@c endfile +@ignore +@c file eg/lib/div.awk +# +# Arnold Robbins, arnold@@skeeve.com, Public Domain +# July, 2014 + +@c endfile + +@end ignore +@c file eg/lib/div.awk +function div(numerator, denominator, result) +@{ + split("", result) + + numerator = int(numerator) + denominator = int(denominator) + result["quotient"] = int(numerator / denominator) + result["remainder"] = int(numerator % denominator) + + return 0.0 +@} +@c endfile +@end example + +The following example program, contributed by Katie Wasserman, +uses @code{div()} to +compute the digits of @value{PI} to as many places as you +choose to set: + +@example +@c file eg/prog/pi.awk +# pi.awk --- compute the digits of pi +@c endfile +@c endfile +@ignore +@c file eg/prog/pi.awk +# +# Katie Wasserman, katie@@wass.net +# August 2014 +@c endfile +@end ignore +@c file eg/prog/pi.awk + +BEGIN @{ + digits = 100000 + two = 2 * 10 ^ digits + pi = two + for (m = digits * 4; m > 0; --m) @{ + d = m * 2 + 1 + x = pi * m + div(x, d, result) + pi = result["quotient"] + pi = pi + two + @} + print pi +@} +@c endfile +@end example + +@ignore +Date: Wed, 20 Aug 2014 10:19:11 -0400 +To: arnold@skeeve.com +From: Katherine Wasserman <katie@wass.net> +Subject: Re: computation of digits of pi? + +Arnold, + +>The program that you sent to compute the digits of pi using div(). Is +>that some standard algorithm that every math student knows? If so, +>what's it called? + +It's not that well known but it's not that obscure either + +It's Euler's modification to Newton's method for calculating pi. + +Take a look at lines (23) - (25) here: http://mathworld.wolfram.com/PiFormulas.htm + +The algorithm I wrote simply expands the multiply by 2 and works from the innermost expression outwards. I used this to program HP calculators because it's quite easy to modify for tiny memory devices with smallish word sizes. + +http://www.hpmuseum.org/cgi-sys/cgiwrap/hpmuseum/articles.cgi?read=899 + +-Katie +@end ignore + +When asked about the algorithm used, Katie replied: + +@quotation +It's not that well known but it's not that obscure either. +It's Euler's modification to Newton's method for calculating pi. +Take a look at lines (23) - (25) here: @uref{http://mathworld.wolfram.com/PiFormulas.htm}. + +The algorithm I wrote simply expands the multiply by 2 and works from +the innermost expression outwards. I used this to program HP calculators +because it's quite easy to modify for tiny memory devices with smallish +word sizes. See +@uref{http://www.hpmuseum.org/cgi-sys/cgiwrap/hpmuseum/articles.cgi?read=899}. +@end quotation + @node POSIX Floating Point Problems @section Standards Versus Existing Practice @@ -34946,6 +35102,10 @@ for @command{gawk} @value{PVERSION} 4.1: Ultrix @end itemize +@item +@c FIXME: Verify the version here. +Support for MirBSD was removed at @command{gawk} @value{PVERSION} 4.2. + @end itemize @c XXX ADD MORE STUFF HERE @@ -36229,6 +36389,8 @@ The generated Info file for The @command{troff} source for a manual page describing the @command{igawk} program presented in @ref{Igawk Program}. +(Since @command{gawk} can do its own @code{@@include} processing, +neither @command{igawk} nor @file{igawk.1} are installed.) @item doc/Makefile.in The input file used during the configuration process to generate the @@ -36273,8 +36435,6 @@ source file for this @value{DOCUMENT}. It also contains a @file{Makefile.in} fil @file{Makefile.am} is used by GNU Automake to create @file{Makefile.in}. The library functions from @ref{Library Functions}, -and the @command{igawk} program from -@ref{Igawk Program}, are included as ready-to-use files in the @command{gawk} distribution. They are installed as part of the installation process. The rest of the programs in this @value{DOCUMENT} are available in appropriate @@ -36285,6 +36445,12 @@ The source code, manual pages, and infrastructure files for the sample extensions included with @command{gawk}. @xref{Dynamic Extensions}, for more information. +@item extras/* +Additional non-essential files. Currently, this directory contains some shell +startup files to be installed in @file{/etc/profile.d} to aid in manipulating +the @env{AWKPATH} and @env{AWKLIBPATH} environment variables. +@xref{Shell Startup Files}, for more information. + @item posix/* Files needed for building @command{gawk} on POSIX-compliant systems. @@ -36317,6 +36483,7 @@ to configure @command{gawk} for your system yourself. @menu * Quick Installation:: Compiling @command{gawk} under Unix. +* Shell Startup Files:: Shell convenience functions. * Additional Configuration Options:: Other compile-time options. * Configuration Philosophy:: How it's all supposed to work. @end menu @@ -36397,6 +36564,44 @@ is likely that you will be asked for your password, and you will have to have been set up previously as a user who is allowed to run the @command{sudo} command. +@node Shell Startup Files +@appendixsubsec Shell Startup Files + +The distribution contains shell startup files @file{gawk.sh} and +@file{gawk.csh} containing functions to aid in manipulating +the @env{AWKPATH} and @env{AWKLIBPATH} environment variables. +On a Fedora system, these files should be installed in @file{/etc/profile.d}; +on other platforms, the appropriate location may be different. + +@table @command + +@cindex @command{gawkpath_default} shell function +@item gawkpath_default +Reset the @env{AWKPATH} environment variable to its default value. + +@cindex @command{gawkpath_prepend} shell function +@item gawkpath_prepend +Add the argument to the front of the @env{AWKPATH} environment variable. + +@cindex @command{gawkpath_append} shell function +@item gawkpath_append +Add the argument to the end of the @env{AWKPATH} environment variable. + +@cindex @command{gawklibpath_default} shell function +@item gawklibpath_default +Reset the @env{AWKLIBPATH} environment variable to its default value. + +@cindex @command{gawklibpath_prepend} shell function +@item gawklibpath_prepend +Add the argument to the front of the @env{AWKLIBPATH} environment variable. + +@cindex @command{gawklibpath_append} shell function +@item gawklibpath_append +Add the argument to the end of the @env{AWKLIBPATH} environment variable. + +@end table + + @node Additional Configuration Options @appendixsubsec Additional Configuration Options @cindex @command{gawk}, configuring, options @@ -37352,7 +37557,8 @@ The people maintaining the various @command{gawk} ports are: @end multitable If your bug is also reproducible under Unix, please send a copy of your -report to the @EMAIL{bug-gawk@@gnu.org,bug-gawk at gnu dot org} email list as well. +report to the @EMAIL{bug-gawk@@gnu.org,bug-gawk at gnu dot org} email +list as well. @c ENDOFRANGE dbugg @c ENDOFRANGE tblgawb |