getdefs(1) | User Commands | getdefs(1) |
getdefs - AutoGen Definition Extraction Tool
getdefs [option-name value]
All arguments are named options.
If no input argument is provided or is set to simply "-", and if stdin is not a tty, then the list of input files will be read from stdin.
This program extracts AutoGen definitions from a list of source files. Definitions are delimited by /*=<entry-type> <entry-name>0fP and =*/0fP.
If you want definitions only from a particular category, or even with names matching particular patterns, then specify this regular expression for the text that must follow the /*=.
This option is used to create shorthand entries for nested definitions. For example, with:
using subblock thus --subblock=arg=argname,type,null
and defining an arg thus arg: this, char *
will then expand to: arg = { argname = this; type =
"char *"; @;}
The "this, char *" string is separated at the commas, with the
white space removed. You may use characters other than commas by
starting the value string with a punctuation character other than a
single or double quote character. You may also omit intermediate values
by placing the commas next to each other with no intervening white
space. For example, "+mumble++yes+" will expand to:
arg = { argname = mumble; null = "yes"; @;}.
This option is used to create shorthand entries for
definitions that generally appear several times. That is, they tend to
be a list of values. For example, with:
listattr=foo defined, the text:
foo: this, is, a, multi-list will then expand to:
foo = 'this', 'is', 'a', 'multi-list';
The texts are separated by the commas, with the white space removed. You
may use characters other than commas by starting the value string with a
punctuation character other than a single or double quote character.
By default, ordering is alphabetical by the entry name. Use, no-ordering if order is unimportant. Use ordering with no argument to order without case sensitivity. Use ordering=<file-name> if chronological order is important. getdefs will maintain the text content of file-name. file-name need not exist.
By default, the first occurrence of a named definition will have an index of zero. Sometimes, that needs to be a reserved value. Provide this option to specify a different starting point.
Inserts the name of each input file into the output definitions. If no argument is supplied, the format will be:
If an argument is supplied, that string will be used for the entry name instead of infile.
infile = '%s';
The argument to each copy of this option will be inserted into the output definitions, with only a semicolon attached.
The argument to each copy of this option will be inserted into each output definition, with only a semicolon attached.
The content of each file named by these options will be inserted into the output definitions.
Inserts the name of the input file where a definition was found into the output definition. If no argument is supplied, the format will be:
If an argument is supplied, that string will be used for the entry name instead of srcfile.
srcfile = '%s';
Inserts the line number in the input file where a definition was found into the output definition. If no argument is supplied, the format will be:
If an argument is supplied, that string will be used for the entry name instead of linenum.
linenum = '%s';
All files that are to be searched for definitions must be named on the command line or read from stdin. If there is only one input option and it is the string, "-", then the input file list is read from stdin. If a command line argument is not an option name and does not contain an assignment operator (=), then it defaults to being an input file name. At least one input file must be specified.
If you are not sending the output to an AutoGen process, you may name an output file instead.
This is the default output mode. Specifying no-autogen is equivalent to output=-. If you supply an argument to this option, that program will be started as if it were AutoGen and its standard in will be set to the output definitions of this program.
Specifies the template name to be used for generating the final output.
This is a pass-through argument. It allows you to specify any arbitrary argument to be passed to AutoGen.
When output is going to AutoGen, a base name must either be supplied or derived. If this option is not supplied, then it is taken from the template option. If that is not provided either, then it is set to the base name of the current directory.
Any option that is not marked as not presettable may be preset by loading values from configuration ("RC" or ".INI") file(s). The homerc file is "/dev/null", unless that is a directory. In that case, the file ".getdefsrc" is searched for within that directory.
See OPTION PRESETS for configuration files.
One of the following exit values will be returned:
This program is documented more fully in the Getdefs section of the Add-On chapter in the AutoGen Info system documentation.
Bruce Korb
Copyright (C) 1999-2018 Bruce Korb all rights reserved. This program is released under the terms of the GNU General Public License, version 3 or later.
Please send bug reports to: autogen-users@lists.sourceforge.net
This manual page was AutoGen-erated from the getdefs option definitions.
2022-05-24 | GNU AutoGen (1.5) |