diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/CMakeLists.txt | 95 | ||||
| -rw-r--r-- | doc/ChangeLog | 60 | ||||
| -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, 1544 insertions, 805 deletions
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt new file mode 100644 index 00000000..e12f5de0 --- /dev/null +++ b/doc/CMakeLists.txt @@ -0,0 +1,95 @@ +# +# doc/CMakeLists.txt --- CMake input file for gawk +# +# Copyright (C) 2013 +# the Free Software Foundation, Inc. +# +# This file is part of GAWK, the GNU implementation of the +# AWK Programming Language. +# +# GAWK is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 3 of the License, or +# (at your option) any later version. +# +# GAWK is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA +# + +## process this file with CMake to produce Makefile + +MACRO(DocDependency outfile) + add_dependencies(doc ${outfile}) + add_custom_target( + ${outfile} + DEPENDS ${ARGN} + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} + COMMAND ${CMAKE_SOURCE_DIR}/cmake/docmaker ${outfile} ${ARGN} + ) +ENDMACRO(DocDependency) + +find_program(TEXI2DVI_CONVERTER texi2dvi) +if (TEXI2DVI_CONVERTER) + add_custom_target(doc) + DocDependency(gawk.texi gawktexi.in rflashlight.eps api-figure1.fig api-figure2.fig api-figure3.fig general-program.fig process-flow.fig) + DocDependency(rflashlight.eps) + DocDependency(api-figure1.fig) + DocDependency(api-figure2.fig) + DocDependency(api-figure3.fig) + DocDependency(general-program.fig) + DocDependency(process-flow.fig) + DocDependency(gawk.dvi gawk.texi) + DocDependency(gawk.info gawk.texi) + DocDependency(gawkinet.dvi gawkinet.texi) + DocDependency(gawkinet.info gawkinet.texi) + DocDependency(gawkinet.texi statist.eps) + DocDependency(gawk.1.ps gawk.1) + DocDependency(igawk.1.ps igawk.1) + find_program(DVIPS_CONVERTER dvips) + if (DVIPS_CONVERTER) + DocDependency(gawk.ps gawk.dvi) + DocDependency(gawkinet.ps gawkinet.dvi) + find_program(PS2PDF_CONVERTER ps2pdf) + if (PS2PDF_CONVERTER) + DocDependency(gawk.1.pdf gawk.1.ps) + DocDependency(igawk.1.pdf igawk.1.ps) + DocDependency(gawk.pdf gawk.ps) + DocDependency(gawkinet.pdf gawkinet.ps) + install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/gawk.1.pdf DESTINATION doc) + install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/igawk.1.pdf DESTINATION doc) + install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/gawk.info DESTINATION doc) + install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/gawk.pdf DESTINATION doc) + install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/gawkinet.info DESTINATION doc) + install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/gawkinet.pdf DESTINATION doc) + + set(CARDSRC macros cardfonts colors awkcard.tr) + set(CARDSRC_N macros cardfonts no.colors awkcard.tr) + set(CARDFILES ${CARDSRC} ad.block awkcard.in setter.outline) + DocDependency(awkcard.tr awkcard.in) + DocDependency(awkcard.nc ${CARDFILES}) + DocDependency(awkcard.ps ${CARDFILES}) + DocDependency(awkcard.pdf awkcard.ps) + install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/awkcard.pdf DESTINATION doc) + + else() + message(WARNING "Found no ps2pdf tool; no doc will be generated") + install(CODE "MESSAGE(\"doc generated only in .ps files\")") + endif() + else() + message(WARNING "Found no dvips tool; no doc will be generated") + install(CODE "MESSAGE(\"doc generated only in .dvi files and man pages in .ps files\")") + endif() +else() + message(WARNING "Found no texi2dvi tool; no doc will be generated") + add_custom_command( + TARGET doc + COMMAND echo no doc generated because of missing texi2dvi + ) +endif() + diff --git a/doc/ChangeLog b/doc/ChangeLog index 6efc88b3..2d924497 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -8,7 +8,7 @@ 2015-01-25 Arnold D. Robbins <arnold@skeeve.com> - * gawktexi.in: Fix a bad URL. + * gawktexi.in: Fix a bad URL. And another one. More O'Reilly fixes. 2015-01-23 Arnold D. Robbins <arnold@skeeve.com> @@ -67,6 +67,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. @@ -80,6 +85,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. @@ -93,6 +103,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> @@ -134,10 +145,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. @@ -233,6 +259,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. @@ -266,6 +296,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. @@ -280,6 +314,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 @@ -290,6 +336,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. @@ -586,7 +637,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> @@ -660,6 +711,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 30a371d7..68aacf48 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -353,7 +353,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 \ @@ -377,7 +377,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/" @@ -878,9 +878,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 @@ -894,12 +894,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 80cca4be..3bcfde12 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 @@ -10326,10 +10327,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 @@ -11891,6 +11906,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 @@ -19880,8 +19910,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/ @@ -19940,8 +19969,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 @@ -22428,6 +22473,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.html'. + + 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 @@ -26456,6 +26557,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 @@ -27358,7 +27461,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 @@ -27400,17 +27505,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. @@ -27441,11 +27552,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 -------------------------------------------- @@ -27501,9 +27613,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' @@ -27545,7 +27691,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 @@ -31497,20 +31643,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) @@ -31518,9 +31664,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) @@ -31528,32 +31674,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) @@ -31615,10 +31761,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. @@ -31658,7 +31804,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 30) * \ (backslash), in shell commands: Quoting. (line 48) * \ (backslash), regexp operator: Regexp Operators. (line 18) @@ -31826,7 +31972,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) @@ -31884,10 +32030,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. @@ -31927,7 +32073,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 30) * backslash (\), in shell commands: Quoting. (line 48) * backslash (\), regexp operator: Regexp Operators. (line 18) @@ -32033,7 +32179,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) @@ -32227,7 +32373,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) @@ -32258,12 +32404,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) @@ -32413,7 +32559,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) @@ -32452,12 +32598,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) @@ -32480,7 +32626,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) @@ -32490,7 +32636,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. @@ -32498,7 +32644,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 152) * differences in awk and gawk, trunc-mod operation: Arithmetic Ops. @@ -32514,6 +32660,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) @@ -32534,12 +32681,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) @@ -32594,13 +32741,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) @@ -32633,10 +32780,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) @@ -32654,7 +32801,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) @@ -32735,7 +32882,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) @@ -32803,9 +32950,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. @@ -32842,7 +32989,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. @@ -32855,7 +33002,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) @@ -32904,8 +33051,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) @@ -32923,13 +33070,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) @@ -32940,7 +33087,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. @@ -32972,7 +33119,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. @@ -32980,23 +33127,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 152) * 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 399) * General Public License, See GPL: Manual History. (line 11) * generate time values: Time Functions. (line 25) @@ -33073,7 +33226,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. @@ -33095,7 +33248,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) @@ -33174,8 +33327,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. @@ -33231,7 +33384,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. @@ -33303,7 +33456,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) @@ -33319,14 +33472,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) @@ -33367,8 +33520,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 258) * McPhee, Patrick: Contributors. (line 100) * message object files: Explaining gettext. (line 42) @@ -33380,8 +33533,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) @@ -33401,7 +33554,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) @@ -33430,7 +33583,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. @@ -33439,9 +33592,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. @@ -33555,7 +33708,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) @@ -33597,14 +33750,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. @@ -33622,7 +33775,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) @@ -33643,7 +33796,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. @@ -33670,11 +33823,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 124) * precedence <1>: Precedence. (line 6) * precedence: Increment Ops. (line 60) @@ -33721,24 +33874,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) @@ -33773,7 +33926,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) @@ -33782,12 +33935,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) @@ -33856,7 +34009,7 @@ Index (line 60) * 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) @@ -33896,7 +34049,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) @@ -33914,7 +34067,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 128) @@ -33922,9 +34075,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) @@ -33937,14 +34090,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) @@ -33963,7 +34116,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) @@ -34024,14 +34177,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. @@ -34053,19 +34206,19 @@ Index (line 58) * 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) @@ -34115,10 +34268,10 @@ Index * sprintf() function, OFMT variable and: User-modified. (line 114) * 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 375) * Stallman, Richard <2>: Contributors. (line 23) @@ -34189,9 +34342,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) @@ -34258,7 +34411,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) @@ -34314,7 +34467,7 @@ Index * uniq.awk program: Uniq Program. (line 65) * Unix: Glossary. (line 753) * 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. @@ -34334,7 +34487,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) @@ -34368,10 +34521,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) @@ -34408,7 +34561,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) @@ -34461,559 +34614,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 Longest175687 -Node: Computed Regexps176989 -Node: GNU Regexp Operators180418 -Node: Case-sensitivity184090 -Ref: Case-sensitivity-Footnote-1186975 -Ref: Case-sensitivity-Footnote-2187210 -Node: Regexp Summary187318 -Node: Reading Files188785 -Node: Records190878 -Node: awk split records191611 -Node: gawk split records196540 -Ref: gawk split records-Footnote-1201079 -Node: Fields201116 -Ref: Fields-Footnote-1203894 -Node: Nonconstant Fields203980 -Ref: Nonconstant Fields-Footnote-1206218 -Node: Changing Fields206421 -Node: Field Separators212352 -Node: Default Field Splitting215056 -Node: Regexp Field Splitting216173 -Node: Single Character Fields219523 -Node: Command Line Field Separator220582 -Node: Full Line Fields223799 -Ref: Full Line Fields-Footnote-1225320 -Ref: Full Line Fields-Footnote-2225366 -Node: Field Splitting Summary225467 -Node: Constant Size227541 -Node: Splitting By Content232124 -Ref: Splitting By Content-Footnote-1236089 -Node: Multiple Line236252 -Ref: Multiple Line-Footnote-1242133 -Node: Getline242312 -Node: Plain Getline244519 -Node: Getline/Variable247159 -Node: Getline/File248308 -Node: Getline/Variable/File249693 -Ref: Getline/Variable/File-Footnote-1251296 -Node: Getline/Pipe251383 -Node: Getline/Variable/Pipe254061 -Node: Getline/Coprocess255192 -Node: Getline/Variable/Coprocess256456 -Node: Getline Notes257195 -Node: Getline Summary259989 -Ref: table-getline-variants260401 -Node: Read Timeout261230 -Ref: Read Timeout-Footnote-1265067 -Node: Command-line directories265125 -Node: Input Summary266030 -Node: Input Exercises269415 -Node: Printing270143 -Node: Print271920 -Node: Print Examples273377 -Node: Output Separators276156 -Node: OFMT278174 -Node: Printf279529 -Node: Basic Printf280314 -Node: Control Letters281886 -Node: Format Modifiers285871 -Node: Printf Examples291881 -Node: Redirection294367 -Node: Special FD301205 -Ref: Special FD-Footnote-1304371 -Node: Special Files304445 -Node: Other Inherited Files305062 -Node: Special Network306062 -Node: Special Caveats306924 -Node: Close Files And Pipes307873 -Ref: Close Files And Pipes-Footnote-1315064 -Ref: Close Files And Pipes-Footnote-2315212 -Node: Output Summary315362 -Node: Output Exercises316360 -Node: Expressions317040 -Node: Values318229 -Node: Constants318906 -Node: Scalar Constants319597 -Ref: Scalar Constants-Footnote-1320459 -Node: Nondecimal-numbers320709 -Node: Regexp Constants323719 -Node: Using Constant Regexps324245 -Node: Variables327408 -Node: Using Variables328065 -Node: Assignment Options329976 -Node: Conversion331851 -Node: Strings And Numbers332375 -Ref: Strings And Numbers-Footnote-1335440 -Node: Locale influences conversions335549 -Ref: table-locale-affects338295 -Node: All Operators338887 -Node: Arithmetic Ops339516 -Node: Concatenation342021 -Ref: Concatenation-Footnote-1344840 -Node: Assignment Ops344947 -Ref: table-assign-ops349926 -Node: Increment Ops351236 -Node: Truth Values and Conditions354667 -Node: Truth Values355750 -Node: Typing and Comparison356799 -Node: Variable Typing357615 -Node: Comparison Operators361282 -Ref: table-relational-ops361692 -Node: POSIX String Comparison365187 -Ref: POSIX String Comparison-Footnote-1366259 -Node: Boolean Ops366398 -Ref: Boolean Ops-Footnote-1370876 -Node: Conditional Exp370967 -Node: Function Calls372705 -Node: Precedence376585 -Node: Locales380245 -Node: Expressions Summary381877 -Node: Patterns and Actions384448 -Node: Pattern Overview385568 -Node: Regexp Patterns387247 -Node: Expression Patterns387790 -Node: Ranges391499 -Node: BEGIN/END394606 -Node: Using BEGIN/END395367 -Ref: Using BEGIN/END-Footnote-1398103 -Node: I/O And BEGIN/END398209 -Node: BEGINFILE/ENDFILE400524 -Node: Empty403421 -Node: Using Shell Variables403738 -Node: Action Overview406011 -Node: Statements408337 -Node: If Statement410185 -Node: While Statement411680 -Node: Do Statement413708 -Node: For Statement414856 -Node: Switch Statement418014 -Node: Break Statement420396 -Node: Continue Statement422437 -Node: Next Statement424264 -Node: Nextfile Statement426645 -Node: Exit Statement429273 -Node: Built-in Variables431684 -Node: User-modified432817 -Ref: User-modified-Footnote-1440520 -Node: Auto-set440582 -Ref: Auto-set-Footnote-1453634 -Ref: Auto-set-Footnote-2453839 -Node: ARGC and ARGV453895 -Node: Pattern Action Summary458113 -Node: Arrays460546 -Node: Array Basics461875 -Node: Array Intro462719 -Ref: figure-array-elements464653 -Ref: Array Intro-Footnote-1467273 -Node: Reference to Elements467401 -Node: Assigning Elements469863 -Node: Array Example470354 -Node: Scanning an Array472113 -Node: Controlling Scanning475133 -Ref: Controlling Scanning-Footnote-1480527 -Node: Numeric Array Subscripts480843 -Node: Uninitialized Subscripts483028 -Node: Delete484645 -Ref: Delete-Footnote-1487394 -Node: Multidimensional487451 -Node: Multiscanning490548 -Node: Arrays of Arrays492137 -Node: Arrays Summary496891 -Node: Functions498982 -Node: Built-in499881 -Node: Calling Built-in500959 -Node: Numeric Functions502950 -Ref: Numeric Functions-Footnote-1506967 -Ref: Numeric Functions-Footnote-2507324 -Ref: Numeric Functions-Footnote-3507372 -Node: String Functions507644 -Ref: String Functions-Footnote-1531121 -Ref: String Functions-Footnote-2531250 -Ref: String Functions-Footnote-3531498 -Node: Gory Details531585 -Ref: table-sub-escapes533366 -Ref: table-sub-proposed534886 -Ref: table-posix-sub536250 -Ref: table-gensub-escapes537786 -Ref: Gory Details-Footnote-1538618 -Node: I/O Functions538769 -Ref: I/O Functions-Footnote-1545987 -Node: Time Functions546134 -Ref: Time Functions-Footnote-1556622 -Ref: Time Functions-Footnote-2556690 -Ref: Time Functions-Footnote-3556848 -Ref: Time Functions-Footnote-4556959 -Ref: Time Functions-Footnote-5557071 -Ref: Time Functions-Footnote-6557298 -Node: Bitwise Functions557564 -Ref: table-bitwise-ops558126 -Ref: Bitwise Functions-Footnote-1562435 -Node: Type Functions562604 -Node: I18N Functions563755 -Node: User-defined565400 -Node: Definition Syntax566205 -Ref: Definition Syntax-Footnote-1571612 -Node: Function Example571683 -Ref: Function Example-Footnote-1574602 -Node: Function Caveats574624 -Node: Calling A Function575142 -Node: Variable Scope576100 -Node: Pass By Value/Reference579088 -Node: Return Statement582583 -Node: Dynamic Typing585564 -Node: Indirect Calls586493 -Ref: Indirect Calls-Footnote-1597795 -Node: Functions Summary597923 -Node: Library Functions600625 -Ref: Library Functions-Footnote-1604234 -Ref: Library Functions-Footnote-2604377 -Node: Library Names604548 -Ref: Library Names-Footnote-1608002 -Ref: Library Names-Footnote-2608225 -Node: General Functions608311 -Node: Strtonum Function609414 -Node: Assert Function612436 -Node: Round Function615760 -Node: Cliff Random Function617301 -Node: Ordinal Functions618317 -Ref: Ordinal Functions-Footnote-1621380 -Ref: Ordinal Functions-Footnote-2621632 -Node: Join Function621843 -Ref: Join Function-Footnote-1623612 -Node: Getlocaltime Function623812 -Node: Readfile Function627556 -Node: Shell Quoting629526 -Node: Data File Management630927 -Node: Filetrans Function631559 -Node: Rewind Function635615 -Node: File Checking637002 -Ref: File Checking-Footnote-1638334 -Node: Empty Files638535 -Node: Ignoring Assigns640514 -Node: Getopt Function642065 -Ref: Getopt Function-Footnote-1653527 -Node: Passwd Functions653727 -Ref: Passwd Functions-Footnote-1662564 -Node: Group Functions662652 -Ref: Group Functions-Footnote-1670546 -Node: Walking Arrays670759 -Node: Library Functions Summary672362 -Node: Library Exercises673763 -Node: Sample Programs675043 -Node: Running Examples675813 -Node: Clones676541 -Node: Cut Program677765 -Node: Egrep Program687484 -Ref: Egrep Program-Footnote-1694982 -Node: Id Program695092 -Node: Split Program698737 -Ref: Split Program-Footnote-1702185 -Node: Tee Program702313 -Node: Uniq Program705102 -Node: Wc Program712521 -Ref: Wc Program-Footnote-1716771 -Node: Miscellaneous Programs716865 -Node: Dupword Program718078 -Node: Alarm Program720109 -Node: Translate Program724913 -Ref: Translate Program-Footnote-1729478 -Node: Labels Program729748 -Ref: Labels Program-Footnote-1733099 -Node: Word Sorting733183 -Node: History Sorting737254 -Node: Extract Program739090 -Node: Simple Sed746615 -Node: Igawk Program749683 -Ref: Igawk Program-Footnote-1764007 -Ref: Igawk Program-Footnote-2764208 -Ref: Igawk Program-Footnote-3764330 -Node: Anagram Program764445 -Node: Signature Program767502 -Node: Programs Summary768749 -Node: Programs Exercises769942 -Ref: Programs Exercises-Footnote-1774073 -Node: Advanced Features774164 -Node: Nondecimal Data776112 -Node: Array Sorting777702 -Node: Controlling Array Traversal778399 -Ref: Controlling Array Traversal-Footnote-1786732 -Node: Array Sorting Functions786850 -Ref: Array Sorting Functions-Footnote-1790739 -Node: Two-way I/O790935 -Ref: Two-way I/O-Footnote-1795880 -Ref: Two-way I/O-Footnote-2796066 -Node: TCP/IP Networking796148 -Node: Profiling799021 -Node: Advanced Features Summary806568 -Node: Internationalization808501 -Node: I18N and L10N809981 -Node: Explaining gettext810667 -Ref: Explaining gettext-Footnote-1815692 -Ref: Explaining gettext-Footnote-2815876 -Node: Programmer i18n816041 -Ref: Programmer i18n-Footnote-1820907 -Node: Translator i18n820956 -Node: String Extraction821750 -Ref: String Extraction-Footnote-1822881 -Node: Printf Ordering822967 -Ref: Printf Ordering-Footnote-1825753 -Node: I18N Portability825817 -Ref: I18N Portability-Footnote-1828272 -Node: I18N Example828335 -Ref: I18N Example-Footnote-1831138 -Node: Gawk I18N831210 -Node: I18N Summary831848 -Node: Debugger833187 -Node: Debugging834209 -Node: Debugging Concepts834650 -Node: Debugging Terms836503 -Node: Awk Debugging839075 -Node: Sample Debugging Session839969 -Node: Debugger Invocation840489 -Node: Finding The Bug841873 -Node: List of Debugger Commands848348 -Node: Breakpoint Control849681 -Node: Debugger Execution Control853377 -Node: Viewing And Changing Data856741 -Node: Execution Stack860119 -Node: Debugger Info861756 -Node: Miscellaneous Debugger Commands865773 -Node: Readline Support870802 -Node: Limitations871694 -Node: Debugging Summary873808 -Node: Arbitrary Precision Arithmetic874976 -Node: Computer Arithmetic876392 -Ref: table-numeric-ranges879990 -Ref: Computer Arithmetic-Footnote-1880849 -Node: Math Definitions880906 -Ref: table-ieee-formats884194 -Ref: Math Definitions-Footnote-1884798 -Node: MPFR features884903 -Node: FP Math Caution886574 -Ref: FP Math Caution-Footnote-1887624 -Node: Inexactness of computations887993 -Node: Inexact representation888952 -Node: Comparing FP Values890309 -Node: Errors accumulate891391 -Node: Getting Accuracy892824 -Node: Try To Round895486 -Node: Setting precision896385 -Ref: table-predefined-precision-strings897069 -Node: Setting the rounding mode898858 -Ref: table-gawk-rounding-modes899222 -Ref: Setting the rounding mode-Footnote-1902677 -Node: Arbitrary Precision Integers902856 -Ref: Arbitrary Precision Integers-Footnote-1905842 -Node: POSIX Floating Point Problems905991 -Ref: POSIX Floating Point Problems-Footnote-1909864 -Node: Floating point summary909902 -Node: Dynamic Extensions912096 -Node: Extension Intro913648 -Node: Plugin License914914 -Node: Extension Mechanism Outline915711 -Ref: figure-load-extension916139 -Ref: figure-register-new-function917619 -Ref: figure-call-new-function918623 -Node: Extension API Description920609 -Node: Extension API Functions Introduction922059 -Node: General Data Types926883 -Ref: General Data Types-Footnote-1932622 -Node: Memory Allocation Functions932921 -Ref: Memory Allocation Functions-Footnote-1935760 -Node: Constructor Functions935856 -Node: Registration Functions937590 -Node: Extension Functions938275 -Node: Exit Callback Functions940572 -Node: Extension Version String941820 -Node: Input Parsers942485 -Node: Output Wrappers952364 -Node: Two-way processors956879 -Node: Printing Messages959083 -Ref: Printing Messages-Footnote-1960159 -Node: Updating `ERRNO'960311 -Node: Requesting Values961051 -Ref: table-value-types-returned961779 -Node: Accessing Parameters962736 -Node: Symbol Table Access963967 -Node: Symbol table by name964481 -Node: Symbol table by cookie966462 -Ref: Symbol table by cookie-Footnote-1970606 -Node: Cached values970669 -Ref: Cached values-Footnote-1974168 -Node: Array Manipulation974259 -Ref: Array Manipulation-Footnote-1975357 -Node: Array Data Types975394 -Ref: Array Data Types-Footnote-1978049 -Node: Array Functions978141 -Node: Flattening Arrays981995 -Node: Creating Arrays988887 -Node: Extension API Variables993658 -Node: Extension Versioning994294 -Node: Extension API Informational Variables996195 -Node: Extension API Boilerplate997260 -Node: Finding Extensions1001069 -Node: Extension Example1001629 -Node: Internal File Description1002401 -Node: Internal File Ops1006468 -Ref: Internal File Ops-Footnote-11018138 -Node: Using Internal File Ops1018278 -Ref: Using Internal File Ops-Footnote-11020661 -Node: Extension Samples1020934 -Node: Extension Sample File Functions1022460 -Node: Extension Sample Fnmatch1030098 -Node: Extension Sample Fork1031589 -Node: Extension Sample Inplace1032804 -Node: Extension Sample Ord1034479 -Node: Extension Sample Readdir1035315 -Ref: table-readdir-file-types1036191 -Node: Extension Sample Revout1037002 -Node: Extension Sample Rev2way1037592 -Node: Extension Sample Read write array1038332 -Node: Extension Sample Readfile1040272 -Node: Extension Sample Time1041367 -Node: Extension Sample API Tests1042716 -Node: gawkextlib1043207 -Node: Extension summary1045865 -Node: Extension Exercises1049554 -Node: Language History1050276 -Node: V7/SVR3.11051932 -Node: SVR41054113 -Node: POSIX1055558 -Node: BTL1056947 -Node: POSIX/GNU1057681 -Node: Feature History1063245 -Node: Common Extensions1076343 -Node: Ranges and Locales1077667 -Ref: Ranges and Locales-Footnote-11082285 -Ref: Ranges and Locales-Footnote-21082312 -Ref: Ranges and Locales-Footnote-31082546 -Node: Contributors1082767 -Node: History summary1088308 -Node: Installation1089678 -Node: Gawk Distribution1090624 -Node: Getting1091108 -Node: Extracting1091931 -Node: Distribution contents1093566 -Node: Unix Installation1099283 -Node: Quick Installation1099900 -Node: Additional Configuration Options1102324 -Node: Configuration Philosophy1104062 -Node: Non-Unix Installation1106431 -Node: PC Installation1106889 -Node: PC Binary Installation1108208 -Node: PC Compiling1110056 -Ref: PC Compiling-Footnote-11113077 -Node: PC Testing1113186 -Node: PC Using1114362 -Node: Cygwin1118477 -Node: MSYS1119300 -Node: VMS Installation1119800 -Node: VMS Compilation1120592 -Ref: VMS Compilation-Footnote-11121814 -Node: VMS Dynamic Extensions1121872 -Node: VMS Installation Details1123556 -Node: VMS Running1125808 -Node: VMS GNV1128644 -Node: VMS Old Gawk1129378 -Node: Bugs1129848 -Node: Other Versions1133731 -Node: Installation summary1140155 -Node: Notes1141211 -Node: Compatibility Mode1142076 -Node: Additions1142858 -Node: Accessing The Source1143783 -Node: Adding Code1145218 -Node: New Ports1151375 -Node: Derived Files1155857 -Ref: Derived Files-Footnote-11161332 -Ref: Derived Files-Footnote-21161366 -Ref: Derived Files-Footnote-31161962 -Node: Future Extensions1162076 -Node: Implementation Limitations1162682 -Node: Extension Design1163930 -Node: Old Extension Problems1165084 -Ref: Old Extension Problems-Footnote-11166601 -Node: Extension New Mechanism Goals1166658 -Ref: Extension New Mechanism Goals-Footnote-11170018 -Node: Extension Other Design Decisions1170207 -Node: Extension Future Growth1172315 -Node: Old Extension Mechanism1173151 -Node: Notes summary1174913 -Node: Basic Concepts1176099 -Node: Basic High Level1176780 -Ref: figure-general-flow1177052 -Ref: figure-process-flow1177651 -Ref: Basic High Level-Footnote-11180880 -Node: Basic Data Typing1181065 -Node: Glossary1184393 -Node: Copying1216322 -Node: GNU Free Documentation License1253878 -Node: Index1279014 +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 Longest175842 +Node: Computed Regexps177144 +Node: GNU Regexp Operators180573 +Node: Case-sensitivity184245 +Ref: Case-sensitivity-Footnote-1187130 +Ref: Case-sensitivity-Footnote-2187365 +Node: Regexp Summary187473 +Node: Reading Files188940 +Node: Records191033 +Node: awk split records191766 +Node: gawk split records196695 +Ref: gawk split records-Footnote-1201234 +Node: Fields201271 +Ref: Fields-Footnote-1204049 +Node: Nonconstant Fields204135 +Ref: Nonconstant Fields-Footnote-1206373 +Node: Changing Fields206576 +Node: Field Separators212507 +Node: Default Field Splitting215211 +Node: Regexp Field Splitting216328 +Node: Single Character Fields219678 +Node: Command Line Field Separator220737 +Node: Full Line Fields223954 +Ref: Full Line Fields-Footnote-1225475 +Ref: Full Line Fields-Footnote-2225521 +Node: Field Splitting Summary225622 +Node: Constant Size227696 +Node: Splitting By Content232279 +Ref: Splitting By Content-Footnote-1236244 +Node: Multiple Line236407 +Ref: Multiple Line-Footnote-1242288 +Node: Getline242467 +Node: Plain Getline244674 +Node: Getline/Variable247314 +Node: Getline/File248463 +Node: Getline/Variable/File249848 +Ref: Getline/Variable/File-Footnote-1251451 +Node: Getline/Pipe251538 +Node: Getline/Variable/Pipe254216 +Node: Getline/Coprocess255347 +Node: Getline/Variable/Coprocess256611 +Node: Getline Notes257350 +Node: Getline Summary260144 +Ref: table-getline-variants260556 +Node: Read Timeout261385 +Ref: Read Timeout-Footnote-1265222 +Node: Command-line directories265280 +Node: Input Summary266185 +Node: Input Exercises269570 +Node: Printing270298 +Node: Print272075 +Node: Print Examples273532 +Node: Output Separators276311 +Node: OFMT278329 +Node: Printf279684 +Node: Basic Printf280469 +Node: Control Letters282041 +Node: Format Modifiers286026 +Node: Printf Examples292036 +Node: Redirection294522 +Node: Special FD301360 +Ref: Special FD-Footnote-1304526 +Node: Special Files304600 +Node: Other Inherited Files305217 +Node: Special Network306217 +Node: Special Caveats307079 +Node: Close Files And Pipes308028 +Ref: Close Files And Pipes-Footnote-1315219 +Ref: Close Files And Pipes-Footnote-2315367 +Node: Output Summary315517 +Node: Output Exercises316515 +Node: Expressions317195 +Node: Values318384 +Node: Constants319061 +Node: Scalar Constants319752 +Ref: Scalar Constants-Footnote-1320614 +Node: Nondecimal-numbers320864 +Node: Regexp Constants323874 +Node: Using Constant Regexps324400 +Node: Variables327563 +Node: Using Variables328220 +Node: Assignment Options330131 +Node: Conversion332006 +Node: Strings And Numbers332530 +Ref: Strings And Numbers-Footnote-1335595 +Node: Locale influences conversions335704 +Ref: table-locale-affects338450 +Node: All Operators339042 +Node: Arithmetic Ops339671 +Node: Concatenation342176 +Ref: Concatenation-Footnote-1344995 +Node: Assignment Ops345102 +Ref: table-assign-ops350081 +Node: Increment Ops351391 +Node: Truth Values and Conditions354822 +Node: Truth Values355905 +Node: Typing and Comparison356954 +Node: Variable Typing357770 +Node: Comparison Operators361437 +Ref: table-relational-ops361847 +Node: POSIX String Comparison365342 +Ref: POSIX String Comparison-Footnote-1366414 +Node: Boolean Ops366553 +Ref: Boolean Ops-Footnote-1371031 +Node: Conditional Exp371122 +Node: Function Calls372860 +Node: Precedence376740 +Node: Locales380400 +Node: Expressions Summary382032 +Node: Patterns and Actions384603 +Node: Pattern Overview385723 +Node: Regexp Patterns387402 +Node: Expression Patterns387945 +Node: Ranges391654 +Node: BEGIN/END394761 +Node: Using BEGIN/END395522 +Ref: Using BEGIN/END-Footnote-1398258 +Node: I/O And BEGIN/END398364 +Node: BEGINFILE/ENDFILE400679 +Node: Empty403576 +Node: Using Shell Variables403893 +Node: Action Overview406166 +Node: Statements408492 +Node: If Statement410340 +Node: While Statement411835 +Node: Do Statement413863 +Node: For Statement415011 +Node: Switch Statement418169 +Node: Break Statement420551 +Node: Continue Statement422592 +Node: Next Statement424419 +Node: Nextfile Statement426800 +Node: Exit Statement429428 +Node: Built-in Variables431839 +Node: User-modified432972 +Ref: User-modified-Footnote-1440675 +Node: Auto-set440737 +Ref: Auto-set-Footnote-1454446 +Ref: Auto-set-Footnote-2454651 +Node: ARGC and ARGV454707 +Node: Pattern Action Summary458925 +Node: Arrays461358 +Node: Array Basics462687 +Node: Array Intro463531 +Ref: figure-array-elements465465 +Ref: Array Intro-Footnote-1468085 +Node: Reference to Elements468213 +Node: Assigning Elements470675 +Node: Array Example471166 +Node: Scanning an Array472925 +Node: Controlling Scanning475945 +Ref: Controlling Scanning-Footnote-1481339 +Node: Numeric Array Subscripts481655 +Node: Uninitialized Subscripts483840 +Node: Delete485457 +Ref: Delete-Footnote-1488206 +Node: Multidimensional488263 +Node: Multiscanning491360 +Node: Arrays of Arrays492949 +Node: Arrays Summary497703 +Node: Functions499794 +Node: Built-in500693 +Node: Calling Built-in501771 +Node: Numeric Functions503762 +Ref: Numeric Functions-Footnote-1508581 +Ref: Numeric Functions-Footnote-2508938 +Ref: Numeric Functions-Footnote-3508986 +Node: String Functions509258 +Ref: String Functions-Footnote-1532735 +Ref: String Functions-Footnote-2532864 +Ref: String Functions-Footnote-3533112 +Node: Gory Details533199 +Ref: table-sub-escapes534980 +Ref: table-sub-proposed536500 +Ref: table-posix-sub537864 +Ref: table-gensub-escapes539400 +Ref: Gory Details-Footnote-1540232 +Node: I/O Functions540383 +Ref: I/O Functions-Footnote-1547601 +Node: Time Functions547748 +Ref: Time Functions-Footnote-1558236 +Ref: Time Functions-Footnote-2558304 +Ref: Time Functions-Footnote-3558462 +Ref: Time Functions-Footnote-4558573 +Ref: Time Functions-Footnote-5558685 +Ref: Time Functions-Footnote-6558912 +Node: Bitwise Functions559178 +Ref: table-bitwise-ops559740 +Ref: Bitwise Functions-Footnote-1564049 +Node: Type Functions564218 +Node: I18N Functions565369 +Node: User-defined567014 +Node: Definition Syntax567819 +Ref: Definition Syntax-Footnote-1573226 +Node: Function Example573297 +Ref: Function Example-Footnote-1576216 +Node: Function Caveats576238 +Node: Calling A Function576756 +Node: Variable Scope577714 +Node: Pass By Value/Reference580702 +Node: Return Statement584197 +Node: Dynamic Typing587178 +Node: Indirect Calls588107 +Ref: Indirect Calls-Footnote-1599409 +Node: Functions Summary599537 +Node: Library Functions602239 +Ref: Library Functions-Footnote-1605848 +Ref: Library Functions-Footnote-2605991 +Node: Library Names606162 +Ref: Library Names-Footnote-1609616 +Ref: Library Names-Footnote-2609839 +Node: General Functions609925 +Node: Strtonum Function611028 +Node: Assert Function614050 +Node: Round Function617374 +Node: Cliff Random Function618915 +Node: Ordinal Functions619931 +Ref: Ordinal Functions-Footnote-1622994 +Ref: Ordinal Functions-Footnote-2623246 +Node: Join Function623457 +Ref: Join Function-Footnote-1625226 +Node: Getlocaltime Function625426 +Node: Readfile Function629170 +Node: Shell Quoting631140 +Node: Data File Management632541 +Node: Filetrans Function633173 +Node: Rewind Function637229 +Node: File Checking638616 +Ref: File Checking-Footnote-1639948 +Node: Empty Files640149 +Node: Ignoring Assigns642128 +Node: Getopt Function643679 +Ref: Getopt Function-Footnote-1655141 +Node: Passwd Functions655341 +Ref: Passwd Functions-Footnote-1664178 +Node: Group Functions664266 +Ref: Group Functions-Footnote-1672160 +Node: Walking Arrays672373 +Node: Library Functions Summary673976 +Node: Library Exercises675377 +Node: Sample Programs676657 +Node: Running Examples677427 +Node: Clones678155 +Node: Cut Program679379 +Node: Egrep Program689098 +Ref: Egrep Program-Footnote-1696596 +Node: Id Program696706 +Node: Split Program700351 +Ref: Split Program-Footnote-1703799 +Node: Tee Program703927 +Node: Uniq Program706716 +Node: Wc Program714135 +Ref: Wc Program-Footnote-1718385 +Node: Miscellaneous Programs718479 +Node: Dupword Program719692 +Node: Alarm Program721723 +Node: Translate Program726527 +Ref: Translate Program-Footnote-1731092 +Node: Labels Program731362 +Ref: Labels Program-Footnote-1734713 +Node: Word Sorting734797 +Node: History Sorting738868 +Node: Extract Program740704 +Node: Simple Sed748229 +Node: Igawk Program751297 +Ref: Igawk Program-Footnote-1765621 +Ref: Igawk Program-Footnote-2765822 +Ref: Igawk Program-Footnote-3765944 +Node: Anagram Program766059 +Node: Signature Program769116 +Node: Programs Summary770363 +Node: Programs Exercises771556 +Ref: Programs Exercises-Footnote-1775687 +Node: Advanced Features775778 +Node: Nondecimal Data777726 +Node: Array Sorting779316 +Node: Controlling Array Traversal780013 +Ref: Controlling Array Traversal-Footnote-1788346 +Node: Array Sorting Functions788464 +Ref: Array Sorting Functions-Footnote-1792353 +Node: Two-way I/O792549 +Ref: Two-way I/O-Footnote-1797494 +Ref: Two-way I/O-Footnote-2797680 +Node: TCP/IP Networking797762 +Node: Profiling800635 +Node: Advanced Features Summary808912 +Node: Internationalization810845 +Node: I18N and L10N812325 +Node: Explaining gettext813011 +Ref: Explaining gettext-Footnote-1818036 +Ref: Explaining gettext-Footnote-2818220 +Node: Programmer i18n818385 +Ref: Programmer i18n-Footnote-1823251 +Node: Translator i18n823300 +Node: String Extraction824094 +Ref: String Extraction-Footnote-1825225 +Node: Printf Ordering825311 +Ref: Printf Ordering-Footnote-1828097 +Node: I18N Portability828161 +Ref: I18N Portability-Footnote-1830616 +Node: I18N Example830679 +Ref: I18N Example-Footnote-1833482 +Node: Gawk I18N833554 +Node: I18N Summary834192 +Node: Debugger835531 +Node: Debugging836553 +Node: Debugging Concepts836994 +Node: Debugging Terms838847 +Node: Awk Debugging841419 +Node: Sample Debugging Session842313 +Node: Debugger Invocation842833 +Node: Finding The Bug844217 +Node: List of Debugger Commands850692 +Node: Breakpoint Control852025 +Node: Debugger Execution Control855721 +Node: Viewing And Changing Data859085 +Node: Execution Stack862463 +Node: Debugger Info864100 +Node: Miscellaneous Debugger Commands868117 +Node: Readline Support873146 +Node: Limitations874038 +Node: Debugging Summary876152 +Node: Arbitrary Precision Arithmetic877320 +Node: Computer Arithmetic878736 +Ref: table-numeric-ranges882334 +Ref: Computer Arithmetic-Footnote-1883193 +Node: Math Definitions883250 +Ref: table-ieee-formats886538 +Ref: Math Definitions-Footnote-1887142 +Node: MPFR features887247 +Node: FP Math Caution888918 +Ref: FP Math Caution-Footnote-1889968 +Node: Inexactness of computations890337 +Node: Inexact representation891296 +Node: Comparing FP Values892653 +Node: Errors accumulate893735 +Node: Getting Accuracy895168 +Node: Try To Round897830 +Node: Setting precision898729 +Ref: table-predefined-precision-strings899413 +Node: Setting the rounding mode901202 +Ref: table-gawk-rounding-modes901566 +Ref: Setting the rounding mode-Footnote-1905021 +Node: Arbitrary Precision Integers905200 +Ref: Arbitrary Precision Integers-Footnote-1910100 +Node: POSIX Floating Point Problems910249 +Ref: POSIX Floating Point Problems-Footnote-1914122 +Node: Floating point summary914160 +Node: Dynamic Extensions916354 +Node: Extension Intro917906 +Node: Plugin License919172 +Node: Extension Mechanism Outline919969 +Ref: figure-load-extension920397 +Ref: figure-register-new-function921877 +Ref: figure-call-new-function922881 +Node: Extension API Description924867 +Node: Extension API Functions Introduction926317 +Node: General Data Types931141 +Ref: General Data Types-Footnote-1936880 +Node: Memory Allocation Functions937179 +Ref: Memory Allocation Functions-Footnote-1940018 +Node: Constructor Functions940114 +Node: Registration Functions941848 +Node: Extension Functions942533 +Node: Exit Callback Functions944830 +Node: Extension Version String946078 +Node: Input Parsers946743 +Node: Output Wrappers956622 +Node: Two-way processors961137 +Node: Printing Messages963341 +Ref: Printing Messages-Footnote-1964417 +Node: Updating `ERRNO'964569 +Node: Requesting Values965309 +Ref: table-value-types-returned966037 +Node: Accessing Parameters966994 +Node: Symbol Table Access968225 +Node: Symbol table by name968739 +Node: Symbol table by cookie970720 +Ref: Symbol table by cookie-Footnote-1974864 +Node: Cached values974927 +Ref: Cached values-Footnote-1978426 +Node: Array Manipulation978517 +Ref: Array Manipulation-Footnote-1979615 +Node: Array Data Types979652 +Ref: Array Data Types-Footnote-1982307 +Node: Array Functions982399 +Node: Flattening Arrays986253 +Node: Creating Arrays993145 +Node: Extension API Variables997916 +Node: Extension Versioning998552 +Node: Extension API Informational Variables1000453 +Node: Extension API Boilerplate1001518 +Node: Finding Extensions1005327 +Node: Extension Example1005887 +Node: Internal File Description1006659 +Node: Internal File Ops1010726 +Ref: Internal File Ops-Footnote-11022396 +Node: Using Internal File Ops1022536 +Ref: Using Internal File Ops-Footnote-11024919 +Node: Extension Samples1025192 +Node: Extension Sample File Functions1026718 +Node: Extension Sample Fnmatch1034356 +Node: Extension Sample Fork1035847 +Node: Extension Sample Inplace1037062 +Node: Extension Sample Ord1038737 +Node: Extension Sample Readdir1039573 +Ref: table-readdir-file-types1040449 +Node: Extension Sample Revout1041260 +Node: Extension Sample Rev2way1041850 +Node: Extension Sample Read write array1042590 +Node: Extension Sample Readfile1044530 +Node: Extension Sample Time1045625 +Node: Extension Sample API Tests1046974 +Node: gawkextlib1047465 +Node: Extension summary1050123 +Node: Extension Exercises1053812 +Node: Language History1054534 +Node: V7/SVR3.11056190 +Node: SVR41058371 +Node: POSIX1059816 +Node: BTL1061205 +Node: POSIX/GNU1061939 +Node: Feature History1067563 +Node: Common Extensions1080661 +Node: Ranges and Locales1081985 +Ref: Ranges and Locales-Footnote-11086603 +Ref: Ranges and Locales-Footnote-21086630 +Ref: Ranges and Locales-Footnote-31086864 +Node: Contributors1087085 +Node: History summary1092626 +Node: Installation1093996 +Node: Gawk Distribution1094942 +Node: Getting1095426 +Node: Extracting1096249 +Node: Distribution contents1097884 +Node: Unix Installation1103949 +Node: Quick Installation1104632 +Node: Shell Startup Files1107043 +Node: Additional Configuration Options1108122 +Node: Configuration Philosophy1109861 +Node: Non-Unix Installation1112230 +Node: PC Installation1112688 +Node: PC Binary Installation1114007 +Node: PC Compiling1115855 +Ref: PC Compiling-Footnote-11118876 +Node: PC Testing1118985 +Node: PC Using1120161 +Node: Cygwin1124276 +Node: MSYS1125099 +Node: VMS Installation1125599 +Node: VMS Compilation1126391 +Ref: VMS Compilation-Footnote-11127613 +Node: VMS Dynamic Extensions1127671 +Node: VMS Installation Details1129355 +Node: VMS Running1131607 +Node: VMS GNV1134443 +Node: VMS Old Gawk1135177 +Node: Bugs1135647 +Node: Other Versions1139530 +Node: Installation summary1145954 +Node: Notes1147010 +Node: Compatibility Mode1147875 +Node: Additions1148657 +Node: Accessing The Source1149582 +Node: Adding Code1151017 +Node: New Ports1157174 +Node: Derived Files1161656 +Ref: Derived Files-Footnote-11167131 +Ref: Derived Files-Footnote-21167165 +Ref: Derived Files-Footnote-31167761 +Node: Future Extensions1167875 +Node: Implementation Limitations1168481 +Node: Extension Design1169729 +Node: Old Extension Problems1170883 +Ref: Old Extension Problems-Footnote-11172400 +Node: Extension New Mechanism Goals1172457 +Ref: Extension New Mechanism Goals-Footnote-11175817 +Node: Extension Other Design Decisions1176006 +Node: Extension Future Growth1178114 +Node: Old Extension Mechanism1178950 +Node: Notes summary1180712 +Node: Basic Concepts1181898 +Node: Basic High Level1182579 +Ref: figure-general-flow1182851 +Ref: figure-process-flow1183450 +Ref: Basic High Level-Footnote-11186679 +Node: Basic Data Typing1186864 +Node: Glossary1190192 +Node: Copying1222121 +Node: GNU Free Documentation License1259677 +Node: Index1284813 End Tag Table diff --git a/doc/gawk.texi b/doc/gawk.texi index 48583f4d..a5243277 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 @@ -14788,10 +14790,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 @@ -16928,6 +16944,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 @@ -27729,8 +27762,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 @@ -27824,10 +27856,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 @@ -30876,6 +30924,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.html}. + +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 @@ -35708,6 +35869,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 @@ -36985,6 +37150,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 @@ -37029,8 +37196,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 @@ -37041,6 +37206,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. @@ -37072,6 +37243,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 @@ -37152,6 +37324,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 8fd84288..897cfefb 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 @@ -14116,10 +14118,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 @@ -16210,6 +16226,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 @@ -26821,8 +26854,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 @@ -26916,10 +26948,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 @@ -29968,6 +30016,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.html}. + +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 @@ -34800,6 +34961,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 @@ -36077,6 +36242,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 @@ -36121,8 +36288,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 @@ -36133,6 +36298,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. @@ -36164,6 +36335,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 @@ -36244,6 +36416,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 |