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

PROLOG

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
11

NAME

13       cxref — generate a C-language program cross-reference  table  (DEVELOP‐
14       MENT)
15

SYNOPSIS

17       cxref [−cs] [−o file] [−w num] [−D name[=def]]... [−I dir]...
18           [−U name]... file...
19

DESCRIPTION

21       The  cxref  utility  shall analyze a collection of C-language files and
22       attempt to build a  cross-reference  table.  Information  from  #define
23       lines  shall be included in the symbol table. A sorted listing shall be
24       written to standard output of all symbols (auto, static, and global) in
25       each  file separately, or with the −c option, in combination. Each sym‐
26       bol shall contain an <asterisk> before the declaring reference.
27

OPTIONS

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

OPERANDS

52       The following operand shall be supported:
53
54       file      A pathname of a C-language source file.
55

STDIN

57       Not used.
58

INPUT FILES

60       The input files are C-language source files.
61

ENVIRONMENT VARIABLES

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

ASYNCHRONOUS EVENTS

92       Default.
93

STDOUT

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

STDERR

114       The standard error shall be used only for diagnostic messages.
115

OUTPUT FILES

117       The output file named by the −o option shall be used instead  of  stan‐
118       dard output.
119

EXTENDED DESCRIPTION

121       None.
122

EXIT STATUS

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

CONSEQUENCES OF ERRORS

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

APPLICATION USAGE

136       None.
137

EXAMPLES

139       None.
140

RATIONALE

142       None.
143

FUTURE DIRECTIONS

145       None.
146

SEE ALSO

148       c99
149
150       The  Base  Definitions  volume  of POSIX.1‐2008, Chapter 8, Environment
151       Variables, Section 12.2, Utility Syntax Guidelines
152
154       Portions of this text are reprinted and reproduced in  electronic  form
155       from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
156       -- Portable Operating System Interface (POSIX),  The  Open  Group  Base
157       Specifications Issue 7, Copyright (C) 2013 by the Institute of Electri‐
158       cal and Electronics Engineers,  Inc  and  The  Open  Group.   (This  is
159       POSIX.1-2008  with  the  2013  Technical Corrigendum 1 applied.) In the
160       event of any discrepancy between this version and the original IEEE and
161       The  Open Group Standard, the original IEEE and The Open Group Standard
162       is the referee document. The original Standard can be  obtained  online
163       at http://www.unix.org/online.html .
164
165       Any  typographical  or  formatting  errors that appear in this page are
166       most likely to have been introduced during the conversion of the source
167       files  to  man page format. To report such errors, see https://www.ker
168       nel.org/doc/man-pages/reporting_bugs.html .
169
170
171
172IEEE/The Open Group                  2013                            CXREF(1P)
Impressum