GETDEFS(1)

NAME
getdefs - AutoGen Definition Extraction Tool

SYNOPSIS
getdefs [opt-name[=value]]...

All arguments are named options.

DESCRIPTION
This manual page documents, briefly, the getdefs command. This program extracts AutoGen definitions from a list of source files. Definitions are delimited by `/*=<entry-type> <entry-name> \n' and `=*/\n'. From that, this program creates a definition of the following form:
    #line nnn "source-file-name"
    entry_type = {
        name = entry_name;
        ...
    }; The ellipsis `...' is filled in by text found between the two delimiters, with everything up through the first sequence of asterisks deleted on every line. Additionally, if the `<entry-name>' is followed by a comma, the word `if' and a name `if_name', then the above entry will appear as: @format
    #ifdef if_name
    #line nnn "source-file-name"
    entry_type = @{
        name = entry_name;
        ...
    @};
    #endif @end format

OPTIONS

defs-to-get=reg-ex
    Regexp to look for after the "/*="

    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 /*=.

ordering[=file-name]
    Alphabetize or use named file. Special attributes apply to this option. See the invocation section in the info document.

    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.

input=file
    Input file to search for defs. Special attributes apply to this option. See the invocation section in the info document.

    All files that are to be searched for definitions must be named on the command line. If an option name is not mentioned in the command line argument, it is presumed to be this option. There must be at least one.

subblock=sub-def
    subblock definition names. Special attributes apply to this option. See the invocation section in the info document.

    This option is used to create shorthand entries for subblocks. For example, with:
    subblock=arg=argname,type defined, the text:
    arg: this, char * will then expand to:
    arg = { argname = this; type = "char *" @;}.

filelist[=file]
    Insert source file names into defs

    Inserts the name of each input file into the output definitions. If no argument is supplied, the format will be:
        infile = '%s';
    If an argument is supplied, that string will be used for the entry name instead of infile.

assign=ag-def
    Global assignments. Special attributes apply to this option. See the invocation section in the info document.

    The argument to each copy of this option will be inserted into the output definitions, with only a semicolon attached.

common-assign=ag-def
    Assignments common to all blocks. Special attributes apply to this option. See the invocation section in the info document.

    The argument to each copy of this option will be inserted into each output definition, with only a semicolon attached.

copy=file
    File(s) to copy into definitions. Special attributes apply to this option. See the invocation section in the info document.

    The content of each file named by these options will be inserted into the output definitions.

srcfile[=file]
    Insert source file name into each def

    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:
        srcfile = '%s';
    If an argument is supplied, that string will be used for the entry name instead of srcfile.

linenum[=def-name]
    Insert source line number into each def

    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:
        linenum = '%s';
    If an argument is supplied, that string will be used for the entry name instead of linenum.

output=file
    Output file to open. Special attributes apply to this option. See the invocation section in the info document.

    If you are not sending the output to an Augogen process, you may name an output file instead.

autogen[=ag-cmd]
    Invoke AutoGen with defs. Special attributes apply to this option. See the invocation section in the info document.

    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.

template=file
    Template Name

    Specifies the template name to be used for generating the final output.

agarg=ag-opt
    AutoGen Argument. Special attributes apply to this option. See the invocation section in the info document.

    This is a passthrough argument. It allows you to have AutoGen invoked with any arbitrary argument.

base-name=name
    Base name for output file(s). Special attributes apply to this option. See the invocation section in the info document.

    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.

help
    Display usage information and exit.

more-help
    Extended usage information passed thru pager.

version[=v|c|n]
    Output version of program and exit. The default mode is `v', a simple version. The `c' mode will print copyright information and `n' will print the full copyright notice.

SEE ALSO
This program is documented more fully in the Getdefs section of the Add-On chapter in the AutoGen Info system documentation.

AUTHOR
Bruce Korb <bkorb@gnu.org>

This manual page was AutoGen-erated from the getdefs option definitions.