5.1 autogen help/usage (‘--help’)

This is the automatically generated usage text for autogen.

The text printed is the same whether selected with the help option
(‘--help’) or the more-help option (‘--more-help’). more-help will print
the usage text by passing it through a pager program.
more-help is disabled on platforms without a working
fork(2) function. The PAGER environment variable is
used to select the program, defaulting to ‘more’. Both will exit
with a status code of 0.

autogen (GNU AutoGen) - The Automated Program Generator - Ver. 5.18.4
Usage: autogen [ -<flag> [<val>] | --<name>[{=| }<val>] ]... [ <def-file> ]
The following options select definitions, templates and scheme functions
to use:
Flg Arg Option-Name Description
-L Str templ-dirs Search for templates in DIR
- may appear multiple times
-T Str override-tpl Use TPL-FILE for the template
- may not be preset
Str definitions Read definitions from FILE
- disabled as '--no-definitions'
- enabled by default
- may not be preset
Str shell name or path name of shell to use
-m no no-fmemopen Do not use in-mem streams
Str equate characters considered equivalent
The following options modify how output is handled:
Flg Arg Option-Name Description
-b Str base-name Specify NAME as the base name for output
- may not be preset
no source-time set mod times to latest source
- disabled as '--no-source-time'
no writable Allow output files to be writable
- disabled as '--not-writable'
The following options are often useful while debugging new templates:
Flg Arg Option-Name Description
Num loop-limit Limit on increment loops
- is scalable with a suffix: k/K/m/M/g/G/t/T
- it must lie in one of the ranges:
-1 exactly, or
1 to 16777216
-t Num timeout Limit server shell operations to SECONDS
- it must be in the range:
0 to 3600
KWd trace tracing level of detail
Str trace-out tracing output file or filter
no show-defs Show the definition tree
- may not be preset
no used-defines Show the definitions used
- may not be preset
-C no core Leave a core dump on a failure exit
These options can be used to control what gets processed in the
definitions files and template files:
Flg Arg Option-Name Description
-s Str skip-suffix Skip the file with this SUFFIX
- prohibits the option 'select-suffix'
- may not be preset
- may appear multiple times
-o Str select-suffix specify this output suffix
- may not be preset
- may appear multiple times
-D Str define name to add to definition list
- may appear multiple times
-U Str undefine definition list removal pattern
- an alternate for 'define'
This option is used to automate dependency tracking:
Flg Arg Option-Name Description
-M opt make-dep emit make dependency file
- may not be preset
- may appear multiple times
help, version and option handling:
Flg Arg Option-Name Description
-R Str reset-option reset an option's state
-v opt version output version information and exit
-? no help display extended usage information and exit
-! no more-help extended usage information passed thru pager
-u no usage abbreviated usage to stdout
-> opt save-opts save the option state to a config file
-< Str load-opts load options from a config file
- disabled as '--no-load-opts'
- may appear multiple times
Options are specified by doubled hyphens and their name or by a single
hyphen and the flag character.
AutoGen creates text files from templates using external definitions.
The following option preset mechanisms are supported:
- reading file $HOME
- reading file ./.autogenrc
- examining environment variables named AUTOGEN_*
The valid "trace" option keywords are:
nothing debug-message server-shell templates block-macros
expressions everything
or an integer from 0 through 6
AutoGen is a tool designed for generating program files that contain
repetitive text with varied substitutions.
Packaged by Bruce (2014-08-30)
Report autogen bugs to bkorb@gnu.org