logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

cxref.1p (5664B)


  1. '\" et
  2. .TH CXREF "1P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
  3. .\"
  4. .SH PROLOG
  5. This manual page is part of the POSIX Programmer's Manual.
  6. The Linux implementation of this interface may differ (consult
  7. the corresponding Linux manual page for details of Linux behavior),
  8. or the interface may not be implemented on Linux.
  9. .\"
  10. .SH NAME
  11. cxref
  12. \(em generate a C-language program cross-reference table
  13. (\fBDEVELOPMENT\fP)
  14. .SH SYNOPSIS
  15. .LP
  16. .nf
  17. cxref \fB[\fR-cs\fB] [\fR-o \fIfile\fB] [\fR-w \fInum\fB] [\fR-D \fIname\fB[\fR=\fIdef\fB]]\fR...\fB [\fR-I \fIdir\fB]\fR...
  18. \fB[\fR-U \fIname\fB]\fR... \fIfile\fR...
  19. .fi
  20. .SH DESCRIPTION
  21. The
  22. .IR cxref
  23. utility shall analyze a collection of C-language
  24. .IR file s
  25. and attempt to build a cross-reference table. Information from
  26. .BR #define
  27. lines shall be included in the symbol table. A sorted listing shall be
  28. written to standard output of all symbols (auto, static, and global) in
  29. each
  30. .IR file
  31. separately, or with the
  32. .BR \-c
  33. option, in combination. Each symbol shall contain an
  34. <asterisk>
  35. before the declaring reference.
  36. .SH OPTIONS
  37. The
  38. .IR cxref
  39. utility shall conform to the Base Definitions volume of POSIX.1\(hy2017,
  40. .IR "Section 12.2" ", " "Utility Syntax Guidelines",
  41. except that the order of the
  42. .BR \-D ,
  43. .BR \-I ,
  44. and
  45. .BR \-U
  46. options (which are identical to their interpretation by
  47. .IR c99 )
  48. is significant. The following options shall be supported:
  49. .IP "\fB\-c\fP" 10
  50. Write a combined cross-reference of all input files.
  51. .IP "\fB\-s\fP" 10
  52. Operate silently; do not print input filenames.
  53. .IP "\fB\-o\ \fIfile\fR" 10
  54. Direct output to named
  55. .IR file .
  56. .IP "\fB\-w\ \fInum\fR" 10
  57. Format output no wider than
  58. .IR num
  59. (decimal) columns. This option defaults to 80 if
  60. .IR num
  61. is not specified or is less than 51.
  62. .IP "\fB\-D\fP" 10
  63. Equivalent to
  64. .IR c99 .
  65. .IP "\fB\-I\fP" 10
  66. Equivalent to
  67. .IR c99 .
  68. .IP "\fB\-U\fP" 10
  69. Equivalent to
  70. .IR c99 .
  71. .SH OPERANDS
  72. The following operand shall be supported:
  73. .IP "\fIfile\fR" 10
  74. A pathname of a C-language source file.
  75. .SH STDIN
  76. Not used.
  77. .SH "INPUT FILES"
  78. The input files are C-language source files.
  79. .SH "ENVIRONMENT VARIABLES"
  80. The following environment variables shall affect the execution of
  81. .IR cxref :
  82. .IP "\fILANG\fP" 10
  83. Provide a default value for the internationalization variables that are
  84. unset or null. (See the Base Definitions volume of POSIX.1\(hy2017,
  85. .IR "Section 8.2" ", " "Internationalization Variables"
  86. for the precedence of internationalization variables used to determine
  87. the values of locale categories.)
  88. .IP "\fILC_ALL\fP" 10
  89. If set to a non-empty string value, override the values of all the
  90. other internationalization variables.
  91. .IP "\fILC_COLLATE\fP" 10
  92. .br
  93. Determine the locale for the ordering of the output.
  94. .IP "\fILC_CTYPE\fP" 10
  95. Determine the locale for the interpretation of sequences of bytes of
  96. text data as characters (for example, single-byte as opposed to
  97. multi-byte characters in arguments and input files).
  98. .IP "\fILC_MESSAGES\fP" 10
  99. .br
  100. Determine the locale that should be used to affect the format and
  101. contents of diagnostic messages written to standard error.
  102. .IP "\fINLSPATH\fP" 10
  103. Determine the location of message catalogs for the processing of
  104. .IR LC_MESSAGES .
  105. .SH "ASYNCHRONOUS EVENTS"
  106. Default.
  107. .SH STDOUT
  108. The standard output shall be used for the cross-reference listing,
  109. unless the
  110. .BR \-o
  111. option is used to select a different output file.
  112. .P
  113. The format of standard output is unspecified, except that the following
  114. information shall be included:
  115. .IP " *" 4
  116. If the
  117. .BR \-c
  118. option is not specified, each portion of the listing shall start
  119. with the name of the input file on a separate line.
  120. .IP " *" 4
  121. The name line shall be followed by a sorted list of symbols, each with
  122. its associated location pathname, the name of the function in which it
  123. appears (if it is not a function name itself), and line number
  124. references.
  125. .IP " *" 4
  126. Each line number may be preceded by an
  127. <asterisk>
  128. (\c
  129. .BR '*' )
  130. flag, meaning that this is the declaring reference. Other
  131. single-character flags, with implementation-defined meanings, may be
  132. included.
  133. .SH STDERR
  134. The standard error shall be used only for diagnostic messages.
  135. .SH "OUTPUT FILES"
  136. The output file named by the
  137. .BR \-o
  138. option shall be used instead of standard output.
  139. .SH "EXTENDED DESCRIPTION"
  140. None.
  141. .SH "EXIT STATUS"
  142. The following exit values shall be returned:
  143. .IP "\00" 6
  144. Successful completion.
  145. .IP >0 6
  146. An error occurred.
  147. .SH "CONSEQUENCES OF ERRORS"
  148. Default.
  149. .LP
  150. .IR "The following sections are informative."
  151. .SH "APPLICATION USAGE"
  152. None.
  153. .SH EXAMPLES
  154. None.
  155. .SH RATIONALE
  156. None.
  157. .SH "FUTURE DIRECTIONS"
  158. None.
  159. .SH "SEE ALSO"
  160. .IR "\fIc99\fR\^"
  161. .P
  162. The Base Definitions volume of POSIX.1\(hy2017,
  163. .IR "Chapter 8" ", " "Environment Variables",
  164. .IR "Section 12.2" ", " "Utility Syntax Guidelines"
  165. .\"
  166. .SH COPYRIGHT
  167. Portions of this text are reprinted and reproduced in electronic form
  168. from IEEE Std 1003.1-2017, Standard for Information Technology
  169. -- Portable Operating System Interface (POSIX), The Open Group Base
  170. Specifications Issue 7, 2018 Edition,
  171. Copyright (C) 2018 by the Institute of
  172. Electrical and Electronics Engineers, Inc and The Open Group.
  173. In the event of any discrepancy between this version and the original IEEE and
  174. The Open Group Standard, the original IEEE and The Open Group Standard
  175. is the referee document. The original Standard can be obtained online at
  176. http://www.opengroup.org/unix/online.html .
  177. .PP
  178. Any typographical or formatting errors that appear
  179. in this page are most likely
  180. to have been introduced during the conversion of the source files to
  181. man page format. To report such errors, see
  182. https://www.kernel.org/doc/man-pages/reporting_bugs.html .