diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/CMakeLists.txt | 95 | ||||
| -rw-r--r-- | doc/ChangeLog | 116 | ||||
| -rw-r--r-- | doc/Makefile.am | 14 | ||||
| -rw-r--r-- | doc/Makefile.in | 30 | ||||
| -rw-r--r-- | doc/awkcard.in | 3 | ||||
| -rw-r--r-- | doc/gawk.1 | 72 | ||||
| -rw-r--r-- | doc/gawk.info | 1862 | ||||
| -rw-r--r-- | doc/gawk.texi | 567 | ||||
| -rw-r--r-- | doc/gawktexi.in | 567 |
9 files changed, 2480 insertions, 846 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 1c9420d9..dd671ff0 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -22,6 +22,10 @@ * gawktexi.in: Fix description of nextfile within a function. Sigh. +2015-05-15 Andrew J. Schorr <aschorr@telemetry-investments.com> + + * gawktexi.in (Undocumented): Describe the new PROCINFO["argv"] array. + 2015-05-14 Arnold D. Robbins <arnold@skeeve.com> * gawktexi.in (Bugs): Add that email should be in plain @@ -31,6 +35,10 @@ * 4.1.2: Release tar ball made. +2015-04-16 Arnold D. Robbins <arnold@skeeve.com> + + * gawktexi.in (Undocumented): More info added. + 2015-04-08 Arnold D. Robbins <arnold@skeeve.com> * gawktexi.in: Update feature history section. @@ -52,6 +60,11 @@ * gawktexi.in: Fix a figure caption. Thanks to Antonio Colombo for pointing this out. + * gawktexi.in: Additional typo fix, also thanks to Antonio. + +2015-04-02 Arnold D. Robbins <arnold@skeeve.com> + + * gawktexi.in, gawk.1, awkcard.in: Name change: div() --> intdiv(). 2015-03-31 Arnold D. Robbins <arnold@skeeve.com> @@ -59,10 +72,17 @@ indirectly. Small additional fix relating to rand(). Thanks to Antonio Colombo. +2015-03-27 Arnold D. Robbins <arnold@skeeve.com> + + * gawktexi.in: Minor edits. + 2015-03-24 Arnold D. Robbins <arnold@skeeve.com> * gawktexi.in: Minor fixes from Antonio Colombo and new exercise in chapter 16. + * gawk.1: Minor edits. + * gawktexi.in: Edits in material on errno and retryable and get_file + API. 2015-03-17 Andrew J. Schorr <aschorr@telemetry-investments.com> @@ -76,6 +96,12 @@ Thanks to Nicholas Mills <nlmills@clemson.edu> for pointing out the issue. +2015-03-08 Arnold D. Robbins <arnold@skeeve.com> + + * gawktexi.in: Briefly describe that nonfatal I/O overrides + GAWK_SOCK_RETRIES, in the env var part and in the nonfatal I/O + part. + 2015-03-01 Arnold D. Robbins <arnold@skeeve.com> * gawktexi.in: Change quotes to @dfn for pseudorandom. @@ -132,6 +158,7 @@ 2015-02-08 Arnold D. Robbins <arnold@skeeve.com> * gawktexi.in: O'Reilly fixes. + Make non-fatal i/o use "NONFATAL". 2015-02-06 Arnold D. Robbins <arnold@skeeve.com> @@ -140,6 +167,7 @@ 2015-02-04 Arnold D. Robbins <arnold@skeeve.com> * gawktexi.in: O'Reilly fixes. + * gawktexi.in: Update various version-related bits of info. 2015-02-02 Arnold D. Robbins <arnold@skeeve.com> @@ -169,7 +197,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> @@ -191,12 +219,40 @@ * gawkinet.texi: Fix capitalization in document title. * gawktexi.in: Here we go again: Starting on more O'Reilly fixes. +2014-12-27 Arnold D. Robbins <arnold@skeeve.com> + + * gawktexi.in: Add info that nonfatal I/O works with stdout and + stderr. Revise version info and what was added when. + +2015-01-05 Andrew J. Schorr <aschorr@telemetry-investments.com> + + * gawktexi.in: Improve get_file documentation. + +2015-01-05 Andrew J. Schorr <aschorr@telemetry-investments.com> + + * gawktexi.in: Replace "Retrying I/O" with "Retrying Input", since this + feature pertains to input, not output. + +2015-01-04 Andrew J. Schorr <aschorr@telemetry-investments.com> + + * gawktexi.in: Document the get_file API function. + +2015-01-04 Andrew J. Schorr <aschorr@telemetry-investments.com> + + * gawk.1: Document new features PROCINFO["errno"] and + PROCINFO["input", "RETRY"], and new getline return value of -2. + * gawktexi.in: Ditto. + 2014-12-26 Antonio Giovanni Colombo <azc100@gmail.com> * gawktexi.in (Glossary): Really sort the items. 2014-12-24 Arnold D. Robbins <arnold@skeeve.com> + * gawktexi.in: Start documenting nonfatal output. + +2014-12-24 Arnold D. Robbins <arnold@skeeve.com> + * gawktexi.in: Add one more paragraph to new foreword. * gawktexi.in: Fix exponentiation in TeX mode. Thanks to Marco Curreli by way of Antonio Giovanni Colombo. @@ -228,6 +284,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. @@ -241,6 +302,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. @@ -254,6 +320,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> @@ -295,10 +362,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. @@ -394,6 +476,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. @@ -427,6 +513,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. @@ -441,6 +531,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 @@ -451,6 +553,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. @@ -747,7 +854,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> @@ -821,6 +928,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..0219bc97 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -116,14 +116,14 @@ ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 am__aclocal_m4_deps = $(top_srcdir)/m4/arch.m4 \ $(top_srcdir)/m4/codeset.m4 $(top_srcdir)/m4/gettext.m4 \ $(top_srcdir)/m4/iconv.m4 $(top_srcdir)/m4/intlmacosx.m4 \ - $(top_srcdir)/m4/isc-posix.m4 $(top_srcdir)/m4/lcmessage.m4 \ - $(top_srcdir)/m4/lib-ld.m4 $(top_srcdir)/m4/lib-link.m4 \ - $(top_srcdir)/m4/lib-prefix.m4 $(top_srcdir)/m4/libsigsegv.m4 \ - $(top_srcdir)/m4/longlong.m4 $(top_srcdir)/m4/mpfr.m4 \ - $(top_srcdir)/m4/nls.m4 $(top_srcdir)/m4/noreturn.m4 \ - $(top_srcdir)/m4/po.m4 $(top_srcdir)/m4/progtest.m4 \ - $(top_srcdir)/m4/readline.m4 $(top_srcdir)/m4/socket.m4 \ - $(top_srcdir)/m4/ulonglong.m4 $(top_srcdir)/configure.ac + $(top_srcdir)/m4/lcmessage.m4 $(top_srcdir)/m4/lib-ld.m4 \ + $(top_srcdir)/m4/lib-link.m4 $(top_srcdir)/m4/lib-prefix.m4 \ + $(top_srcdir)/m4/libsigsegv.m4 $(top_srcdir)/m4/longlong.m4 \ + $(top_srcdir)/m4/mpfr.m4 $(top_srcdir)/m4/nls.m4 \ + $(top_srcdir)/m4/noreturn.m4 $(top_srcdir)/m4/po.m4 \ + $(top_srcdir)/m4/progtest.m4 $(top_srcdir)/m4/readline.m4 \ + $(top_srcdir)/m4/socket.m4 $(top_srcdir)/m4/ulonglong.m4 \ + $(top_srcdir)/configure.ac am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ $(ACLOCAL_M4) DIST_COMMON = $(srcdir)/Makefile.am $(am__DIST_COMMON) @@ -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 05c03502..64b3c465 100644 --- a/doc/awkcard.in +++ b/doc/awkcard.in @@ -1611,6 +1611,9 @@ l lw(2i). \*(FCcos(\*(FIexpr\*(FC)\*(FR The cosine of \*(FIexpr\fP, which is in radians. \*(FCexp(\*(FIexpr\*(FC)\*(FR The exponential function (\*(FIe \*(FC^ \*(FIx\*(FR). \*(FCint(\*(FIexpr\*(FC)\*(FR Truncate to integer. +\*(CB\*(FCintdiv(\*(FIn\*(FR\*(FC,\*(FI d\*(FR\*(FC,\*(FI res\*(FR\*(FC)\*(FR T{ +Return the result of integer division in \*(FIres\*(FR.\*(CD +T} \*(FClog(\*(FIexpr\*(FC)\*(FR The natural logarithm function (base \*(FIe\^\*(FR). \*(FCrand()\fP A random number \*(FIN\fP such that 0 \(<= \*(FIN\fP < 1. \*(FCsin(\*(FIexpr\*(FC)\*(FR The sine of \*(FIexpr\fP, which is in radians. @@ -13,7 +13,7 @@ . if \w'\(rq' .ds rq "\(rq . \} .\} -.TH GAWK 1 "Aug 03 2014" "Free Software Foundation" "Utility Commands" +.TH GAWK 1 "Apr 02 2015" "Free Software Foundation" "Utility Commands" .SH NAME gawk \- pattern scanning and processing language .SH SYNOPSIS @@ -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 @@ -936,6 +942,15 @@ then will contain a string describing the error. The value is subject to translation in non-English locales. +If the string in +.B ERRNO +corresponds to a system error in the +.IR errno (3) +variable, then the numeric value can be found in +.B PROCINFO["errno"]. +For non-system errors, +.B PROCINFO["errno"] +will be zero. .TP .B FIELDWIDTHS A whitespace separated list of field widths. When set, @@ -1097,6 +1112,13 @@ system call. The default time format string for .BR strftime() . .TP +\fBPROCINFO["errno"]\fP +The value of +.IR errno (3) +when +.BR ERRNO +is set to the associated error message. +.TP \fBPROCINFO["euid"]\fP The value of the .IR geteuid (2) @@ -1215,6 +1237,28 @@ where is a redirection string or a filename. A value of zero or less than zero means no timeout. .TP +\fBPROCINFO["input", "RETRY"]\fP +If an I/O error that may be retried occurs when reading data from +.IR input , +and this array entry exists, then +.B getline +will return \-2 instead of following the default behavior of returning \-1 +and configuring +.IR input +to return no further data. +An I/O error that may be retried is one where +.IR errno (3) +has the value +.IR EAGAIN , +.IR EWOULDBLOCK , +.IR EINTR , +or +.IR ETIMEDOUT . +This may be useful in conjunction with +\fBPROCINFO["input", "READ_TIMEOUT"]\fP +or situations where a file descriptor has been configured to behave in a +non-blocking fashion. +.TP \fBPROCINFO["mpfr_version"]\fP The version of the GNU MPFR library used for arbitrary precision number support in @@ -2283,6 +2327,13 @@ below.) The .B getline command returns 1 on success, 0 on end of file, and \-1 on an error. +If the +.IR errno (3) +value indicates that the I/O operation may be retried, +and \fBPROCINFO["input", "RETRY"]\fP +is set, then \-2 will be returned instead of \-1, and further calls to +.B getline +may be attempted. Upon an error, .B ERRNO is set to a string describing the problem. @@ -2635,6 +2686,23 @@ The exponential function. .BI int( expr ) Truncate to integer. .TP +.BI intdiv( 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 log( expr ) The natural logarithm function. .TP diff --git a/doc/gawk.info b/doc/gawk.info index 8d328901..337c148c 100644 --- a/doc/gawk.info +++ b/doc/gawk.info @@ -217,6 +217,7 @@ in (a) below. A copy of the license is included in the section entitled 'getline'. * Getline Summary:: Summary of 'getline' Variants. * Read Timeout:: Reading input with a timeout. +* Retrying Input:: Retrying input after certain errors. * Command-line directories:: What happens if you put a directory on the command line. * Input Summary:: Input summary. @@ -246,6 +247,7 @@ in (a) below. A copy of the license is included in the section entitled * Special Caveats:: Things to watch out for. * Close Files And Pipes:: Closing Input and Output Files and Pipes. +* Nonfatal:: Enabling Nonfatal Output. * Output Summary:: Output summary. * Output Exercises:: Exercises. * Values:: Constants, Variables, and Regular @@ -557,6 +559,7 @@ in (a) below. A copy of the license is included in the section entitled * Array Functions:: Functions for working with arrays. * Flattening Arrays:: How to flatten arrays. * Creating Arrays:: How to create and populate arrays. +* Redirection API:: How to access and manipulate redirections. * Extension API Variables:: Variables provided by the API. * Extension Versioning:: API Version information. * Extension API Informational Variables:: Variables providing information about @@ -615,6 +618,7 @@ in (a) below. A copy of the license is included in the section entitled * 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 @@ -2629,10 +2633,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' @@ -2931,6 +2933,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. @@ -2970,6 +2975,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. @@ -2996,7 +3004,8 @@ used by regular users: 'GAWK_SOCK_RETRIES' Controls the number of times 'gawk' attempts to retry a two-way TCP/IP (socket) connection before giving up. *Note TCP/IP - Networking::. + Networking::. Note that when nonfatal I/O is enabled (*note + Nonfatal::), 'gawk' only tries to open a TCP/IP socket once. 'POSIXLY_CORRECT' Causes 'gawk' to switch to POSIX-compatibility mode, disabling all @@ -3041,13 +3050,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. @@ -3438,15 +3440,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 4.2, only two + digits are processed. '\/' A literal slash (necessary for regexp constants only). This @@ -4159,6 +4164,7 @@ be named on the 'awk' command line (*note Getline::). * Getline:: Reading files under explicit program control using the 'getline' function. * Read Timeout:: Reading input with a timeout. +* Retrying Input:: Retrying input after certain errors. * Command-line directories:: What happens if you put a directory on the command line. * Input Summary:: Input summary. @@ -5422,6 +5428,11 @@ record, such as a file that cannot be opened, then 'getline' returns -1. In this case, 'gawk' sets the variable 'ERRNO' to a string describing the error that occurred. + If 'ERRNO' indicates that the I/O operation may be retried, and +'PROCINFO["INPUT", "RETRY"]' is set, then 'getline' returns -2 instead +of -1, and further calls to 'getline' may be attemped. *Note Retrying +Input::, for further information about this feature. + In the following examples, COMMAND stands for a string value that represents a shell command. @@ -5857,7 +5868,7 @@ VAR Table 4.1: 'getline' variants and what they set -File: gawk.info, Node: Read Timeout, Next: Command-line directories, Prev: Getline, Up: Reading Files +File: gawk.info, Node: Read Timeout, Next: Retrying Input, Prev: Getline, Up: Reading Files 4.10 Reading Input with a Timeout ================================= @@ -5936,7 +5947,8 @@ per-command or per-connection basis. 'gawk' considers a timeout event to be an error even though the attempt to read from the underlying device may succeed in a later attempt. This is a limitation, and it also means that you cannot use -this to multiplex input from two or more sources. +this to multiplex input from two or more sources. *Note Retrying +Input::, for a way to enable later I/O attempts to succeed. Assigning a timeout value prevents read operations from blocking indefinitely. But bear in mind that there are other ways 'gawk' can @@ -5950,9 +5962,36 @@ can block indefinitely until some other process opens it for writing. (1) This assumes that standard input is the keyboard. -File: gawk.info, Node: Command-line directories, Next: Input Summary, Prev: Read Timeout, Up: Reading Files +File: gawk.info, Node: Retrying Input, Next: Command-line directories, Prev: Read Timeout, Up: Reading Files + +4.11 Retrying Reads After Certain Input Errors +============================================== + +This minor node describes a feature that is specific to 'gawk'. + + When 'gawk' encounters an error while reading input, by default +'getline' returns -1, and subsequent attempts to read from that file +result in an end-of-file indication. However, you may optionally +instruct 'gawk' to allow I/O to be retried when certain errors are +encountered by setting a special element in the 'PROCINFO' array (*note +Auto-set::): + + PROCINFO["INPUT_NAME", "RETRY"] = 1 + + When this element exists, 'gawk' checks the value of the system (C +language) 'errno' variable when an I/O error occurs. If 'errno' +indicates a subsequent I/O attempt may succeed, 'getline' instead +returns -2 and further calls to 'getline' may succeed. This applies to +the 'errno' values 'EAGAIN', 'EWOULDBLOCK', 'EINTR', or 'ETIMEDOUT'. + + This feature is useful in conjunction with 'PROCINFO["INPUT_NAME", +"READ_TIMEOUT"]' or situations where a file descriptor has been +configured to behave in a non-blocking fashion. + + +File: gawk.info, Node: Command-line directories, Next: Input Summary, Prev: Retrying Input, Up: Reading Files -4.11 Directories on the Command Line +4.12 Directories on the Command Line ==================================== According to the POSIX standard, files named on the 'awk' command line @@ -5975,7 +6014,7 @@ usable data from an 'awk' program. File: gawk.info, Node: Input Summary, Next: Input Exercises, Prev: Command-line directories, Up: Reading Files -4.12 Summary +4.13 Summary ============ * Input is split into records based on the value of 'RS'. The @@ -6047,7 +6086,7 @@ File: gawk.info, Node: Input Summary, Next: Input Exercises, Prev: Command-li File: gawk.info, Node: Input Exercises, Prev: Input Summary, Up: Reading Files -4.13 Exercises +4.14 Exercises ============== 1. Using the 'FIELDWIDTHS' variable (*note Constant Size::), write a @@ -6097,6 +6136,7 @@ function. 'gawk' allows access to inherited file descriptors. * Close Files And Pipes:: Closing Input and Output Files and Pipes. +* Nonfatal:: Enabling Nonfatal Output. * Output Summary:: Output summary. * Output Exercises:: Exercises. @@ -7004,7 +7044,7 @@ that 'gawk' provides: behavior. -File: gawk.info, Node: Close Files And Pipes, Next: Output Summary, Prev: Special Files, Up: Printing +File: gawk.info, Node: Close Files And Pipes, Next: Nonfatal, Prev: Special Files, Up: Printing 5.9 Closing Input and Output Redirections ========================================= @@ -7172,9 +7212,68 @@ call. See the system manual pages for information on how to decode this value. -File: gawk.info, Node: Output Summary, Next: Output Exercises, Prev: Close Files And Pipes, Up: Printing +File: gawk.info, Node: Nonfatal, Next: Output Summary, Prev: Close Files And Pipes, Up: Printing + +5.10 Enabling Nonfatal Output +============================= + +This minor node describes a 'gawk'-specific feature. + + In standard 'awk', output with 'print' or 'printf' to a nonexistent +file, or some other I/O error (such as filling up the disk) is a fatal +error. + + $ gawk 'BEGIN { print "hi" > "/no/such/file" }' + error-> gawk: cmd. line:1: fatal: can't redirect to `/no/such/file' (No such file or directory) + + 'gawk' makes it possible to detect that an error has occurred, +allowing you to possibly recover from the error, or at least print an +error message of your choosing before exiting. You can do this in one +of two ways: + + * For all output files, by assigning any value to + 'PROCINFO["NONFATAL"]'. + + * On a per-file basis, by assigning any value to 'PROCINFO[FILENAME, + "NONFATAL"]'. Here, FILENAME is the name of the file to which you + wish output to be nonfatal. + + Once you have enabled nonfatal output, you must check 'ERRNO' after +every relevant 'print' or 'printf' statement to see if something went +wrong. It is also a good idea to initialize 'ERRNO' to zero before +attempting the output. For example: + + $ gawk ' + > BEGIN { + > PROCINFO["NONFATAL"] = 1 + > ERRNO = 0 + > print "hi" > "/no/such/file" + > if (ERRNO) { + > print("Output failed:", ERRNO) > "/dev/stderr" + > exit 1 + > } + > }' + error-> Output failed: No such file or directory + + Here, 'gawk' did not produce a fatal error; instead it let the 'awk' +program code detect the problem and handle it. + + This mechanism works also for standard output and standard error. +For standard output, you may use 'PROCINFO["-", "NONFATAL"]' or +'PROCINFO["/dev/stdout", "NONFATAL"]'. For standard error, use +'PROCINFO["/dev/stderr", "NONFATAL"]'. + + When attempting to open a TCP/IP socket (*note TCP/IP Networking::), +'gawk' tries multiple times. The 'GAWK_SOCK_RETRIES' environment +variable (*note Other Environment Variables::) allows you to override +'gawk''s builtin default number of attempts. However, once nonfatal I/O +is enabled for a given socket, 'gawk' only retries once, relying on +'awk'-level code to notice that there was a problem. + + +File: gawk.info, Node: Output Summary, Next: Output Exercises, Prev: Nonfatal, Up: Printing -5.10 Summary +5.11 Summary ============ * The 'print' statement prints comma-separated expressions. Each @@ -7196,10 +7295,15 @@ File: gawk.info, Node: Output Summary, Next: Output Exercises, Prev: Close Fi For coprocesses, it is possible to close only one direction of the communications. + * Normally errors with 'print' or 'printf' are fatal. 'gawk' lets + you make output errors be nonfatal either for all files or on a + per-file basis. You must then check for errors after every + relevant output statement. + File: gawk.info, Node: Output Exercises, Prev: Output Summary, Up: Printing -5.11 Exercises +5.12 Exercises ============== 1. Rewrite the program: @@ -10283,10 +10387,24 @@ 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.) + '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 'ENVIRON["AWKPATH"]' @@ -10309,6 +10427,11 @@ they are not special: 'getline' returning -1. You are, of course, free to clear it yourself before doing an I/O operation. + If the value of 'ERRNO' corresponds to a system error in the C + 'errno' variable, then 'PROCINFO["errno"]' will be set to the value + of 'errno'. For non-system errors, 'PROCINFO["errno"]' will be + zero. + 'FILENAME' The name of the current input file. When no data files are listed on the command line, 'awk' reads from the standard input and @@ -10357,6 +10480,10 @@ they are not special: 'PROCINFO["egid"]' The value of the 'getegid()' system call. + 'PROCINFO["errno"]' + The value of the C 'errno' variable when 'ERRNO' is set to the + associated error message. + 'PROCINFO["euid"]' The value of the 'geteuid()' system call. @@ -10466,6 +10593,10 @@ they are not special: input file, pipe, or coprocess. *Note Read Timeout::, for more information. + * It may be used to indicate that input may be retried when it + fails due to certain errors. *Note Retrying Input::, for more + information. + * It may be used to cause coprocesses to communicate over pseudo-ttys instead of through two-way pipes; this is discussed further in *note Two-way I/O::. @@ -11855,6 +11986,21 @@ with numbers. Optional parameters are enclosed in square brackets ([ ]): truncated toward zero. For example, 'int(3)' is 3, 'int(3.9)' is 3, 'int(-3.9)' is -3, and 'int(-3)' is -3 as well. +'intdiv(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::). + 'log(X)' Return the natural logarithm of X, if X is positive; otherwise, return 'NaN' ("not a number") on IEEE 754 systems. Additionally, @@ -19828,8 +19974,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: +representation. Also, things such as: /foo/ @@ -19888,8 +20033,24 @@ 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 @@ -22367,6 +22528,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 'intdiv()' function (*note Numeric Functions::). + + You can simulate the 'intdiv()' function in standard 'awk' using this +user-defined function: + + # intdiv --- do integer division + + function intdiv(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 +'intdiv()' 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 + intdiv(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 @@ -22728,6 +22945,7 @@ API in detail. * Symbol Table Access:: Functions for accessing global variables. * Array Manipulation:: Functions for working with arrays. +* Redirection API:: How to access and manipulate redirections. * Extension API Variables:: Variables provided by the API. * Extension API Boilerplate:: Boilerplate code for using the API. @@ -22783,6 +23001,8 @@ operations: - Flattening an array for easy C-style looping over all its indices and elements + * Accessing and manipulating redirections. + Some points about using the API: * The following types, macros, and/or functions are referenced in @@ -23988,7 +24208,7 @@ using 'release_value()'. 'double' to store. -File: gawk.info, Node: Array Manipulation, Next: Extension API Variables, Prev: Symbol Table Access, Up: Extension API Description +File: gawk.info, Node: Array Manipulation, Next: Redirection API, Prev: Symbol Table Access, Up: Extension API Description 16.4.11 Array Manipulation -------------------------- @@ -24472,9 +24692,78 @@ array: environment variable.) -File: gawk.info, Node: Extension API Variables, Next: Extension API Boilerplate, Prev: Array Manipulation, Up: Extension API Description +File: gawk.info, Node: Redirection API, Next: Extension API Variables, Prev: Array Manipulation, Up: Extension API Description + +16.4.12 Accessing and Manipulating Redirections +----------------------------------------------- + +The following function allows extensions to access and manipulate +redirections. + +'awk_bool_t get_file(const char *name,' +' size_t name_len,' +' const char *filetype,' +' int fd,' +' const awk_input_buf_t **ibufp,' +' const awk_output_buf_t **obufp);' + Look up a file in 'gawk''s internal redirection table. If 'name' + is 'NULL' or 'name_len' is zero, return data for the currently open + input file corresponding to 'FILENAME'. (This does not access the + 'filetype' argument, so that may be undefined). If the file is not + already open, attempt to open it. The 'filetype' argument must be + zero-terminated and should be one of: + + '">"' + A file opened for output. + + '">>"' + A file opened for append. + + '"<"' + A file opened for input. + + '"|>"' + A pipe opened for output. + + '"|<"' + A pipe opened for input. + + '"|&"' + A two-way coprocess. + + On error, return a 'false' value. Otherwise, return 'true', and + return additional information about the redirection in the 'ibufp' + and 'obufp' pointers. For input redirections, the '*ibufp' value + should be non-'NULL', and '*obufp' should be 'NULL'. For output + redirections, the '*obufp' value should be non-'NULL', and '*ibufp' + should be 'NULL'. For two-way coprocesses, both values should be + non-'NULL'. + + In the usual case, the extension is interested in '(*ibufp)->fd' + and/or 'fileno((*obufp)->fp)'. If the file is not already open, + and the 'fd' argument is non-negative, 'gawk' will use that file + descriptor instead of opening the file in the usual way. If 'fd' + is non-negative, but the file exists already, 'gawk' ignores 'fd' + and returns the existing file. It is the caller's responsibility + to notice that neither the 'fd' in the returned 'awk_input_buf_t' + nor the 'fd' in the returned 'awk_output_buf_t' matches the + requested value. -16.4.12 API Variables + Note that supplying a file descriptor is currently _not_ supported + for pipes. However, supplying a file descriptor should work for + input, output, append, and two-way (coprocess) sockets. If + 'filetype' is two-way, 'gawk' assumes that it is a socket! Note + that in the two-way case, the input and output file descriptors may + differ. To check for success, you must check whether either + matches. + + It is anticipated that this API function will be used to implement +I/O multiplexing and a socket library. + + +File: gawk.info, Node: Extension API Variables, Next: Extension API Boilerplate, Prev: Redirection API, Up: Extension API Description + +16.4.13 API Variables --------------------- The API provides two sets of variables. The first provides information @@ -24491,7 +24780,7 @@ information about how 'gawk' was invoked. File: gawk.info, Node: Extension Versioning, Next: Extension API Informational Variables, Up: Extension API Variables -16.4.12.1 API Version Constants and Variables +16.4.13.1 API Version Constants and Variables ............................................. The API provides both a "major" and a "minor" version number. The API @@ -24540,7 +24829,7 @@ Boilerplate::). File: gawk.info, Node: Extension API Informational Variables, Prev: Extension Versioning, Up: Extension API Variables -16.4.12.2 Informational Variables +16.4.13.2 Informational Variables ................................. The API provides access to several variables that describe whether the @@ -24575,7 +24864,7 @@ change during execution. File: gawk.info, Node: Extension API Boilerplate, Prev: Extension API Variables, Up: Extension API Description -16.4.13 Boilerplate Code +16.4.14 Boilerplate Code ------------------------ As mentioned earlier (*note Extension Mechanism Outline::), the function @@ -25876,15 +26165,17 @@ project. * GD graphics library extension + * MPFR library extension (this provides access to a number of MPFR + functions that 'gawk''s native MPFR support does not) + * PDF extension * PostgreSQL extension - * MPFR library extension (this provides access to a number of MPFR - functions that 'gawk''s native MPFR support does not) - * Redis extension + * Select extension + * XML parser extension, using the Expat (http://expat.sourceforge.net) XML parsing library @@ -26297,6 +26588,9 @@ current version of 'gawk'. - Directories on the command line produce a warning and are skipped (*note Command-line directories::) + - Output with 'print' and 'printf' need not be fatal (*note + Nonfatal::) + * New keywords: - The 'BEGINFILE' and 'ENDFILE' special patterns (*note @@ -26346,6 +26640,9 @@ current version of 'gawk'. - The 'bindtextdomain()', 'dcgettext()', and 'dcngettext()' functions for internationalization (*note Programmer i18n::) + - The 'intdiv()' function for doing integer division and + remainder (*note Numeric Functions::) + * Changes and/or additions in the command-line options: - The 'AWKPATH' environment variable for specifying a path @@ -26399,6 +26696,11 @@ current version of 'gawk'. - Ultrix + * Support for the following systems was removed from the code for + 'gawk' version 4.2: + + - MirBSD + File: gawk.info, Node: Feature History, Next: Common Extensions, Prev: POSIX/GNU, Up: Language History @@ -26790,6 +27092,26 @@ POSIX 'awk', in the order they were added to 'gawk'. * Support for Ultrix was removed. + Version 4.2 introduced the following changes: + + * Changes to 'ENVIRON' are reflected into 'gawk''s environment and + that of programs that it runs. *Note Auto-set::. + + * The '--pretty-print' option no longer runs the 'awk' program too. + *Note Options::. + + * The 'igawk' program and its manual page are no longer installed + when 'gawk' is built. *Note Igawk Program::. + + * The 'intdiv()' function. *Note Numeric Functions::. + + * The maximum number of hexdecimal digits in '\x' escapes is now two. + *Note Escape Sequences::. + + * Nonfatal output with 'print' and 'printf'. *Note Nonfatal::. + + * Support for MirBSD was removed. + File: gawk.info, Node: Common Extensions, Next: Ranges and Locales, Prev: Feature History, Up: Language History @@ -27305,7 +27627,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::. + 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 @@ -27347,17 +27671,22 @@ 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. @@ -27388,11 +27717,12 @@ 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 -------------------------------------------- @@ -27447,9 +27777,42 @@ 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. -B.2.2 Additional Configuration Options +'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.3 Additional Configuration Options -------------------------------------- There are several additional options you may use on the 'configure' @@ -27493,7 +27856,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 @@ -31441,20 +31804,20 @@ Index * '--include' option: Options. (line 159) * '--lint' option: Command Line. (line 20) * '--lint' option <1>: Options. (line 184) -* '--lint-old' option: Options. (line 294) +* '--lint-old' option: Options. (line 292) * '--load' option: Options. (line 172) * '--non-decimal-data' option: Options. (line 209) * '--non-decimal-data' option <1>: Nondecimal Data. (line 6) * '--non-decimal-data' option, 'strtonum()' function and: Nondecimal Data. (line 35) -* '--optimize' option: Options. (line 236) -* '--posix' option: Options. (line 254) -* '--posix' option, '--traditional' option and: Options. (line 272) +* '--optimize' option: Options. (line 234) +* '--posix' option: Options. (line 252) +* '--posix' option, '--traditional' option and: Options. (line 270) * '--pretty-print' option: Options. (line 223) -* '--profile' option: Options. (line 242) +* '--profile' option: Options. (line 240) * '--profile' option <1>: Profiling. (line 12) -* '--re-interval' option: Options. (line 278) -* '--sandbox' option: Options. (line 285) +* '--re-interval' option: Options. (line 276) +* '--sandbox' option: Options. (line 283) * '--sandbox' option, disabling 'system()' function: I/O Functions. (line 129) * '--sandbox' option, input redirection with 'getline': Getline. @@ -31463,9 +31826,9 @@ Index (line 6) * '--source' option: Options. (line 117) * '--traditional' option: Options. (line 82) -* '--traditional' option, '--posix' option and: Options. (line 272) +* '--traditional' option, '--posix' option and: Options. (line 270) * '--use-lc-numeric' option: Options. (line 218) -* '--version' option: Options. (line 299) +* '--version' option: Options. (line 297) * '--with-whiny-user-strftime' configuration option: Additional Configuration Options. (line 37) * '-b' option: Options. (line 69) @@ -31475,31 +31838,31 @@ Index * '-D' option: Options. (line 108) * '-e' option: Options. (line 117) * '-E' option: Options. (line 125) -* '-e' option <1>: Options. (line 335) +* '-e' option <1>: Options. (line 333) * '-f' option: Long. (line 12) * '-F' option: Options. (line 21) * '-f' option <1>: Options. (line 25) -* '-F' option, '-Ft' sets 'FS' to TAB: Options. (line 307) +* '-F' option, '-Ft' sets 'FS' to TAB: Options. (line 305) * '-F' option, command-line: Command Line Field Separator. (line 6) -* '-f' option, multiple uses: Options. (line 312) +* '-f' option, multiple uses: Options. (line 310) * '-g' option: Options. (line 147) * '-h' option: Options. (line 154) * '-i' option: Options. (line 159) * '-l' option: Options. (line 172) * '-l' option <1>: Options. (line 184) -* '-L' option: Options. (line 294) +* '-L' option: Options. (line 292) * '-M' option: Options. (line 203) * '-n' option: Options. (line 209) * '-N' option: Options. (line 218) * '-o' option: Options. (line 223) -* '-O' option: Options. (line 236) -* '-p' option: Options. (line 242) -* '-P' option: Options. (line 254) -* '-r' option: Options. (line 278) -* '-S' option: Options. (line 285) +* '-O' option: Options. (line 234) +* '-p' option: Options. (line 240) +* '-P' option: Options. (line 252) +* '-r' option: Options. (line 276) +* '-S' option: Options. (line 283) * '-v' option: Options. (line 32) -* '-V' option: Options. (line 299) +* '-V' option: Options. (line 297) * '-v' option <1>: Assignment Options. (line 12) * '-W' option: Options. (line 47) * '.' (period), regexp operator: Regexp Operators. (line 44) @@ -31575,16 +31938,16 @@ Index * '\' (backslash), in bracket expressions: Bracket Expressions. (line 17) * '\' (backslash), in escape sequences: Escape Sequences. (line 6) -* '\' (backslash), in escape sequences <1>: Escape Sequences. (line 100) +* '\' (backslash), in escape sequences <1>: Escape Sequences. (line 103) * '\' (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) -* '\' (backslash), '\"' escape sequence: Escape Sequences. (line 82) +* '\' (backslash), '\"' escape sequence: Escape Sequences. (line 85) * '\' (backslash), '\'' operator ('gawk'): GNU Regexp Operators. (line 59) -* '\' (backslash), '\/' escape sequence: Escape Sequences. (line 73) +* '\' (backslash), '\/' escape sequence: Escape Sequences. (line 76) * '\' (backslash), '\<' operator ('gawk'): GNU Regexp Operators. (line 33) * '\' (backslash), '\>' operator ('gawk'): GNU Regexp Operators. @@ -31802,7 +32165,7 @@ Index * 'awf' (amazingly workable formatter) program: Glossary. (line 24) * 'awk' debugging, enabling: Options. (line 108) * 'awk' language, POSIX version: Assignment Ops. (line 138) -* 'awk' profiling, enabling: Options. (line 242) +* 'awk' profiling, enabling: Options. (line 240) * 'awk' programs: Getting Started. (line 12) * 'awk' programs <1>: Executable Scripts. (line 6) * 'awk' programs <2>: Two Rules. (line 6) @@ -31877,16 +32240,16 @@ Index * backslash ('\'), in bracket expressions: Bracket Expressions. (line 17) * backslash ('\'), in escape sequences: Escape Sequences. (line 6) -* backslash ('\'), in escape sequences <1>: Escape Sequences. (line 100) +* backslash ('\'), in escape sequences <1>: Escape Sequences. (line 103) * 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) -* backslash ('\'), '\"' escape sequence: Escape Sequences. (line 82) +* backslash ('\'), '\"' escape sequence: Escape Sequences. (line 85) * backslash ('\'), '\'' operator ('gawk'): GNU Regexp Operators. (line 59) -* backslash ('\'), '\/' escape sequence: Escape Sequences. (line 73) +* backslash ('\'), '\/' escape sequence: Escape Sequences. (line 76) * backslash ('\'), '\<' operator ('gawk'): GNU Regexp Operators. (line 33) * backslash ('\'), '\>' operator ('gawk'): GNU Regexp Operators. @@ -32007,7 +32370,7 @@ Index * Brennan, Michael <5>: Other Versions. (line 6) * Brennan, Michael <6>: Other Versions. (line 48) * Brian Kernighan's 'awk': When. (line 21) -* Brian Kernighan's 'awk' <1>: Escape Sequences. (line 109) +* Brian Kernighan's 'awk' <1>: Escape Sequences. (line 112) * Brian Kernighan's 'awk' <2>: GNU Regexp Operators. (line 85) * Brian Kernighan's 'awk' <3>: Regexp Field Splitting. @@ -32218,7 +32581,7 @@ Index * counting: Wc Program. (line 6) * 'csh' utility: Statements/Lines. (line 43) * 'csh' utility, 'POSIXLY_CORRECT' environment variable: Options. - (line 353) + (line 351) * 'csh' utility, '|&' operator, comparison with: Two-way I/O. (line 27) * 'ctime()' user-defined function: Function Example. (line 74) * currency symbols, localization: Explaining gettext. (line 104) @@ -32249,12 +32612,12 @@ Index * dark corner, 'CONVFMT' variable: Strings And Numbers. (line 39) * 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: Getline Notes. (line 19) -* dark corner, 'FILENAME' variable <1>: Auto-set. (line 90) -* dark corner, 'FNR'/'NR' variables: Auto-set. (line 313) +* dark corner, 'FILENAME' variable <1>: Auto-set. (line 109) +* dark corner, 'FNR'/'NR' variables: Auto-set. (line 340) * dark corner, format-control characters: Control Letters. (line 18) * dark corner, format-control characters <1>: Control Letters. (line 93) @@ -32408,7 +32771,7 @@ Index * debugger, read commands from a file: Debugger Info. (line 97) * debugging 'awk' programs: Debugger. (line 6) * debugging 'gawk', bug reports: Bugs. (line 9) -* decimal point character, locale specific: Options. (line 269) +* decimal point character, locale specific: Options. (line 267) * decrement operators: Increment Ops. (line 35) * 'default' keyword: Switch Statement. (line 6) * Deifik, Scott: Acknowledgments. (line 60) @@ -32451,7 +32814,7 @@ Index * differences in 'awk' and 'gawk', command-line directories: Command-line directories. (line 6) * differences in 'awk' and 'gawk', 'ERRNO' variable: Auto-set. - (line 74) + (line 88) * differences in 'awk' and 'gawk', error messages: Special FD. (line 19) * differences in 'awk' and 'gawk', 'FIELDWIDTHS' variable: User-modified. @@ -32459,7 +32822,7 @@ Index * differences in 'awk' and 'gawk', 'FPAT' variable: User-modified. (line 43) * differences in 'awk' and 'gawk', 'FUNCTAB' variable: Auto-set. - (line 116) + (line 135) * differences in 'awk' and 'gawk', function arguments ('gawk'): Calling Built-in. (line 16) * differences in 'awk' and 'gawk', 'getline' command: Getline. @@ -32485,7 +32848,7 @@ Index * differences in 'awk' and 'gawk', 'print'/'printf' statements: Format Modifiers. (line 13) * differences in 'awk' and 'gawk', 'PROCINFO' array: Auto-set. - (line 130) + (line 149) * differences in 'awk' and 'gawk', read timeouts: Read Timeout. (line 6) * differences in 'awk' and 'gawk', record separators: awk split records. @@ -32494,9 +32857,11 @@ Index (line 43) * differences in 'awk' and 'gawk', regular expressions: Case-sensitivity. (line 26) +* differences in 'awk' and 'gawk', retrying input: Retrying Input. + (line 6) * differences in 'awk' and 'gawk', 'RS'/'RT' variables: gawk split records. (line 58) -* differences in 'awk' and 'gawk', 'RT' variable: Auto-set. (line 264) +* differences in 'awk' and 'gawk', 'RT' variable: Auto-set. (line 291) * differences in 'awk' and 'gawk', single-character fields: Single Character Fields. (line 6) * differences in 'awk' and 'gawk', 'split()' function: String Functions. @@ -32505,7 +32870,7 @@ Index * differences in 'awk' and 'gawk', strings, storing: gawk split records. (line 76) * differences in 'awk' and 'gawk', 'SYMTAB' variable: Auto-set. - (line 268) + (line 295) * differences in 'awk' and 'gawk', 'TEXTDOMAIN' variable: User-modified. (line 152) * differences in 'awk' and 'gawk', trunc-mod operation: Arithmetic Ops. @@ -32541,13 +32906,13 @@ Index * 'dump' debugger command: Miscellaneous Debugger Commands. (line 9) * 'dupword.awk' program: Dupword Program. (line 31) -* dynamic profiling: Profiling. (line 178) +* dynamic profiling: Profiling. (line 177) * 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 154) +* effective user ID of 'gawk' user: Auto-set. (line 162) * 'egrep' utility: Bracket Expressions. (line 26) * 'egrep' utility <1>: Egrep Program. (line 6) * 'egrep.awk' program: Egrep Program. (line 53) @@ -32602,7 +32967,7 @@ Index (line 11) * equals sign ('='), '==' operator <1>: Precedence. (line 64) * EREs (Extended Regular Expressions): Bracket Expressions. (line 26) -* 'ERRNO' variable: Auto-set. (line 74) +* 'ERRNO' variable: Auto-set. (line 88) * 'ERRNO' variable <1>: TCP/IP Networking. (line 54) * 'ERRNO' variable, with 'BEGINFILE' pattern: BEGINFILE/ENDFILE. (line 26) @@ -32610,7 +32975,7 @@ Index (line 140) * 'ERRNO' variable, with 'getline' command: Getline. (line 19) * error handling: Special FD. (line 19) -* error handling, 'ERRNO' variable and: Auto-set. (line 74) +* error handling, 'ERRNO' variable and: Auto-set. (line 88) * error output: Special FD. (line 6) * escape processing, 'gsub()'/'gensub()'/'sub()' functions: Gory Details. (line 6) @@ -32650,7 +33015,7 @@ Index (line 99) * 'exp': Numeric Functions. (line 17) * 'expand' utility: Very Simple. (line 72) -* Expat XML parser library: gawkextlib. (line 35) +* Expat XML parser library: gawkextlib. (line 37) * exponent: Numeric Functions. (line 17) * expressions: Expressions. (line 6) * expressions, as patterns: Expression Patterns. (line 6) @@ -32669,7 +33034,7 @@ Index (line 6) * extension API version: Extension Versioning. (line 6) -* extension API, version number: Auto-set. (line 231) +* extension API, version number: Auto-set. (line 254) * extension example: Extension Example. (line 6) * extension registration: Registration Functions. (line 6) @@ -32755,7 +33120,7 @@ Index * file names, in compatibility mode: Special Caveats. (line 9) * file names, standard streams in 'gawk': Special FD. (line 48) * 'FILENAME' variable: Reading Files. (line 6) -* 'FILENAME' variable <1>: Auto-set. (line 90) +* 'FILENAME' variable <1>: Auto-set. (line 109) * 'FILENAME' variable, 'getline', setting with: Getline Notes. (line 19) * filenames, assignments as: Ignoring Assigns. (line 6) @@ -32825,8 +33190,8 @@ Index * 'fnmatch()' extension function: Extension Sample Fnmatch. (line 12) * 'FNR' variable: Records. (line 6) -* 'FNR' variable <1>: Auto-set. (line 100) -* 'FNR' variable, changing: Auto-set. (line 313) +* 'FNR' variable <1>: Auto-set. (line 119) +* 'FNR' variable, changing: Auto-set. (line 340) * 'for' statement: For Statement. (line 6) * 'for' statement, looping over arrays: Scanning an Array. (line 20) * 'fork()' extension function: Extension Sample Fork. @@ -32864,7 +33229,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 266) +* 'FS' variable, as TAB character: Options. (line 264) * 'FS' variable, changing value of: Field Separators. (line 34) * 'FS' variable, running 'awk' programs and: Cut Program. (line 63) * 'FS' variable, setting from command line: Command Line Field Separator. @@ -32878,7 +33243,7 @@ Index * FSF (Free Software Foundation) <3>: Glossary. (line 405) * 'fts()' extension function: Extension Sample File Functions. (line 60) -* 'FUNCTAB' array: Auto-set. (line 116) +* 'FUNCTAB' array: Auto-set. (line 135) * function calls: Function Calls. (line 6) * function calls, indirect: Indirect Calls. (line 6) * function calls, indirect, '@'-notation for: Indirect Calls. (line 47) @@ -32927,8 +33292,8 @@ Index (line 47) * G-d: Acknowledgments. (line 93) * Garfinkle, Scott: Contributors. (line 35) -* 'gawk' program, dynamic profiling: Profiling. (line 178) -* 'gawk' version: Auto-set. (line 206) +* 'gawk' program, dynamic profiling: Profiling. (line 177) +* 'gawk' version: Auto-set. (line 229) * 'gawk', 'ARGIND' variable in: Other Arguments. (line 15) * 'gawk', 'awk' and: Preface. (line 21) * 'gawk', 'awk' and <1>: This Manual. (line 14) @@ -32949,10 +33314,10 @@ Index * 'gawk', 'ERRNO' variable in <1>: Close Files And Pipes. (line 140) * 'gawk', 'ERRNO' variable in <2>: BEGINFILE/ENDFILE. (line 26) -* 'gawk', 'ERRNO' variable in <3>: Auto-set. (line 74) +* 'gawk', 'ERRNO' variable in <3>: Auto-set. (line 88) * 'gawk', 'ERRNO' variable in <4>: TCP/IP Networking. (line 54) -* 'gawk', escape sequences: Escape Sequences. (line 117) -* 'gawk', extensions, disabling: Options. (line 254) +* 'gawk', escape sequences: Escape Sequences. (line 120) +* 'gawk', extensions, disabling: Options. (line 252) * 'gawk', features, adding: Adding Code. (line 6) * 'gawk', features, advanced: Advanced Features. (line 6) * 'gawk', field separators and: User-modified. (line 71) @@ -32964,7 +33329,7 @@ Index * 'gawk', 'FPAT' variable in: Splitting By Content. (line 25) * 'gawk', 'FPAT' variable in <1>: User-modified. (line 43) -* 'gawk', 'FUNCTAB' array in: Auto-set. (line 116) +* 'gawk', 'FUNCTAB' array in: Auto-set. (line 135) * 'gawk', function arguments and: Calling Built-in. (line 16) * 'gawk', hexadecimal numbers and: Nondecimal-numbers. (line 41) * 'gawk', 'IGNORECASE' variable in: Case-sensitivity. (line 26) @@ -32995,8 +33360,8 @@ Index * 'gawk', octal numbers and: Nondecimal-numbers. (line 41) * 'gawk', OS/2 version of: PC Using. (line 16) * 'gawk', predefined variables and: Built-in Variables. (line 14) -* 'gawk', 'PROCINFO' array in: Auto-set. (line 130) -* 'gawk', 'PROCINFO' array in <1>: Auto-set. (line 241) +* 'gawk', 'PROCINFO' array in: Auto-set. (line 149) +* 'gawk', 'PROCINFO' array in <1>: Auto-set. (line 264) * 'gawk', 'PROCINFO' array in <2>: Time Functions. (line 47) * 'gawk', 'PROCINFO' array in <3>: Two-way I/O. (line 99) * 'gawk', regexp constants and: Using Constant Regexps. @@ -33008,21 +33373,27 @@ Index * 'gawk', regular expressions, precedence: Regexp Operators. (line 161) * 'gawk', 'RT' variable in: awk split records. (line 124) * 'gawk', 'RT' variable in <1>: Multiple Line. (line 129) -* 'gawk', 'RT' variable in <2>: Auto-set. (line 264) +* 'gawk', 'RT' variable in <2>: Auto-set. (line 291) * 'gawk', See Also 'awk': Preface. (line 34) * 'gawk', source code, obtaining: Getting. (line 6) * 'gawk', splitting fields and: Constant Size. (line 86) * 'gawk', string-translation functions: I18N Functions. (line 6) -* 'gawk', 'SYMTAB' array in: Auto-set. (line 268) +* 'gawk', 'SYMTAB' array in: Auto-set. (line 295) * '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 299) +* 'gawk', versions of, information about, printing: Options. (line 297) * 'gawk', VMS version of: VMS Installation. (line 6) * 'gawk', word-boundary operator: GNU Regexp Operators. (line 66) * '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 396) * General Public License, See GPL: Manual History. (line 11) * generate time values: Time Functions. (line 25) @@ -33077,7 +33448,7 @@ Index * 'gettext()' function (C library): Explaining gettext. (line 63) * 'gettimeofday()' extension function: Extension Sample Time. (line 12) -* 'git' utility: gawkextlib. (line 29) +* 'git' utility: gawkextlib. (line 31) * 'git' utility <1>: Other Versions. (line 29) * 'git' utility <2>: Accessing The Source. (line 10) @@ -33105,7 +33476,7 @@ Index * Grigera, Juan: Contributors. (line 58) * group database, reading: Group Functions. (line 6) * group file: Group Functions. (line 6) -* group ID of 'gawk' user: Auto-set. (line 179) +* group ID of 'gawk' user: Auto-set. (line 202) * groups, information about: Group Functions. (line 6) * 'gsub': Using Constant Regexps. (line 43) @@ -33127,7 +33498,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 210) +* 'HUP' signal, for dynamic profiling: Profiling. (line 209) * hyphen ('-'), '-' operator: Precedence. (line 51) * hyphen ('-'), '-' operator <1>: Precedence. (line 57) * hyphen ('-'), '--' operator: Increment Ops. (line 48) @@ -33210,7 +33581,9 @@ Index * installing 'gawk': Installation. (line 6) * instruction tracing, in debugger: Debugger Info. (line 90) * 'int': Numeric Functions. (line 22) -* 'INT' signal (MS-Windows): Profiling. (line 213) +* 'INT' signal (MS-Windows): Profiling. (line 212) +* 'intdiv': Numeric Functions. (line 27) +* intdiv: Numeric Functions. (line 27) * integer array indices: Numeric Array Subscripts. (line 31) * integers, arbitrary precision: Arbitrary Precision Integers. @@ -33266,7 +33639,7 @@ Index * Kernighan, Brian <8>: Other Versions. (line 13) * Kernighan, Brian <9>: Basic Data Typing. (line 54) * Kernighan, Brian <10>: Glossary. (line 206) -* 'kill' command, dynamic profiling: Profiling. (line 187) +* 'kill' command, dynamic profiling: Profiling. (line 186) * Knights, jedi: Undocumented. (line 6) * Kwok, Conrad: Contributors. (line 35) * 'l' debugger command (alias for 'list'): Miscellaneous Debugger Commands. @@ -33338,7 +33711,7 @@ Index * lint checking, empty programs: Command Line. (line 16) * lint checking, issuing warnings: Options. (line 184) * lint checking, 'POSIXLY_CORRECT' environment variable: Options. - (line 338) + (line 336) * lint checking, undefined functions: Pass By Value/Reference. (line 85) * 'LINT' variable: User-modified. (line 87) @@ -33354,14 +33727,14 @@ Index * loading, extensions: Options. (line 172) * local variables, in a function: Variable Scope. (line 6) * locale categories: Explaining gettext. (line 81) -* locale decimal point character: Options. (line 269) +* locale decimal point character: Options. (line 267) * 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 27) +* 'log': Numeric Functions. (line 42) * log files, timestamps in: Time Functions. (line 6) -* logarithm: Numeric Functions. (line 27) +* logarithm: Numeric Functions. (line 42) * logical false/true: Truth Values. (line 6) * logical operators, See Boolean expressions: Boolean Ops. (line 6) * login information: Passwd Functions. (line 16) @@ -33398,12 +33771,12 @@ Index (line 9) * matching, leftmost longest: Multiple Line. (line 26) * matching, null strings: String Functions. (line 537) -* 'mawk' utility: Escape Sequences. (line 117) +* 'mawk' utility: Escape Sequences. (line 120) * 'mawk' utility <1>: Getline/Pipe. (line 62) * 'mawk' utility <2>: Concatenation. (line 36) * 'mawk' utility <3>: Nextfile Statement. (line 47) * 'mawk' utility <4>: Other Versions. (line 48) -* maximum precision supported by MPFR library: Auto-set. (line 220) +* maximum precision supported by MPFR library: Auto-set. (line 243) * McIlroy, Doug: Glossary. (line 257) * McPhee, Patrick: Contributors. (line 101) * message object files: Explaining gettext. (line 42) @@ -33415,8 +33788,8 @@ Index (line 48) * 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 required by MPFR library: Auto-set. (line 223) +* metacharacters, escape sequences for: Escape Sequences. (line 139) +* minimum precision required by MPFR library: Auto-set. (line 246) * 'mktime': Time Functions. (line 25) * modifiers, in format specifiers: Format Modifiers. (line 6) * monetary information, localization: Explaining gettext. (line 104) @@ -33436,7 +33809,7 @@ Index * networks, programming: TCP/IP Networking. (line 6) * networks, support for: Special Network. (line 6) * newlines: Statements/Lines. (line 6) -* newlines <1>: Options. (line 260) +* newlines <1>: Options. (line 258) * newlines <2>: Boolean Ops. (line 69) * newlines, as field separators: Default Field Splitting. (line 6) @@ -33468,7 +33841,7 @@ Index * 'nexti' debugger command: Debugger Execution Control. (line 49) * 'NF' variable: Fields. (line 33) -* 'NF' variable <1>: Auto-set. (line 105) +* 'NF' variable <1>: Auto-set. (line 124) * 'NF' variable, decrementing: Changing Fields. (line 107) * 'ni' debugger command (alias for 'nexti'): Debugger Execution Control. (line 49) @@ -33477,8 +33850,8 @@ Index (line 23) * not Boolean-logic operator: Boolean Ops. (line 6) * 'NR' variable: Records. (line 6) -* 'NR' variable <1>: Auto-set. (line 125) -* 'NR' variable, changing: Auto-set. (line 313) +* 'NR' variable <1>: Auto-set. (line 144) +* 'NR' variable, changing: Auto-set. (line 340) * null strings: awk split records. (line 114) * null strings <1>: Regexp Field Splitting. (line 43) @@ -33599,7 +33972,7 @@ Index * 'p' debugger command (alias for 'print'): Viewing And Changing Data. (line 35) * Papadopoulos, Panos: Contributors. (line 129) -* parent process ID of 'gawk' process: Auto-set. (line 188) +* parent process ID of 'gawk' process: Auto-set. (line 211) * parentheses '()', in a profile: Profiling. (line 146) * parentheses '()', regexp operator: Regexp Operators. (line 81) * password file: Passwd Functions. (line 16) @@ -33644,14 +34017,14 @@ Index * plus sign ('+'), '+=' operator <1>: Precedence. (line 94) * 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 144) * 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. @@ -33670,7 +34043,7 @@ Index * portability, operators: Increment Ops. (line 60) * portability, operators, not in POSIX 'awk': Precedence. (line 97) * portability, 'POSIXLY_CORRECT' environment variable: Options. - (line 358) + (line 356) * portability, 'substr()' function: String Functions. (line 513) * portable object files: Explaining gettext. (line 37) * portable object files <1>: Translator i18n. (line 6) @@ -33692,7 +34065,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 15) * POSIX 'awk', bracket expressions and: Bracket Expressions. (line 26) * POSIX 'awk', bracket expressions and, character classes: Bracket Expressions. @@ -33722,12 +34095,12 @@ 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 56) -* POSIX mode: Options. (line 254) -* POSIX mode <1>: Options. (line 338) +* POSIX mode: Options. (line 252) +* POSIX mode <1>: Options. (line 336) * 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 338) +* 'POSIXLY_CORRECT' environment variable: Options. (line 336) * 'PREC' variable: User-modified. (line 124) * precedence: Increment Ops. (line 60) * precedence <1>: Precedence. (line 6) @@ -33778,11 +34151,11 @@ 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 ID of 'gawk' process: Auto-set. (line 182) -* process ID of 'gawk' process: Auto-set. (line 185) +* process group ID of 'gawk' process: Auto-set. (line 205) +* process ID of 'gawk' process: Auto-set. (line 208) * processes, two-way communications with: Two-way I/O. (line 6) * processing data: Basic High Level. (line 6) -* 'PROCINFO' array: Auto-set. (line 130) +* 'PROCINFO' array: Auto-set. (line 149) * 'PROCINFO' array <1>: Time Functions. (line 47) * 'PROCINFO' array <2>: Passwd Functions. (line 6) * 'PROCINFO' array, and communications via ptys: Two-way I/O. (line 99) @@ -33791,12 +34164,12 @@ Index (line 15) * 'PROCINFO' array, testing the field splitting: Passwd Functions. (line 154) -* 'PROCINFO' array, uses: Auto-set. (line 241) +* 'PROCINFO' array, uses: Auto-set. (line 264) * 'PROCINFO', values of 'sorted_in': Controlling Scanning. (line 26) * profiling 'awk' programs: Profiling. (line 6) -* profiling 'awk' programs, dynamically: Profiling. (line 178) -* program identifiers: Auto-set. (line 148) +* profiling 'awk' programs, dynamically: Profiling. (line 177) +* program identifiers: Auto-set. (line 171) * program, definition of: Getting Started. (line 21) * programming conventions, '--non-decimal-data' option: Nondecimal Data. (line 35) @@ -33832,7 +34205,7 @@ Index * QuikTrim Awk: Other Versions. (line 139) * 'quit' debugger command: Miscellaneous Debugger Commands. (line 99) -* 'QUIT' signal (MS-Windows): Profiling. (line 213) +* 'QUIT' signal (MS-Windows): Profiling. (line 212) * 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) @@ -33841,12 +34214,12 @@ Index * Rakitzis, Byron: History Sorting. (line 25) * Ramey, Chet: Acknowledgments. (line 60) * Ramey, Chet <1>: General Data Types. (line 6) -* 'rand': Numeric Functions. (line 32) +* 'rand': Numeric Functions. (line 47) * random numbers, Cliff: Cliff Random Function. (line 6) * random numbers, 'rand()'/'srand()' functions: Numeric Functions. - (line 32) -* random numbers, seed of: Numeric Functions. (line 62) + (line 47) +* random numbers, seed of: Numeric Functions. (line 77) * range expressions (regexps): Bracket Expressions. (line 6) * range patterns: Ranges. (line 6) * range patterns, line continuation and: Ranges. (line 64) @@ -33916,7 +34289,7 @@ Index (line 60) * regular expressions, 'gawk', command-line options: GNU Regexp Operators. (line 73) -* regular expressions, interval expressions and: Options. (line 278) +* regular expressions, interval expressions and: Options. (line 276) * regular expressions, leftmost longest match: Leftmost Longest. (line 6) * regular expressions, operators: Regexp Usage. (line 19) @@ -33933,6 +34306,7 @@ Index * relational operators, See comparison operators: Typing and Comparison. (line 9) * replace in string: String Functions. (line 409) +* retrying input: Retrying Input. (line 6) * 'return' debugger command: Debugger Execution Control. (line 54) * 'return' statement, user-defined functions: Return Statement. @@ -33959,7 +34333,7 @@ Index * right shift: Bitwise Functions. (line 54) * right shift, bitwise: Bitwise Functions. (line 32) * Ritchie, Dennis: Basic Data Typing. (line 54) -* 'RLENGTH' variable: Auto-set. (line 251) +* 'RLENGTH' variable: Auto-set. (line 278) * 'RLENGTH' variable, 'match()' function and: String Functions. (line 227) * Robbins, Arnold: Command Line Field Separator. @@ -33986,12 +34360,12 @@ Index * 'RS' variable <1>: User-modified. (line 133) * 'RS' variable, multiline records and: Multiple Line. (line 17) * 'rshift': Bitwise Functions. (line 54) -* 'RSTART' variable: Auto-set. (line 257) +* 'RSTART' variable: Auto-set. (line 284) * 'RSTART' variable, 'match()' function and: String Functions. (line 227) * 'RT' variable: awk split records. (line 124) * 'RT' variable <1>: Multiple Line. (line 129) -* 'RT' variable <2>: Auto-set. (line 264) +* 'RT' variable <2>: Auto-set. (line 291) * Rubin, Paul: History. (line 30) * Rubin, Paul <1>: Contributors. (line 16) * rule, definition of: Getting Started. (line 21) @@ -34002,14 +34376,14 @@ Index (line 68) * sample debugging session: Sample Debugging Session. (line 6) -* sandbox mode: Options. (line 285) +* sandbox mode: Options. (line 283) * save debugger options: Debugger Info. (line 85) * 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: Acknowledgments. (line 60) -* Schorr, Andrew <1>: Auto-set. (line 296) +* Schorr, Andrew <1>: Auto-set. (line 323) * Schorr, Andrew <2>: Contributors. (line 134) * Schreiber, Bert: Acknowledgments. (line 38) * Schreiber, Rita: Acknowledgments. (line 38) @@ -34028,7 +34402,7 @@ Index * 'sed' utility: Full Line Fields. (line 22) * 'sed' utility <1>: Simple Sed. (line 6) * 'sed' utility <2>: Glossary. (line 16) -* seeding random number generator: Numeric Functions. (line 62) +* seeding random number generator: Numeric Functions. (line 77) * semicolon (';'), 'AWKPATH' variable and: PC Using. (line 10) * semicolon (';'), separating statements in actions: Statements/Lines. (line 90) @@ -34093,14 +34467,14 @@ Index * sidebar, A Constant's Base Does Not Affect Its Value: Nondecimal-numbers. (line 63) * 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 311) +* sidebar, Changing 'NR' and 'FNR': Auto-set. (line 338) * sidebar, Controlling Output Buffering with 'system()': I/O Functions. (line 137) * sidebar, Escape Sequences for Metacharacters: Escape Sequences. - (line 134) + (line 137) * sidebar, 'FS' and 'IGNORECASE': Field Splitting Summary. (line 37) * sidebar, Interactive Versus Noninteractive Buffering: I/O Functions. @@ -34122,19 +34496,19 @@ Index (line 130) * sidebar, Using '\n' in Bracket Expressions of Dynamic Regexps: Computed Regexps. (line 58) -* '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) +* 'SIGHUP' signal, for dynamic profiling: Profiling. (line 209) +* 'SIGINT' signal (MS-Windows): Profiling. (line 212) +* signals, 'HUP'/'SIGHUP', for profiling: Profiling. (line 209) +* signals, 'INT'/'SIGINT' (MS-Windows): Profiling. (line 212) +* signals, 'QUIT'/'SIGQUIT' (MS-Windows): Profiling. (line 212) +* signals, 'USR1'/'SIGUSR1', for profiling: Profiling. (line 186) * signature program: Signature Program. (line 6) -* 'SIGQUIT' signal (MS-Windows): Profiling. (line 213) -* 'SIGUSR1' signal, for dynamic profiling: Profiling. (line 187) +* 'SIGQUIT' signal (MS-Windows): Profiling. (line 212) +* 'SIGUSR1' signal, for dynamic profiling: Profiling. (line 186) * 'silent' debugger command: Debugger Execution Control. (line 10) -* 'sin': Numeric Functions. (line 73) -* sine: Numeric Functions. (line 73) +* 'sin': Numeric Functions. (line 88) +* sine: Numeric Functions. (line 88) * single quote ('''): One-shot. (line 15) * single quote (''') in 'gawk' command lines: Long. (line 35) * single quote ('''), in shell commands: Quoting. (line 48) @@ -34184,10 +34558,10 @@ Index * 'sprintf()' function, 'OFMT' variable and: User-modified. (line 113) * 'sprintf()' function, 'print'/'printf' statements and: Round Function. (line 6) -* 'sqrt': Numeric Functions. (line 76) +* 'sqrt': Numeric Functions. (line 91) * square brackets ('[]'), regexp operator: Regexp Operators. (line 56) -* square root: Numeric Functions. (line 76) -* 'srand': Numeric Functions. (line 80) +* square root: Numeric Functions. (line 91) +* 'srand': Numeric Functions. (line 95) * stack frame: Debugging Terms. (line 10) * Stallman, Richard: Manual History. (line 6) * Stallman, Richard <1>: Acknowledgments. (line 18) @@ -34259,9 +34633,9 @@ Index * 'substr': String Functions. (line 482) * substring: String Functions. (line 482) * Sumner, Andrew: Other Versions. (line 68) -* supplementary groups of 'gawk' process: Auto-set. (line 236) +* supplementary groups of 'gawk' process: Auto-set. (line 259) * 'switch' statement: Switch Statement. (line 6) -* 'SYMTAB' array: Auto-set. (line 268) +* 'SYMTAB' array: Auto-set. (line 295) * syntactic ambiguity: '/=' operator vs. '/=.../' regexp constant: Assignment Ops. (line 149) * 'system': I/O Functions. (line 107) @@ -34334,7 +34708,7 @@ Index * troubleshooting, 'awk' uses 'FS' not 'IFS': Field Separators. (line 29) * 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) @@ -34391,7 +34765,7 @@ Index * 'uniq.awk' program: Uniq Program. (line 65) * Unix: Glossary. (line 748) * Unix 'awk', backslashes in escape sequences: Escape Sequences. - (line 117) + (line 120) * Unix 'awk', 'close()' function and: Close Files And Pipes. (line 132) * Unix 'awk', password files, field separators and: Command Line Field Separator. @@ -34411,7 +34785,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 187) +* 'USR1' signal, for dynamic profiling: Profiling. (line 186) * values, numeric: Basic Data Typing. (line 13) * values, string: Basic Data Typing. (line 13) * variable assignments and input files: Other Arguments. (line 26) @@ -34445,10 +34819,10 @@ Index * variables, uninitialized, as array subscripts: Uninitialized Subscripts. (line 6) * variables, user-defined: Variables. (line 6) -* version of 'gawk': Auto-set. (line 206) -* version of 'gawk' extension API: Auto-set. (line 231) -* version of GNU MP library: Auto-set. (line 217) -* version of GNU MPFR library: Auto-set. (line 213) +* version of 'gawk': Auto-set. (line 229) +* version of 'gawk' extension API: Auto-set. (line 254) +* version of GNU MP library: Auto-set. (line 240) +* version of GNU MPFR library: Auto-set. (line 236) * vertical bar ('|'): Regexp Operators. (line 70) * vertical bar ('|'), '|' operator (I/O): Getline/Pipe. (line 10) * vertical bar ('|'), '|' operator (I/O) <1>: Precedence. (line 64) @@ -34485,7 +34859,7 @@ Index * whitespace, as field separators: Default Field Splitting. (line 6) * whitespace, functions, calling: Calling Built-in. (line 10) -* whitespace, newlines as: Options. (line 260) +* whitespace, newlines as: Options. (line 258) * Williams, Kent: Contributors. (line 35) * Woehlke, Matthew: Contributors. (line 80) * Woods, John: Contributors. (line 28) @@ -34515,559 +34889,563 @@ Index Tag Table: Node: Top1200 -Node: Foreword342140 -Node: Foreword446582 -Node: Preface48114 -Ref: Preface-Footnote-150986 -Ref: Preface-Footnote-251093 -Ref: Preface-Footnote-351327 -Node: History51469 -Node: Names53822 -Ref: Names-Footnote-154916 -Node: This Manual55063 -Ref: This Manual-Footnote-161545 -Node: Conventions61645 -Node: Manual History64000 -Ref: Manual History-Footnote-166996 -Ref: Manual History-Footnote-267037 -Node: How To Contribute67111 -Node: Acknowledgments68240 -Node: Getting Started73108 -Node: Running gawk75547 -Node: One-shot76737 -Node: Read Terminal78000 -Node: Long80032 -Node: Executable Scripts81545 -Ref: Executable Scripts-Footnote-184340 -Node: Comments84443 -Node: Quoting86927 -Node: DOS Quoting92445 -Node: Sample Data Files93120 -Node: Very Simple95715 -Node: Two Rules100617 -Node: More Complex102503 -Node: Statements/Lines105366 -Ref: Statements/Lines-Footnote-1109825 -Node: Other Features110090 -Node: When111027 -Ref: When-Footnote-1112781 -Node: Intro Summary112846 -Node: Invoking Gawk113730 -Node: Command Line115244 -Node: Options116042 -Ref: Options-Footnote-1131949 -Ref: Options-Footnote-2132179 -Node: Other Arguments132204 -Node: Naming Standard Input135151 -Node: Environment Variables136244 -Node: AWKPATH Variable136802 -Ref: AWKPATH Variable-Footnote-1140103 -Ref: AWKPATH Variable-Footnote-2140148 -Node: AWKLIBPATH Variable140409 -Node: Other Environment Variables141553 -Node: Exit Status145318 -Node: Include Files145995 -Node: Loading Shared Libraries149590 -Node: Obsolete151018 -Node: Undocumented151710 -Node: Invoking Summary152007 -Node: Regexp153667 -Node: Regexp Usage155121 -Node: Escape Sequences157158 -Node: Regexp Operators163173 -Ref: Regexp Operators-Footnote-1170590 -Ref: Regexp Operators-Footnote-2170737 -Node: Bracket Expressions170835 -Ref: table-char-classes172858 -Node: Leftmost Longest175804 -Node: Computed Regexps177107 -Node: GNU Regexp Operators180534 -Node: Case-sensitivity184213 -Ref: Case-sensitivity-Footnote-1187100 -Ref: Case-sensitivity-Footnote-2187335 -Node: Regexp Summary187443 -Node: Reading Files188909 -Node: Records191003 -Node: awk split records191736 -Node: gawk split records196668 -Ref: gawk split records-Footnote-1201212 -Node: Fields201249 -Ref: Fields-Footnote-1204029 -Node: Nonconstant Fields204115 -Ref: Nonconstant Fields-Footnote-1206351 -Node: Changing Fields206555 -Node: Field Separators212485 -Node: Default Field Splitting215183 -Node: Regexp Field Splitting216301 -Node: Single Character Fields219654 -Node: Command Line Field Separator220714 -Node: Full Line Fields223932 -Ref: Full Line Fields-Footnote-1225454 -Ref: Full Line Fields-Footnote-2225500 -Node: Field Splitting Summary225601 -Node: Constant Size227675 -Node: Splitting By Content232254 -Ref: Splitting By Content-Footnote-1236225 -Node: Multiple Line236388 -Ref: Multiple Line-Footnote-1242271 -Node: Getline242450 -Node: Plain Getline244654 -Node: Getline/Variable247293 -Node: Getline/File248442 -Node: Getline/Variable/File249828 -Ref: Getline/Variable/File-Footnote-1251432 -Node: Getline/Pipe251520 -Node: Getline/Variable/Pipe254225 -Node: Getline/Coprocess255358 -Node: Getline/Variable/Coprocess256623 -Node: Getline Notes257363 -Node: Getline Summary260158 -Ref: table-getline-variants260580 -Node: Read Timeout261328 -Ref: Read Timeout-Footnote-1265169 -Node: Command-line directories265227 -Node: Input Summary266132 -Node: Input Exercises269304 -Node: Printing270032 -Node: Print271809 -Node: Print Examples273266 -Node: Output Separators276046 -Node: OFMT278063 -Node: Printf279419 -Node: Basic Printf280204 -Node: Control Letters281778 -Node: Format Modifiers285766 -Node: Printf Examples291781 -Node: Redirection294267 -Node: Special FD301110 -Ref: Special FD-Footnote-1304278 -Node: Special Files304352 -Node: Other Inherited Files304969 -Node: Special Network305970 -Node: Special Caveats306830 -Node: Close Files And Pipes307779 -Ref: Close Files And Pipes-Footnote-1314972 -Ref: Close Files And Pipes-Footnote-2315120 -Node: Output Summary315271 -Node: Output Exercises316269 -Node: Expressions316948 -Node: Values318136 -Node: Constants318814 -Node: Scalar Constants319505 -Ref: Scalar Constants-Footnote-1320369 -Node: Nondecimal-numbers320619 -Node: Regexp Constants323633 -Node: Using Constant Regexps324159 -Node: Variables327322 -Node: Using Variables327979 -Node: Assignment Options329890 -Node: Conversion331764 -Node: Strings And Numbers332288 -Ref: Strings And Numbers-Footnote-1335352 -Node: Locale influences conversions335461 -Ref: table-locale-affects338219 -Node: All Operators338837 -Node: Arithmetic Ops339466 -Node: Concatenation341972 -Ref: Concatenation-Footnote-1344819 -Node: Assignment Ops344926 -Ref: table-assign-ops349918 -Node: Increment Ops351231 -Node: Truth Values and Conditions354691 -Node: Truth Values355765 -Node: Typing and Comparison356813 -Node: Variable Typing357633 -Node: Comparison Operators361257 -Ref: table-relational-ops361676 -Node: POSIX String Comparison365171 -Ref: POSIX String Comparison-Footnote-1366245 -Node: Boolean Ops366384 -Ref: Boolean Ops-Footnote-1370866 -Node: Conditional Exp370958 -Node: Function Calls372694 -Node: Precedence376574 -Node: Locales380233 -Node: Expressions Summary381865 -Node: Patterns and Actions384438 -Node: Pattern Overview385558 -Node: Regexp Patterns387235 -Node: Expression Patterns387777 -Node: Ranges391558 -Node: BEGIN/END394666 -Node: Using BEGIN/END395427 -Ref: Using BEGIN/END-Footnote-1398164 -Node: I/O And BEGIN/END398270 -Node: BEGINFILE/ENDFILE400586 -Node: Empty403493 -Node: Using Shell Variables403810 -Node: Action Overview406084 -Node: Statements408409 -Node: If Statement410257 -Node: While Statement411752 -Node: Do Statement413780 -Node: For Statement414928 -Node: Switch Statement418087 -Node: Break Statement420473 -Node: Continue Statement422565 -Node: Next Statement424392 -Node: Nextfile Statement426775 -Node: Exit Statement429427 -Node: Built-in Variables431832 -Node: User-modified432965 -Ref: User-modified-Footnote-1440592 -Node: Auto-set440654 -Ref: Auto-set-Footnote-1453722 -Ref: Auto-set-Footnote-2453928 -Node: ARGC and ARGV453984 -Node: Pattern Action Summary458203 -Node: Arrays460633 -Node: Array Basics461962 -Node: Array Intro462806 -Ref: figure-array-elements464781 -Ref: Array Intro-Footnote-1467485 -Node: Reference to Elements467613 -Node: Assigning Elements470077 -Node: Array Example470568 -Node: Scanning an Array472327 -Node: Controlling Scanning475351 -Ref: Controlling Scanning-Footnote-1480750 -Node: Numeric Array Subscripts481066 -Node: Uninitialized Subscripts483250 -Node: Delete484869 -Ref: Delete-Footnote-1487621 -Node: Multidimensional487678 -Node: Multiscanning490773 -Node: Arrays of Arrays492364 -Node: Arrays Summary497132 -Node: Functions499225 -Node: Built-in500263 -Node: Calling Built-in501341 -Node: Numeric Functions503337 -Ref: Numeric Functions-Footnote-1507365 -Ref: Numeric Functions-Footnote-2507722 -Ref: Numeric Functions-Footnote-3507770 -Node: String Functions508042 -Ref: String Functions-Footnote-1531550 -Ref: String Functions-Footnote-2531679 -Ref: String Functions-Footnote-3531927 -Node: Gory Details532014 -Ref: table-sub-escapes533805 -Ref: table-sub-proposed535324 -Ref: table-posix-sub536687 -Ref: table-gensub-escapes538228 -Ref: Gory Details-Footnote-1539051 -Node: I/O Functions539202 -Ref: I/O Functions-Footnote-1546423 -Node: Time Functions546571 -Ref: Time Functions-Footnote-1557076 -Ref: Time Functions-Footnote-2557144 -Ref: Time Functions-Footnote-3557302 -Ref: Time Functions-Footnote-4557413 -Ref: Time Functions-Footnote-5557525 -Ref: Time Functions-Footnote-6557752 -Node: Bitwise Functions558018 -Ref: table-bitwise-ops558612 -Ref: Bitwise Functions-Footnote-1562950 -Node: Type Functions563123 -Node: I18N Functions564279 -Node: User-defined565930 -Node: Definition Syntax566735 -Ref: Definition Syntax-Footnote-1572422 -Node: Function Example572493 -Ref: Function Example-Footnote-1575415 -Node: Function Caveats575437 -Node: Calling A Function575955 -Node: Variable Scope576913 -Node: Pass By Value/Reference579907 -Node: Return Statement583406 -Node: Dynamic Typing586385 -Node: Indirect Calls587315 -Ref: Indirect Calls-Footnote-1597566 -Node: Functions Summary597694 -Node: Library Functions600399 -Ref: Library Functions-Footnote-1604008 -Ref: Library Functions-Footnote-2604151 -Node: Library Names604322 -Ref: Library Names-Footnote-1607783 -Ref: Library Names-Footnote-2608006 -Node: General Functions608092 -Node: Strtonum Function609195 -Node: Assert Function612217 -Node: Round Function615543 -Node: Cliff Random Function617084 -Node: Ordinal Functions618100 -Ref: Ordinal Functions-Footnote-1621163 -Ref: Ordinal Functions-Footnote-2621415 -Node: Join Function621625 -Ref: Join Function-Footnote-1623395 -Node: Getlocaltime Function623595 -Node: Readfile Function627339 -Node: Shell Quoting629313 -Node: Data File Management630714 -Node: Filetrans Function631346 -Node: Rewind Function635443 -Node: File Checking636829 -Ref: File Checking-Footnote-1638163 -Node: Empty Files638364 -Node: Ignoring Assigns640343 -Node: Getopt Function641893 -Ref: Getopt Function-Footnote-1653363 -Node: Passwd Functions653563 -Ref: Passwd Functions-Footnote-1662404 -Node: Group Functions662492 -Ref: Group Functions-Footnote-1670391 -Node: Walking Arrays670598 -Node: Library Functions Summary673608 -Node: Library Exercises675014 -Node: Sample Programs676293 -Node: Running Examples677063 -Node: Clones677791 -Node: Cut Program679015 -Node: Egrep Program688736 -Ref: Egrep Program-Footnote-1696248 -Node: Id Program696358 -Node: Split Program700038 -Ref: Split Program-Footnote-1703497 -Node: Tee Program703626 -Node: Uniq Program706416 -Node: Wc Program713842 -Ref: Wc Program-Footnote-1718097 -Node: Miscellaneous Programs718191 -Node: Dupword Program719404 -Node: Alarm Program721434 -Node: Translate Program726289 -Ref: Translate Program-Footnote-1730854 -Node: Labels Program731124 -Ref: Labels Program-Footnote-1734475 -Node: Word Sorting734559 -Node: History Sorting738631 -Node: Extract Program740466 -Node: Simple Sed747997 -Node: Igawk Program751071 -Ref: Igawk Program-Footnote-1765402 -Ref: Igawk Program-Footnote-2765604 -Ref: Igawk Program-Footnote-3765726 -Node: Anagram Program765841 -Node: Signature Program768903 -Node: Programs Summary770150 -Node: Programs Exercises771365 -Ref: Programs Exercises-Footnote-1775494 -Node: Advanced Features775585 -Node: Nondecimal Data777575 -Node: Array Sorting779166 -Node: Controlling Array Traversal779866 -Ref: Controlling Array Traversal-Footnote-1788235 -Node: Array Sorting Functions788353 -Ref: Array Sorting Functions-Footnote-1792240 -Node: Two-way I/O792436 -Ref: Two-way I/O-Footnote-1797387 -Ref: Two-way I/O-Footnote-2797574 -Node: TCP/IP Networking797656 -Node: Profiling800563 -Node: Advanced Features Summary808102 -Node: Internationalization810038 -Node: I18N and L10N811518 -Node: Explaining gettext812205 -Ref: Explaining gettext-Footnote-1817228 -Ref: Explaining gettext-Footnote-2817413 -Node: Programmer i18n817578 -Ref: Programmer i18n-Footnote-1822434 -Node: Translator i18n822483 -Node: String Extraction823277 -Ref: String Extraction-Footnote-1824410 -Node: Printf Ordering824496 -Ref: Printf Ordering-Footnote-1827282 -Node: I18N Portability827346 -Ref: I18N Portability-Footnote-1829802 -Node: I18N Example829865 -Ref: I18N Example-Footnote-1832671 -Node: Gawk I18N832744 -Node: I18N Summary833389 -Node: Debugger834730 -Node: Debugging835752 -Node: Debugging Concepts836193 -Node: Debugging Terms838002 -Node: Awk Debugging840577 -Node: Sample Debugging Session841483 -Node: Debugger Invocation842017 -Node: Finding The Bug843403 -Node: List of Debugger Commands849881 -Node: Breakpoint Control851214 -Node: Debugger Execution Control854908 -Node: Viewing And Changing Data858270 -Node: Execution Stack861644 -Node: Debugger Info863281 -Node: Miscellaneous Debugger Commands867352 -Node: Readline Support872361 -Node: Limitations873257 -Node: Debugging Summary875366 -Node: Arbitrary Precision Arithmetic876539 -Node: Computer Arithmetic877955 -Ref: table-numeric-ranges881546 -Ref: Computer Arithmetic-Footnote-1882268 -Node: Math Definitions882325 -Ref: table-ieee-formats885639 -Ref: Math Definitions-Footnote-1886242 -Node: MPFR features886347 -Node: FP Math Caution888020 -Ref: FP Math Caution-Footnote-1889092 -Node: Inexactness of computations889461 -Node: Inexact representation890421 -Node: Comparing FP Values891781 -Node: Errors accumulate892863 -Node: Getting Accuracy894296 -Node: Try To Round897006 -Node: Setting precision897905 -Ref: table-predefined-precision-strings898602 -Node: Setting the rounding mode900432 -Ref: table-gawk-rounding-modes900806 -Ref: Setting the rounding mode-Footnote-1904214 -Node: Arbitrary Precision Integers904393 -Ref: Arbitrary Precision Integers-Footnote-1907377 -Node: POSIX Floating Point Problems907526 -Ref: POSIX Floating Point Problems-Footnote-1911408 -Node: Floating point summary911446 -Node: Dynamic Extensions913636 -Node: Extension Intro915189 -Node: Plugin License916455 -Node: Extension Mechanism Outline917252 -Ref: figure-load-extension917691 -Ref: figure-register-new-function919256 -Ref: figure-call-new-function920348 -Node: Extension API Description922411 -Node: Extension API Functions Introduction923861 -Node: General Data Types928673 -Ref: General Data Types-Footnote-1934628 -Node: Memory Allocation Functions934927 -Ref: Memory Allocation Functions-Footnote-1937772 -Node: Constructor Functions937871 -Node: Registration Functions939616 -Node: Extension Functions940301 -Node: Exit Callback Functions942600 -Node: Extension Version String943850 -Node: Input Parsers944513 -Node: Output Wrappers954398 -Node: Two-way processors958910 -Node: Printing Messages961174 -Ref: Printing Messages-Footnote-1962250 -Node: Updating 'ERRNO'962403 -Node: Requesting Values963144 -Ref: table-value-types-returned963883 -Node: Accessing Parameters964766 -Node: Symbol Table Access966002 -Node: Symbol table by name966514 -Node: Symbol table by cookie968535 -Ref: Symbol table by cookie-Footnote-1972684 -Node: Cached values972748 -Ref: Cached values-Footnote-1976249 -Node: Array Manipulation976340 -Ref: Array Manipulation-Footnote-1977439 -Node: Array Data Types977476 -Ref: Array Data Types-Footnote-1980134 -Node: Array Functions980226 -Node: Flattening Arrays984085 -Node: Creating Arrays990993 -Node: Extension API Variables995765 -Node: Extension Versioning996401 -Node: Extension API Informational Variables998292 -Node: Extension API Boilerplate999356 -Node: Finding Extensions1003170 -Node: Extension Example1003730 -Node: Internal File Description1004528 -Node: Internal File Ops1008608 -Ref: Internal File Ops-Footnote-11020370 -Node: Using Internal File Ops1020510 -Ref: Using Internal File Ops-Footnote-11022893 -Node: Extension Samples1023168 -Node: Extension Sample File Functions1024697 -Node: Extension Sample Fnmatch1032346 -Node: Extension Sample Fork1033833 -Node: Extension Sample Inplace1035051 -Node: Extension Sample Ord1037137 -Node: Extension Sample Readdir1037973 -Ref: table-readdir-file-types1038862 -Node: Extension Sample Revout1039667 -Node: Extension Sample Rev2way1040256 -Node: Extension Sample Read write array1040996 -Node: Extension Sample Readfile1042938 -Node: Extension Sample Time1044033 -Node: Extension Sample API Tests1045381 -Node: gawkextlib1045873 -Node: Extension summary1048297 -Node: Extension Exercises1051989 -Node: Language History1053486 -Node: V7/SVR3.11055142 -Node: SVR41057295 -Node: POSIX1058729 -Node: BTL1060109 -Node: POSIX/GNU1060839 -Node: Feature History1066360 -Node: Common Extensions1079690 -Node: Ranges and Locales1080973 -Ref: Ranges and Locales-Footnote-11085589 -Ref: Ranges and Locales-Footnote-21085616 -Ref: Ranges and Locales-Footnote-31085851 -Node: Contributors1086072 -Node: History summary1091641 -Node: Installation1093021 -Node: Gawk Distribution1093966 -Node: Getting1094450 -Node: Extracting1095273 -Node: Distribution contents1096911 -Node: Unix Installation1102664 -Node: Quick Installation1103280 -Node: Additional Configuration Options1105707 -Node: Configuration Philosophy1107511 -Node: Non-Unix Installation1109881 -Node: PC Installation1110339 -Node: PC Binary Installation1111659 -Node: PC Compiling1113511 -Ref: PC Compiling-Footnote-11116535 -Node: PC Testing1116644 -Node: PC Using1117824 -Node: Cygwin1121938 -Node: MSYS1122708 -Node: VMS Installation1123209 -Node: VMS Compilation1124000 -Ref: VMS Compilation-Footnote-11125230 -Node: VMS Dynamic Extensions1125288 -Node: VMS Installation Details1126973 -Node: VMS Running1129226 -Node: VMS GNV1132067 -Node: VMS Old Gawk1132802 -Node: Bugs1133273 -Node: Other Versions1137387 -Node: Installation summary1143861 -Node: Notes1144919 -Node: Compatibility Mode1145784 -Node: Additions1146566 -Node: Accessing The Source1147491 -Node: Adding Code1148927 -Node: New Ports1155082 -Node: Derived Files1159570 -Ref: Derived Files-Footnote-11165055 -Ref: Derived Files-Footnote-21165090 -Ref: Derived Files-Footnote-31165688 -Node: Future Extensions1165802 -Node: Implementation Limitations1166460 -Node: Extension Design1167643 -Node: Old Extension Problems1168797 -Ref: Old Extension Problems-Footnote-11170315 -Node: Extension New Mechanism Goals1170372 -Ref: Extension New Mechanism Goals-Footnote-11173736 -Node: Extension Other Design Decisions1173925 -Node: Extension Future Growth1176038 -Node: Old Extension Mechanism1176874 -Node: Notes summary1178637 -Node: Basic Concepts1179819 -Node: Basic High Level1180500 -Ref: figure-general-flow1180782 -Ref: figure-process-flow1181467 -Ref: Basic High Level-Footnote-11184768 -Node: Basic Data Typing1184953 -Node: Glossary1188281 -Node: Copying1220227 -Node: GNU Free Documentation License1257766 -Node: Index1282884 +Node: Foreword342435 +Node: Foreword446877 +Node: Preface48409 +Ref: Preface-Footnote-151281 +Ref: Preface-Footnote-251388 +Ref: Preface-Footnote-351622 +Node: History51764 +Node: Names54117 +Ref: Names-Footnote-155211 +Node: This Manual55358 +Ref: This Manual-Footnote-161840 +Node: Conventions61940 +Node: Manual History64295 +Ref: Manual History-Footnote-167291 +Ref: Manual History-Footnote-267332 +Node: How To Contribute67406 +Node: Acknowledgments68535 +Node: Getting Started73403 +Node: Running gawk75842 +Node: One-shot77032 +Node: Read Terminal78295 +Node: Long80327 +Node: Executable Scripts81840 +Ref: Executable Scripts-Footnote-184635 +Node: Comments84738 +Node: Quoting87222 +Node: DOS Quoting92740 +Node: Sample Data Files93415 +Node: Very Simple96010 +Node: Two Rules100912 +Node: More Complex102798 +Node: Statements/Lines105661 +Ref: Statements/Lines-Footnote-1110120 +Node: Other Features110385 +Node: When111322 +Ref: When-Footnote-1113076 +Node: Intro Summary113141 +Node: Invoking Gawk114025 +Node: Command Line115539 +Node: Options116337 +Ref: Options-Footnote-1132117 +Ref: Options-Footnote-2132347 +Node: Other Arguments132372 +Node: Naming Standard Input135319 +Node: Environment Variables136412 +Node: AWKPATH Variable136970 +Ref: AWKPATH Variable-Footnote-1140381 +Ref: AWKPATH Variable-Footnote-2140426 +Node: AWKLIBPATH Variable140687 +Node: Other Environment Variables141944 +Node: Exit Status145582 +Node: Include Files146259 +Node: Loading Shared Libraries149854 +Node: Obsolete151282 +Node: Undocumented151974 +Node: Invoking Summary152271 +Node: Regexp153931 +Node: Regexp Usage155385 +Node: Escape Sequences157422 +Node: Regexp Operators163655 +Ref: Regexp Operators-Footnote-1171072 +Ref: Regexp Operators-Footnote-2171219 +Node: Bracket Expressions171317 +Ref: table-char-classes173340 +Node: Leftmost Longest176286 +Node: Computed Regexps177589 +Node: GNU Regexp Operators181016 +Node: Case-sensitivity184695 +Ref: Case-sensitivity-Footnote-1187582 +Ref: Case-sensitivity-Footnote-2187817 +Node: Regexp Summary187925 +Node: Reading Files189391 +Node: Records191554 +Node: awk split records192287 +Node: gawk split records197219 +Ref: gawk split records-Footnote-1201763 +Node: Fields201800 +Ref: Fields-Footnote-1204580 +Node: Nonconstant Fields204666 +Ref: Nonconstant Fields-Footnote-1206902 +Node: Changing Fields207106 +Node: Field Separators213036 +Node: Default Field Splitting215734 +Node: Regexp Field Splitting216852 +Node: Single Character Fields220205 +Node: Command Line Field Separator221265 +Node: Full Line Fields224483 +Ref: Full Line Fields-Footnote-1226005 +Ref: Full Line Fields-Footnote-2226051 +Node: Field Splitting Summary226152 +Node: Constant Size228226 +Node: Splitting By Content232805 +Ref: Splitting By Content-Footnote-1236776 +Node: Multiple Line236939 +Ref: Multiple Line-Footnote-1242822 +Node: Getline243001 +Node: Plain Getline245468 +Node: Getline/Variable248107 +Node: Getline/File249256 +Node: Getline/Variable/File250642 +Ref: Getline/Variable/File-Footnote-1252246 +Node: Getline/Pipe252334 +Node: Getline/Variable/Pipe255039 +Node: Getline/Coprocess256172 +Node: Getline/Variable/Coprocess257437 +Node: Getline Notes258177 +Node: Getline Summary260972 +Ref: table-getline-variants261394 +Node: Read Timeout262142 +Ref: Read Timeout-Footnote-1266049 +Node: Retrying Input266107 +Node: Command-line directories267306 +Node: Input Summary268213 +Node: Input Exercises271385 +Node: Printing272113 +Node: Print273948 +Node: Print Examples275405 +Node: Output Separators278185 +Node: OFMT280202 +Node: Printf281558 +Node: Basic Printf282343 +Node: Control Letters283917 +Node: Format Modifiers287905 +Node: Printf Examples293920 +Node: Redirection296406 +Node: Special FD303249 +Ref: Special FD-Footnote-1306417 +Node: Special Files306491 +Node: Other Inherited Files307108 +Node: Special Network308109 +Node: Special Caveats308969 +Node: Close Files And Pipes309918 +Ref: Close Files And Pipes-Footnote-1317105 +Ref: Close Files And Pipes-Footnote-2317253 +Node: Nonfatal317404 +Node: Output Summary319729 +Node: Output Exercises320951 +Node: Expressions321630 +Node: Values322818 +Node: Constants323496 +Node: Scalar Constants324187 +Ref: Scalar Constants-Footnote-1325051 +Node: Nondecimal-numbers325301 +Node: Regexp Constants328315 +Node: Using Constant Regexps328841 +Node: Variables332004 +Node: Using Variables332661 +Node: Assignment Options334572 +Node: Conversion336446 +Node: Strings And Numbers336970 +Ref: Strings And Numbers-Footnote-1340034 +Node: Locale influences conversions340143 +Ref: table-locale-affects342901 +Node: All Operators343519 +Node: Arithmetic Ops344148 +Node: Concatenation346654 +Ref: Concatenation-Footnote-1349501 +Node: Assignment Ops349608 +Ref: table-assign-ops354600 +Node: Increment Ops355913 +Node: Truth Values and Conditions359373 +Node: Truth Values360447 +Node: Typing and Comparison361495 +Node: Variable Typing362315 +Node: Comparison Operators365939 +Ref: table-relational-ops366358 +Node: POSIX String Comparison369853 +Ref: POSIX String Comparison-Footnote-1370927 +Node: Boolean Ops371066 +Ref: Boolean Ops-Footnote-1375548 +Node: Conditional Exp375640 +Node: Function Calls377376 +Node: Precedence381256 +Node: Locales384915 +Node: Expressions Summary386547 +Node: Patterns and Actions389120 +Node: Pattern Overview390240 +Node: Regexp Patterns391917 +Node: Expression Patterns392459 +Node: Ranges396240 +Node: BEGIN/END399348 +Node: Using BEGIN/END400109 +Ref: Using BEGIN/END-Footnote-1402846 +Node: I/O And BEGIN/END402952 +Node: BEGINFILE/ENDFILE405268 +Node: Empty408175 +Node: Using Shell Variables408492 +Node: Action Overview410766 +Node: Statements413091 +Node: If Statement414939 +Node: While Statement416434 +Node: Do Statement418462 +Node: For Statement419610 +Node: Switch Statement422769 +Node: Break Statement425155 +Node: Continue Statement427247 +Node: Next Statement429074 +Node: Nextfile Statement431457 +Node: Exit Statement434109 +Node: Built-in Variables436514 +Node: User-modified437647 +Ref: User-modified-Footnote-1445274 +Node: Auto-set445336 +Ref: Auto-set-Footnote-1459585 +Ref: Auto-set-Footnote-2459791 +Node: ARGC and ARGV459847 +Node: Pattern Action Summary464066 +Node: Arrays466496 +Node: Array Basics467825 +Node: Array Intro468669 +Ref: figure-array-elements470644 +Ref: Array Intro-Footnote-1473348 +Node: Reference to Elements473476 +Node: Assigning Elements475940 +Node: Array Example476431 +Node: Scanning an Array478190 +Node: Controlling Scanning481214 +Ref: Controlling Scanning-Footnote-1486613 +Node: Numeric Array Subscripts486929 +Node: Uninitialized Subscripts489113 +Node: Delete490732 +Ref: Delete-Footnote-1493484 +Node: Multidimensional493541 +Node: Multiscanning496636 +Node: Arrays of Arrays498227 +Node: Arrays Summary502995 +Node: Functions505088 +Node: Built-in506126 +Node: Calling Built-in507204 +Node: Numeric Functions509200 +Ref: Numeric Functions-Footnote-1514033 +Ref: Numeric Functions-Footnote-2514390 +Ref: Numeric Functions-Footnote-3514438 +Node: String Functions514710 +Ref: String Functions-Footnote-1538218 +Ref: String Functions-Footnote-2538347 +Ref: String Functions-Footnote-3538595 +Node: Gory Details538682 +Ref: table-sub-escapes540473 +Ref: table-sub-proposed541992 +Ref: table-posix-sub543355 +Ref: table-gensub-escapes544896 +Ref: Gory Details-Footnote-1545719 +Node: I/O Functions545870 +Ref: I/O Functions-Footnote-1553091 +Node: Time Functions553239 +Ref: Time Functions-Footnote-1563744 +Ref: Time Functions-Footnote-2563812 +Ref: Time Functions-Footnote-3563970 +Ref: Time Functions-Footnote-4564081 +Ref: Time Functions-Footnote-5564193 +Ref: Time Functions-Footnote-6564420 +Node: Bitwise Functions564686 +Ref: table-bitwise-ops565280 +Ref: Bitwise Functions-Footnote-1569618 +Node: Type Functions569791 +Node: I18N Functions570947 +Node: User-defined572598 +Node: Definition Syntax573403 +Ref: Definition Syntax-Footnote-1579090 +Node: Function Example579161 +Ref: Function Example-Footnote-1582083 +Node: Function Caveats582105 +Node: Calling A Function582623 +Node: Variable Scope583581 +Node: Pass By Value/Reference586575 +Node: Return Statement590074 +Node: Dynamic Typing593053 +Node: Indirect Calls593983 +Ref: Indirect Calls-Footnote-1604234 +Node: Functions Summary604362 +Node: Library Functions607067 +Ref: Library Functions-Footnote-1610676 +Ref: Library Functions-Footnote-2610819 +Node: Library Names610990 +Ref: Library Names-Footnote-1614451 +Ref: Library Names-Footnote-2614674 +Node: General Functions614760 +Node: Strtonum Function615863 +Node: Assert Function618885 +Node: Round Function622211 +Node: Cliff Random Function623752 +Node: Ordinal Functions624768 +Ref: Ordinal Functions-Footnote-1627831 +Ref: Ordinal Functions-Footnote-2628083 +Node: Join Function628293 +Ref: Join Function-Footnote-1630063 +Node: Getlocaltime Function630263 +Node: Readfile Function634007 +Node: Shell Quoting635981 +Node: Data File Management637382 +Node: Filetrans Function638014 +Node: Rewind Function642111 +Node: File Checking643497 +Ref: File Checking-Footnote-1644831 +Node: Empty Files645032 +Node: Ignoring Assigns647011 +Node: Getopt Function648561 +Ref: Getopt Function-Footnote-1660031 +Node: Passwd Functions660231 +Ref: Passwd Functions-Footnote-1669072 +Node: Group Functions669160 +Ref: Group Functions-Footnote-1677059 +Node: Walking Arrays677266 +Node: Library Functions Summary680276 +Node: Library Exercises681682 +Node: Sample Programs682961 +Node: Running Examples683731 +Node: Clones684459 +Node: Cut Program685683 +Node: Egrep Program695404 +Ref: Egrep Program-Footnote-1702916 +Node: Id Program703026 +Node: Split Program706706 +Ref: Split Program-Footnote-1710165 +Node: Tee Program710294 +Node: Uniq Program713084 +Node: Wc Program720510 +Ref: Wc Program-Footnote-1724765 +Node: Miscellaneous Programs724859 +Node: Dupword Program726072 +Node: Alarm Program728102 +Node: Translate Program732957 +Ref: Translate Program-Footnote-1737522 +Node: Labels Program737792 +Ref: Labels Program-Footnote-1741143 +Node: Word Sorting741227 +Node: History Sorting745299 +Node: Extract Program747134 +Node: Simple Sed754665 +Node: Igawk Program757739 +Ref: Igawk Program-Footnote-1772070 +Ref: Igawk Program-Footnote-2772272 +Ref: Igawk Program-Footnote-3772394 +Node: Anagram Program772509 +Node: Signature Program775571 +Node: Programs Summary776818 +Node: Programs Exercises778033 +Ref: Programs Exercises-Footnote-1782162 +Node: Advanced Features782253 +Node: Nondecimal Data784243 +Node: Array Sorting785834 +Node: Controlling Array Traversal786534 +Ref: Controlling Array Traversal-Footnote-1794903 +Node: Array Sorting Functions795021 +Ref: Array Sorting Functions-Footnote-1798908 +Node: Two-way I/O799104 +Ref: Two-way I/O-Footnote-1804055 +Ref: Two-way I/O-Footnote-2804242 +Node: TCP/IP Networking804324 +Node: Profiling807231 +Node: Advanced Features Summary815502 +Node: Internationalization817438 +Node: I18N and L10N818918 +Node: Explaining gettext819605 +Ref: Explaining gettext-Footnote-1824628 +Ref: Explaining gettext-Footnote-2824813 +Node: Programmer i18n824978 +Ref: Programmer i18n-Footnote-1829834 +Node: Translator i18n829883 +Node: String Extraction830677 +Ref: String Extraction-Footnote-1831810 +Node: Printf Ordering831896 +Ref: Printf Ordering-Footnote-1834682 +Node: I18N Portability834746 +Ref: I18N Portability-Footnote-1837202 +Node: I18N Example837265 +Ref: I18N Example-Footnote-1840071 +Node: Gawk I18N840144 +Node: I18N Summary840789 +Node: Debugger842130 +Node: Debugging843152 +Node: Debugging Concepts843593 +Node: Debugging Terms845402 +Node: Awk Debugging847977 +Node: Sample Debugging Session848883 +Node: Debugger Invocation849417 +Node: Finding The Bug850803 +Node: List of Debugger Commands857281 +Node: Breakpoint Control858614 +Node: Debugger Execution Control862308 +Node: Viewing And Changing Data865670 +Node: Execution Stack869044 +Node: Debugger Info870681 +Node: Miscellaneous Debugger Commands874752 +Node: Readline Support879761 +Node: Limitations880657 +Node: Debugging Summary882766 +Node: Arbitrary Precision Arithmetic883939 +Node: Computer Arithmetic885355 +Ref: table-numeric-ranges888946 +Ref: Computer Arithmetic-Footnote-1889668 +Node: Math Definitions889725 +Ref: table-ieee-formats893039 +Ref: Math Definitions-Footnote-1893642 +Node: MPFR features893747 +Node: FP Math Caution895420 +Ref: FP Math Caution-Footnote-1896492 +Node: Inexactness of computations896861 +Node: Inexact representation897821 +Node: Comparing FP Values899181 +Node: Errors accumulate900263 +Node: Getting Accuracy901696 +Node: Try To Round904406 +Node: Setting precision905305 +Ref: table-predefined-precision-strings906002 +Node: Setting the rounding mode907832 +Ref: table-gawk-rounding-modes908206 +Ref: Setting the rounding mode-Footnote-1911614 +Node: Arbitrary Precision Integers911793 +Ref: Arbitrary Precision Integers-Footnote-1916710 +Node: POSIX Floating Point Problems916859 +Ref: POSIX Floating Point Problems-Footnote-1920741 +Node: Floating point summary920779 +Node: Dynamic Extensions922969 +Node: Extension Intro924522 +Node: Plugin License925788 +Node: Extension Mechanism Outline926585 +Ref: figure-load-extension927024 +Ref: figure-register-new-function928589 +Ref: figure-call-new-function929681 +Node: Extension API Description931744 +Node: Extension API Functions Introduction933278 +Node: General Data Types938137 +Ref: General Data Types-Footnote-1944092 +Node: Memory Allocation Functions944391 +Ref: Memory Allocation Functions-Footnote-1947236 +Node: Constructor Functions947335 +Node: Registration Functions949080 +Node: Extension Functions949765 +Node: Exit Callback Functions952064 +Node: Extension Version String953314 +Node: Input Parsers953977 +Node: Output Wrappers963862 +Node: Two-way processors968374 +Node: Printing Messages970638 +Ref: Printing Messages-Footnote-1971714 +Node: Updating 'ERRNO'971867 +Node: Requesting Values972608 +Ref: table-value-types-returned973347 +Node: Accessing Parameters974230 +Node: Symbol Table Access975466 +Node: Symbol table by name975978 +Node: Symbol table by cookie977999 +Ref: Symbol table by cookie-Footnote-1982148 +Node: Cached values982212 +Ref: Cached values-Footnote-1985713 +Node: Array Manipulation985804 +Ref: Array Manipulation-Footnote-1986895 +Node: Array Data Types986932 +Ref: Array Data Types-Footnote-1989590 +Node: Array Functions989682 +Node: Flattening Arrays993541 +Node: Creating Arrays1000449 +Node: Redirection API1005221 +Node: Extension API Variables1008052 +Node: Extension Versioning1008685 +Node: Extension API Informational Variables1010576 +Node: Extension API Boilerplate1011640 +Node: Finding Extensions1015454 +Node: Extension Example1016014 +Node: Internal File Description1016812 +Node: Internal File Ops1020892 +Ref: Internal File Ops-Footnote-11032654 +Node: Using Internal File Ops1032794 +Ref: Using Internal File Ops-Footnote-11035177 +Node: Extension Samples1035452 +Node: Extension Sample File Functions1036981 +Node: Extension Sample Fnmatch1044630 +Node: Extension Sample Fork1046117 +Node: Extension Sample Inplace1047335 +Node: Extension Sample Ord1049421 +Node: Extension Sample Readdir1050257 +Ref: table-readdir-file-types1051146 +Node: Extension Sample Revout1051951 +Node: Extension Sample Rev2way1052540 +Node: Extension Sample Read write array1053280 +Node: Extension Sample Readfile1055222 +Node: Extension Sample Time1056317 +Node: Extension Sample API Tests1057665 +Node: gawkextlib1058157 +Node: Extension summary1060604 +Node: Extension Exercises1064296 +Node: Language History1065793 +Node: V7/SVR3.11067449 +Node: SVR41069602 +Node: POSIX1071036 +Node: BTL1072416 +Node: POSIX/GNU1073146 +Node: Feature History1078985 +Node: Common Extensions1092976 +Node: Ranges and Locales1094259 +Ref: Ranges and Locales-Footnote-11098875 +Ref: Ranges and Locales-Footnote-21098902 +Ref: Ranges and Locales-Footnote-31099137 +Node: Contributors1099358 +Node: History summary1104927 +Node: Installation1106307 +Node: Gawk Distribution1107252 +Node: Getting1107736 +Node: Extracting1108559 +Node: Distribution contents1110197 +Node: Unix Installation1116293 +Node: Quick Installation1116975 +Node: Shell Startup Files1119389 +Node: Additional Configuration Options1120467 +Node: Configuration Philosophy1122272 +Node: Non-Unix Installation1124642 +Node: PC Installation1125100 +Node: PC Binary Installation1126420 +Node: PC Compiling1128272 +Ref: PC Compiling-Footnote-11131296 +Node: PC Testing1131405 +Node: PC Using1132585 +Node: Cygwin1136699 +Node: MSYS1137469 +Node: VMS Installation1137970 +Node: VMS Compilation1138761 +Ref: VMS Compilation-Footnote-11139991 +Node: VMS Dynamic Extensions1140049 +Node: VMS Installation Details1141734 +Node: VMS Running1143987 +Node: VMS GNV1146828 +Node: VMS Old Gawk1147563 +Node: Bugs1148034 +Node: Other Versions1152148 +Node: Installation summary1158622 +Node: Notes1159680 +Node: Compatibility Mode1160545 +Node: Additions1161327 +Node: Accessing The Source1162252 +Node: Adding Code1163688 +Node: New Ports1169843 +Node: Derived Files1174331 +Ref: Derived Files-Footnote-11179816 +Ref: Derived Files-Footnote-21179851 +Ref: Derived Files-Footnote-31180449 +Node: Future Extensions1180563 +Node: Implementation Limitations1181221 +Node: Extension Design1182404 +Node: Old Extension Problems1183558 +Ref: Old Extension Problems-Footnote-11185076 +Node: Extension New Mechanism Goals1185133 +Ref: Extension New Mechanism Goals-Footnote-11188497 +Node: Extension Other Design Decisions1188686 +Node: Extension Future Growth1190799 +Node: Old Extension Mechanism1191635 +Node: Notes summary1193398 +Node: Basic Concepts1194580 +Node: Basic High Level1195261 +Ref: figure-general-flow1195543 +Ref: figure-process-flow1196228 +Ref: Basic High Level-Footnote-11199529 +Node: Basic Data Typing1199714 +Node: Glossary1203042 +Node: Copying1234988 +Node: GNU Free Documentation License1272527 +Node: Index1297645 End Tag Table diff --git a/doc/gawk.texi b/doc/gawk.texi index 57a2f893..df53c97d 100644 --- a/doc/gawk.texi +++ b/doc/gawk.texi @@ -604,6 +604,7 @@ particular records in a file and perform operations upon them. @code{getline}. * Getline Summary:: Summary of @code{getline} Variants. * Read Timeout:: Reading input with a timeout. +* Retrying Input:: Retrying input after certain errors. * Command-line directories:: What happens if you put a directory on the command line. * Input Summary:: Input summary. @@ -633,6 +634,7 @@ particular records in a file and perform operations upon them. * Special Caveats:: Things to watch out for. * Close Files And Pipes:: Closing Input and Output Files and Pipes. +* Nonfatal:: Enabling Nonfatal Output. * Output Summary:: Output summary. * Output Exercises:: Exercises. * Values:: Constants, Variables, and Regular @@ -944,6 +946,7 @@ particular records in a file and perform operations upon them. * Array Functions:: Functions for working with arrays. * Flattening Arrays:: How to flatten arrays. * Creating Arrays:: How to create and populate arrays. +* Redirection API:: How to access and manipulate redirections. * Extension API Variables:: Variables provided by the API. * Extension Versioning:: API Version information. * Extension API Informational Variables:: Variables providing information about @@ -1002,6 +1005,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 @@ -4082,10 +4086,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} @@ -4486,6 +4488,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. @@ -4517,6 +4522,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. @@ -4544,6 +4552,8 @@ wait for input before returning with an error. Controls the number of times @command{gawk} attempts to retry a two-way TCP/IP (socket) connection before giving up. @xref{TCP/IP Networking}. +Note that when nonfatal I/O is enabled (@pxref{Nonfatal}), +@command{gawk} only tries to open a TCP/IP socket once. @item POSIXLY_CORRECT Causes @command{gawk} to switch to POSIX-compatibility @@ -4593,14 +4603,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. @@ -4898,6 +4900,32 @@ Similarly, you may use @code{print} or @code{printf} statements in the @var{init} and @var{increment} parts of a @code{for} loop. This is another long-undocumented ``feature'' of Unix @command{awk}. +@command{gawk} lets you use the names of built-in functions that are +@command{gawk} extensions as the names of parameters in user-defined functions. +This is intended to ``future-proof'' old code that happens to use +function names added by @command{gawk} after the code was written. +Standard @command{awk} built-in functions, such as @code{sin()} or +@code{substr()} are @emph{not} shadowed in this way. + +The @code{PROCINFO["argv"]} array contains all of the command-line arguments +(after glob expansion and redirection processing on platforms where that must +be done manually by the program) with subscripts ranging from 0 through +@code{argc} @minus{} 1. For example, @code{PROCINFO["argv"][0]} will contain +the name by which @command{gawk} was invoked. Here is an example of how this +feature may be used: + +@example +awk ' +BEGIN @{ + for (i = 0; i < length(PROCINFO["argv"]); i++) + print i, PROCINFO["argv"][i] +@}' +@end example + +Please note that this differs from the standard @code{ARGV} array which does +not include command-line arguments that have already been processed by +@command{gawk} (@pxref{ARGC and ARGV}). + @end ignore @node Invoking Summary @@ -5180,17 +5208,21 @@ 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. +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} 4.2, only two digits +are processed. @end quotation @cindex @code{\} (backslash), @code{\/} escape sequence @@ -6323,6 +6355,7 @@ used with it do not have to be named on the @command{awk} command line * Getline:: Reading files under explicit program control using the @code{getline} function. * Read Timeout:: Reading input with a timeout. +* Retrying Input:: Retrying input after certain errors. * Command-line directories:: What happens if you put a directory on the command line. * Input Summary:: Input summary. @@ -8114,6 +8147,13 @@ a record, such as a file that cannot be opened, then @code{getline} returns @minus{}1. In this case, @command{gawk} sets the variable @code{ERRNO} to a string describing the error that occurred. +If @code{ERRNO} indicates that the I/O operation may be +retried, and @code{PROCINFO["@var{input}", "RETRY"]} is set, +then @code{getline} returns @minus{}2 +instead of @minus{}1, and further calls to @code{getline} +may be attemped. @DBXREF{Retrying Input} for further information about +this feature. + In the following examples, @var{command} stands for a string value that represents a shell command. @@ -8768,7 +8808,8 @@ on a per-command or per-connection basis. the attempt to read from the underlying device may succeed in a later attempt. This is a limitation, and it also means that you cannot use this to multiplex input from -two or more sources. +two or more sources. @DBXREF{Retrying Input} for a way to enable +later I/O attempts to succeed. Assigning a timeout value prevents read operations from blocking indefinitely. But bear in mind that there are other ways @@ -8778,6 +8819,36 @@ a connection before it can start reading any data, or the attempt to open a FIFO special file for reading can block indefinitely until some other process opens it for writing. +@node Retrying Input +@section Retrying Reads After Certain Input Errors +@cindex retrying input + +@cindex differences in @command{awk} and @command{gawk}, retrying input +This @value{SECTION} describes a feature that is specific to @command{gawk}. + +When @command{gawk} encounters an error while reading input, by +default @code{getline} returns @minus{}1, and subsequent attempts to +read from that file result in an end-of-file indication. However, you +may optionally instruct @command{gawk} to allow I/O to be retried when +certain errors are encountered by setting a special element in +the @code{PROCINFO} array (@pxref{Auto-set}): + +@example +PROCINFO["@var{input_name}", "RETRY"] = 1 +@end example + +When this element exists, @command{gawk} checks the value of the system +(C language) +@code{errno} variable when an I/O error occurs. If @code{errno} indicates +a subsequent I/O attempt may succeed, @code{getline} instead returns +@minus{}2 and +further calls to @code{getline} may succeed. This applies to the @code{errno} +values @code{EAGAIN}, @code{EWOULDBLOCK}, @code{EINTR}, or @code{ETIMEDOUT}. + +This feature is useful in conjunction with +@code{PROCINFO["@var{input_name}", "READ_TIMEOUT"]} or situations where a file +descriptor has been configured to behave in a non-blocking fashion. + @node Command-line directories @section Directories on the Command Line @cindex differences in @command{awk} and @command{gawk}, command-line directories @@ -8939,6 +9010,7 @@ and discusses the @code{close()} built-in function. @command{gawk} allows access to inherited file descriptors. * Close Files And Pipes:: Closing Input and Output Files and Pipes. +* Nonfatal:: Enabling Nonfatal Output. * Output Summary:: Output summary. * Output Exercises:: Exercises. @end menu @@ -10445,6 +10517,71 @@ when closing a pipe. @end ifnotdocbook +@node Nonfatal +@section Enabling Nonfatal Output + +This @value{SECTION} describes a @command{gawk}-specific feature. + +In standard @command{awk}, output with @code{print} or @code{printf} +to a nonexistent file, or some other I/O error (such as filling up the +disk) is a fatal error. + +@example +$ @kbd{gawk 'BEGIN @{ print "hi" > "/no/such/file" @}'} +@error{} gawk: cmd. line:1: fatal: can't redirect to `/no/such/file' (No such file or directory) +@end example + +@command{gawk} makes it possible to detect that an error has +occurred, allowing you to possibly recover from the error, or +at least print an error message of your choosing before exiting. +You can do this in one of two ways: + +@itemize @bullet +@item +For all output files, by assigning any value to @code{PROCINFO["NONFATAL"]}. + +@item +On a per-file basis, by assigning any value to +@code{PROCINFO[@var{filename}, "NONFATAL"]}. +Here, @var{filename} is the name of the file to which +you wish output to be nonfatal. +@end itemize + +Once you have enabled nonfatal output, you must check @code{ERRNO} +after every relevant @code{print} or @code{printf} statement to +see if something went wrong. It is also a good idea to initialize +@code{ERRNO} to zero before attempting the output. For example: + +@example +$ @kbd{gawk '} +> @kbd{BEGIN @{} +> @kbd{ PROCINFO["NONFATAL"] = 1} +> @kbd{ ERRNO = 0} +> @kbd{ print "hi" > "/no/such/file"} +> @kbd{ if (ERRNO) @{} +> @kbd{ print("Output failed:", ERRNO) > "/dev/stderr"} +> @kbd{ exit 1} +> @kbd{ @}} +> @kbd{@}'} +@error{} Output failed: No such file or directory +@end example + +Here, @command{gawk} did not produce a fatal error; instead +it let the @command{awk} program code detect the problem and handle it. + +This mechanism works also for standard output and standard error. +For standard output, you may use @code{PROCINFO["-", "NONFATAL"]} +or @code{PROCINFO["/dev/stdout", "NONFATAL"]}. For standard error, use +@code{PROCINFO["/dev/stderr", "NONFATAL"]}. + +When attempting to open a TCP/IP socket (@pxref{TCP/IP Networking}), +@command{gawk} tries multiple times. The @env{GAWK_SOCK_RETRIES} +environment variable (@pxref{Other Environment Variables}) allows you to +override @command{gawk}'s builtin default number of attempts. However, +once nonfatal I/O is enabled for a given socket, @command{gawk} only +retries once, relying on @command{awk}-level code to notice that there +was a problem. + @node Output Summary @section Summary @@ -10473,6 +10610,12 @@ Use @code{close()} to close open file, pipe, and coprocess redirections. For coprocesses, it is possible to close only one direction of the communications. +@item +Normally errors with @code{print} or @code{printf} are fatal. +@command{gawk} lets you make output errors be nonfatal either for +all files or on a per-file basis. You must then check for errors +after every relevant output statement. + @end itemize @c EXCLUDE START @@ -14806,10 +14949,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 @@ -14843,6 +15000,11 @@ value to be meaningful when an I/O operation returns a failure value, such as @code{getline} returning @minus{}1. You are, of course, free to clear it yourself before doing an I/O operation. +If the value of @code{ERRNO} corresponds to a system error in the C +@code{errno} variable, then @code{PROCINFO["errno"]} will be set to the value +of @code{errno}. For non-system errors, @code{PROCINFO["errno"]} will +be zero. + @cindex @code{FILENAME} variable @cindex dark corner, @code{FILENAME} variable @item @code{FILENAME} @@ -14911,6 +15073,10 @@ are guaranteed to be available: @item PROCINFO["egid"] The value of the @code{getegid()} system call. +@item PROCINFO["errno"] +The value of the C @code{errno} variable when @code{ERRNO} is set to +the associated error message. + @item PROCINFO["euid"] @cindex effective user ID of @command{gawk} user The value of the @code{geteuid()} system call. @@ -15050,6 +15216,11 @@ open input file, pipe, or coprocess. @DBXREF{Read Timeout} for more information. @item +It may be used to indicate that input may be retried when it fails due to +certain errors. +@DBXREF{Retrying Input} for more information. + +@item It may be used to cause coprocesses to communicate over pseudo-ttys instead of through two-way pipes; this is discussed further in @ref{Two-way I/O}. @@ -16959,6 +17130,23 @@ truncated toward zero. For example, @code{int(3)} is 3, @code{int(3.9)} is 3, @code{int(-3.9)} is @minus{}3, and @code{int(-3)} is @minus{}3 as well. +@item @code{intdiv(@var{numerator}, @var{denominator}, @var{result})} +@cindexawkfunc{intdiv} +@cindex intdiv +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{log(@var{x})} @cindexawkfunc{log} @cindex logarithm @@ -27760,8 +27948,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 @@ -27855,10 +28042,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 @@ -30932,6 +31135,122 @@ 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{intdiv()} function (@pxref{Numeric Functions}). + +You can simulate the @code{intdiv()} function in standard @command{awk} +using this user-defined function: + +@example +@c file eg/lib/intdiv.awk +# intdiv --- do integer division + +@c endfile +@ignore +@c file eg/lib/intdiv.awk +# +# Arnold Robbins, arnold@@skeeve.com, Public Domain +# July, 2014 +# +# Name changed from div() to intdiv() +# April, 2015 + +@c endfile + +@end ignore +@c file eg/lib/intdiv.awk +function intdiv(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{intdiv()} 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 + intdiv(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 @@ -31331,6 +31650,7 @@ This (rather large) @value{SECTION} describes the API in detail. * Symbol Table Access:: Functions for accessing global variables. * Array Manipulation:: Functions for working with arrays. +* Redirection API:: How to access and manipulate redirections. * Extension API Variables:: Variables provided by the API. * Extension API Boilerplate:: Boilerplate code for using the API. @end menu @@ -31406,6 +31726,10 @@ Clearing an array @item Flattening an array for easy C-style looping over all its indices and elements @end itemize + +@item +Accessing and manipulating redirections. + @end itemize Some points about using the API: @@ -33376,6 +33700,75 @@ $ @kbd{AWKLIBPATH=$PWD ./gawk -f subarray.awk} (@DBXREF{Finding Extensions} for more information on the @env{AWKLIBPATH} environment variable.) +@node Redirection API +@subsection Accessing and Manipulating Redirections + +The following function allows extensions to access and manipulate redirections. + +@table @code +@item awk_bool_t get_file(const char *name, +@itemx @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ size_t name_len, +@itemx @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ const char *filetype, +@itemx @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ int fd, +@itemx @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ const awk_input_buf_t **ibufp, +@itemx @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ const awk_output_buf_t **obufp); +Look up a file in @command{gawk}'s internal redirection table. +If @code{name} is @code{NULL} or @code{name_len} is zero, return +data for the currently open input file corresponding to @code{FILENAME}. +(This does not access the @code{filetype} argument, so that may be undefined). +If the file is not already open, attempt to open it. +The @code{filetype} argument must be zero-terminated and should be one of: + +@table @code +@item ">" +A file opened for output. + +@item ">>" +A file opened for append. + +@item "<" +A file opened for input. + +@item "|>" +A pipe opened for output. + +@item "|<" +A pipe opened for input. + +@item "|&" +A two-way coprocess. +@end table + +On error, return a @code{false} value. Otherwise, return +@code{true}, and return additional information about the redirection +in the @code{ibufp} and @code{obufp} pointers. For input +redirections, the @code{*ibufp} value should be non-@code{NULL}, +and @code{*obufp} should be @code{NULL}. For output redirections, +the @code{*obufp} value should be non-@code{NULL}, and @code{*ibufp} +should be @code{NULL}. For two-way coprocesses, both values should +be non-@code{NULL}. + +In the usual case, the extension is interested in @code{(*ibufp)->fd} +and/or @code{fileno((*obufp)->fp)}. If the file is not already +open, and the @code{fd} argument is non-negative, @command{gawk} +will use that file descriptor instead of opening the file in the +usual way. If @code{fd} is non-negative, but the file exists already, +@command{gawk} ignores @code{fd} and returns the existing file. It is +the caller's responsibility to notice that neither the @code{fd} in +the returned @code{awk_input_buf_t} nor the @code{fd} in the returned +@code{awk_output_buf_t} matches the requested value. + +Note that supplying a file descriptor is currently @emph{not} supported +for pipes. However, supplying a file descriptor should work for input, +output, append, and two-way (coprocess) sockets. If @code{filetype} +is two-way, @command{gawk} assumes that it is a socket! Note that in +the two-way case, the input and output file descriptors may differ. +To check for success, you must check whether either matches. +@end table + +It is anticipated that this API function will be used to implement I/O +multiplexing and a socket library. + @node Extension API Variables @subsection API Variables @@ -34917,18 +35310,21 @@ As of this writing, there are seven extensions: GD graphics library extension @item +MPFR library extension +(this provides access to a number of MPFR functions that @command{gawk}'s +native MPFR support does not) + +@item PDF extension @item PostgreSQL extension @item -MPFR library extension -(this provides access to a number of MPFR functions that @command{gawk}'s -native MPFR support does not) +Redis extension @item -Redis extension +Select extension @item XML parser extension, using the @uref{http://expat.sourceforge.net, Expat} @@ -35557,6 +35953,10 @@ Indirect function calls @item Directories on the command line produce a warning and are skipped (@pxref{Command-line directories}) + +@item +Output with @code{print} and @code{printf} need not be fatal +(@pxref{Nonfatal}) @end itemize @item @@ -35644,6 +36044,11 @@ The @code{isarray()} function to check if a variable is an array or not The @code{bindtextdomain()}, @code{dcgettext()}, and @code{dcngettext()} functions for internationalization (@pxref{Programmer i18n}) + +@item +The @code{intdiv()} function for doing integer +division and remainder +(@pxref{Numeric Functions}) @end itemize @item @@ -35776,6 +36181,16 @@ for @command{gawk} @value{PVERSION} 4.1: Ultrix @end itemize +@item +Support for the following systems was removed from the code +for @command{gawk} @value{PVERSION} 4.2: + +@c nested table +@itemize @value{MINUS} +@item +MirBSD +@end itemize + @end itemize @c XXX ADD MORE STUFF HERE @@ -36402,6 +36817,41 @@ Support for Ultrix was removed. @end itemize +Version 4.2 introduced the following changes: + +@itemize @bullet +@item +Changes to @code{ENVIRON} are reflected into @command{gawk}'s +environment and that of programs that it runs. +@xref{Auto-set}. + +@item +The @option{--pretty-print} option no longer runs the @command{awk} +program too. +@xref{Options}. + +@item +The @command{igawk} program and its manual page are no longer +installed when @command{gawk} is built. +@xref{Igawk Program}. + +@item +The @code{intdiv()} function. +@xref{Numeric Functions}. + +@item +The maximum number of hexdecimal digits in @samp{\x} escapes +is now two. +@xref{Escape Sequences}. + +@item +Nonfatal output with @code{print} and @code{printf}. +@xref{Nonfatal}. + +@item +Support for MirBSD was removed. +@end itemize + @c XXX ADD MORE STUFF HERE @end ifclear @@ -37066,6 +37516,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 @@ -37110,8 +37562,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 @@ -37122,6 +37572,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. @@ -37153,6 +37609,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 @@ -37233,6 +37690,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 03857f1e..0cf09842 100644 --- a/doc/gawktexi.in +++ b/doc/gawktexi.in @@ -599,6 +599,7 @@ particular records in a file and perform operations upon them. @code{getline}. * Getline Summary:: Summary of @code{getline} Variants. * Read Timeout:: Reading input with a timeout. +* Retrying Input:: Retrying input after certain errors. * Command-line directories:: What happens if you put a directory on the command line. * Input Summary:: Input summary. @@ -628,6 +629,7 @@ particular records in a file and perform operations upon them. * Special Caveats:: Things to watch out for. * Close Files And Pipes:: Closing Input and Output Files and Pipes. +* Nonfatal:: Enabling Nonfatal Output. * Output Summary:: Output summary. * Output Exercises:: Exercises. * Values:: Constants, Variables, and Regular @@ -939,6 +941,7 @@ particular records in a file and perform operations upon them. * Array Functions:: Functions for working with arrays. * Flattening Arrays:: How to flatten arrays. * Creating Arrays:: How to create and populate arrays. +* Redirection API:: How to access and manipulate redirections. * Extension API Variables:: Variables provided by the API. * Extension Versioning:: API Version information. * Extension API Informational Variables:: Variables providing information about @@ -997,6 +1000,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 @@ -3993,10 +3997,8 @@ No space is allowed between the @option{-o} and @var{file}, if @var{file} is supplied. @quotation NOTE -Due to the way @command{gawk} has evolved, with this option -your program 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} @@ -4397,6 +4399,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. @@ -4428,6 +4433,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. @@ -4455,6 +4463,8 @@ wait for input before returning with an error. Controls the number of times @command{gawk} attempts to retry a two-way TCP/IP (socket) connection before giving up. @xref{TCP/IP Networking}. +Note that when nonfatal I/O is enabled (@pxref{Nonfatal}), +@command{gawk} only tries to open a TCP/IP socket once. @item POSIXLY_CORRECT Causes @command{gawk} to switch to POSIX-compatibility @@ -4504,14 +4514,6 @@ two regexp matchers that @command{gawk} uses internally. (There aren't supposed to be differences, but occasionally theory and practice don't coordinate with each other.) -@item GAWK_NO_PP_RUN -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. @@ -4809,6 +4811,32 @@ Similarly, you may use @code{print} or @code{printf} statements in the @var{init} and @var{increment} parts of a @code{for} loop. This is another long-undocumented ``feature'' of Unix @command{awk}. +@command{gawk} lets you use the names of built-in functions that are +@command{gawk} extensions as the names of parameters in user-defined functions. +This is intended to ``future-proof'' old code that happens to use +function names added by @command{gawk} after the code was written. +Standard @command{awk} built-in functions, such as @code{sin()} or +@code{substr()} are @emph{not} shadowed in this way. + +The @code{PROCINFO["argv"]} array contains all of the command-line arguments +(after glob expansion and redirection processing on platforms where that must +be done manually by the program) with subscripts ranging from 0 through +@code{argc} @minus{} 1. For example, @code{PROCINFO["argv"][0]} will contain +the name by which @command{gawk} was invoked. Here is an example of how this +feature may be used: + +@example +awk ' +BEGIN @{ + for (i = 0; i < length(PROCINFO["argv"]); i++) + print i, PROCINFO["argv"][i] +@}' +@end example + +Please note that this differs from the standard @code{ARGV} array which does +not include command-line arguments that have already been processed by +@command{gawk} (@pxref{ARGC and ARGV}). + @end ignore @node Invoking Summary @@ -5091,17 +5119,21 @@ 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. +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} 4.2, only two digits +are processed. @end quotation @cindex @code{\} (backslash), @code{\/} escape sequence @@ -6107,6 +6139,7 @@ used with it do not have to be named on the @command{awk} command line * Getline:: Reading files under explicit program control using the @code{getline} function. * Read Timeout:: Reading input with a timeout. +* Retrying Input:: Retrying input after certain errors. * Command-line directories:: What happens if you put a directory on the command line. * Input Summary:: Input summary. @@ -7714,6 +7747,13 @@ a record, such as a file that cannot be opened, then @code{getline} returns @minus{}1. In this case, @command{gawk} sets the variable @code{ERRNO} to a string describing the error that occurred. +If @code{ERRNO} indicates that the I/O operation may be +retried, and @code{PROCINFO["@var{input}", "RETRY"]} is set, +then @code{getline} returns @minus{}2 +instead of @minus{}1, and further calls to @code{getline} +may be attemped. @DBXREF{Retrying Input} for further information about +this feature. + In the following examples, @var{command} stands for a string value that represents a shell command. @@ -8368,7 +8408,8 @@ on a per-command or per-connection basis. the attempt to read from the underlying device may succeed in a later attempt. This is a limitation, and it also means that you cannot use this to multiplex input from -two or more sources. +two or more sources. @DBXREF{Retrying Input} for a way to enable +later I/O attempts to succeed. Assigning a timeout value prevents read operations from blocking indefinitely. But bear in mind that there are other ways @@ -8378,6 +8419,36 @@ a connection before it can start reading any data, or the attempt to open a FIFO special file for reading can block indefinitely until some other process opens it for writing. +@node Retrying Input +@section Retrying Reads After Certain Input Errors +@cindex retrying input + +@cindex differences in @command{awk} and @command{gawk}, retrying input +This @value{SECTION} describes a feature that is specific to @command{gawk}. + +When @command{gawk} encounters an error while reading input, by +default @code{getline} returns @minus{}1, and subsequent attempts to +read from that file result in an end-of-file indication. However, you +may optionally instruct @command{gawk} to allow I/O to be retried when +certain errors are encountered by setting a special element in +the @code{PROCINFO} array (@pxref{Auto-set}): + +@example +PROCINFO["@var{input_name}", "RETRY"] = 1 +@end example + +When this element exists, @command{gawk} checks the value of the system +(C language) +@code{errno} variable when an I/O error occurs. If @code{errno} indicates +a subsequent I/O attempt may succeed, @code{getline} instead returns +@minus{}2 and +further calls to @code{getline} may succeed. This applies to the @code{errno} +values @code{EAGAIN}, @code{EWOULDBLOCK}, @code{EINTR}, or @code{ETIMEDOUT}. + +This feature is useful in conjunction with +@code{PROCINFO["@var{input_name}", "READ_TIMEOUT"]} or situations where a file +descriptor has been configured to behave in a non-blocking fashion. + @node Command-line directories @section Directories on the Command Line @cindex differences in @command{awk} and @command{gawk}, command-line directories @@ -8539,6 +8610,7 @@ and discusses the @code{close()} built-in function. @command{gawk} allows access to inherited file descriptors. * Close Files And Pipes:: Closing Input and Output Files and Pipes. +* Nonfatal:: Enabling Nonfatal Output. * Output Summary:: Output summary. * Output Exercises:: Exercises. @end menu @@ -9941,6 +10013,71 @@ when closing a pipe. @end sidebar +@node Nonfatal +@section Enabling Nonfatal Output + +This @value{SECTION} describes a @command{gawk}-specific feature. + +In standard @command{awk}, output with @code{print} or @code{printf} +to a nonexistent file, or some other I/O error (such as filling up the +disk) is a fatal error. + +@example +$ @kbd{gawk 'BEGIN @{ print "hi" > "/no/such/file" @}'} +@error{} gawk: cmd. line:1: fatal: can't redirect to `/no/such/file' (No such file or directory) +@end example + +@command{gawk} makes it possible to detect that an error has +occurred, allowing you to possibly recover from the error, or +at least print an error message of your choosing before exiting. +You can do this in one of two ways: + +@itemize @bullet +@item +For all output files, by assigning any value to @code{PROCINFO["NONFATAL"]}. + +@item +On a per-file basis, by assigning any value to +@code{PROCINFO[@var{filename}, "NONFATAL"]}. +Here, @var{filename} is the name of the file to which +you wish output to be nonfatal. +@end itemize + +Once you have enabled nonfatal output, you must check @code{ERRNO} +after every relevant @code{print} or @code{printf} statement to +see if something went wrong. It is also a good idea to initialize +@code{ERRNO} to zero before attempting the output. For example: + +@example +$ @kbd{gawk '} +> @kbd{BEGIN @{} +> @kbd{ PROCINFO["NONFATAL"] = 1} +> @kbd{ ERRNO = 0} +> @kbd{ print "hi" > "/no/such/file"} +> @kbd{ if (ERRNO) @{} +> @kbd{ print("Output failed:", ERRNO) > "/dev/stderr"} +> @kbd{ exit 1} +> @kbd{ @}} +> @kbd{@}'} +@error{} Output failed: No such file or directory +@end example + +Here, @command{gawk} did not produce a fatal error; instead +it let the @command{awk} program code detect the problem and handle it. + +This mechanism works also for standard output and standard error. +For standard output, you may use @code{PROCINFO["-", "NONFATAL"]} +or @code{PROCINFO["/dev/stdout", "NONFATAL"]}. For standard error, use +@code{PROCINFO["/dev/stderr", "NONFATAL"]}. + +When attempting to open a TCP/IP socket (@pxref{TCP/IP Networking}), +@command{gawk} tries multiple times. The @env{GAWK_SOCK_RETRIES} +environment variable (@pxref{Other Environment Variables}) allows you to +override @command{gawk}'s builtin default number of attempts. However, +once nonfatal I/O is enabled for a given socket, @command{gawk} only +retries once, relying on @command{awk}-level code to notice that there +was a problem. + @node Output Summary @section Summary @@ -9969,6 +10106,12 @@ Use @code{close()} to close open file, pipe, and coprocess redirections. For coprocesses, it is possible to close only one direction of the communications. +@item +Normally errors with @code{print} or @code{printf} are fatal. +@command{gawk} lets you make output errors be nonfatal either for +all files or on a per-file basis. You must then check for errors +after every relevant output statement. + @end itemize @c EXCLUDE START @@ -14134,10 +14277,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 @@ -14171,6 +14328,11 @@ value to be meaningful when an I/O operation returns a failure value, such as @code{getline} returning @minus{}1. You are, of course, free to clear it yourself before doing an I/O operation. +If the value of @code{ERRNO} corresponds to a system error in the C +@code{errno} variable, then @code{PROCINFO["errno"]} will be set to the value +of @code{errno}. For non-system errors, @code{PROCINFO["errno"]} will +be zero. + @cindex @code{FILENAME} variable @cindex dark corner, @code{FILENAME} variable @item @code{FILENAME} @@ -14239,6 +14401,10 @@ are guaranteed to be available: @item PROCINFO["egid"] The value of the @code{getegid()} system call. +@item PROCINFO["errno"] +The value of the C @code{errno} variable when @code{ERRNO} is set to +the associated error message. + @item PROCINFO["euid"] @cindex effective user ID of @command{gawk} user The value of the @code{geteuid()} system call. @@ -14378,6 +14544,11 @@ open input file, pipe, or coprocess. @DBXREF{Read Timeout} for more information. @item +It may be used to indicate that input may be retried when it fails due to +certain errors. +@DBXREF{Retrying Input} for more information. + +@item It may be used to cause coprocesses to communicate over pseudo-ttys instead of through two-way pipes; this is discussed further in @ref{Two-way I/O}. @@ -16241,6 +16412,23 @@ truncated toward zero. For example, @code{int(3)} is 3, @code{int(3.9)} is 3, @code{int(-3.9)} is @minus{}3, and @code{int(-3)} is @minus{}3 as well. +@item @code{intdiv(@var{numerator}, @var{denominator}, @var{result})} +@cindexawkfunc{intdiv} +@cindex intdiv +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{log(@var{x})} @cindexawkfunc{log} @cindex logarithm @@ -26851,8 +27039,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 @@ -26946,10 +27133,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 @@ -30023,6 +30226,122 @@ 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{intdiv()} function (@pxref{Numeric Functions}). + +You can simulate the @code{intdiv()} function in standard @command{awk} +using this user-defined function: + +@example +@c file eg/lib/intdiv.awk +# intdiv --- do integer division + +@c endfile +@ignore +@c file eg/lib/intdiv.awk +# +# Arnold Robbins, arnold@@skeeve.com, Public Domain +# July, 2014 +# +# Name changed from div() to intdiv() +# April, 2015 + +@c endfile + +@end ignore +@c file eg/lib/intdiv.awk +function intdiv(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{intdiv()} 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 + intdiv(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 @@ -30422,6 +30741,7 @@ This (rather large) @value{SECTION} describes the API in detail. * Symbol Table Access:: Functions for accessing global variables. * Array Manipulation:: Functions for working with arrays. +* Redirection API:: How to access and manipulate redirections. * Extension API Variables:: Variables provided by the API. * Extension API Boilerplate:: Boilerplate code for using the API. @end menu @@ -30497,6 +30817,10 @@ Clearing an array @item Flattening an array for easy C-style looping over all its indices and elements @end itemize + +@item +Accessing and manipulating redirections. + @end itemize Some points about using the API: @@ -32467,6 +32791,75 @@ $ @kbd{AWKLIBPATH=$PWD ./gawk -f subarray.awk} (@DBXREF{Finding Extensions} for more information on the @env{AWKLIBPATH} environment variable.) +@node Redirection API +@subsection Accessing and Manipulating Redirections + +The following function allows extensions to access and manipulate redirections. + +@table @code +@item awk_bool_t get_file(const char *name, +@itemx @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ size_t name_len, +@itemx @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ const char *filetype, +@itemx @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ int fd, +@itemx @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ const awk_input_buf_t **ibufp, +@itemx @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ const awk_output_buf_t **obufp); +Look up a file in @command{gawk}'s internal redirection table. +If @code{name} is @code{NULL} or @code{name_len} is zero, return +data for the currently open input file corresponding to @code{FILENAME}. +(This does not access the @code{filetype} argument, so that may be undefined). +If the file is not already open, attempt to open it. +The @code{filetype} argument must be zero-terminated and should be one of: + +@table @code +@item ">" +A file opened for output. + +@item ">>" +A file opened for append. + +@item "<" +A file opened for input. + +@item "|>" +A pipe opened for output. + +@item "|<" +A pipe opened for input. + +@item "|&" +A two-way coprocess. +@end table + +On error, return a @code{false} value. Otherwise, return +@code{true}, and return additional information about the redirection +in the @code{ibufp} and @code{obufp} pointers. For input +redirections, the @code{*ibufp} value should be non-@code{NULL}, +and @code{*obufp} should be @code{NULL}. For output redirections, +the @code{*obufp} value should be non-@code{NULL}, and @code{*ibufp} +should be @code{NULL}. For two-way coprocesses, both values should +be non-@code{NULL}. + +In the usual case, the extension is interested in @code{(*ibufp)->fd} +and/or @code{fileno((*obufp)->fp)}. If the file is not already +open, and the @code{fd} argument is non-negative, @command{gawk} +will use that file descriptor instead of opening the file in the +usual way. If @code{fd} is non-negative, but the file exists already, +@command{gawk} ignores @code{fd} and returns the existing file. It is +the caller's responsibility to notice that neither the @code{fd} in +the returned @code{awk_input_buf_t} nor the @code{fd} in the returned +@code{awk_output_buf_t} matches the requested value. + +Note that supplying a file descriptor is currently @emph{not} supported +for pipes. However, supplying a file descriptor should work for input, +output, append, and two-way (coprocess) sockets. If @code{filetype} +is two-way, @command{gawk} assumes that it is a socket! Note that in +the two-way case, the input and output file descriptors may differ. +To check for success, you must check whether either matches. +@end table + +It is anticipated that this API function will be used to implement I/O +multiplexing and a socket library. + @node Extension API Variables @subsection API Variables @@ -34008,18 +34401,21 @@ As of this writing, there are seven extensions: GD graphics library extension @item +MPFR library extension +(this provides access to a number of MPFR functions that @command{gawk}'s +native MPFR support does not) + +@item PDF extension @item PostgreSQL extension @item -MPFR library extension -(this provides access to a number of MPFR functions that @command{gawk}'s -native MPFR support does not) +Redis extension @item -Redis extension +Select extension @item XML parser extension, using the @uref{http://expat.sourceforge.net, Expat} @@ -34648,6 +35044,10 @@ Indirect function calls @item Directories on the command line produce a warning and are skipped (@pxref{Command-line directories}) + +@item +Output with @code{print} and @code{printf} need not be fatal +(@pxref{Nonfatal}) @end itemize @item @@ -34735,6 +35135,11 @@ The @code{isarray()} function to check if a variable is an array or not The @code{bindtextdomain()}, @code{dcgettext()}, and @code{dcngettext()} functions for internationalization (@pxref{Programmer i18n}) + +@item +The @code{intdiv()} function for doing integer +division and remainder +(@pxref{Numeric Functions}) @end itemize @item @@ -34867,6 +35272,16 @@ for @command{gawk} @value{PVERSION} 4.1: Ultrix @end itemize +@item +Support for the following systems was removed from the code +for @command{gawk} @value{PVERSION} 4.2: + +@c nested table +@itemize @value{MINUS} +@item +MirBSD +@end itemize + @end itemize @c XXX ADD MORE STUFF HERE @@ -35493,6 +35908,41 @@ Support for Ultrix was removed. @end itemize +Version 4.2 introduced the following changes: + +@itemize @bullet +@item +Changes to @code{ENVIRON} are reflected into @command{gawk}'s +environment and that of programs that it runs. +@xref{Auto-set}. + +@item +The @option{--pretty-print} option no longer runs the @command{awk} +program too. +@xref{Options}. + +@item +The @command{igawk} program and its manual page are no longer +installed when @command{gawk} is built. +@xref{Igawk Program}. + +@item +The @code{intdiv()} function. +@xref{Numeric Functions}. + +@item +The maximum number of hexdecimal digits in @samp{\x} escapes +is now two. +@xref{Escape Sequences}. + +@item +Nonfatal output with @code{print} and @code{printf}. +@xref{Nonfatal}. + +@item +Support for MirBSD was removed. +@end itemize + @c XXX ADD MORE STUFF HERE @end ifclear @@ -36157,6 +36607,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 @@ -36201,8 +36653,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 @@ -36213,6 +36663,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. @@ -36244,6 +36700,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 @@ -36324,6 +36781,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 |