cxref - generate a C-language program cross-reference table (DEVELOPMENT)
cxref [-cs][-o file][-w num] [-D name[=def]]...[-I dir]...[-U name]... file ...
The cxref utility analyses a collection of C-language files and attempts to build a cross-reference table. Information from #define lines is included in the symbol table. A sorted listing is written to standard output of all symbols (auto, static and global) in each file separately, or with the -c option, in combination. Each symbol contains an asterisk before the declaring reference.
The cxref utility supports the XBD specification, Utility Syntax Guidelines , except that the order of the -D, -I and -U options (which are identical to their interpretation by c89) is significant. The following options are supported:
- Write a combined cross-reference of all input files.
- -w num
- Format output no wider than num (decimal) columns. This option defaults to 80 if num is not specified or is less than 51.
- -o file
- Direct output to named file.
- Operate silently; do not print input filenames.
The following operand is supported:
- A pathname of a C-language source file.
The input files are C-language source files.
The following environment variables affect the execution of cxref:
- Provide a default value for the internationalisation variables that are unset or null. If LANG is unset or null, the corresponding value from the implementation-dependent default locale will be used. If any of the internationalisation variables contains an invalid setting, the utility will behave as if none of the variables had been defined.
- If set to a non-empty string value, override the values of all the other internationalisation variables.
- Determine the locale for the ordering of the output.
- Determine the locale for the interpretation of sequences of bytes of text data as characters (for example, single- as opposed to multi-byte characters in arguments and input files).
- Determine the locale that should be used to affect the format and contents of diagnostic messages written to standard error.
- Determine the location of message catalogues for the processing of LC_MESSAGES .
The standard output is used for the cross-reference listing, unless the -o option is used to select a different output file.
The format of standard output is unspecified, except that the following information is included:
- If the -c option is not specified, each portion of the listing starts with the name of the input file on a separate line.
- The name line is followed by a sorted list of symbols, each with its associated location pathname, the name of the function in which it appears (if it is not a function name itself), and line number references.
- Each line number may be preceded by an asterisk (*) flag, meaning that this is the declaring reference. Other single-character flags, with implementation-dependent meanings, may be included.
Used only for diagnostic messages.
The output file named by the -o option is used instead of standard output.
The following exit values are returned:
- Successful completion.
- An error occurred.