diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/CMakeLists.txt | 95 | ||||
| -rw-r--r-- | doc/ChangeLog | 58 | ||||
| -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 | 1594 | ||||
| -rw-r--r-- | doc/gawk.texi | 272 | ||||
| -rw-r--r-- | doc/gawktexi.in | 272 |
9 files changed, 1543 insertions, 804 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 b78fcb6f..d6e825f2 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -49,6 +49,11 @@ * gawktexi.in: Various minor fixes and updates. +2014-11-23 Arnold D. Robbins <arnold@skeeve.com> + + * gawktexi.in: Update that TZ env. var can influnce mktime + in running program. Thanks to Hermann Peifer. + 2014-11-19 Arnold D. Robbins <arnold@skeeve.com> * gawktexi.in: Update that RFC 4180 documents CSV data. @@ -62,6 +67,11 @@ * gawktexi.in: Comment out that I need an owner for awk.info. I may have found one or two people. +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. @@ -75,6 +85,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> @@ -116,10 +127,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. @@ -215,6 +241,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. @@ -248,6 +278,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. @@ -262,6 +296,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 @@ -272,6 +318,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. @@ -568,7 +619,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> @@ -642,6 +693,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 b8743d28..a17000bc 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -342,7 +342,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 \ @@ -366,7 +366,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/" @@ -866,9 +866,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 @@ -882,12 +882,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 de004225..cf827935 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 @@ -2634,10 +2635,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 still executes. 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' @@ -2937,6 +2936,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. @@ -2976,6 +2978,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. @@ -3047,13 +3052,6 @@ change. The variables are: supposed to be differences, but occasionally theory and practice don't coordinate with each other.) -`GAWK_NO_PP_RUN' - When `gawk' is invoked with the `--pretty-print' option, it will - not run the program if this environment variable exists. - - 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. @@ -3445,15 +3443,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 release 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 @@ -10322,10 +10323,24 @@ 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. + + This can also affect the running `gawk' program, since some of the + built-in functions may pay attention to certain environment + variables. The most notable instance of this is `mktime()' (*note + Time Functions::), which pays attention the value of the `TZ' + environment variable on many systems. Some operating systems may not have environment variables. On such systems, the `ENVIRON' array is empty (except for @@ -11877,6 +11892,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 @@ -19866,8 +19896,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/ @@ -19926,8 +19955,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 @@ -22414,6 +22459,62 @@ 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 @@ -26442,6 +26543,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 @@ -27344,7 +27447,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 @@ -27386,17 +27491,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. @@ -27427,11 +27538,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 -------------------------------------------- @@ -27487,9 +27599,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' @@ -27531,7 +27677,7 @@ supplied by `configure'. 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 @@ -31336,20 +31482,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 238) -* --posix option: Options. (line 256) -* --posix option, --traditional option and: Options. (line 275) +* --optimize option: Options. (line 236) +* --posix option: Options. (line 254) +* --posix option, --traditional option and: Options. (line 273) * --pretty-print option: Options. (line 225) * --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 128) * --sandbox option, input redirection with getline: Getline. (line 19) @@ -31357,9 +31503,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 220) -* --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) @@ -31367,32 +31513,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 220) * -n option: Options. (line 211) -* -O option: Options. (line 238) +* -O option: Options. (line 236) * -o option: Options. (line 225) -* -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) @@ -31454,10 +31600,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. @@ -31497,7 +31643,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 105) + (line 108) * \ (backslash), in regexp constants: Computed Regexps. (line 29) * \ (backslash), in shell commands: Quoting. (line 48) * \ (backslash), regexp operator: Regexp Operators. (line 18) @@ -31665,7 +31811,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) @@ -31723,10 +31869,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. @@ -31766,7 +31912,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 105) + (line 108) * backslash (\), in regexp constants: Computed Regexps. (line 29) * backslash (\), in shell commands: Quoting. (line 48) * backslash (\), regexp operator: Regexp Operators. (line 18) @@ -31872,7 +32018,7 @@ Index (line 67) * Brian Kernighan's awk <12>: GNU Regexp Operators. (line 82) -* Brian Kernighan's awk <13>: Escape Sequences. (line 109) +* Brian Kernighan's awk <13>: Escape Sequences. (line 112) * 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) @@ -32066,7 +32212,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) @@ -32097,12 +32243,12 @@ 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: Full Line Fields. (line 22) -* dark corner, FILENAME variable <1>: Auto-set. (line 90) +* dark corner, FILENAME variable <1>: Auto-set. (line 104) * dark corner, FILENAME variable: Getline Notes. (line 19) -* dark corner, FNR/NR variables: Auto-set. (line 314) +* dark corner, FNR/NR variables: Auto-set. (line 328) * dark corner, format-control characters: Control Letters. (line 18) * dark corner, FS as null string: Single Character Fields. (line 20) @@ -32252,7 +32398,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 70) @@ -32291,12 +32437,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 88) * 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 116) +* differences in awk and gawk, FUNCTAB variable: Auto-set. (line 130) * differences in awk and gawk, function arguments (gawk): Calling Built-in. (line 16) * differences in awk and gawk, getline command: Getline. (line 19) @@ -32319,7 +32465,7 @@ Index (line 263) * differences in awk and gawk, print/printf statements: Format Modifiers. (line 13) -* differences in awk and gawk, PROCINFO array: Auto-set. (line 130) +* differences in awk and gawk, PROCINFO array: Auto-set. (line 144) * differences in awk and gawk, read timeouts: Read Timeout. (line 6) * differences in awk and gawk, record separators: awk split records. (line 125) @@ -32329,7 +32475,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 265) +* differences in awk and gawk, RT variable: Auto-set. (line 279) * differences in awk and gawk, single-character fields: Single Character Fields. (line 6) * differences in awk and gawk, split() function: String Functions. @@ -32337,7 +32483,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 269) +* differences in awk and gawk, SYMTAB variable: Auto-set. (line 283) * differences in awk and gawk, TEXTDOMAIN variable: User-modified. (line 151) * differences in awk and gawk, trunc-mod operation: Arithmetic Ops. @@ -32353,6 +32499,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) @@ -32373,12 +32520,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 135) -* effective user ID of gawk user: Auto-set. (line 139) +* effective group ID of gawk user: Auto-set. (line 149) +* effective user ID of gawk user: Auto-set. (line 153) * egrep utility <1>: Egrep Program. (line 6) * egrep utility: Bracket Expressions. (line 26) * egrep.awk program: Egrep Program. (line 54) @@ -32433,13 +32580,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 88) * ERRNO variable, with BEGINFILE pattern: BEGINFILE/ENDFILE. (line 26) * ERRNO variable, with close() function: Close Files And Pipes. (line 141) * 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 88) * error output: Special FD. (line 6) * escape processing, gsub()/gensub()/sub() functions: Gory Details. (line 6) @@ -32472,10 +32619,10 @@ Index * exit status, of VMS: VMS Running. (line 28) * exit the debugger: Miscellaneous Debugger Commands. (line 99) -* exp: Numeric Functions. (line 18) +* exp: Numeric Functions. (line 33) * expand utility: Very Simple. (line 73) * Expat XML parser library: gawkextlib. (line 33) -* 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) @@ -32493,7 +32640,7 @@ Index (line 6) * extension API version: Extension Versioning. (line 6) -* extension API, version number: Auto-set. (line 232) +* extension API, version number: Auto-set. (line 246) * extension example: Extension Example. (line 6) * extension registration: Registration Functions. (line 6) @@ -32574,7 +32721,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 104) * FILENAME variable: Reading Files. (line 6) * FILENAME variable, getline, setting with: Getline Notes. (line 19) * filenames, assignments as: Ignoring Assigns. (line 6) @@ -32642,9 +32789,9 @@ Index * flush buffered output: I/O Functions. (line 28) * fnmatch() extension function: Extension Sample Fnmatch. (line 12) -* FNR variable <1>: Auto-set. (line 100) +* FNR variable <1>: Auto-set. (line 114) * FNR variable: Records. (line 6) -* FNR variable, changing: Auto-set. (line 314) +* FNR variable, changing: Auto-set. (line 328) * for statement: For Statement. (line 6) * for statement, looping over arrays: Scanning an Array. (line 20) * fork() extension function: Extension Sample Fork. @@ -32681,7 +32828,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. @@ -32694,7 +32841,7 @@ Index * FSF (Free Software Foundation): Manual History. (line 6) * fts() extension function: Extension Sample File Functions. (line 61) -* FUNCTAB array: Auto-set. (line 116) +* FUNCTAB array: Auto-set. (line 130) * function calls: Function Calls. (line 6) * function calls, indirect: Indirect Calls. (line 6) * function calls, indirect, @-notation for: Indirect Calls. (line 47) @@ -32743,8 +32890,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 207) +* gawk program, dynamic profiling: Profiling. (line 178) +* gawk version: Auto-set. (line 221) * gawk, ARGIND variable in: Other Arguments. (line 15) * gawk, awk and <1>: This Manual. (line 14) * gawk, awk and: Preface. (line 21) @@ -32762,13 +32909,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 88) * gawk, ERRNO variable in <3>: BEGINFILE/ENDFILE. (line 26) * gawk, ERRNO variable in <4>: Close Files And Pipes. (line 141) * gawk, ERRNO variable in: Getline. (line 19) -* gawk, escape sequences: Escape Sequences. (line 117) -* gawk, extensions, disabling: Options. (line 256) +* gawk, escape sequences: Escape Sequences. (line 120) +* 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) @@ -32779,7 +32926,7 @@ Index * gawk, FPAT variable in <1>: User-modified. (line 43) * gawk, FPAT variable in: Splitting By Content. (line 25) -* gawk, FUNCTAB array in: Auto-set. (line 116) +* gawk, FUNCTAB array in: Auto-set. (line 130) * 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. @@ -32811,7 +32958,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 130) +* gawk, PROCINFO array in: Auto-set. (line 144) * gawk, regexp constants and: Using Constant Regexps. (line 28) * gawk, regular expressions, case sensitivity: Case-sensitivity. @@ -32819,23 +32966,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 265) +* gawk, RT variable in <1>: Auto-set. (line 279) * 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 87) * gawk, string-translation functions: I18N Functions. (line 6) -* gawk, SYMTAB array in: Auto-set. (line 269) +* gawk, SYMTAB array in: Auto-set. (line 283) * 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) @@ -32912,7 +33065,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 180) +* group ID of gawk user: Auto-set. (line 194) * groups, information about: Group Functions. (line 6) * gsub <1>: String Functions. (line 140) * gsub: Using Constant Regexps. @@ -32934,7 +33087,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) @@ -33013,8 +33166,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. @@ -33070,7 +33223,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. @@ -33142,7 +33295,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 85) * LINT variable: User-modified. (line 88) @@ -33158,14 +33311,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 28) +* log: Numeric Functions. (line 43) * log files, timestamps in: Time Functions. (line 6) -* logarithm: Numeric Functions. (line 28) +* logarithm: Numeric Functions. (line 43) * logical false/true: Truth Values. (line 6) * logical operators, See Boolean expressions: Boolean Ops. (line 6) * login information: Passwd Functions. (line 16) @@ -33206,8 +33359,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 117) -* maximum precision supported by MPFR library: Auto-set. (line 221) +* mawk utility: Escape Sequences. (line 120) +* maximum precision supported by MPFR library: Auto-set. (line 235) * McIlroy, Doug: Glossary. (line 177) * McPhee, Patrick: Contributors. (line 100) * message object files: Explaining gettext. (line 42) @@ -33219,8 +33372,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 224) +* metacharacters, escape sequences for: Escape Sequences. (line 139) +* minimum precision supported by MPFR library: Auto-set. (line 238) * mktime: Time Functions. (line 25) * modifiers, in format specifiers: Format Modifiers. (line 6) * monetary information, localization: Explaining gettext. (line 104) @@ -33240,7 +33393,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) @@ -33269,7 +33422,7 @@ Index (line 47) * nexti debugger command: Debugger Execution Control. (line 49) -* NF variable <1>: Auto-set. (line 105) +* NF variable <1>: Auto-set. (line 119) * NF variable: Fields. (line 33) * NF variable, decrementing: Changing Fields. (line 107) * ni debugger command (alias for nexti): Debugger Execution Control. @@ -33278,9 +33431,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 125) +* NR variable <1>: Auto-set. (line 139) * NR variable: Records. (line 6) -* NR variable, changing: Auto-set. (line 314) +* NR variable, changing: Auto-set. (line 328) * null strings <1>: Basic Data Typing. (line 26) * null strings <2>: Truth Values. (line 6) * null strings <3>: Regexp Field Splitting. @@ -33394,7 +33547,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 189) +* parent process ID of gawk process: Auto-set. (line 203) * parentheses (), in a profile: Profiling. (line 146) * parentheses (), regexp operator: Regexp Operators. (line 81) * password file: Passwd Functions. (line 16) @@ -33436,14 +33589,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 105) + (line 108) * portability, close() function and: Close Files And Pipes. (line 81) * portability, data files as single record: gawk split records. @@ -33461,7 +33614,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 512) * portable object files <1>: Translator i18n. (line 6) * portable object files: Explaining gettext. (line 37) @@ -33482,7 +33635,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 105) + (line 108) * 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. @@ -33509,11 +33662,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) @@ -33560,24 +33713,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 183) -* process ID of gawk process: Auto-set. (line 186) +* process group idIDof gawk process: Auto-set. (line 197) +* process ID of gawk process: Auto-set. (line 200) * 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 130) +* PROCINFO array: Auto-set. (line 144) * 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 242) +* PROCINFO array, uses: Auto-set. (line 256) * 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 148) +* profiling awk programs, dynamically: Profiling. (line 178) +* program identifiers: Auto-set. (line 162) * program, definition of: Getting Started. (line 21) * programming conventions, --non-decimal-data option: Nondecimal Data. (line 35) @@ -33612,7 +33765,7 @@ Index * QuikTrim Awk: Other Versions. (line 139) * 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) @@ -33621,12 +33774,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 33) +* rand: Numeric Functions. (line 48) * random numbers, Cliff: Cliff Random Function. (line 6) * random numbers, rand()/srand() functions: Numeric Functions. - (line 33) -* random numbers, seed of: Numeric Functions. (line 63) + (line 48) +* random numbers, seed of: Numeric Functions. (line 78) * range expressions (regexps): Bracket Expressions. (line 6) * range patterns: Ranges. (line 6) * range patterns, line continuation and: Ranges. (line 65) @@ -33695,7 +33848,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) @@ -33735,7 +33888,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 252) +* RLENGTH variable: Auto-set. (line 266) * RLENGTH variable, match() function and: String Functions. (line 228) * Robbins, Arnold <1>: Future Extensions. (line 6) * Robbins, Arnold <2>: Bugs. (line 70) @@ -33753,7 +33906,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) @@ -33761,9 +33914,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 258) +* RSTART variable: Auto-set. (line 272) * RSTART variable, match() function and: String Functions. (line 228) -* RT variable <1>: Auto-set. (line 265) +* RT variable <1>: Auto-set. (line 279) * RT variable <2>: Multiple Line. (line 129) * RT variable: awk split records. (line 125) * Rubin, Paul <1>: Contributors. (line 15) @@ -33776,14 +33929,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 297) +* Schorr, Andrew <2>: Auto-set. (line 311) * Schorr, Andrew: Acknowledgments. (line 60) * Schreiber, Bert: Acknowledgments. (line 38) * Schreiber, Rita: Acknowledgments. (line 38) @@ -33802,7 +33955,7 @@ Index * sed utility <1>: Glossary. (line 16) * sed utility <2>: Simple Sed. (line 6) * sed utility: Full Line Fields. (line 22) -* seeding random number generator: Numeric Functions. (line 63) +* seeding random number generator: Numeric Functions. (line 78) * semicolon (;), AWKPATH variable and: PC Using. (line 10) * semicolon (;), separating statements in actions <1>: Statements. (line 10) @@ -33863,14 +34016,14 @@ Index * sidebar, A Constant's Base Does Not Affect Its Value: Nondecimal-numbers. (line 64) * sidebar, Backslash Before Regular Characters: Escape Sequences. - (line 103) + (line 106) * sidebar, Changing FS Does Not Affect the Fields: Full Line Fields. (line 14) -* sidebar, Changing NR and FNR: Auto-set. (line 312) +* sidebar, Changing NR and FNR: Auto-set. (line 326) * sidebar, Controlling Output Buffering with system(): I/O Functions. (line 138) * sidebar, Escape Sequences for Metacharacters: Escape Sequences. - (line 134) + (line 137) * sidebar, FS and IGNORECASE: Field Splitting Summary. (line 38) * sidebar, Interactive Versus Noninteractive Buffering: I/O Functions. @@ -33892,19 +34045,19 @@ Index (line 57) * sidebar, Using close()'s Return Value: Close Files And Pipes. (line 131) -* 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 74) -* sine: Numeric Functions. (line 74) +* sin: Numeric Functions. (line 89) +* sine: Numeric Functions. (line 89) * single quote ('): One-shot. (line 15) * single quote (') in gawk command lines: Long. (line 35) * single quote ('), in shell commands: Quoting. (line 48) @@ -33954,10 +34107,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 77) +* sqrt: Numeric Functions. (line 92) * square brackets ([]), regexp operator: Regexp Operators. (line 56) -* square root: Numeric Functions. (line 77) -* srand: Numeric Functions. (line 81) +* square root: Numeric Functions. (line 92) +* srand: Numeric Functions. (line 96) * stack frame: Debugging Terms. (line 10) * Stallman, Richard <1>: Glossary. (line 288) * Stallman, Richard <2>: Contributors. (line 23) @@ -34028,9 +34181,9 @@ Index * substr: String Functions. (line 481) * substring: String Functions. (line 481) * Sumner, Andrew: Other Versions. (line 68) -* supplementary groups of gawk process: Auto-set. (line 237) +* supplementary groups of gawk process: Auto-set. (line 251) * switch statement: Switch Statement. (line 6) -* SYMTAB array: Auto-set. (line 269) +* SYMTAB array: Auto-set. (line 283) * syntactic ambiguity: /= operator vs. /=.../ regexp constant: Assignment Ops. (line 148) * system: I/O Functions. (line 106) @@ -34097,7 +34250,7 @@ Index (line 37) * troubleshooting, awk uses FS not IFS: Field Separators. (line 30) * troubleshooting, backslash before nonspecial character: Escape Sequences. - (line 105) + (line 108) * troubleshooting, division: Arithmetic Ops. (line 44) * troubleshooting, fatal errors, field widths, specifying: Constant Size. (line 22) @@ -34153,7 +34306,7 @@ Index * uniq.awk program: Uniq Program. (line 65) * Unix: Glossary. (line 611) * Unix awk, backslashes in escape sequences: Escape Sequences. - (line 117) + (line 120) * Unix awk, close() function and: Close Files And Pipes. (line 133) * Unix awk, password files, field separators and: Command Line Field Separator. @@ -34173,7 +34326,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) @@ -34207,10 +34360,10 @@ Index * variables, uninitialized, as array subscripts: Uninitialized Subscripts. (line 6) * variables, user-defined: Variables. (line 6) -* version of gawk: Auto-set. (line 207) -* version of gawk extension API: Auto-set. (line 232) -* version of GNU MP library: Auto-set. (line 218) -* version of GNU MPFR library: Auto-set. (line 214) +* version of gawk: Auto-set. (line 221) +* version of gawk extension API: Auto-set. (line 246) +* version of GNU MP library: Auto-set. (line 232) +* version of GNU MPFR library: Auto-set. (line 228) * vertical bar (|): Regexp Operators. (line 70) * vertical bar (|), | operator (I/O) <1>: Precedence. (line 65) * vertical bar (|), | operator (I/O): Getline/Pipe. (line 9) @@ -34247,7 +34400,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) @@ -34300,559 +34453,560 @@ Index Tag Table: Node: Top1204 -Node: Foreword342156 -Node: Foreword446600 -Node: Preface48131 -Ref: Preface-Footnote-151002 -Ref: Preface-Footnote-251109 -Ref: Preface-Footnote-351342 -Node: History51484 -Node: Names53835 -Ref: Names-Footnote-154928 -Node: This Manual55074 -Ref: This Manual-Footnote-161574 -Node: Conventions61674 -Node: Manual History64011 -Ref: Manual History-Footnote-167004 -Ref: Manual History-Footnote-267045 -Node: How To Contribute67119 -Node: Acknowledgments68248 -Node: Getting Started73065 -Node: Running gawk75504 -Node: One-shot76694 -Node: Read Terminal77958 -Node: Long79989 -Node: Executable Scripts81502 -Ref: Executable Scripts-Footnote-184291 -Node: Comments84394 -Node: Quoting86876 -Node: DOS Quoting92394 -Node: Sample Data Files93069 -Node: Very Simple95664 -Node: Two Rules100563 -Node: More Complex102449 -Node: Statements/Lines105311 -Ref: Statements/Lines-Footnote-1109766 -Node: Other Features110031 -Node: When110967 -Ref: When-Footnote-1112721 -Node: Intro Summary112786 -Node: Invoking Gawk113670 -Node: Command Line115184 -Node: Options115982 -Ref: Options-Footnote-1131904 -Ref: Options-Footnote-2132133 -Node: Other Arguments132158 -Node: Naming Standard Input135106 -Node: Environment Variables136199 -Node: AWKPATH Variable136757 -Ref: AWKPATH Variable-Footnote-1140054 -Ref: AWKPATH Variable-Footnote-2140099 -Node: AWKLIBPATH Variable140359 -Node: Other Environment Variables141502 -Node: Exit Status145260 -Node: Include Files145936 -Node: Loading Shared Libraries149525 -Node: Obsolete150952 -Node: Undocumented151644 -Node: Invoking Summary151911 -Node: Regexp153574 -Node: Regexp Usage155028 -Node: Escape Sequences157065 -Node: Regexp Operators163075 -Ref: Regexp Operators-Footnote-1170485 -Ref: Regexp Operators-Footnote-2170632 -Node: Bracket Expressions170730 -Ref: table-char-classes172745 -Node: Leftmost Longest175670 -Node: Computed Regexps176972 -Node: GNU Regexp Operators180369 -Node: Case-sensitivity184042 -Ref: Case-sensitivity-Footnote-1186927 -Ref: Case-sensitivity-Footnote-2187162 -Node: Regexp Summary187270 -Node: Reading Files188737 -Node: Records190831 -Node: awk split records191564 -Node: gawk split records196479 -Ref: gawk split records-Footnote-1201023 -Node: Fields201060 -Ref: Fields-Footnote-1203836 -Node: Nonconstant Fields203922 -Ref: Nonconstant Fields-Footnote-1206165 -Node: Changing Fields206369 -Node: Field Separators212298 -Node: Default Field Splitting215003 -Node: Regexp Field Splitting216120 -Node: Single Character Fields219470 -Node: Command Line Field Separator220529 -Node: Full Line Fields223741 -Ref: Full Line Fields-Footnote-1225258 -Ref: Full Line Fields-Footnote-2225304 -Node: Field Splitting Summary225405 -Node: Constant Size227479 -Node: Splitting By Content232068 -Ref: Splitting By Content-Footnote-1236062 -Node: Multiple Line236225 -Ref: Multiple Line-Footnote-1242111 -Node: Getline242290 -Node: Plain Getline244502 -Node: Getline/Variable247142 -Node: Getline/File248290 -Node: Getline/Variable/File249674 -Ref: Getline/Variable/File-Footnote-1251277 -Node: Getline/Pipe251364 -Node: Getline/Variable/Pipe254047 -Node: Getline/Coprocess255178 -Node: Getline/Variable/Coprocess256430 -Node: Getline Notes257169 -Node: Getline Summary259961 -Ref: table-getline-variants260373 -Node: Read Timeout261202 -Ref: Read Timeout-Footnote-1265026 -Node: Command-line directories265084 -Node: Input Summary265989 -Node: Input Exercises269290 -Node: Printing270018 -Node: Print271795 -Node: Print Examples273252 -Node: Output Separators276031 -Node: OFMT278049 -Node: Printf279403 -Node: Basic Printf280188 -Node: Control Letters281758 -Node: Format Modifiers285741 -Node: Printf Examples291750 -Node: Redirection294236 -Node: Special FD301077 -Ref: Special FD-Footnote-1304237 -Node: Special Files304311 -Node: Other Inherited Files304928 -Node: Special Network305928 -Node: Special Caveats306790 -Node: Close Files And Pipes307741 -Ref: Close Files And Pipes-Footnote-1314923 -Ref: Close Files And Pipes-Footnote-2315071 -Node: Output Summary315221 -Node: Output Exercises316219 -Node: Expressions316899 -Node: Values318084 -Node: Constants318762 -Node: Scalar Constants319453 -Ref: Scalar Constants-Footnote-1320312 -Node: Nondecimal-numbers320562 -Node: Regexp Constants323580 -Node: Using Constant Regexps324105 -Node: Variables327248 -Node: Using Variables327903 -Node: Assignment Options329814 -Node: Conversion331689 -Node: Strings And Numbers332213 -Ref: Strings And Numbers-Footnote-1335278 -Node: Locale influences conversions335387 -Ref: table-locale-affects338134 -Node: All Operators338722 -Node: Arithmetic Ops339352 -Node: Concatenation341857 -Ref: Concatenation-Footnote-1344676 -Node: Assignment Ops344782 -Ref: table-assign-ops349761 -Node: Increment Ops351033 -Node: Truth Values and Conditions354471 -Node: Truth Values355556 -Node: Typing and Comparison356605 -Node: Variable Typing357415 -Node: Comparison Operators361068 -Ref: table-relational-ops361478 -Node: POSIX String Comparison364973 -Ref: POSIX String Comparison-Footnote-1366045 -Node: Boolean Ops366183 -Ref: Boolean Ops-Footnote-1370662 -Node: Conditional Exp370753 -Node: Function Calls372480 -Node: Precedence376360 -Node: Locales380021 -Node: Expressions Summary381653 -Node: Patterns and Actions384213 -Node: Pattern Overview385333 -Node: Regexp Patterns387012 -Node: Expression Patterns387555 -Node: Ranges391265 -Node: BEGIN/END394371 -Node: Using BEGIN/END395132 -Ref: Using BEGIN/END-Footnote-1397866 -Node: I/O And BEGIN/END397972 -Node: BEGINFILE/ENDFILE400286 -Node: Empty403187 -Node: Using Shell Variables403504 -Node: Action Overview405777 -Node: Statements408103 -Node: If Statement409951 -Node: While Statement411446 -Node: Do Statement413475 -Node: For Statement414619 -Node: Switch Statement417776 -Node: Break Statement420158 -Node: Continue Statement422199 -Node: Next Statement424026 -Node: Nextfile Statement426407 -Node: Exit Statement429037 -Node: Built-in Variables431440 -Node: User-modified432573 -Ref: User-modified-Footnote-1440254 -Node: Auto-set440316 -Ref: Auto-set-Footnote-1453351 -Ref: Auto-set-Footnote-2453556 -Node: ARGC and ARGV453612 -Node: Pattern Action Summary457830 -Node: Arrays460257 -Node: Array Basics461586 -Node: Array Intro462430 -Ref: figure-array-elements464394 -Ref: Array Intro-Footnote-1466920 -Node: Reference to Elements467048 -Node: Assigning Elements469500 -Node: Array Example469991 -Node: Scanning an Array471749 -Node: Controlling Scanning474765 -Ref: Controlling Scanning-Footnote-1479961 -Node: Numeric Array Subscripts480277 -Node: Uninitialized Subscripts482462 -Node: Delete484079 -Ref: Delete-Footnote-1486822 -Node: Multidimensional486879 -Node: Multiscanning489976 -Node: Arrays of Arrays491565 -Node: Arrays Summary496324 -Node: Functions498416 -Node: Built-in499315 -Node: Calling Built-in500393 -Node: Numeric Functions502384 -Ref: Numeric Functions-Footnote-1506401 -Ref: Numeric Functions-Footnote-2506758 -Ref: Numeric Functions-Footnote-3506806 -Node: String Functions507078 -Ref: String Functions-Footnote-1530553 -Ref: String Functions-Footnote-2530682 -Ref: String Functions-Footnote-3530930 -Node: Gory Details531017 -Ref: table-sub-escapes532798 -Ref: table-sub-proposed534318 -Ref: table-posix-sub535682 -Ref: table-gensub-escapes537218 -Ref: Gory Details-Footnote-1538050 -Node: I/O Functions538201 -Ref: I/O Functions-Footnote-1545419 -Node: Time Functions545566 -Ref: Time Functions-Footnote-1556054 -Ref: Time Functions-Footnote-2556122 -Ref: Time Functions-Footnote-3556280 -Ref: Time Functions-Footnote-4556391 -Ref: Time Functions-Footnote-5556503 -Ref: Time Functions-Footnote-6556730 -Node: Bitwise Functions556996 -Ref: table-bitwise-ops557558 -Ref: Bitwise Functions-Footnote-1561867 -Node: Type Functions562036 -Node: I18N Functions563187 -Node: User-defined564832 -Node: Definition Syntax565637 -Ref: Definition Syntax-Footnote-1571044 -Node: Function Example571115 -Ref: Function Example-Footnote-1574034 -Node: Function Caveats574056 -Node: Calling A Function574574 -Node: Variable Scope575532 -Node: Pass By Value/Reference578520 -Node: Return Statement582015 -Node: Dynamic Typing584996 -Node: Indirect Calls585925 -Ref: Indirect Calls-Footnote-1597227 -Node: Functions Summary597355 -Node: Library Functions600057 -Ref: Library Functions-Footnote-1603666 -Ref: Library Functions-Footnote-2603809 -Node: Library Names603980 -Ref: Library Names-Footnote-1607434 -Ref: Library Names-Footnote-2607657 -Node: General Functions607743 -Node: Strtonum Function608846 -Node: Assert Function611868 -Node: Round Function615192 -Node: Cliff Random Function616733 -Node: Ordinal Functions617749 -Ref: Ordinal Functions-Footnote-1620812 -Ref: Ordinal Functions-Footnote-2621064 -Node: Join Function621275 -Ref: Join Function-Footnote-1623044 -Node: Getlocaltime Function623244 -Node: Readfile Function626988 -Node: Shell Quoting628958 -Node: Data File Management630359 -Node: Filetrans Function630991 -Node: Rewind Function635047 -Node: File Checking636434 -Ref: File Checking-Footnote-1637766 -Node: Empty Files637967 -Node: Ignoring Assigns639946 -Node: Getopt Function641497 -Ref: Getopt Function-Footnote-1652959 -Node: Passwd Functions653159 -Ref: Passwd Functions-Footnote-1661996 -Node: Group Functions662084 -Ref: Group Functions-Footnote-1669978 -Node: Walking Arrays670191 -Node: Library Functions Summary671794 -Node: Library Exercises673195 -Node: Sample Programs674475 -Node: Running Examples675245 -Node: Clones675973 -Node: Cut Program677197 -Node: Egrep Program686916 -Ref: Egrep Program-Footnote-1694414 -Node: Id Program694524 -Node: Split Program698169 -Ref: Split Program-Footnote-1701617 -Node: Tee Program701745 -Node: Uniq Program704534 -Node: Wc Program711953 -Ref: Wc Program-Footnote-1716203 -Node: Miscellaneous Programs716297 -Node: Dupword Program717510 -Node: Alarm Program719541 -Node: Translate Program724345 -Ref: Translate Program-Footnote-1728910 -Node: Labels Program729180 -Ref: Labels Program-Footnote-1732531 -Node: Word Sorting732615 -Node: History Sorting736686 -Node: Extract Program738522 -Node: Simple Sed746047 -Node: Igawk Program749115 -Ref: Igawk Program-Footnote-1763439 -Ref: Igawk Program-Footnote-2763640 -Ref: Igawk Program-Footnote-3763762 -Node: Anagram Program763877 -Node: Signature Program766934 -Node: Programs Summary768181 -Node: Programs Exercises769374 -Ref: Programs Exercises-Footnote-1773505 -Node: Advanced Features773596 -Node: Nondecimal Data775544 -Node: Array Sorting777134 -Node: Controlling Array Traversal777831 -Ref: Controlling Array Traversal-Footnote-1786164 -Node: Array Sorting Functions786282 -Ref: Array Sorting Functions-Footnote-1790171 -Node: Two-way I/O790367 -Ref: Two-way I/O-Footnote-1795312 -Ref: Two-way I/O-Footnote-2795498 -Node: TCP/IP Networking795580 -Node: Profiling798453 -Node: Advanced Features Summary806000 -Node: Internationalization807933 -Node: I18N and L10N809413 -Node: Explaining gettext810099 -Ref: Explaining gettext-Footnote-1815124 -Ref: Explaining gettext-Footnote-2815308 -Node: Programmer i18n815473 -Ref: Programmer i18n-Footnote-1820339 -Node: Translator i18n820388 -Node: String Extraction821182 -Ref: String Extraction-Footnote-1822313 -Node: Printf Ordering822399 -Ref: Printf Ordering-Footnote-1825185 -Node: I18N Portability825249 -Ref: I18N Portability-Footnote-1827704 -Node: I18N Example827767 -Ref: I18N Example-Footnote-1830570 -Node: Gawk I18N830642 -Node: I18N Summary831280 -Node: Debugger832619 -Node: Debugging833641 -Node: Debugging Concepts834082 -Node: Debugging Terms835935 -Node: Awk Debugging838507 -Node: Sample Debugging Session839401 -Node: Debugger Invocation839921 -Node: Finding The Bug841305 -Node: List of Debugger Commands847780 -Node: Breakpoint Control849113 -Node: Debugger Execution Control852809 -Node: Viewing And Changing Data856173 -Node: Execution Stack859551 -Node: Debugger Info861188 -Node: Miscellaneous Debugger Commands865205 -Node: Readline Support870234 -Node: Limitations871126 -Node: Debugging Summary873240 -Node: Arbitrary Precision Arithmetic874408 -Node: Computer Arithmetic875824 -Ref: table-numeric-ranges879422 -Ref: Computer Arithmetic-Footnote-1880281 -Node: Math Definitions880338 -Ref: table-ieee-formats883626 -Ref: Math Definitions-Footnote-1884230 -Node: MPFR features884335 -Node: FP Math Caution886006 -Ref: FP Math Caution-Footnote-1887056 -Node: Inexactness of computations887425 -Node: Inexact representation888384 -Node: Comparing FP Values889741 -Node: Errors accumulate890823 -Node: Getting Accuracy892256 -Node: Try To Round894918 -Node: Setting precision895817 -Ref: table-predefined-precision-strings896501 -Node: Setting the rounding mode898290 -Ref: table-gawk-rounding-modes898654 -Ref: Setting the rounding mode-Footnote-1902109 -Node: Arbitrary Precision Integers902288 -Ref: Arbitrary Precision Integers-Footnote-1905274 -Node: POSIX Floating Point Problems905423 -Ref: POSIX Floating Point Problems-Footnote-1909296 -Node: Floating point summary909334 -Node: Dynamic Extensions911528 -Node: Extension Intro913080 -Node: Plugin License914346 -Node: Extension Mechanism Outline915143 -Ref: figure-load-extension915571 -Ref: figure-register-new-function917051 -Ref: figure-call-new-function918055 -Node: Extension API Description920041 -Node: Extension API Functions Introduction921491 -Node: General Data Types926315 -Ref: General Data Types-Footnote-1932054 -Node: Memory Allocation Functions932353 -Ref: Memory Allocation Functions-Footnote-1935192 -Node: Constructor Functions935288 -Node: Registration Functions937022 -Node: Extension Functions937707 -Node: Exit Callback Functions940004 -Node: Extension Version String941252 -Node: Input Parsers941917 -Node: Output Wrappers951796 -Node: Two-way processors956311 -Node: Printing Messages958515 -Ref: Printing Messages-Footnote-1959591 -Node: Updating `ERRNO'959743 -Node: Requesting Values960483 -Ref: table-value-types-returned961211 -Node: Accessing Parameters962168 -Node: Symbol Table Access963399 -Node: Symbol table by name963913 -Node: Symbol table by cookie965894 -Ref: Symbol table by cookie-Footnote-1970038 -Node: Cached values970101 -Ref: Cached values-Footnote-1973600 -Node: Array Manipulation973691 -Ref: Array Manipulation-Footnote-1974789 -Node: Array Data Types974826 -Ref: Array Data Types-Footnote-1977481 -Node: Array Functions977573 -Node: Flattening Arrays981427 -Node: Creating Arrays988319 -Node: Extension API Variables993090 -Node: Extension Versioning993726 -Node: Extension API Informational Variables995627 -Node: Extension API Boilerplate996692 -Node: Finding Extensions1000501 -Node: Extension Example1001061 -Node: Internal File Description1001833 -Node: Internal File Ops1005900 -Ref: Internal File Ops-Footnote-11017570 -Node: Using Internal File Ops1017710 -Ref: Using Internal File Ops-Footnote-11020093 -Node: Extension Samples1020366 -Node: Extension Sample File Functions1021892 -Node: Extension Sample Fnmatch1029530 -Node: Extension Sample Fork1031021 -Node: Extension Sample Inplace1032236 -Node: Extension Sample Ord1033911 -Node: Extension Sample Readdir1034747 -Ref: table-readdir-file-types1035623 -Node: Extension Sample Revout1036434 -Node: Extension Sample Rev2way1037024 -Node: Extension Sample Read write array1037764 -Node: Extension Sample Readfile1039704 -Node: Extension Sample Time1040799 -Node: Extension Sample API Tests1042148 -Node: gawkextlib1042639 -Node: Extension summary1045297 -Node: Extension Exercises1048986 -Node: Language History1049708 -Node: V7/SVR3.11051364 -Node: SVR41053545 -Node: POSIX1054990 -Node: BTL1056379 -Node: POSIX/GNU1057113 -Node: Feature History1062677 -Node: Common Extensions1075775 -Node: Ranges and Locales1077099 -Ref: Ranges and Locales-Footnote-11081717 -Ref: Ranges and Locales-Footnote-21081744 -Ref: Ranges and Locales-Footnote-31081978 -Node: Contributors1082199 -Node: History summary1087740 -Node: Installation1089110 -Node: Gawk Distribution1090056 -Node: Getting1090540 -Node: Extracting1091363 -Node: Distribution contents1092998 -Node: Unix Installation1098715 -Node: Quick Installation1099332 -Node: Additional Configuration Options1101756 -Node: Configuration Philosophy1103494 -Node: Non-Unix Installation1105863 -Node: PC Installation1106321 -Node: PC Binary Installation1107640 -Node: PC Compiling1109488 -Ref: PC Compiling-Footnote-11112509 -Node: PC Testing1112618 -Node: PC Using1113794 -Node: Cygwin1117909 -Node: MSYS1118732 -Node: VMS Installation1119232 -Node: VMS Compilation1120024 -Ref: VMS Compilation-Footnote-11121246 -Node: VMS Dynamic Extensions1121304 -Node: VMS Installation Details1122988 -Node: VMS Running1125240 -Node: VMS GNV1128076 -Node: VMS Old Gawk1128810 -Node: Bugs1129280 -Node: Other Versions1133163 -Node: Installation summary1139587 -Node: Notes1140643 -Node: Compatibility Mode1141508 -Node: Additions1142290 -Node: Accessing The Source1143215 -Node: Adding Code1144650 -Node: New Ports1150815 -Node: Derived Files1155297 -Ref: Derived Files-Footnote-11160772 -Ref: Derived Files-Footnote-21160806 -Ref: Derived Files-Footnote-31161402 -Node: Future Extensions1161516 -Node: Implementation Limitations1162122 -Node: Extension Design1163370 -Node: Old Extension Problems1164524 -Ref: Old Extension Problems-Footnote-11166041 -Node: Extension New Mechanism Goals1166098 -Ref: Extension New Mechanism Goals-Footnote-11169458 -Node: Extension Other Design Decisions1169647 -Node: Extension Future Growth1171755 -Node: Old Extension Mechanism1172591 -Node: Notes summary1174353 -Node: Basic Concepts1175539 -Node: Basic High Level1176220 -Ref: figure-general-flow1176492 -Ref: figure-process-flow1177091 -Ref: Basic High Level-Footnote-11180320 -Node: Basic Data Typing1180505 -Node: Glossary1183833 -Node: Copying1208991 -Node: GNU Free Documentation License1246547 -Node: Index1271683 +Node: Foreword342225 +Node: Foreword446669 +Node: Preface48200 +Ref: Preface-Footnote-151071 +Ref: Preface-Footnote-251178 +Ref: Preface-Footnote-351411 +Node: History51553 +Node: Names53904 +Ref: Names-Footnote-154997 +Node: This Manual55143 +Ref: This Manual-Footnote-161643 +Node: Conventions61743 +Node: Manual History64080 +Ref: Manual History-Footnote-167073 +Ref: Manual History-Footnote-267114 +Node: How To Contribute67188 +Node: Acknowledgments68317 +Node: Getting Started73134 +Node: Running gawk75573 +Node: One-shot76763 +Node: Read Terminal78027 +Node: Long80058 +Node: Executable Scripts81571 +Ref: Executable Scripts-Footnote-184360 +Node: Comments84463 +Node: Quoting86945 +Node: DOS Quoting92463 +Node: Sample Data Files93138 +Node: Very Simple95733 +Node: Two Rules100632 +Node: More Complex102518 +Node: Statements/Lines105380 +Ref: Statements/Lines-Footnote-1109835 +Node: Other Features110100 +Node: When111036 +Ref: When-Footnote-1112790 +Node: Intro Summary112855 +Node: Invoking Gawk113739 +Node: Command Line115253 +Node: Options116051 +Ref: Options-Footnote-1131846 +Ref: Options-Footnote-2132075 +Node: Other Arguments132100 +Node: Naming Standard Input135048 +Node: Environment Variables136141 +Node: AWKPATH Variable136699 +Ref: AWKPATH Variable-Footnote-1140106 +Ref: AWKPATH Variable-Footnote-2140151 +Node: AWKLIBPATH Variable140411 +Node: Other Environment Variables141667 +Node: Exit Status145185 +Node: Include Files145861 +Node: Loading Shared Libraries149450 +Node: Obsolete150877 +Node: Undocumented151569 +Node: Invoking Summary151836 +Node: Regexp153499 +Node: Regexp Usage154953 +Node: Escape Sequences156990 +Node: Regexp Operators163230 +Ref: Regexp Operators-Footnote-1170640 +Ref: Regexp Operators-Footnote-2170787 +Node: Bracket Expressions170885 +Ref: table-char-classes172900 +Node: Leftmost Longest175825 +Node: Computed Regexps177127 +Node: GNU Regexp Operators180524 +Node: Case-sensitivity184197 +Ref: Case-sensitivity-Footnote-1187082 +Ref: Case-sensitivity-Footnote-2187317 +Node: Regexp Summary187425 +Node: Reading Files188892 +Node: Records190986 +Node: awk split records191719 +Node: gawk split records196634 +Ref: gawk split records-Footnote-1201178 +Node: Fields201215 +Ref: Fields-Footnote-1203991 +Node: Nonconstant Fields204077 +Ref: Nonconstant Fields-Footnote-1206320 +Node: Changing Fields206524 +Node: Field Separators212453 +Node: Default Field Splitting215158 +Node: Regexp Field Splitting216275 +Node: Single Character Fields219625 +Node: Command Line Field Separator220684 +Node: Full Line Fields223896 +Ref: Full Line Fields-Footnote-1225413 +Ref: Full Line Fields-Footnote-2225459 +Node: Field Splitting Summary225560 +Node: Constant Size227634 +Node: Splitting By Content232223 +Ref: Splitting By Content-Footnote-1236217 +Node: Multiple Line236380 +Ref: Multiple Line-Footnote-1242266 +Node: Getline242445 +Node: Plain Getline244657 +Node: Getline/Variable247297 +Node: Getline/File248445 +Node: Getline/Variable/File249829 +Ref: Getline/Variable/File-Footnote-1251432 +Node: Getline/Pipe251519 +Node: Getline/Variable/Pipe254202 +Node: Getline/Coprocess255333 +Node: Getline/Variable/Coprocess256585 +Node: Getline Notes257324 +Node: Getline Summary260116 +Ref: table-getline-variants260528 +Node: Read Timeout261357 +Ref: Read Timeout-Footnote-1265181 +Node: Command-line directories265239 +Node: Input Summary266144 +Node: Input Exercises269445 +Node: Printing270173 +Node: Print271950 +Node: Print Examples273407 +Node: Output Separators276186 +Node: OFMT278204 +Node: Printf279558 +Node: Basic Printf280343 +Node: Control Letters281913 +Node: Format Modifiers285896 +Node: Printf Examples291905 +Node: Redirection294391 +Node: Special FD301232 +Ref: Special FD-Footnote-1304392 +Node: Special Files304466 +Node: Other Inherited Files305083 +Node: Special Network306083 +Node: Special Caveats306945 +Node: Close Files And Pipes307896 +Ref: Close Files And Pipes-Footnote-1315078 +Ref: Close Files And Pipes-Footnote-2315226 +Node: Output Summary315376 +Node: Output Exercises316374 +Node: Expressions317054 +Node: Values318239 +Node: Constants318917 +Node: Scalar Constants319608 +Ref: Scalar Constants-Footnote-1320467 +Node: Nondecimal-numbers320717 +Node: Regexp Constants323735 +Node: Using Constant Regexps324260 +Node: Variables327403 +Node: Using Variables328058 +Node: Assignment Options329969 +Node: Conversion331844 +Node: Strings And Numbers332368 +Ref: Strings And Numbers-Footnote-1335433 +Node: Locale influences conversions335542 +Ref: table-locale-affects338289 +Node: All Operators338877 +Node: Arithmetic Ops339507 +Node: Concatenation342012 +Ref: Concatenation-Footnote-1344831 +Node: Assignment Ops344937 +Ref: table-assign-ops349916 +Node: Increment Ops351188 +Node: Truth Values and Conditions354626 +Node: Truth Values355711 +Node: Typing and Comparison356760 +Node: Variable Typing357570 +Node: Comparison Operators361223 +Ref: table-relational-ops361633 +Node: POSIX String Comparison365128 +Ref: POSIX String Comparison-Footnote-1366200 +Node: Boolean Ops366338 +Ref: Boolean Ops-Footnote-1370817 +Node: Conditional Exp370908 +Node: Function Calls372635 +Node: Precedence376515 +Node: Locales380176 +Node: Expressions Summary381808 +Node: Patterns and Actions384368 +Node: Pattern Overview385488 +Node: Regexp Patterns387167 +Node: Expression Patterns387710 +Node: Ranges391420 +Node: BEGIN/END394526 +Node: Using BEGIN/END395287 +Ref: Using BEGIN/END-Footnote-1398021 +Node: I/O And BEGIN/END398127 +Node: BEGINFILE/ENDFILE400441 +Node: Empty403342 +Node: Using Shell Variables403659 +Node: Action Overview405932 +Node: Statements408258 +Node: If Statement410106 +Node: While Statement411601 +Node: Do Statement413630 +Node: For Statement414774 +Node: Switch Statement417931 +Node: Break Statement420313 +Node: Continue Statement422354 +Node: Next Statement424181 +Node: Nextfile Statement426562 +Node: Exit Statement429192 +Node: Built-in Variables431595 +Node: User-modified432728 +Ref: User-modified-Footnote-1440409 +Node: Auto-set440471 +Ref: Auto-set-Footnote-1454163 +Ref: Auto-set-Footnote-2454368 +Node: ARGC and ARGV454424 +Node: Pattern Action Summary458642 +Node: Arrays461069 +Node: Array Basics462398 +Node: Array Intro463242 +Ref: figure-array-elements465206 +Ref: Array Intro-Footnote-1467732 +Node: Reference to Elements467860 +Node: Assigning Elements470312 +Node: Array Example470803 +Node: Scanning an Array472561 +Node: Controlling Scanning475577 +Ref: Controlling Scanning-Footnote-1480773 +Node: Numeric Array Subscripts481089 +Node: Uninitialized Subscripts483274 +Node: Delete484891 +Ref: Delete-Footnote-1487634 +Node: Multidimensional487691 +Node: Multiscanning490788 +Node: Arrays of Arrays492377 +Node: Arrays Summary497136 +Node: Functions499228 +Node: Built-in500127 +Node: Calling Built-in501205 +Node: Numeric Functions503196 +Ref: Numeric Functions-Footnote-1508015 +Ref: Numeric Functions-Footnote-2508372 +Ref: Numeric Functions-Footnote-3508420 +Node: String Functions508692 +Ref: String Functions-Footnote-1532167 +Ref: String Functions-Footnote-2532296 +Ref: String Functions-Footnote-3532544 +Node: Gory Details532631 +Ref: table-sub-escapes534412 +Ref: table-sub-proposed535932 +Ref: table-posix-sub537296 +Ref: table-gensub-escapes538832 +Ref: Gory Details-Footnote-1539664 +Node: I/O Functions539815 +Ref: I/O Functions-Footnote-1547033 +Node: Time Functions547180 +Ref: Time Functions-Footnote-1557668 +Ref: Time Functions-Footnote-2557736 +Ref: Time Functions-Footnote-3557894 +Ref: Time Functions-Footnote-4558005 +Ref: Time Functions-Footnote-5558117 +Ref: Time Functions-Footnote-6558344 +Node: Bitwise Functions558610 +Ref: table-bitwise-ops559172 +Ref: Bitwise Functions-Footnote-1563481 +Node: Type Functions563650 +Node: I18N Functions564801 +Node: User-defined566446 +Node: Definition Syntax567251 +Ref: Definition Syntax-Footnote-1572658 +Node: Function Example572729 +Ref: Function Example-Footnote-1575648 +Node: Function Caveats575670 +Node: Calling A Function576188 +Node: Variable Scope577146 +Node: Pass By Value/Reference580134 +Node: Return Statement583629 +Node: Dynamic Typing586610 +Node: Indirect Calls587539 +Ref: Indirect Calls-Footnote-1598841 +Node: Functions Summary598969 +Node: Library Functions601671 +Ref: Library Functions-Footnote-1605280 +Ref: Library Functions-Footnote-2605423 +Node: Library Names605594 +Ref: Library Names-Footnote-1609048 +Ref: Library Names-Footnote-2609271 +Node: General Functions609357 +Node: Strtonum Function610460 +Node: Assert Function613482 +Node: Round Function616806 +Node: Cliff Random Function618347 +Node: Ordinal Functions619363 +Ref: Ordinal Functions-Footnote-1622426 +Ref: Ordinal Functions-Footnote-2622678 +Node: Join Function622889 +Ref: Join Function-Footnote-1624658 +Node: Getlocaltime Function624858 +Node: Readfile Function628602 +Node: Shell Quoting630572 +Node: Data File Management631973 +Node: Filetrans Function632605 +Node: Rewind Function636661 +Node: File Checking638048 +Ref: File Checking-Footnote-1639380 +Node: Empty Files639581 +Node: Ignoring Assigns641560 +Node: Getopt Function643111 +Ref: Getopt Function-Footnote-1654573 +Node: Passwd Functions654773 +Ref: Passwd Functions-Footnote-1663610 +Node: Group Functions663698 +Ref: Group Functions-Footnote-1671592 +Node: Walking Arrays671805 +Node: Library Functions Summary673408 +Node: Library Exercises674809 +Node: Sample Programs676089 +Node: Running Examples676859 +Node: Clones677587 +Node: Cut Program678811 +Node: Egrep Program688530 +Ref: Egrep Program-Footnote-1696028 +Node: Id Program696138 +Node: Split Program699783 +Ref: Split Program-Footnote-1703231 +Node: Tee Program703359 +Node: Uniq Program706148 +Node: Wc Program713567 +Ref: Wc Program-Footnote-1717817 +Node: Miscellaneous Programs717911 +Node: Dupword Program719124 +Node: Alarm Program721155 +Node: Translate Program725959 +Ref: Translate Program-Footnote-1730524 +Node: Labels Program730794 +Ref: Labels Program-Footnote-1734145 +Node: Word Sorting734229 +Node: History Sorting738300 +Node: Extract Program740136 +Node: Simple Sed747661 +Node: Igawk Program750729 +Ref: Igawk Program-Footnote-1765053 +Ref: Igawk Program-Footnote-2765254 +Ref: Igawk Program-Footnote-3765376 +Node: Anagram Program765491 +Node: Signature Program768548 +Node: Programs Summary769795 +Node: Programs Exercises770988 +Ref: Programs Exercises-Footnote-1775119 +Node: Advanced Features775210 +Node: Nondecimal Data777158 +Node: Array Sorting778748 +Node: Controlling Array Traversal779445 +Ref: Controlling Array Traversal-Footnote-1787778 +Node: Array Sorting Functions787896 +Ref: Array Sorting Functions-Footnote-1791785 +Node: Two-way I/O791981 +Ref: Two-way I/O-Footnote-1796926 +Ref: Two-way I/O-Footnote-2797112 +Node: TCP/IP Networking797194 +Node: Profiling800067 +Node: Advanced Features Summary808344 +Node: Internationalization810277 +Node: I18N and L10N811757 +Node: Explaining gettext812443 +Ref: Explaining gettext-Footnote-1817468 +Ref: Explaining gettext-Footnote-2817652 +Node: Programmer i18n817817 +Ref: Programmer i18n-Footnote-1822683 +Node: Translator i18n822732 +Node: String Extraction823526 +Ref: String Extraction-Footnote-1824657 +Node: Printf Ordering824743 +Ref: Printf Ordering-Footnote-1827529 +Node: I18N Portability827593 +Ref: I18N Portability-Footnote-1830048 +Node: I18N Example830111 +Ref: I18N Example-Footnote-1832914 +Node: Gawk I18N832986 +Node: I18N Summary833624 +Node: Debugger834963 +Node: Debugging835985 +Node: Debugging Concepts836426 +Node: Debugging Terms838279 +Node: Awk Debugging840851 +Node: Sample Debugging Session841745 +Node: Debugger Invocation842265 +Node: Finding The Bug843649 +Node: List of Debugger Commands850124 +Node: Breakpoint Control851457 +Node: Debugger Execution Control855153 +Node: Viewing And Changing Data858517 +Node: Execution Stack861895 +Node: Debugger Info863532 +Node: Miscellaneous Debugger Commands867549 +Node: Readline Support872578 +Node: Limitations873470 +Node: Debugging Summary875584 +Node: Arbitrary Precision Arithmetic876752 +Node: Computer Arithmetic878168 +Ref: table-numeric-ranges881766 +Ref: Computer Arithmetic-Footnote-1882625 +Node: Math Definitions882682 +Ref: table-ieee-formats885970 +Ref: Math Definitions-Footnote-1886574 +Node: MPFR features886679 +Node: FP Math Caution888350 +Ref: FP Math Caution-Footnote-1889400 +Node: Inexactness of computations889769 +Node: Inexact representation890728 +Node: Comparing FP Values892085 +Node: Errors accumulate893167 +Node: Getting Accuracy894600 +Node: Try To Round897262 +Node: Setting precision898161 +Ref: table-predefined-precision-strings898845 +Node: Setting the rounding mode900634 +Ref: table-gawk-rounding-modes900998 +Ref: Setting the rounding mode-Footnote-1904453 +Node: Arbitrary Precision Integers904632 +Ref: Arbitrary Precision Integers-Footnote-1909531 +Node: POSIX Floating Point Problems909680 +Ref: POSIX Floating Point Problems-Footnote-1913553 +Node: Floating point summary913591 +Node: Dynamic Extensions915785 +Node: Extension Intro917337 +Node: Plugin License918603 +Node: Extension Mechanism Outline919400 +Ref: figure-load-extension919828 +Ref: figure-register-new-function921308 +Ref: figure-call-new-function922312 +Node: Extension API Description924298 +Node: Extension API Functions Introduction925748 +Node: General Data Types930572 +Ref: General Data Types-Footnote-1936311 +Node: Memory Allocation Functions936610 +Ref: Memory Allocation Functions-Footnote-1939449 +Node: Constructor Functions939545 +Node: Registration Functions941279 +Node: Extension Functions941964 +Node: Exit Callback Functions944261 +Node: Extension Version String945509 +Node: Input Parsers946174 +Node: Output Wrappers956053 +Node: Two-way processors960568 +Node: Printing Messages962772 +Ref: Printing Messages-Footnote-1963848 +Node: Updating `ERRNO'964000 +Node: Requesting Values964740 +Ref: table-value-types-returned965468 +Node: Accessing Parameters966425 +Node: Symbol Table Access967656 +Node: Symbol table by name968170 +Node: Symbol table by cookie970151 +Ref: Symbol table by cookie-Footnote-1974295 +Node: Cached values974358 +Ref: Cached values-Footnote-1977857 +Node: Array Manipulation977948 +Ref: Array Manipulation-Footnote-1979046 +Node: Array Data Types979083 +Ref: Array Data Types-Footnote-1981738 +Node: Array Functions981830 +Node: Flattening Arrays985684 +Node: Creating Arrays992576 +Node: Extension API Variables997347 +Node: Extension Versioning997983 +Node: Extension API Informational Variables999884 +Node: Extension API Boilerplate1000949 +Node: Finding Extensions1004758 +Node: Extension Example1005318 +Node: Internal File Description1006090 +Node: Internal File Ops1010157 +Ref: Internal File Ops-Footnote-11021827 +Node: Using Internal File Ops1021967 +Ref: Using Internal File Ops-Footnote-11024350 +Node: Extension Samples1024623 +Node: Extension Sample File Functions1026149 +Node: Extension Sample Fnmatch1033787 +Node: Extension Sample Fork1035278 +Node: Extension Sample Inplace1036493 +Node: Extension Sample Ord1038168 +Node: Extension Sample Readdir1039004 +Ref: table-readdir-file-types1039880 +Node: Extension Sample Revout1040691 +Node: Extension Sample Rev2way1041281 +Node: Extension Sample Read write array1042021 +Node: Extension Sample Readfile1043961 +Node: Extension Sample Time1045056 +Node: Extension Sample API Tests1046405 +Node: gawkextlib1046896 +Node: Extension summary1049554 +Node: Extension Exercises1053243 +Node: Language History1053965 +Node: V7/SVR3.11055621 +Node: SVR41057802 +Node: POSIX1059247 +Node: BTL1060636 +Node: POSIX/GNU1061370 +Node: Feature History1066994 +Node: Common Extensions1080092 +Node: Ranges and Locales1081416 +Ref: Ranges and Locales-Footnote-11086034 +Ref: Ranges and Locales-Footnote-21086061 +Ref: Ranges and Locales-Footnote-31086295 +Node: Contributors1086516 +Node: History summary1092057 +Node: Installation1093427 +Node: Gawk Distribution1094373 +Node: Getting1094857 +Node: Extracting1095680 +Node: Distribution contents1097315 +Node: Unix Installation1103380 +Node: Quick Installation1104063 +Node: Shell Startup Files1106474 +Node: Additional Configuration Options1107553 +Node: Configuration Philosophy1109292 +Node: Non-Unix Installation1111661 +Node: PC Installation1112119 +Node: PC Binary Installation1113438 +Node: PC Compiling1115286 +Ref: PC Compiling-Footnote-11118307 +Node: PC Testing1118416 +Node: PC Using1119592 +Node: Cygwin1123707 +Node: MSYS1124530 +Node: VMS Installation1125030 +Node: VMS Compilation1125822 +Ref: VMS Compilation-Footnote-11127044 +Node: VMS Dynamic Extensions1127102 +Node: VMS Installation Details1128786 +Node: VMS Running1131038 +Node: VMS GNV1133874 +Node: VMS Old Gawk1134608 +Node: Bugs1135078 +Node: Other Versions1138961 +Node: Installation summary1145385 +Node: Notes1146441 +Node: Compatibility Mode1147306 +Node: Additions1148088 +Node: Accessing The Source1149013 +Node: Adding Code1150448 +Node: New Ports1156613 +Node: Derived Files1161095 +Ref: Derived Files-Footnote-11166570 +Ref: Derived Files-Footnote-21166604 +Ref: Derived Files-Footnote-31167200 +Node: Future Extensions1167314 +Node: Implementation Limitations1167920 +Node: Extension Design1169168 +Node: Old Extension Problems1170322 +Ref: Old Extension Problems-Footnote-11171839 +Node: Extension New Mechanism Goals1171896 +Ref: Extension New Mechanism Goals-Footnote-11175256 +Node: Extension Other Design Decisions1175445 +Node: Extension Future Growth1177553 +Node: Old Extension Mechanism1178389 +Node: Notes summary1180151 +Node: Basic Concepts1181337 +Node: Basic High Level1182018 +Ref: figure-general-flow1182290 +Ref: figure-process-flow1182889 +Ref: Basic High Level-Footnote-11186118 +Node: Basic Data Typing1186303 +Node: Glossary1189631 +Node: Copying1214789 +Node: GNU Free Documentation License1252345 +Node: Index1277481 End Tag Table diff --git a/doc/gawk.texi b/doc/gawk.texi index ad4bae1e..a4567760 100644 --- a/doc/gawk.texi +++ b/doc/gawk.texi @@ -1001,6 +1001,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 @@ -4075,10 +4076,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 still executes. 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} @@ -4479,6 +4478,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. @@ -4510,6 +4512,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. @@ -4586,14 +4591,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 -When @command{gawk} is invoked with the @option{--pretty-print} option, -it will not run the program if this environment variable exists. - -@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. @@ -5173,17 +5170,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 release 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 @@ -14767,10 +14769,24 @@ 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. + +This can also affect the running @command{gawk} program, since some of the +built-in functions may pay attention to certain environment variables. +The most notable instance of this is @code{mktime()} (@pxref{Time +Functions}), which pays attention the value of the @env{TZ} environment +variable on many systems. Some operating systems may not have environment variables. On such systems, the @code{ENVIRON} array is empty (except for @@ -16891,6 +16907,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 @@ -27692,8 +27725,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 @@ -27787,10 +27819,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. + @node Advanced Features Summary @section Summary @@ -30839,6 +30887,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 @@ -35671,6 +35832,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 @@ -36948,6 +37113,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 @@ -36992,8 +37159,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 -@DBREF{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 @@ -37004,6 +37169,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. @@ -37035,6 +37206,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 @@ -37115,6 +37287,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 diff --git a/doc/gawktexi.in b/doc/gawktexi.in index 7379a9c9..34c47270 100644 --- a/doc/gawktexi.in +++ b/doc/gawktexi.in @@ -996,6 +996,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 @@ -3986,10 +3987,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 still executes. 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} @@ -4390,6 +4389,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. @@ -4421,6 +4423,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. @@ -4497,14 +4502,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 -When @command{gawk} is invoked with the @option{--pretty-print} option, -it will not run the program if this environment variable exists. - -@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. @@ -5084,17 +5081,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 release 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 @@ -14096,10 +14098,24 @@ 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. + +This can also affect the running @command{gawk} program, since some of the +built-in functions may pay attention to certain environment variables. +The most notable instance of this is @code{mktime()} (@pxref{Time +Functions}), which pays attention the value of the @env{TZ} environment +variable on many systems. Some operating systems may not have environment variables. On such systems, the @code{ENVIRON} array is empty (except for @@ -16174,6 +16190,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 @@ -26785,8 +26818,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 @@ -26880,10 +26912,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. + @node Advanced Features Summary @section Summary @@ -29932,6 +29980,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 @@ -34764,6 +34925,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 @@ -36041,6 +36206,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 @@ -36085,8 +36252,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 -@DBREF{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 @@ -36097,6 +36262,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. @@ -36128,6 +36299,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 @@ -36208,6 +36380,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 |