NAME

cxref - generate a C-language program cross-reference table (DEVELOPMENT)

 SYNOPSIS

cxref [-cs][-o file][-w num] [-D name[=def]]...[-I dir]...[-U name]...
file ...

 DESCRIPTION

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.

 OPTIONS

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:

-c

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.

-s

Operate silently; do not print input filenames.

 OPERANDS

The following operand is supported:

file

A pathname of a C-language source file.

 STDIN

Not used.

 INPUT FILES

The input files are C-language source files.

 ENVIRONMENT VARIABLES

The following environment variables affect the execution of cxref:

LANG

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.

LC_ALL

If set to a non-empty string value, override the values of all the other internationalisation variables.

LC_COLLATE

Determine the locale for the ordering of the output.

LC_CTYPE

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).

LC_MESSAGES

Determine the locale that should be used to affect the format and contents of diagnostic messages written to standard error.

NLSPATH

Determine the location of message catalogues for the processing of LC_MESSAGES .

 ASYNCHRONOUS EVENTS

Default.

 STDOUT

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.

 STDERR

Used only for diagnostic messages.

 OUTPUT FILES

The output file named by the -o option is used instead of standard output.

 EXTENDED DESCRIPTION

None.

 EXIT STATUS

The following exit values are returned:

0

Successful completion.

>0

An error occurred.

 CONSEQUENCES OF ERRORS

Default.

 APPLICATION USAGE

None.

 EXAMPLES

None.

 FUTURE DIRECTIONS

None.

 SEE ALSO

cc, c89.