B.1.3 Contents of the gawk Distribution

The gawk distribution has a number of C source files, documentation files, subdirectories, and files related to the configuration process (see section Compiling and Installing gawk on Unix-like Systems), as well as several subdirectories related to different non-Unix operating systems:

Various ‘.c’, ‘.y’, and ‘.h’ files

The actual gawk source code.

‘README’

‘README_d/README.*’

Descriptive files: ‘README’ for gawk under Unix and the rest for the various hardware and software combinations.

‘INSTALL’

A file providing an overview of the configuration and installation process.

‘ChangeLog’

A detailed list of source code changes as bugs are fixed or improvements made.

‘ChangeLog.0’

An older list of source code changes.

‘NEWS’

A list of changes to gawk since the last release or patch.

‘NEWS.0’

An older list of changes to gawk.

‘COPYING’

The GNU General Public License.

‘FUTURES’

A brief list of features and changes being contemplated for future releases, with some indication of the time frame for the feature, based on its difficulty.

‘LIMITATIONS’

A list of those factors that limit gawk’s performance. Most of these depend on the hardware or operating system software and are not limits in gawk itself.

‘POSIX.STD’

A description of behaviors in the POSIX standard for awk which are left undefined, or where gawk may not comply fully, as well as a list of things that the POSIX standard should describe but does not.

‘doc/awkforai.txt’

A short article describing why gawk is a good language for Artificial Intelligence (AI) programming.

‘doc/bc_notes’

A brief description of gawk’s “byte code” internals.

‘doc/README.card’

‘doc/ad.block’

‘doc/awkcard.in’

‘doc/cardfonts’

‘doc/colors’

‘doc/macros’

‘doc/no.colors’

‘doc/setter.outline’

The troff source for a five-color awk reference card. A modern version of troff such as GNU troff (groff) is needed to produce the color version. See the file ‘README.card’ for instructions if you have an older troff.

‘doc/gawk.1’

The troff source for a manual page describing gawk. This is distributed for the convenience of Unix users.

‘doc/gawk.texi’

The Texinfo source file for this Web page. It should be processed with TeX (via texi2dvi or texi2pdf) to produce a printed document, and with makeinfo to produce an Info or HTML file.

‘doc/gawk.info’

The generated Info file for this Web page.

‘doc/gawkinet.texi’

The Texinfo source file for TCP/IP Internetworking with gawk. It should be processed with TeX (via texi2dvi or texi2pdf) to produce a printed document and with makeinfo to produce an Info or HTML file.

‘doc/gawkinet.info’

The generated Info file for TCP/IP Internetworking with gawk.

‘doc/igawk.1’

The troff source for a manual page describing the igawk program presented in An Easy Way to Use Library Functions.

‘doc/Makefile.in’

The input file used during the configuration process to generate the actual ‘Makefile’ for creating the documentation.

‘Makefile.am’

‘*/Makefile.am’

Files used by the GNU automake software for generating the ‘Makefile.in’ files used by autoconf and configure.

‘Makefile.in’

‘aclocal.m4’

‘configh.in’

‘configure.ac’

‘configure’

‘custom.h’

‘missing_d/*’

‘m4/*’

These files and subdirectories are used when configuring gawk for various Unix systems. They are explained in Compiling and Installing gawk on Unix-like Systems.

‘po/*’

The ‘po’ library contains message translations.

‘awklib/extract.awk’

‘awklib/Makefile.am’

‘awklib/Makefile.in’

‘awklib/eg/*’

The ‘awklib’ directory contains a copy of ‘extract.awk’ (see section Extracting Programs from Texinfo Source Files), which can be used to extract the sample programs from the Texinfo source file for this Web page. It also 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 A Library of awk Functions, and the igawk program from An Easy Way to Use Library 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 Web page are available in appropriate subdirectories of ‘awklib/eg’.

‘posix/*’

Files needed for building gawk on POSIX-compliant systems.

‘pc/*’

Files needed for building gawk under MS-Windows and OS/2 (see section Installation on PC Operating Systems, for details).

‘vms/*’

Files needed for building gawk under VMS (see section How to Compile and Install gawk on VMS, for details).

‘test/*’

A test suite for gawk. You can use ‘make check’ from the top-level gawk directory to run your version of gawk against the test suite. If gawk successfully passes ‘make check’, then you can be confident of a successful port.