| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
AutoOpts 19.0 is bundled with AutoGen. It is a tool that virtually eliminates the hassle of processing options and keeping man pages, info docs and usage text up to date. This package allows you to specify several program attributes, up to a hundred option types and many option attributes. From this, it then produces all the code necessary to parse and handle the command line and initialization file options, and the documentation that should go with your program as well.
AutoOpts is distributed under The GNU Lesser General Public License. "Lesser" meaning you have greater license with it and may link it into commercial programs.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
AutoOpts supports option processing; option state saving; and program documentation with innumerable features. Here, we list a few obvious ones and some important ones, but the full list is really defined by all the attributes defined in the 7.3 Option Definitions section.
dis-abled with a disablement prefix.
Such options may default to either an enabled or a disabled state. You
may also provide an enablement prifix, too, e.g., --allow-mumble
and --prevent-mumble.
--help and --version are automatically supported.
--more-help will page the generated help.
main() routines can take advantage of all of AutoOpts' functionality.
test-main is defined, the output `.c' file will contain a
main routine that will be compiled when TEST_<prog-name>_OPTS is
defined. See section 7.7 AutoOpts for Shell Scripts. If you choose to compile this program,
it is currently capable of producing one of three results:
test-main may specify a routine that will be called with a
pointer to the option descriptions as the single argument. You must
supply this routine and, obviously, you can cause it to do whatever you
wish it to do.
#include-d into the client option definitions
and they specify an "anchor" option that has a callback and must be invoked.
That will give the library access to the option state for their options.
gnu-usage attribute (see section 7.3.3 Program Information Attributes).
This can be overridden by the user himself with the
AUTOOPTS_USAGE environment variable. If it exists and is set
to the string gnu, it will force GNU-ish style format; if it is
set to the string autoopts, it will force AutoOpts standard
format; otherwise, it will have no effect.
Explanatory details:
loading rc files saving rc files process a text string for options
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
homerc (see section 7.3.1 Program Description Attributes). The initialization values
are identified by the long option name followed by white space and any
associated value. The value, if any, will continue through the end of
the last line not continued with a backslash. Leading and trailing
white space is stripped.
Initialization files are selected both by the homerc entries and,
optionally, via an automatically supplied command line option. The
first component of the homerc entry may be an environment
variable such as $HOME, or it may also be $$ (two
dollar sign characters) to specify the directory of the executable.
For example:
homerc = "$$/../share/autogen"; |
will cause the AutoOpts library to look in the normal autogen datadir for an initialization file.
The initialization files are processed in the order they are specified
by the homerc attribute, so that each new file will normally
override the settings of the previous files. A few options may be
marked for immediate action (see section 7.3.4.4 Immediate Action Attributes). Any such
options are acted upon in reverse order. The disabled
load-opts (--no-load-opts) option, for example, is an
immediate action option. Its presence in the last homerc file
will prevent the processing of any prior homerc files.
Further initialization file processing can be suppressed by
specifying --no-load-opts on the command line, or
PROGRAM_LOAD_OPTS=no in the environment, or no-load-opts
in any of the specified homerc files.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
--save-opts option.
All of the known option state will be written to either the specified
output file or, if it is not specified, then to the last specified
homerc file.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
The optionLoadLine takes two arguments:
Leading and trailing white space is trimmed from the value, but otherwise new lines are not discarded. The caller is expected to have NUL terminated the string at the correct point.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Since it is generally easier to start with a simple example than it is
to look at the options that AutoGen uses itself, here is a very simple
AutoOpts example. You can copy this example out of the Info file and
into a source file to try it. You can then embellish it into what you
really need. For more extensive examples, you can also examine the help
output and option definitions for the commands columns,
getdefs and autogen itself.
For our simple example, assume you have a program named check
that takes two options:
check does.
You want this option available as a POSIX-style flag option
and a GNU long option. You want to allow as many of these
as the user wishes.
First, specify your program attributes and its options to AutoOpts, as with the following example.
AutoGen Definitions options;
prog-name = check;
prog-title = "Checkout Automated Options";
long-opts;
test_main;
flag = {
name = check_dirs;
value = L; /* flag style option character */
arg_type = string; /* option argument indication */
max = NOLIMIT; /* occurrence limit (none) */
stack_arg; /* save opt args in a stack */
descrip = "Checkout directory list";
};
flag = {
name = show_defs;
descrip = "Show the definition tree";
disable = dont; /* mark as enable/disable type */
/* option. Disable as `dont-' */
};
|
Then perform the following steps:
autogen checkopt.def
cc -o check -DTEST_CHECK_OPTS -g checkopt.c -L $prefix/lib -lopts
And now, ./check --help yields:
check - Checkout Automated Options
USAGE: check [-<flag> [<val>]]... [--<name>[{=| }<val>]]...
Flg Arg Option-Name Description
-L YES check-dirs Checkout directory list
- may appear without limit
no show-defs Show the definition tree
- disabled as --dont-show-defs
-? no help Display usage information and exit
-! no more-help Extended usage information passed thru pager
Options may be specified by doubled markers and their name
or by a single marker and the flag character/option value.
|
Normally, however, you would compile `checkopt.c' as in:
cc -o checkopt.o -I$prefix/include -c checkopt.c |
and link `checkopt.o' with the rest of your program.
The main program causes the options to be processed
by calling optionProcess (see section 7.4.28.3 optionProcess):
main( int argc, char** argv )
{
{
int optct = optionProcess( &checkOptions, argc, argv );
argc -= optct;
argv += optct;
}
|
The options are tested and used as in the following fragment:
if (HAVE_OPT( SHOW_DEFS ) && HAVE_OPT( CHECK_DIRS )) {
int dirct = STACKCT_OPT( CHECK_DIRS );
char** dirs = STACKLST_OPT( CHECK_DIRS );
while (dirct-- > 0) {
char* dir = *dirs++;
...
|
A lot of magic happens to make this happen. The rest of this chapter will describe the myriad of option attributes supported by AutoOpts. However, keep in mind that, in general, you won't need much more than what was described in this "quick start" section.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
AutoOpts uses an AutoGen definitions file for the definitions of the program options and overall configuration attributes. The complete list of program and option attributes is quite extensive, so if you are reading to understand how to use AutoOpts, I recommend reading the "Quick Start" section (see section 7.2 Quick Start) and paying attention to the following:
prog-name, prog-title, and argument, program
attributes, See section 7.3.1 Program Description Attributes.
name and descrip option attributes, See section 7.3.4.1 Required Attributes.
value (flag character) and min (occurrence counts)
option attributes, See section 7.3.4.2 Common Option Attributes.
arg-type from the option argument specification section,
See section 7.3.4.6 Option Argument Specification.
Keep in mind that the majority are rarely used and can be safely ignored. However, when you have special option processing requirements, the flexibility is there.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
The following global definitions are used to define attributes of the entire program. These generally alter the configuration or global behavior of the AutoOpts option parser. The first two are required of every program. The rest have been alphabetized. Except as noted, there may be only one copy of each of these definitions:
string->c_name! (see section 3.5.47 `string->c-name!' - map non-name chars to underscore).
ERRSKIP_OPTERR and ERRSTOP_OPTERR from the
generated interface file.
[), then there is no requirement on the presence or
absence of command line argument following the options. Lastly, if it
is supplied and does not start with an open bracket, then option
processing must not consume all of the command line arguments.
PROGRAM_OPTNAME, where PROGRAM is the upper cased
C-name of the program and OPTNAME is the upper cased
C-name of the option. The C-names are the regular
names with all special characters converted to underscores (_).
If a particular option may be disabled, then its disabled state
is indicated by setting the value to the disablement prefix.
So, for example, if the disablement prefix were dont, then
you can disable the optname option by setting the
PROGRAM_OPTNAME' environment variable to `dont'.
See section 7.3.4.2 Common Option Attributes.
#include directives required by
flag_code text and shared with other program text.
Do not specify your configuration header (`config.h') in this
attribute or the include attribute, however. Instead, use
config-header, below.
.
or `/usr/local/share/progname') or an environment variable (like
`$HOME/rc/' or `$PREFIX/share/progname') or the directory
where the executable was found (`$$[/...]') to use to try to find
the rcfile. Use as many as you like. The presence of this attribute
activates the --save-opts and --load-opts options.
See section loading rc files.
flag_code program text.
long-opts. If
none of your options specify an option value (flag character) and you do
not specify long-opts, then command line arguments are processed
in "named option mode". This means that:
- and -- are completely optional.
argument program attribute is disallowed.
homerc attribute.
default: .<prog-name>rc
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
AutoOpts can generate the main procedure in certain circumstances. It will do this to help with integrating with the guile library environment, and for creating a program to convert command line options into environment variables for use in processing shell script options and for testing the command line interface.
guile-main has been specified and if this is specified
as well, then this code will be inserted into the actual main()
procedure before gh_enter() is called.
optionProcess() and will
invoke any code specified by this attribute. If this attribute
does not specify any code, then calls to the AutoOpts library procedure
export_options_to_guile() and then scm_shell() will
be inserted into inner_main().
int main( int argc, char** argv ) {
[+ main-text +]
return EXIT_SUCCESS;
}
|
test-main is short (3 or fewer characters), the
generated main() will call putBourneShell. That routine will emit
Bourne shell commands that can be eval-ed by a Bourne-derived shell to
incorporate the digested options into the shell's environment,
See section 7.7 AutoOpts for Shell Scripts. You would use it thus:
eval "`./programopts $@`"
test -z "${OPTION_CT}" ] && exit 1
test ${OPTION_CT} -gt 0 && shift ${OPTION_CT}
|
test-main contains putShellParse, the
program will generate portable Bourne shell commands that will parse the
command line options. The expectation is that this result will be
copied into a shell script and used there, See section 7.7 AutoOpts for Shell Scripts.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
These attributes are used to define how and what information is displayed to the user of the program.
copyright is a structured value containing three to five
values. If copyright is used, then the first three are required.
copyright = {
date = "1992-2003";
owner = "Bruce Korb";
eaddr = 'bkorb@gnu.org';
type = GPL;
};
|
settable. The library client program will invoke the
SET_OPTION macro which will invoke a handler function that will
finally set these global variables.
Every RC file will be considered partitioned by lines that commence with
the square open bracket ([). All text before such a line is
always processed. Once such a line is found, the upper-cased
c-variable-syntax program name will be compared against the text
following that bracket. If there is a match and the next character
after that is a square close bracket (]), then the section is
processed and the file closed. Otherwise, the section is ignored and a
matching section is searched for.
For exampe, if the fumble-stumble options had a sectioned RC file,
then a line containing [FUMBLE_STUMBLE] would be searched for.
optionUsage() does not work for you. If you specify
gnu_usage as the value of this attribute, for example,
you will use a procedure by that name for displaying usage.
Of course, you will need to provide that procedure.
optionUsage procedure
is AutoOpts Standard. By specifying this attribute, the default format
will be GNU-ish style. Either default may be overridden by the user with
the AUTOOPTS_USAGE environment variable. If it is set to gnu
or autoopts, it will alter the style appropriately. This attribute
will conflict with the usage attribute.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
For each option you wish to specify, you must have a block macro named
flag defined. There are two required attributes: name and
descrip. If any options do not have a value (traditional flag
character) attribute, then the long-opts global text macro must also
be defined. As a special exception, if no options have a value
and long-opts is not defined and argument is
not defined, then all arguments to the program are named. In this case, the
- and -- command line option markers are optional.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Every option must have exactly one copy of both of these attributes.
usage() output next to the option name. If, however, the
option is a documentation option, it will appear on one or more lines by
itself. It is thus used to visually separate and comment upon groups of
options in the usage text.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
These option attributes are optional. Any that do appear in the definition of a flag, may appear only once.
-L.
mumble that is indicated
with the compile time define, WITH_MUMBLING, then add:
ifdef = WITH_MUMBLING; |
Note that case and spelling must match whatever you are using. Do not confuse these attributes with the AutoGen directives of the same names, See section 2.5 Controlling What Gets Processed. These cause C pre-processing directives to be inserted into the generated C text.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
These option attributes do not fit well with other categories.
TEMPL_DIRS is a settable option for AutoGen, so a macro named
SET_OPT_TEMPL_DIRS(a) appears in the interface file. This
attribute interacts with the documentation attribute.
For an option equivalence class, there is a single occurrence counter for all the members of the class. All members of the equivalence class must contain the same equivalenced-to option, including the equivalenced-to option itself. Thus, it must be a member.
As an example, cpio(1) has three options -o, -i,
and -p that define the operational mode of the program
(create, extract and pass-through, respectively).
They form an equivalence class from which one and only one member must
appear on the command line. If cpio were an AutoOpt-ed program,
then each of these option definitions would contain:
equivalence = create; |
and the program would be able to determine the operating mode with code that worked something like this:
switch (WHICH_IDX_CREATE) {
case INDEX_OPT_CREATE: ...
case INDEX_OPT_EXTRACT: ...
case INDEX_OPT_PASS_THROUGH: ...
default: /* cannot happen */
}
|
If present, this option disables all other attributes except
settable, call_proc and flag_code. settable
must be and is only specified if call_proc or flag_code
has been specified. When present, the descrip attribute will be
displayed only when the --help option has been specified. It
will be displayed flush to the left hand margin and may consist of one
or more lines of text. The name of the option will not be printed.
Documentation options are for clarifying the usage text and will not appear in generated man pages or in the generated invoking texinfo doc.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Certain options may need to be processed early. For example, in order
to suppress the processing of RC files, it is necessary to process the
command line option --no-load-opts before the RC files
are processed. To accommodate this, certain options may have their
enabled or disabled forms marked for immediate processing. The
consequence of this is that they are processed ahead of all other
options in the reverse of normal order.
Normally, the first options processed are the options specified in the
first homerc file, followed by then next homerc file
through to the end of RC file processing. Next, environment variables
are processed and finally, the command line options. The later
options override settings processed earlier. That actually gives them
higher priority. Command line immediate action options actually have
the lowest priority of all. They would be used only if they are to have
an effect on the processing of subsequent options.
help and more-help
options are so specified. They will also call exit() upon
completion, so they do have an effect on the processing
of the remaining options :-).
load-opts option is
so specified. The --no-load-opts command line option will
suppress the processing of RC files and environment variables.
Contrariwise, the --load-opts command line option is
processed normally. That means that the options specified in that file
will be processed after all the homerc files and, in fact, after
options that precede it on the command line.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
These attributes may be used as many times as you need. They are used at the end of the option processing to verify that the context within which each option is found does not conflict with the presence or absence of other options.
This is not a complete cover of all possible conflicts and requirements, but it simple to implement and covers the more common situations.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Several attributes relate to the handling of arguments to options.
Each may appear only once, except for the arg-range attribute.
It may appear as often as may be needed.
arg-range section below for some considerations.
AutoOpts contains a library procedure to convert the string to a number.
If you specify range checking with arg-range, then AutoOpts
produces a special purpose procedure for this option.
f, F, n or N
(representing False or No). Anything else will be interpreted as True.
optn-name,
the strings will be converted into an enumeration of type te_Optn_Name
with the values OPTN_NAME_KEYWORD. If you have not
specified a default value, the value OPTN_NAME_UNDEFINED will be
inserted with the value zero. The option will be initialized to that
value. You may now use this in your code as follows:
te_Optn_Name opt = OPT_VALUE_OPTN_NAME;
switch (opt) {
case OPTN_NAME_UNDEFINED: /* undefined things */ break;
case OPTN_NAME_KEYWORD: /* `keyword' things */ break;
default: /* utterly impossible */ ;
}
|
AutoOpts produces a special purpose procedure for this option.
arg-type is keyword, then you must specify the
list of keywords by a series of keyword entries. The interface
file will contain an enumeration of <OPTN_NAME>_<KEYWORD> for
each keyword entry.
string or keyword. If it is keyword, then
this attribute may also specify the default keyword to assume when
the argument is not supplied. If left empty, arg-default or
the zero-valued keyword will be used.
arg-type
specified, but not the arg-optional attribute. That is to say,
the option argument must be required.
If you have done this, then any arguments that do not match an option
name and do not contain an equal sign (=) will be interpreted as
an option argument to the default option.
arg-type is number, then arg-ranges may be
specified, too. If you specify one or more of these option attributes,
then AutoOpts will create a callback procedure for handling it. The
argument value supplied for the option must match one of the range
entries. Each arg-range should consist of either an integer by itself
or an integer range. The integer range is specified by one or two
integers separated by the two character sequence, ->.
The generated procedure imposes some constraints:
INT_MIN,
both for obvious reasons and because
that value is used to indicate a single-valued match.
The usage procedure displays these ranges by calling the callback
with the pOptDesc pointer set to NULL. Therefore,
all callback procedures designed to handle options with numeric
arguments must be prepared to handle a call with that
pointer set NULL.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
AutoOpts will automatically generate a callback procedure for options with enumerated keyword arguments and numeric arguments with range checking. If you have specified such an option, you may not specify any of the attributes listed here.
Otherwise, you may pick zero or one of the following attributes.
The first two attributes interact with the documentation and
settable attributes, See section 7.3.4.3 Special Option Handling.
static void
doOpt<name>( tOptions* pOptions, tOptDesc* pOptDesc )
{
<flag_code>
}
|
Only certain fields within the tOptions and tOptDesc
structures may be accessed. See section 7.4.1 Data for Option Processing.
flag_code, except that the
source is kept in the output file instead of the definitions file.
A long comment is used to demarcate the code. You must not modify
that marker. Before regenerating the option code file,
the old file is renamed from MUMBLE.c to MUMBLE.c.save. The template
will be looking there for the text to copy into the new output file.
doOpt<name>. It has the same restrictions
regarding the fields within the structures passed in as arguments.
See section 7.4.1 Data for Option Processing.
flag_code can be executed
when this option is encountered.
STACKCT_OPT(NAME)) and to obtain a
pointer to a list of pointers to the argument values
(STACKLST_OPT(NAME)). Obviously, for a stackable argument,
the max attribute needs to be set higher than 1.
If two options are equivalenced (see section 7.3.4.3 Special Option Handling) and
specify this attribute, then the "equivalenced-to" option will add
entries to the stack, and the "equivalencing" option, if specified,
will remove entries that match the regular expression argument. The
pattern, ".*" will efficiently remove all the entries in the
stack. It would not be useful to have more than two options in this
equivalence class.
If the stacked option has a disablement prefix, then the entire
stack of arguments will be cleared even more efficiently than the
".*" regular expression. A stacked, equivalencing option with
a disablement prefix will cause undefined results.
If all of this is confusing, then don't mess with equivalenced stacked
option arguments. If you really want to know, the AutoGen --define
option (see section 5.20 define option (-D)) has a stacked argument, and --undefine
(see section 5.21 undefine option (-U)) is equivalenced to it.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
AutoOpts includes AutoGen templates for producing abbreviated man pages and for producing the invoking section of an info document. To take advantage of these templates, you must add several attributes to your option definitions.
flag definition other than "documentation"
definitions, must have a doc attribute defined. If the option takes
an argument, then it will need an arg-name attribute as well. The
doc text should be in plain sentences with minimal formatting. The
Texinfo commands @code, and @var will have its enclosed text
made into \fB entries in the man page, and the @file text
will be made into \fI entries. The arg-name attribute is
used to display the option's argument in the man page.
Options marked with the "documentation" attribute are for documenting the usage text. All other options should have the "doc" attribute in order to document the usage of the option in the generated man pages.
arg-type, but
it will likely be clearer with something else like, file-name
instead of string (the type).
detail definition, this may be sufficient.
If not, or if you need special formatting for one of the manual formats,
then you will need either a definition for prog-man-descrip or
prog-info-descrip or both. These will be inserted verbatim
in the man page document and the info document, respectively.
SEE ALSO or
USAGE or other, put that text in a man-doc definition. This
text will be inserted verbatim in the man page after the OPTIONS
section and before the AUTHOR section.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
AutoOpts provides automated support for five options. help and
more-help are always provided. version is provided if
version is defined in the option definitions See section 7.3.1 Program Description Attributes.
save-opts and load-opts are provided if at least
one homerc is defined See section 7.3.1 Program Description Attributes.
Below are the option names and flag values. The flags are activated if and
only if at least one user-defined option also uses a flag value. These
flags may be deleted or changed to characters of your choosing by specifying
xxx-value = "y";, where xxx is one of the five names below and
y is either empty or the character of your choice. For example, to
change the help flag from ? to h, specify help-value = "h";;
and to require that save-opts be specified only with its long
option name, specify save-opts-value = "";.
USAGE() procedure
and display the usage line, a description of each option with
its description and option usage information. This is followed
by the contents of the definition of the detail text macro.
help option, except that
it also includes the contents of the detail-file file
(if provided and found), plus the output is passed through
a pager program. (more by default, or the program identified
by the PAGER environment variable.)
c and a value for copyright and owner have
been provided, then the copyright will be printed, too. If it is followed
by the letter n, then the full copyright notice (if available) will
be printed.
The output file will be the RC/INI file name (default or provided by
rcfile) in the last directory named in a homerc definition.
This option may be set from within your program by invoking the
"SET_OPT_SAVE_OPTS(filename)" macro (see section 7.4.16 SET_OPT_name - Force an option to be set).
Invoking this macro will set the file name for saving the option processing
state, but the state will not actually be saved. You must call
optionSaveFile to do that (see section 7.4.28.5 optionSaveFile).
CAVEAT: if, after invoking this macro, you call
optionProcess, the option processing state will be saved to this file
and optionProcess will not return. You may wish to invoke
CLEAR_OPT( SAVE_OPTS ) (see section 7.4.2 CLEAR_OPT( <NAME> ) - Clear Option Markings) beforehand.
It is ultimately intended that specifying the option,
no-load-opts will suppress the processing of rc/ini files and
environment variables. To do this, AutoOpts must first implement
pre-scanning of the options, environment and rc files.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
AutoOpts has developed a set of standardized options.
You may incorporate these options in your program simply by first
adding a #define for the options you want, and then the line,
#include stdoptions.def |
in your option definitions. The supported options are specified thus:
#define DEBUG #define DIRECTORY #define DRY_RUN #define INPUT #define INTERACTIVE #define OUTPUT #define WARN #define SILENT #define QUIET #define BRIEF #define VERBOSE |
By default, only the long form of the option will be available.
To specify the short (flag) form, suffix these names with _FLAG.
e.g.,
#define DEBUG_FLAG |
--silent, --quiet, --brief and --verbose are
related in that they all indicate some level of diagnostic output.
These options are all designed to conflict with each other.
Instead of four different options, however, several levels can be
incorporated by #define-ing VERBOSE_ENUM. In conjunction
with VERBOSE, it incorporates the notion of 5 levels in an
enumeration: silent, quiet, brief,
informative and verbose; with the default being
brief.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
The user interface for access to the argument information is completely defined in the generated header file and in the portions of the distributed file "options.h" that are marked "public".
In the following macros, text marked <NAME> or name
is the name of the option in upper case and segmented
with underscores _. The macros and enumerations defined in the
options header (interface) file are used as follows:
To see how these #define macros are used in a program,
the reader is referred to the several `opts.h' files
included with the AutoGen sources.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
This section describes the data that may be accessed from within the
option processing callback routines. The following fields may be used
in the following ways and may be used for read only. The first set is
addressed from the tOptDesc* pointer:
OPTST_, e.g. OPTST_INIT):
SET_OPT() macro.
optionLoadLine() routine.
disabled.)
As an example of how this might be used, in AutoGen I want to allow
template writers to specify that the template output can be left
in a writable or read-only state. To support this, there is a Guile
function named set-writable (see section 3.4.32 `set-writable' - Make the output file be writable).
Also, I provide for command options --writable and
--not-writable. I give precedence to command line and RC
file options, thus:
switch (STATE_OPT( WRITABLE )) {
case OPTST_DEFINED:
case OPTST_PRESET:
fprintf( stderr, zOverrideWarn, pCurTemplate->pzFileName,
pCurMacro->lineNo );
break;
default:
if (gh_boolean_p( set ) && (set == SCM_BOOL_F))
CLEAR_OPT( WRITABLE );
else
SET_OPT_WRITABLE;
}
|
The following two fields are addressed from the tOptions* pointer:
Note these fields get filled in during the first call to
optionProcess(). All other fields are private, for the exclusive
use of AutoOpts code and is subject to change.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Make as if the option had never been specified.
HAVE_OPT(<NAME>) will yield FALSE
after invoking this macro.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
This macro will tell you how many times the option was specified on the command line. It does not include counts of preset options.
if (COUNT_OPT( NAME ) != desired-count) {
make-an-undesirable-message.
}
|
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
This macro is used internally by other AutoOpt macros. It is not for general use. It is used to obtain the option description corresponding to its UPPER CASED option name argument. This is primarily used in other macro definitions.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
This macro is emitted if it is both settable and it can be disabled. If it cannot be disabled, it may always be CLEAR-ed (see above).
The form of the macro will actually depend on whether the
option is equivalenced to another, and/or has an assigned
handler procedure. Unlike the SET_OPT macro,
this macro does not allow an option argument.
DISABLE_OPT_NAME; |
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Yields true if the option defaults to disabled and
ISUNUSED_OPT() would yield true. It also yields true if
the option has been specified with a disablement prefix,
disablement value or the DISABLE_OPT_NAME macro was invoked.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
When it is necessary to continue (return to caller) on option errors, invoke this option. It is reversible. See section 7.4.8 ERRSTOP_OPTERR - Stop on Errors.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
After invoking this macro, if optionProcess()
encounters an error, it will call exit(1) rather than return.
This is the default processing mode. It can be overridden by
specifying allow-errors in the definitions file,
or invoking the macro See section 7.4.7 ERRSKIP_OPTERR - Ignore Option Errors.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
This macro yields true if the option has been specified in any fashion at all. It is used thus:
if (HAVE_OPT( NAME )) {
<do-things-associated-with-opt-name>;
}
|
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
This macro yields true if the option has been specified either on the command line or via a SET/DISABLE macro.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
This macro yields true if the option has
never been specified, or has been cleared via the
CLEAR_OPT() macro.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
The full count of all options, both those defined and those generated automatically by AutoOpts. This is primarily used to initialize the program option descriptor structure.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
The option argument value as a pointer to string. Note that argument
values that have been specified as numbers are stored as numbers or
keywords. For such options, use instead the OPT_VALUE_name
define. It is used thus:
if (HAVE_OPT( NAME )) {
char* p = OPT_ARG( NAME );
<do-things-with-opt-name-argument-string>;
}
|
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
This macro gets emitted only for options that take numeric or keyword arguments. The macro yields a word-sized integer containing the enumeration or numeric value of the option argument.
int opt_val = OPT_VALUE_NAME; |
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
If option processing has stopped (either because of an error
or something was encountered that looked like a program argument),
it can be resumed by providing this macro with the index n
of the next option to process and calling optionProcess() again.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
This macro gets emitted only when the given
option has the settable attribute specified.
The form of the macro will actually depend on whether the option is equivalenced to another, has an option argument and/or has an assigned handler procedure. If the option has an argument, then this macro will too. Beware that the argument is not reallocated, so the value must not be on the stack or deallocated in any other way for as long as the value might get referenced.
If you have supplied at least one `homerc' file
(see section 7.3.1 Program Description Attributes), this macro will be emitted for the
--save-opts option.
SET_OPT_SAVE_OPTS( "filename" ); |
See section 7.3.6 Automatically Supported Options, for a discussion of the implications of using this particular example.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
When the option handling attribute is specified
as stack_arg, this macro may be used to determine how
many of them actually got stacked.
Do not use this on options that have not been stacked or has not been
specified (the stack_arg attribute must have been specified,
and HAVE_OPT(<NAME>) must yield TRUE).
Otherwise, you will likely seg fault.
if (HAVE_OPT( NAME )) {
int ct = STACKCT_OPT( NAME );
char** pp = STACKLST_OPT( NAME );
do {
char* p = *pp++;
do-things-with-p;
} while (--ct > 0);
}
|
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
The address of the list of pointers to the option arguments. The pointers are ordered by the order in which they were encountered in the option presets and command line processing.
Do not use this on options that have not been stacked or has not been
specified (the stack_arg attribute must have been specified,
and HAVE_OPT(<OPTION>) must yield TRUE).
Otherwise, you will likely seg fault.
if (HAVE_OPT( NAME )) {
int ct = STACKCT_OPT( NAME );
char** pp = STACKLST_OPT( NAME );
do {
char* p = *pp++;
do-things-with-p;
} while (--ct > 0);
}
|
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
This is just a shortcut for RESTART_OPT(1) (See section 7.4.15 RESTART_OPT( n ) - Resume Option Processing.)
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
If you need to know if an option was set because of
presetting actions (RC/INI processing or environment variables),
versus a command line entry versus one of the SET/DISABLE macros,
then use this macro. It will yield one of four values:
OPTST_INIT, OPTST_SET, OPTST_PRESET
or OPTST_DEFINED. It is used thus:
switch (STATE_OPT( NAME )) {
case OPTST_INIT:
not-preset, set or on the command line. (unless CLEAR-ed)
case OPTST_SET:
option set via the SET_OPT_NAME() macro.
case OPTST_PRESET:
option set via an RC/INI file or environment variable
case OPTST_DEFINED:
option set via a command line option.
default:
cannot happen :)
}
|
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
This macro invokes the procedure registered to display
the usage text. Normally, this will be optionUsage from the
AutoOpts library, but you may select another procedure by specifying
usage = "proc_name" program attribute. This procedure must
take two arguments first, a pointer to the option descriptor, and
second the exit code. The macro supplies the option descriptor
automatically. This routine is expected to call exit(3) with
the provided exit code.
The optionUsage routine also behaves differently depending
on the exit code. If the exit code is zero, it is assumed that
assistance has been requested. Consequently, a little more
information is provided than when displaying usage and exiting
with a non-zero exit code.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
This is a #define for the flag character used to
specify an option on the command line. If value was not
specified for the option, then it is a unique number associated
with the option. option value refers to this value,
option argument refers to the (optional) argument to the
option.
switch (WHICH_OPT_OTHER_OPT) {
case VALUE_OPT_NAME:
this-option-was-really-opt-name;
case VALUE_OPT_OTHER_OPT:
this-option-was-really-other-opt;
}
|
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
If the version attribute is defined for the program,
then a stringified version will be #defined as PROGRAM_VERSION and
PROGRAM_FULL_VERSION. PROGRAM_FULL_VERSION is used for printing
the program version in response to the version option. The version
option is automatically supplied in response to this attribute, too.
You may access PROGRAM_VERSION via programOptions.pzFullVersion.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
This macro gets emitted only for equivalenced-to options. It is used to obtain the index for the one of the several equivalence class members set the equivalenced-to option.
switch (WHICH_IDX_OTHER_OPT) {
case INDEX_OPT_NAME:
this-option-was-really-opt-name;
case INDEX_OPT_OTHER_OPT:
this-option-was-really-other-opt;
}
|
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
This macro gets emitted only for equivalenced-to options. It is used to obtain the value code for the one of the several equivalence class members set the equivalenced-to option.
switch (WHICH_OPT_OTHER_OPT) {
case VALUE_OPT_NAME:
this-option-was-really-opt-name;
case VALUE_OPT_OTHER_OPT:
this-option-was-really-other-opt;
}
|
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
This enum defines the complete set of options, both user specified and automatically provided. This can be used, for example, to distinguish which of the equivalenced options was actually used.
switch (pOptDesc->optActualIndex) {
case INDEX_OPT_FIRST:
stuff;
case INDEX_OPT_DIFFERENT:
different-stuff;
default:
unknown-things;
}
|
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
You will not actually need to reference this value, but you need to be
aware that it is there. It is the first value in the option descriptor
that you pass to optionProcess. It contains a magic number and
version information. Normally, you should be able to work with a more
recent option library than the one you compiled with. However, if the
library is changed incompatibly, then the library will detect the out of
date magic marker, explain the difficulty and exit. You will then need
to rebuild and recompile your option definitions. This has rarely been
necessary.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
These are the routines that libopts users may call directly from their code. There are several other routines that can be called by code generated by the libopts option templates, but they are not to be called from any other user code. The `options.h' is fairly clear about this, too.
7.4.28.1 optionFree 7.4.28.2 optionLoadLine 7.4.28.3 optionProcess 7.4.28.4 optionRestore 7.4.28.5 optionSaveFile 7.4.28.6 optionSaveState 7.4.28.7 optionVersion
This subsection was automatically generated by AutoGen using extracted information and the aginfo3.tpl template.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
free allocated option processing memory
Usage:
optionFree( pOpts ); |
| Name | Type | Description | |
| ----- | ----- | ------------- | |
| pOpts | tOptions* |
program options descriptor |
AutoOpts sometimes allocates memory and puts pointers to it in the option state structures. This routine deallocates all such memory.
As long as memory has not been corrupted, this routine is always successful.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
process a string for an option name and value
Usage:
optionLoadLine( pOpts, pzLine ); |
| Name | Type | Description | |
| ----- | ----- | ------------- | |
| pOpts | tOptions* |
program options descriptor | |
| pzLine | const char* |
NUL-terminated text |
This is a user callable routine for setting options from, for example, the contents of a file that they read in. Only one option may appear in the text. It will be treated as a normal (non-preset) option.
When passed a pointer to the option struct and a string, it will find the option named by the first token on the string and set the option argument to the remainder of the string. The caller must NUL terminate the string. Any embedded new lines will be included in the option argument.
Invalid options are silently ignored. Invalid option arguments will cause a warning to print, but the function should return.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
this is the main option processing routine
Usage:
int res = optionProcess( pOpts, argc, argv ); |
| Name | Type | Description | |
| ----- | ----- | ------------- | |
| pOpts | tOptions* |
program options descriptor | |
| argc | int |
program arg count | |
| argv | char** |
program arg vector | |
| returns | int | the count of the arguments processed |
This is the main entry point for processing options. It is intended that this procedure be called once at the beginning of the execution of a program. Depending on options selected earlier, it is sometimes necessary to stop and restart option processing, or to select completely different sets of options. This can be done easily, but you generally do not want to do this.
The number of arguments processed always includes the program name. If one of the arguments is "--", then it is counted and the processing stops. If an error was encountered and errors are to be tolerated, then the returned value is the index of the argument causing the error.
Errors will cause diagnostics to be printed. exit(3) may
or may not be called. It depends upon whether or not the options
were generated with the "allow-errors" attribute, or if the
ERRSKIP_OPTERR or ERRSTOP_OPTERR macros were invoked.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
restore option state from memory copy
Usage:
optionRestore( pOpts ); |
| Name | Type | Description | |
| ----- | ----- | ------------- | |
| pOpts | tOptions* |
program options descriptor |
Copy back the option state from saved memory. The allocated memory is left intact, so this routine can be called repeatedly without having to call optionSaveState again.
If you have not called optionSaveState before, a diagnostic is
printed to stderr and exit is called.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
saves the option state to a file
Usage:
optionSaveFile( pOpts ); |
| Name | Type | Description | |
| ----- | ----- | ------------- | |
| pOpts | tOptions* |
program options descriptor |
This routine will save the state of option processing to a file. The name
of that file can be specified with the argument to the --save-opts
option, or by appending the rcfile attribute to the last
homerc attribute. If no rcfile attribute was specified, it
will default to .programnamerc. If you wish to specify another
file, you should invoke the SET_OPT_SAVE_OPTS( filename ) macro.
If no homerc file was specified, this routine will silently return
and do nothing. If the output file cannot be created or updated, a message
will be printed to stderr and the routine will return.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
saves the option state to memory
Usage:
optionSaveState( pOpts ); |
| Name | Type | Description | |
| ----- | ----- | ------------- | |
| pOpts | tOptions* |
program options descriptor |
This routine will allocate enough memory to save the current option processing state. If this routine has been called before, that memory will be reused. You may only save one copy of the option state. This routine may be called before optionProcess(3).
If it fails to allocate the memory, it will print a message to stderr and exit. Otherwise, it will always succeed.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
return the compiled AutoOpts version number
Usage:
const char* res = optionVersion(); |
| Name | Type | Description | |
| ----- | ----- | ------------- | |
| returns | const char* | the version string in constant memory |
Returns the full version string compiled into the library. The returned string cannot be modified.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
This is the module that is to be compiled and linked with your program.
It contains internal data and procedures subject to change. Basically,
it contains a single global data structure containing all the
information provided in the option definitions, plus a number of static
strings and any callout procedures that are specified or required. You
should never have need for looking at this, except, perhaps, to examine
the code generated for implementing the flag_code construct.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
There are actually several levels of "using" autoopts. Which you choose depends upon how you plan to distribute (or not) your application.
7.6.1 local-only use 7.6.2 binary distro, AutoOpts not installed 7.6.3 binary distro, AutoOpts pre-installed 7.6.4 source distro, AutoOpts pre-installed 7.6.5 source distro, AutoOpts not installed
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
To use AutoOpts in your application where you do not have to worry about distribution issues, your issues are simple and few.
myopts.h)
and the option descriptor code (myopts.c):
autogen myopts.def |
#include "myopts.h".
#define ARGC_MIN some-lower-limit
#define ARGC_MAX some-upper-limit
main( int argc, char** argv )
{
{
int arg_ct = optionProcess( &myprogOptions, argc, argv );
argc -= arg_ct;
if ((argc < ARGC_MIN) || (argc > ARGC_MAX)) {
fprintf( stderr, "%s ERROR: remaining args (%d) "
"out of range\n", myprogOptions.pzProgName,
argc );
USAGE( EXIT_FAILURE );
}
argv += arg_ct;
}
if (HAVE_OPT(OPTN_NAME))
respond_to_optn_name();
...
}
|
myopts.c -I$prefix/include -L $prefix/lib -lopts |
These values can be derived from the "autoopts-config" script:
myopts.c `autoopts-config cflags` `autoopts-config ldflags` |
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
If you will be distributing (or copying) your project to a system that does not have AutoOpts installed, you will need to statically link the AutoOpts library, "libopts" into your program. Add the output from the following to your link command:
autoopts-config static-libs |
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
If you will be distributing (or copying) your project to a system that
does have AutoOpts installed, you will still need to ensure that the library
is findable at program load time, or you will still have to statically
link. The former can be accomplished by linking your project with
--rpath or by setting the LD_LIBRARY_PATH appropriately.
Otherwise, See section 7.6.2 binary distro, AutoOpts not installed.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
If you will be distributing your project to a system that will build your product but it may not be pre-installed with AutoOpts, you will need to do some configuration checking before you start the build. Assuming you are willing to fail the build if AutoOpts has not been installed, you will still need to do a little work.
AutoOpts is distributed with a configuration check M4 script,
`autoopts.m4'. It will add an autoconf macro named,
AG_PATH_AUTOOPTS. Add this to your `configure.ac' script
and use the following substitution values:
AUTOGEN
AUTOGEN_TPLIB
AUTOOPTS_CFLAGS
AUTOOPTS_LIBS
libopts library
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
If you will be distributing your project to a system that will build
your product but it may not be pre-installed with AutoOpts, you may
wish to incorporate the sources for libopts in your project.
To do this, I recommend reading the tear-off libopts library
`README' that you can find in the `pkg/libopts' directory.
You can also examine an example package (blocksort) that incorporates
this tear off library in the autogen distribution directory. There is
also a web page that describes what you need to do:
http://autogen.sourceforge.net/blocksort.html |
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
AutoOpts may be used with shell scripts by automatically creating a complete program that will process command line options and pass back the results to the invoking shell by issuing shell variable assignment commands. It may also be used to generate portable shell code that can be inserted into your script.
The functionality of these features, of course, is somewhat constrained compared with the normal program facilities. Specifically, you cannot invoke callout procedures with either of these methods. Additionally, if you generate a shell script:
Both of these methods are enabled by running AutoGen on the definitions file with the additional global attribute:
test-main [ = proc-to-call ] ; |
If you do not supply a proc-to-call, it will default
to putBourneShell. That will produce a program that
will process the options and generate shell text for the
invoking shell to interpret. If you supply the name,
putShellParse, then you will have a program that
will generate a shell script that can parse the options.
If you supply a different procedure name, you will have to
provide that routine and it may do whatever you like.
In summary, you will need to issue approximately the following two commands to have a working program:
autogen -L <opt-template-dir> program.def
cc -o progopts -L <opt-lib-dir> -I <opt-include-dir> \
-DTEST_program_OPTS program.c -lopts
|
The resulting program can be used within your shell script as follows:
eval `./progopts $@`
if [ -z "${OPTION_CT}" ] ; then exit 1 ; fi
shift ${OPTION_CT}
|
If you had used test-main = putShellParse instead, then you can,
at this point, merely run the program and it will write the parsing
script to standard out. You may also provide this program with command
line options to specify the shell script file to create or edit, and you
may specify the shell program to use on the first shell script line.
That program's usage text would look something like this:
genshellopt - Generate Shell Option Processing Script - Ver. 1
USAGE: genshellopt [ -<flag> [<val>] | --<name>[{=| }<val>] ]...
Flg Arg Option-Name Description
-o Str script Output Script File
-s Str shell Shell name (follows "#!" magic)
- disabled as --no-shell
- enabled by default
-v opt version Output version information and exit
-? no help Display usage information and exit
-! no more-help Extended usage information passed thru pager
Options are specified by doubled hyphens and their name
or by a single hyphen and the flag character.
Note that `shell' is only useful if the output file does not already
exist. If it does, then the shell name and optional first argument
will be extracted from the script file.
If the script file already exists and contains Automated Option Processing
text, the second line of the file through the ending tag will be replaced
by the newly generated text. The first `#!' line will be regenerated.
please send bug reports to: autogen-bugs@lists.sf.net
= = = = = = = =
This incarnation of genshell will produce
a shell script to parse the options for getdefs:
getdefs - AutoGen Definition Extraction Tool - Ver. 1.4
USAGE: getdefs [ <option-name>[{=| }<val>] ]...
Arg Option-Name Description
Str defs-to-get Regexp to look for after the "/*="
opt ordering Alphabetize or use named file
Num first-index The first index to apply to groups
Str input Input file to search for defs
Str subblock subblock definition names
Str listattr attribute with list of values
opt filelist Insert source file names into defs
Str assign Global assignments
Str common-assign Assignments common to all blocks
Str copy File(s) to copy into definitions
opt srcfile Insert source file name into each def
opt linenum Insert source line number into each def
Str output Output file to open
opt autogen Invoke AutoGen with defs
Str template Template Name
Str agarg AutoGen Argument
Str base-name Base name for output file(s)
opt version Output version information and exit
no help Display usage information and exit
no more-help Extended usage information passed thru pager
opt save-opts Save the option state to an rc file
Str load-opts Load options from an rc file
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''.
please send bug reports to: autogen-bugs@lists.sf.net
|
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
AutoOpts provides two templates for producing `.texi' documentation. `aginfo.tpl' for the invoking section, and `aginfo3.tpl' for describing exported library functions and macros.
For both types of documents, the documentation level is selected by passing a `-DLEVEL=<level-name>' argument to AutoGen when you build the document. (See the example invocation below.)
Two files will be produced, a `.texi' file and a `.menu' file. You should include the `.menu' file in your document where you wish to reference the `invoking' chapter, section or subsection.
The `.texi' file will contain an introductory paragraph, a menu and a subordinate section for the invocation usage and for each documented option. The introductory paragraph is normally the boiler plate text, along the lines of:
This chapter documents the @file{AutoOpts} generated usage text
and option meanings for the @file{your-program} program.
|
or:
These are the publicly exported procedures from the libname library. Any other functions mentioned in the header file are for the private use of the library. |
7.8.1 "invoking" info docs 7.8.2 library info docs
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Using the option definitions for an AutoOpt client program, the `aginfo.tpl' template will produce texinfo text that documents the invocation of your program. The text emitted is designed to be included in the full texinfo document for your product. It is not a stand-alone document. The usage text for the 5.1 autogen usage help (-?), 8.5.1 getdefs usage help and 8.4.1 columns usage help (-?) programs, are included in this document and are all generated using this template.
If your program's option definitions include a `prog-info-descrip' section, then that text will replace the boilerplate introductory paragraph.
These files are produced by invoking the following command:
autogen -L ${prefix}/share/autogen -T aginfo.tpl \
-DLEVEL=section your-opts.def
|
Where `${prefix}' is the AutoGen installation prefix and `your-opts.def' is the name of your product's option definition file.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
The `texinfo' doc for libraries is derived from mostly the same
information as is used for producing man pages See section 7.9.2 library man pages. The main
difference is that there is only one output file and the individual
functions are referenced from a .texi menu. There is also
a small difference in the global attributes used:
| lib_description | A description of the library. This text appears before the menu. If not provided, the standard boilerplate version will be inserted. | |
| see_also | The SEE ALSO functionality is not supported for the
`texinfo' documentation, so any see_also attribute will be ignored.
|
These files are produced by invoking the following commands:
getdefs linenum srcfile template=aginfo3.tpl output=libexport.def \
<source-file-list>
autogen -L ${prefix}/share/autogen -DLEVEL=section libexport.def
|
Where `${prefix}' is the AutoGen installation prefix and `libexport.def' is some name that suits you.
An example of this can be seen in this document, See section 7.4.28 libopts External Procedures.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
AutoOpts provides two templates for producing man pages. The command (`man1') pages are derived from the options definition file, and the library (`man3') pages are derived from stylized comments (see section 8.5 Invoking getdefs).
7.9.1 command line man pages 7.9.2 library man pages
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Using the option definitions for an AutoOpt client program, the `agman1.tpl' template will produce an nroff document suitable for use as a `man(1)' page document for a command line command. The description section of the document is either the `prog-man-descrip' text, if present, or the `detail' text.
Each option in the option definitions file is fully documented
in its usage. This includes all the information documented
above for each option (see section 7.3.4 Option Attributes), plus
the `doc' attribute is appended. Since the `doc'
text is presumed to be designed for texinfo documentation,
sed is used to convert some constructs from texi
to nroff-for-man-pages. Specifically,
convert @code, @var and @samp into \fB...\fP phrases convert @file into \fI...\fP phrases Remove the '@' prefix from curly braces Indent example regions Delete the example commands Replace `end example' command with ".br" Replace the `@*' command with ".br" |
This document is produced by invoking the following command:
AutoGen -L ${prefix}/share/autogen -T agman1.tpl options.def
|
Where `${prefix}' is the AutoGen installation prefix and `options.def' is the name of your product's option definition file. I do not use this very much, so any feedback or improvements would be greatly appreciated.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Two global definitions are required, and then
one library man page is produced for each export_func definition
that is found. It is generally convenient to place these definitions
as `getdefs' comments (see section 8.5 Invoking getdefs) near the procedure
definition, but they may also be a separate AutoGen definitions file
(see section 2. AutoGen Definitions File). Each function will be cross referenced
with their sister functions in a `SEE ALSO' section. A global
see_also definition will be appended to this cross referencing text.
The two global definitions required are:
| library | This is the name of your library, without the `lib' prefix.
The AutoOpts library is named `libopts.so...', so the library
attribute would have the value opts.
| |
| header | Generally, using a library with a compiled program entails
#include-ing a header file. Name that header with this attribute.
In the case of AutoOpts, it is generated and will vary based on the
name of the option definition file. Consequently, `your-opts.h' is
specified.
|
The export_func definition should contain the following attributes:
| name | The name of the procedure the library user may call. | |
| what | A brief sentence describing what the procedure does. | |
| doc | A detailed description of what the procedure does. It may ramble on for as long as necessary to properly describe it. | |
| err | A short description of how errors are handled. | |
| ret_type | The data type returned by the procedure.
Omit this for void procedures.
| |
| ret_desc | Describe what the returned value is, if needed. | |
| private | If specified, the function will not be documented. This is used, for example, to produce external declarations for functions that are not available for public use, but are used in the generated text. | |
| arg | This is a compound attribute that contains: |
| arg_type | The data type of the argument. | ||
| arg_name | A short name for it. | ||
| arg_desc | A brief description. |
As a `getdefs' comment, this would appear something like this:
/*=--subblock=arg=arg_type,arg_name,arg_desc =*/ /*=* * library: opts * header: your-opts.h =*/ /*=export_func optionProcess * * what: this is the main option processing routine * arg: + tOptions* + pOpts + program options descriptor + * arg: + int + argc + program arg count + * arg: + char** + argv + program arg vector + * ret_type: int * ret_desc: the count of the arguments processed * * doc: This is what it does. * err: When it can't, it does this. =*/ |
Note the subblock and library comments.
subblock is an embedded `getdefs'
option (see section 8.5.6 subblock option) that tells it how to parse the
arg attribute. The library and header entries
are global definitions that apply to all the documented functions.
| [ << ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |