6.4 Installing AutoGen

There are several files that get installed. The number depend whether or not both shared and archive libraries are to be installed. The following assumes that everything is installed relative to $prefix. You can, of course, use configure to place these files where you wish.

NB AutoGen does not contain any compiled-in path names. All support directories are located via option processing, the environment variable HOME or finding the directory where the executable came from.

The installed files are:

1. The executables in `bin' (autogen, getdefs and columns).
2. The AutoOpts link libraries as `lib/libopts.*'.
3. An include file in `include/options.h', needed for Automated Option Processing (see next chapter).
4. Several template files and a scheme script in `share/autogen', needed for Automated Option Processing (see section Automated Option Processing), parsing definitions written with scheme syntax (see section Dynamic Text), the templates for producing documentation for your program (see section Man and Info doc Attributes), autoconf test macros, and AutoFSM.
5. Info-style help files as `info/autogen.info*'. These files document AutoGen, the option processing library AutoOpts, and several add-on components.
6. The three man pages for the three executables are installed in man/man1.

This program, library and supporting files can be installed with three commands:

• <src-dir>/configure [ <configure-options> ]
• make
• make install

However, you may wish to insert make check before the make install command.

If you do perform a make check and there are any failures, you will find the results in <module>/test/FAILURES. Needless to say, I would be interested in seeing the contents of those files and any associated messages. If you choose to go on and analyze one of these failures, you will need to invoke the test scripts individually. You may do so by specifying the test (or list of test) in the TESTS make variable, thus:

gmake TESTS=test-name.test check

I specify gmake because most makes will not let you override internal definitions with command line arguments. gmake does.

All of the AutoGen tests are written to honor the contents of the VERBOSE environment variable. Normally, any commentary generated during a test run is discarded unless the VERBOSE environment variable is set. So, to see what is happening during the test, you might invoke the following with bash or ksh:

VERBOSE=1 gmake TESTS="for.test forcomma.test" check

Or equivalently with csh:

env VERBOSE=1 gmake TESTS="for.test forcomma.test" check

This document was generated by Bruce Korb on September, 30 2006 using texi2html 1.76.