gawk: Distribution contents

1 
1 B.1.3 Contents of the 'gawk' Distribution
1 -----------------------------------------
1 
1 The 'gawk' distribution has a number of C source files, documentation
1 files, subdirectories, and files related to the configuration process
1 (⇒Unix Installation), as well as several subdirectories related
1 to different non-Unix operating systems:
1 
1 Various '.c', '.y', and '.h' files
1      These files contain the actual 'gawk' source code.
1 
1 'support/*'
1      C header and source files for routines that 'gawk' uses, but that
1      are not part of its core functionality.  For example, argument
1      parsing, regular expression matching, and random number generating
1      routines are all kept here.
1 
1 'ABOUT-NLS'
1      A file containing information about GNU 'gettext' and translations.
1 
1 'AUTHORS'
1      A file with some information about the authorship of 'gawk'.  It
1      exists only to satisfy the pedants at the Free Software Foundation.
1 
1 'README'
1 'README_d/README.*'
1      Descriptive files: 'README' for 'gawk' under Unix and the rest for
1      the various hardware and software combinations.
1 
1 'INSTALL'
1      A file providing an overview of the configuration and installation
1      process.
1 
1 'ChangeLog'
1      A detailed list of source code changes as bugs are fixed or
1      improvements made.
1 
1 'ChangeLog.0'
1      An older list of source code changes.
1 
1 'NEWS'
1      A list of changes to 'gawk' since the last release or patch.
1 
1 'NEWS.0'
1      An older list of changes to 'gawk'.
1 
1 'COPYING'
1      The GNU General Public License.
1 
1 'POSIX.STD'
1      A description of behaviors in the POSIX standard for 'awk' that are
1      left undefined, or where 'gawk' may not comply fully, as well as a
1      list of things that the POSIX standard should describe but does
1      not.
1 
1 'doc/awkforai.txt'
1      Pointers to the original draft of a short article describing why
1      'gawk' is a good language for artificial intelligence (AI)
1      programming.
1 
1 'doc/bc_notes'
1      A brief description of 'gawk''s "byte code" internals.
1 
1 'doc/README.card'
1 'doc/ad.block'
1 'doc/awkcard.in'
1 'doc/cardfonts'
1 'doc/colors'
1 'doc/macros'
1 'doc/no.colors'
1 'doc/setter.outline'
1      The 'troff' source for a five-color 'awk' reference card.  A modern
1      version of 'troff' such as GNU 'troff' ('groff') is needed to
1      produce the color version.  See the file 'README.card' for
1      instructions if you have an older 'troff'.
1 
1 'doc/gawk.1'
1      The 'troff' source for a manual page describing 'gawk'.  This is
1      distributed for the convenience of Unix users.
1 
1 'doc/gawktexi.in'
1 'doc/sidebar.awk'
1      The Texinfo source file for this Info file.  It should be processed
1      by 'doc/sidebar.awk' before processing with 'texi2dvi' or
1      'texi2pdf' to produce a printed document, and with 'makeinfo' to
1      produce an Info or HTML file.  The 'Makefile' takes care of this
1      processing and produces printable output via 'texi2dvi' or
1      'texi2pdf'.
1 
1 'doc/gawk.texi'
1      The file produced after processing 'gawktexi.in' with
1      'sidebar.awk'.
1 
1 'doc/gawk.info'
1      The generated Info file for this Info file.
1 
1 'doc/gawkinet.texi'
1      The Texinfo source file for *note(General Introduction, gawkinet,
1      TCP/IP Internetworking with 'gawk')Top::.  It should be processed
1      with TeX (via 'texi2dvi' or 'texi2pdf') to produce a printed
1      document and with 'makeinfo' to produce an Info or HTML file.
1 
1 'doc/gawkinet.info'
1      The generated Info file for 'TCP/IP Internetworking with 'gawk''.
1 
1 'doc/igawk.1'
1      The 'troff' source for a manual page describing the 'igawk' program
1      presented in ⇒Igawk Program.  (Since 'gawk' can do its own
1      '@include' processing, neither 'igawk' nor 'igawk.1' are
1      installed.)
1 
1 'doc/it/*'
1      Files for the Italian translation of this Info file, produced and
1      contributed by Antonio Colombo and Marco Curreli.
1 
1 'doc/Makefile.in'
1      The input file used during the configuration process to generate
1      the actual 'Makefile' for creating the documentation.
1 
1 'Makefile.am'
1 '*/Makefile.am'
1      Files used by the GNU Automake software for generating the
1      'Makefile.in' files used by Autoconf and 'configure'.
1 
1 'Makefile.in'
1 'aclocal.m4'
1 'bisonfix.awk'
1 'config.guess'
1 'configh.in'
1 'configure.ac'
1 'configure'
1 'custom.h'
1 'depcomp'
1 'install-sh'
1 'missing_d/*'
1 'mkinstalldirs'
1 'm4/*'
1      These files and subdirectories are used when configuring and
1      compiling 'gawk' for various Unix systems.  Most of them are
1      explained in ⇒Unix Installation.  The rest are there to
1      support the main infrastructure.
1 
1 'po/*'
1      The 'po' library contains message translations.
1 
1 'awklib/extract.awk'
1 'awklib/Makefile.am'
1 'awklib/Makefile.in'
1 'awklib/eg/*'
11      The 'awklib' directory contains a copy of 'extract.awk' (⇒
      Extract Program), which can be used to extract the sample
1      programs from the Texinfo source file for this Info file.  It also
1      contains a 'Makefile.in' file, which 'configure' uses to generate a
1      'Makefile'.  'Makefile.am' is used by GNU Automake to create
11      'Makefile.in'.  The library functions from ⇒Library
      Functions, are included as ready-to-use files in the 'gawk'
1      distribution.  They are installed as part of the installation
1      process.  The rest of the programs in this Info file are available
1      in appropriate subdirectories of 'awklib/eg'.
1 
1 'extension/*'
1      The source code, manual pages, and infrastructure files for the
11      sample extensions included with 'gawk'.  ⇒Dynamic
      Extensions, for more information.
1 
1 'extras/*'
1      Additional non-essential files.  Currently, this directory contains
1      some shell startup files to be installed in '/etc/profile.d' to aid
1      in manipulating the 'AWKPATH' and 'AWKLIBPATH' environment
1      variables.  ⇒Shell Startup Files, for more information.
1 
1 'posix/*'
1      Files needed for building 'gawk' on POSIX-compliant systems.
1 
1 'pc/*'
11      Files needed for building 'gawk' under MS-Windows (⇒PC
      Installation for details).
1 
1 'vms/*'
11      Files needed for building 'gawk' under Vax/VMS and OpenVMS (⇒
      VMS Installation for details).
1 
1 'test/*'
1      A test suite for 'gawk'.  You can use 'make check' from the
1      top-level 'gawk' directory to run your version of 'gawk' against
1      the test suite.  If 'gawk' successfully passes 'make check', then
1      you can be confident of a successful port.
1