itchconfig Documentation
Reserved File Names and Identifiers
Introduction
itchconfig reserves certain file name and identifier patterns for current or
future use. To avoid problems, you should not use such file names and
identifiers otherwise in your software package.
Reserved file name pattern: config*
Reserved identifier patterns in configure.base files (and thus configure
script files): ic*, IC*, _ic*, _IC*, __ic*, __IC* etc.; i_*, _i_*, __i_*
etc.
Reserved identifier and line-begin pattern in source code files: __IC*
File Names
Currently, reserved file names are (resp. can be) used as follows:
- config.h: the C configuration header file, as specified with IC_BEGIN; generated by
configure.act
- config.guess, config.sub: shell scripts to guess a canonical system name;
can be found on ftp.gnu.org and
used e.g. with IC_SUBSTITUTE_OUTPUT or IC_EMIT_SH
- configure: a configuration shell script for a software package; generated
by itchconfig (via configure.pl) from configure.base
- configure.act: configured actions for a software package; generated by
configure
- configure.base: a package configuration base file; written by developers of
software packages
- configure.log: contains logging and debugging messages; generated by
configure when configure in turn has been generated with logging/debugging
enabled
- configure.pl: a temporary Perl script which generates the final configure
script; generated by itchconfig
- configure.scan: a starting point for a configure.base file; generated by
itchscan
- configure.site: user-site specific
configuration initializations; written by users of software packages
- configure.subst: a temporary file for identifier substitutions in ".in"
files; generated by configure.act
Identifiers in configure Scripts
For itchconfig's internal algorithms, identifiers in configure scripts are
mostly used as follows; the "mostly" will vanish in one of the next
versions.
- ic_...: for permanent, longer-term values; "ic" is the abbr. for
"itchconfig"
- i_...: for intermediary, temporary values; "i" is the abbr. for
"intermediary"
- several environment variables
This documentation file is part of version 0.0.4 of itchconfig, a configuration tool
created by Arne Thomaßen. itchconfig is basically
released under certain versions of the GNU General Public License and WITHOUT
ANY WARRANTY. Copyright (C) 2002 Arne Thomaßen.