1CXREF(1P) POSIX Programmer's Manual CXREF(1P)
2
6 This manual page is part of the POSIX Programmer's Manual. The Linux
7 implementation of this interface may differ (consult the corresponding
8 Linux manual page for details of Linux behavior), or the interface may
9 not be implemented on Linux.
10
12 cxref - generate a C-language program cross-reference table (DEVELOP‐
13 MENT)
14
16 cxref [-cs][-o file][-w num] [-D name[=def]]...[-I dir]...
17 [-U name]... file ...
18
20 The cxref utility shall analyze a collection of C-language files and
21 attempt to build a cross-reference table. Information from #define
22 lines shall be included in the symbol table. A sorted listing shall be
23 written to standard output of all symbols (auto, static, and global) in
24 each file separately, or with the -c option, in combination. Each sym‐
25 bol shall contain an asterisk before the declaring reference.
26
28 The cxref utility shall conform to the Base Definitions volume of
29 IEEE Std 1003.1-2001, Section 12.2, Utility Syntax Guidelines, except
30 that the order of the -D, -I, and -U options (which are identical to
31 their interpretation by c99) is significant. The following options
32 shall be supported:
33 -c Write a combined cross-reference of all input files.
35 -s Operate silently; do not print input filenames.
37 -o file
39 Direct output to named file.
40 -w num
42 Format output no wider than num (decimal) columns. This option
43 defaults to 80 if num is not specified or is less than 51.
44 -D Equivalent to c99.
46 -I Equivalent to c99.
48 -U Equivalent to c99.
50
53 The following operand shall be supported:
54 file A pathname of a C-language source file.
56
59 Not used.
60
62 The input files are C-language source files.
63
65 The following environment variables shall affect the execution of
66 cxref:
67 LANG Provide a default value for the internationalization variables
69 that are unset or null. (See the Base Definitions volume of
70 IEEE Std 1003.1-2001, Section 8.2, Internationalization Vari‐
71 ables for the precedence of internationalization variables used
72 to determine the values of locale categories.)
73 LC_ALL If set to a non-empty string value, override the values of all
75 the other internationalization variables.
76 LC_COLLATE
78 Determine the locale for the ordering of the output.
80 LC_CTYPE
82 Determine the locale for the interpretation of sequences of
83 bytes of text data as characters (for example, single-byte as
84 opposed to multi-byte characters in arguments and input files).
85 LC_MESSAGES
87 Determine the locale that should be used to affect the format
88 and contents of diagnostic messages written to standard error.
89 NLSPATH
91 Determine the location of message catalogs for the processing of
92 LC_MESSAGES .
93
96 Default.
97
99 The standard output shall be used for the cross-reference listing,
100 unless the -o option is used to select a different output file.
101 The format of standard output is unspecified, except that the following
103 information shall be included:
104 * If the -c option is not specified, each portion of the listing shall
106 start with the name of the input file on a separate line.
107 * The name line shall be followed by a sorted list of symbols, each
109 with its associated location pathname, the name of the function in
110 which it appears (if it is not a function name itself), and line
111 number references.
112 * Each line number may be preceded by an asterisk ( '*' ) flag, mean‐
114 ing that this is the declaring reference. Other single-character
115 flags, with implementation-defined meanings, may be included.
116
118 The standard error shall be used only for diagnostic messages.
119
121 The output file named by the -o option shall be used instead of stan‐
122 dard output.
123
125 None.
126
128 The following exit values shall be returned:
129 0 Successful completion.
131 >0 An error occurred.
133
136 Default.
137 The following sections are informative.
139
141 None.
142
144 None.
145
147 None.
148
150 None.
151
153 c99
154
156 Portions of this text are reprinted and reproduced in electronic form
157 from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology
158 -- Portable Operating System Interface (POSIX), The Open Group Base
159 Specifications Issue 6, Copyright (C) 2001-2003 by the Institute of
160 Electrical and Electronics Engineers, Inc and The Open Group. In the
161 event of any discrepancy between this version and the original IEEE and
162 The Open Group Standard, the original IEEE and The Open Group Standard
163 is the referee document. The original Standard can be obtained online
164 at http://www.opengroup.org/unix/online.html .
165IEEE/The Open Group 2003 CXREF(1P)