[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

8.6.4 doc-insert options

Definition insertion options.

filelist option.

This is the “insert source file names into defs” option. This option takes an optional string argument ‘file’. 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 option.

This is the “global assignments” option. This option takes a string argument ‘ag-def’.

This option has some usage constraints. It:

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

common-assign option.

This is the “assignments common to all blocks” option. This option takes a string argument ‘ag-def’.

This option has some usage constraints. It:

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

copy option.

This is the “file(s) to copy into definitions” option. This option takes a string argument ‘file’.

This option has some usage constraints. It:

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

srcfile option.

This is the “insert source file name into each def” option. This option takes an optional string argument ‘file’. 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 option.

This is the “insert source line number into each def” option. This option takes an optional string argument ‘def-name’. 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.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

This document was generated by Bruce Korb on August 24, 2014 using texi2html 1.82.