1CXREF(P)                   POSIX Programmer's Manual                  CXREF(P)
2
3
4

NAME

6       cxref  -  generate a C-language program cross-reference table (DEVELOP‐
7       MENT)
8

SYNOPSIS

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

DESCRIPTION

14       The cxref utility shall analyze a collection of  C-language  files  and
15       attempt  to  build  a  cross-reference table.  Information from #define
16       lines shall be included in the symbol table. A sorted listing shall  be
17       written to standard output of all symbols (auto, static, and global) in
18       each file separately, or with the -c option, in combination. Each  sym‐
19       bol shall contain an asterisk before the declaring reference.
20

OPTIONS

22       The  cxref  utility  shall  conform  to  the Base Definitions volume of
23       IEEE Std 1003.1-2001, Section 12.2, Utility Syntax  Guidelines,  except
24       that  the  order  of the -D, -I, and -U options (which are identical to
25       their interpretation by c99)  is  significant.  The  following  options
26       shall be supported:
27
28       -c     Write a combined cross-reference of all input files.
29
30       -s     Operate silently; do not print input filenames.
31
32       -o  file
33              Direct output to named file.
34
35       -w  num
36              Format  output  no wider than num (decimal) columns. This option
37              defaults to 80 if num is not specified or is less than 51.
38
39       -D     Equivalent to c99.
40
41       -I     Equivalent to c99.
42
43       -U     Equivalent to c99.
44
45

OPERANDS

47       The following operand shall be supported:
48
49       file   A pathname of a C-language source file.
50
51

STDIN

53       Not used.
54

INPUT FILES

56       The input files are C-language source files.
57

ENVIRONMENT VARIABLES

59       The following environment  variables  shall  affect  the  execution  of
60       cxref:
61
62       LANG   Provide  a  default value for the internationalization variables
63              that are unset or null. (See  the  Base  Definitions  volume  of
64              IEEE Std 1003.1-2001,  Section  8.2,  Internationalization Vari‐
65              ables for the precedence of internationalization variables  used
66              to determine the values of locale categories.)
67
68       LC_ALL If  set  to a non-empty string value, override the values of all
69              the other internationalization variables.
70
71       LC_COLLATE
72
73              Determine the locale for the ordering of the output.
74
75       LC_CTYPE
76              Determine the locale for  the  interpretation  of  sequences  of
77              bytes  of  text  data as characters (for example, single-byte as
78              opposed to multi-byte characters in arguments and input files).
79
80       LC_MESSAGES
81              Determine the locale that should be used to  affect  the  format
82              and contents of diagnostic messages written to standard error.
83
84       NLSPATH
85              Determine the location of message catalogs for the processing of
86              LC_MESSAGES .
87
88

ASYNCHRONOUS EVENTS

90       Default.
91

STDOUT

93       The standard output shall be  used  for  the  cross-reference  listing,
94       unless the -o option is used to select a different output file.
95
96       The format of standard output is unspecified, except that the following
97       information shall be included:
98
99        * If the -c option is not specified, each portion of the listing shall
100          start with the name of the input file on a separate line.
101
102        * The  name  line  shall be followed by a sorted list of symbols, each
103          with its associated location pathname, the name of the  function  in
104          which  it  appears  (if  it is not a function name itself), and line
105          number references.
106
107        * Each line number may be preceded by an asterisk ( '*' ) flag,  mean‐
108          ing  that  this  is  the declaring reference. Other single-character
109          flags, with implementation-defined meanings, may be included.
110

STDERR

112       The standard error shall be used only for diagnostic messages.
113

OUTPUT FILES

115       The output file named by the -o option shall be used instead  of  stan‐
116       dard output.
117

EXTENDED DESCRIPTION

119       None.
120

EXIT STATUS

122       The following exit values shall be returned:
123
124        0     Successful completion.
125
126       >0     An error occurred.
127
128

CONSEQUENCES OF ERRORS

130       Default.
131
132       The following sections are informative.
133

APPLICATION USAGE

135       None.
136

EXAMPLES

138       None.
139

RATIONALE

141       None.
142

FUTURE DIRECTIONS

144       None.
145

SEE ALSO

147       c99
148

COPYRIGHT

150       Portions  of  this text are reprinted and reproduced in electronic form
151       from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology
152       --  Portable  Operating  System  Interface (POSIX), The Open Group Base
153       Specifications Issue 6, Copyright (C) 2001-2003  by  the  Institute  of
154       Electrical  and  Electronics  Engineers, Inc and The Open Group. In the
155       event of any discrepancy between this version and the original IEEE and
156       The  Open Group Standard, the original IEEE and The Open Group Standard
157       is the referee document. The original Standard can be  obtained  online
158       at http://www.opengroup.org/unix/online.html .
159
160
161
162IEEE/The Open Group                  2003                             CXREF(P)