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 POSIX.1‐2017, Section 12.2, Utility Syntax Guidelines, except that the
30 order of the -D, -I, and -U options (which are identical to their
31 interpretation by c99) is significant. The following options shall be
32 supported:
33 -c Write a combined cross-reference of all input files.
35 -s Operate silently; do not print input filenames.
37 -o file Direct output to named file.
39 -w num Format output no wider than num (decimal) columns. This
41 option defaults to 80 if num is not specified or is less than
42 51.
43 -D Equivalent to c99.
45 -I Equivalent to c99.
47 -U Equivalent to c99.
49
51 The following operand shall be supported:
52 file A pathname of a C-language source file.
54
56 Not used.
57
59 The input files are C-language source files.
60
62 The following environment variables shall affect the execution of
63 cxref:
64 LANG Provide a default value for the internationalization vari‐
66 ables that are unset or null. (See the Base Definitions vol‐
67 ume of POSIX.1‐2017, Section 8.2, Internationalization Vari‐
68 ables for the precedence of internationalization variables
69 used to determine the values of locale categories.)
70 LC_ALL If set to a non-empty string value, override the values of
72 all the other internationalization variables.
73 LC_COLLATE
75 Determine the locale for the ordering of the output.
76 LC_CTYPE Determine the locale for the interpretation of sequences of
78 bytes of text data as characters (for example, single-byte as
79 opposed to multi-byte characters in arguments and input
80 files).
81 LC_MESSAGES
83 Determine the locale that should be used to affect the format
84 and contents of diagnostic messages written to standard
85 error.
86 NLSPATH Determine the location of message catalogs for the processing
88 of LC_MESSAGES.
89
91 Default.
92
94 The standard output shall be used for the cross-reference listing,
95 unless the -o option is used to select a different output file.
96 The format of standard output is unspecified, except that the following
98 information shall be included:
99 * If the -c option is not specified, each portion of the listing
101 shall start with the name of the input file on a separate line.
102 * The name line shall be followed by a sorted list of symbols, each
104 with its associated location pathname, the name of the function in
105 which it appears (if it is not a function name itself), and line
106 number references.
107 * Each line number may be preceded by an <asterisk> ('*') flag, mean‐
109 ing that this is the declaring reference. Other single-character
110 flags, with implementation-defined meanings, may be included.
111
113 The standard error shall be used only for diagnostic messages.
114
116 The output file named by the -o option shall be used instead of stan‐
117 dard output.
118
120 None.
121
123 The following exit values shall be returned:
124 0 Successful completion.
126 >0 An error occurred.
128
130 Default.
131 The following sections are informative.
133
135 None.
136
138 None.
139
141 None.
142
144 None.
145
147 c99
148 The Base Definitions volume of POSIX.1‐2017, Chapter 8, Environment
150 Variables, Section 12.2, Utility Syntax Guidelines
151
153 Portions of this text are reprinted and reproduced in electronic form
154 from IEEE Std 1003.1-2017, Standard for Information Technology -- Por‐
155 table Operating System Interface (POSIX), The Open Group Base Specifi‐
156 cations Issue 7, 2018 Edition, Copyright (C) 2018 by the Institute of
157 Electrical and Electronics Engineers, Inc and The Open Group. In the
158 event of any discrepancy between this version and the original IEEE and
159 The Open Group Standard, the original IEEE and The Open Group Standard
160 is the referee document. The original Standard can be obtained online
161 at http://www.opengroup.org/unix/online.html .
162 Any typographical or formatting errors that appear in this page are
164 most likely to have been introduced during the conversion of the source
165 files to man page format. To report such errors, see https://www.ker‐
166 nel.org/doc/man-pages/reporting_bugs.html .
167IEEE/The Open Group 2017 CXREF(1P)