Program Options

The name of the program is cxref.

Usage: cxref  
  filename [ ... filename]
  [-Odirname] [-Nbasename] [-Rdirname]
  [-all-comments] [-no-comments]
  [-verbatim-comments] [-block-comments]
  [-xref[-all][-file][-func][-var][-type]]
  [-warn[-all][-comment][-xref]]
  [-index[-all][-file][-func][-var][-type]]
  [-raw]
  [-latex|-latex2e]
  [-html]
  [-Idirname] [-Ddefine] [-Udefine]
  [-CPP cpp_program] [– cpp_arg [ ... cpp_arg]]
Usage: cxref  
  filename [ ... filename] -delete
  [-Odirname] [-Nbasename] [-Rdirname]

filename
The name of the file to document, any number of files may be documented at a time.
-delete
The files named are to be deleted from the output directory and their entries in the cross reference database and main output files are to be removed.
-Odirname
The name of a directory to use for the output LATEXfiles and the location of the cross reference files that are created.
-Nbasename
The name to use for the first part of the output and cross reference files instead of cxref, the file extensions remain the same.
-Rdirname
When the source files are in more than one directory, set dirname to the name of the root directory of the source tree (use relative path if easier e.g. ``-R../..''). This will then run cxref from that root directory and the ``-Odirname'' must be relative to that directory.
-all-comments
In case you think that the existing comments might work, (see below for description of special comments). [Danger! This option can produce weird results.]
-no-comments
Ignores all comments, useful if you just want the cross references and not the documentation.
-verbatim-comments
When the comments that you have in the code are formatted in a predetermined style that you want to preserve on the output, this option will force them not to be reformatted. [Note, this is for file and function comments only.]
-block-comments
When the comments in the program are formatted in the ``block'' style (with a leading ``*'' character on every line), this option will remove that character from the output. [Works for a single ``*'', ``+'', ``|'' or ``:'' on each line.]
-xref
Produce cross referencing information (see below).
-all
All cross references.
-file
Cross references for files.
-func
Cross references for functions.
-var
Cross references for variables.
-type
Cross references for types.
-warn
Produce warnings, the options must be concatenated together:
-all
All warnings.
-comment
Warn of missing comments.
-xref
Warn of missing cross references.
-index
Produce a cross reference index, the options must be concatenated together:
-all
All indexes.
-file
Index of files.
-func
Index of functions.
-var
Index of variables.
-type
Index of types.
-raw
Produce a raw form of output, not really of much use except with -warn.
-latex
Produce a LATEXfile to document each of the source files and also an extra file that includes each of these files.
-latex2e
Produce the LATEXfile described above for use with the LATEX2e version of LATEX.
-html
Produce an HTML file to document each of the source files and a main file to reference each of these files.
-Idirname
GCC option to specify the path for include files.
-Ddefine
GCC option to define a pre-processor symbol.
-Udefine
GCC option to undefine a pre-processor symbol.
-CPP program
The name of the program to use instead of the compile time default. The program must be able to perform all of the actions that ``gcc -E -C -dD'' does to work. If the program takes arguments then the whole thing needs to be in quotes so that it is interpreted as a single argument to cxref.
– arg ... arg
Extra arguments to be passed to the pre-processor can be placed after the ``–'' separator.