CXREF(1)                   POSIX Programmer's Manual                  CXREF(1)



PPRROOLLOOGG
       This manual page is part of the POSIX Programmer's Manual.  The OS
       implementation of this interface may differ (consult the corresponding
       OS manual page for details of OS behavior), or the interface may not be
       implemented on OS.

NNAAMMEE
       cxref -- generate a C-language program cross-reference table
       (DDEEVVEELLOOPPMMEENNTT)

SSYYNNOOPPSSIISS
       cxref [[-cs]] [[-o _f_i_l_e]] [[-w _n_u_m]] [[-D _n_a_m_e[[=_d_e_f]]]]... [[-I _d_i_r]]...
           [[-U _n_a_m_e]]... _f_i_l_e...

DDEESSCCRRIIPPTTIIOONN
       The _c_x_r_e_f utility shall analyze a collection of C-language _f_i_l_es and
       attempt to build a cross-reference table. Information from ##ddeeffiinnee
       lines shall be included in the symbol table. A sorted listing shall be
       written to standard output of all symbols (auto, static, and global) in
       each _f_i_l_e separately, or with the --cc option, in combination. Each
       symbol shall contain an <asterisk> before the declaring reference.

OOPPTTIIOONNSS
       The _c_x_r_e_f utility shall conform to the Base Definitions volume of
       POSIX.1-2017, _S_e_c_t_i_o_n _1_2_._2, _U_t_i_l_i_t_y _S_y_n_t_a_x _G_u_i_d_e_l_i_n_e_s, except that the
       order of the --DD, --II, and --UU options (which are identical to their
       interpretation by _c_9_9) is significant. The following options shall be
       supported:

       --cc        Write a combined cross-reference of all input files.

       --ss        Operate silently; do not print input filenames.

       --oo _f_i_l_e   Direct output to named _f_i_l_e.

       --ww _n_u_m    Format output no wider than _n_u_m (decimal) columns. This
                 option defaults to 80 if _n_u_m is not specified or is less than
                 51.

       --DD        Equivalent to _c_9_9.

       --II        Equivalent to _c_9_9.

       --UU        Equivalent to _c_9_9.

OOPPEERRAANNDDSS
       The following operand shall be supported:

       _f_i_l_e      A pathname of a C-language source file.

SSTTDDIINN
       Not used.

IINNPPUUTT FFIILLEESS
       The input files are C-language source files.

EENNVVIIRROONNMMEENNTT VVAARRIIAABBLLEESS
       The following environment variables shall affect the execution of
       _c_x_r_e_f:

       _L_A_N_G      Provide a default value for the internationalization
                 variables that are unset or null. (See the Base Definitions
                 volume of POSIX.1-2017, _S_e_c_t_i_o_n _8_._2, _I_n_t_e_r_n_a_t_i_o_n_a_l_i_z_a_t_i_o_n
                 _V_a_r_i_a_b_l_e_s for the precedence of internationalization
                 variables used to determine the values of locale categories.)

       _L_C___A_L_L    If set to a non-empty string value, override the values of
                 all the other internationalization variables.

       _L_C___C_O_L_L_A_T_E
                 Determine the locale for the ordering of the output.

       _L_C___C_T_Y_P_E  Determine the locale for the interpretation of sequences of
                 bytes of text data as characters (for example, single-byte as
                 opposed to multi-byte characters in arguments and input
                 files).

       _L_C___M_E_S_S_A_G_E_S
                 Determine the locale that should be used to affect the format
                 and contents of diagnostic messages written to standard
                 error.

       _N_L_S_P_A_T_H   Determine the location of message catalogs for the processing
                 of _L_C___M_E_S_S_A_G_E_S.

AASSYYNNCCHHRROONNOOUUSS EEVVEENNTTSS
       Default.

SSTTDDOOUUTT
       The standard output shall be used for the cross-reference listing,
       unless the --oo option is used to select a different output file.

       The format of standard output is unspecified, except that the following
       information shall be included:

        *  If the --cc option is not specified, each portion of the listing
           shall start with the name of the input file on a separate line.

        *  The name line shall be followed by a sorted list of symbols, each
           with its associated location pathname, the name of the function in
           which it appears (if it is not a function name itself), and line
           number references.

        *  Each line number may be preceded by an <asterisk> (''**'') flag,
           meaning that this is the declaring reference. Other single-
           character flags, with implementation-defined meanings, may be
           included.

SSTTDDEERRRR
       The standard error shall be used only for diagnostic messages.

OOUUTTPPUUTT FFIILLEESS
       The output file named by the --oo option shall be used instead of
       standard output.

EEXXTTEENNDDEEDD DDEESSCCRRIIPPTTIIOONN
       None.

EEXXIITT SSTTAATTUUSS
       The following exit values shall be returned:

        0    Successful completion.

       >0    An error occurred.

CCOONNSSEEQQUUEENNCCEESS OOFF EERRRROORRSS
       Default.

       _T_h_e _f_o_l_l_o_w_i_n_g _s_e_c_t_i_o_n_s _a_r_e _i_n_f_o_r_m_a_t_i_v_e_.

AAPPPPLLIICCAATTIIOONN UUSSAAGGEE
       None.

EEXXAAMMPPLLEESS
       None.

RRAATTIIOONNAALLEE
       None.

FFUUTTUURREE DDIIRREECCTTIIOONNSS
       None.

SSEEEE AALLSSOO
       _c_9_9

       The Base Definitions volume of POSIX.1-2017, _C_h_a_p_t_e_r _8, _E_n_v_i_r_o_n_m_e_n_t
       _V_a_r_i_a_b_l_e_s, _S_e_c_t_i_o_n _1_2_._2, _U_t_i_l_i_t_y _S_y_n_t_a_x _G_u_i_d_e_l_i_n_e_s

CCOOPPYYRRIIGGHHTT
       Portions of this text are reprinted and reproduced in electronic form
       from IEEE Std 1003.1-2017, Standard for Information Technology --
       Portable Operating System Interface (POSIX), The Open Group Base
       Specifications Issue 7, 2018 Edition, Copyright (C) 2018 by the
       Institute of Electrical and Electronics Engineers, Inc and The Open
       Group.  In the event of any discrepancy between this version and the
       original IEEE and The Open Group Standard, the original IEEE and The
       Open Group Standard is the referee document. The original Standard can
       be obtained online at http://www.opengroup.org/unix/online.html .

       Any typographical or formatting errors that appear in this page are
       most likely to have been introduced during the conversion of the source
       files to man page format. To report such errors, see
       https://www.kernel.org/doc/man-pages/reporting_bugs.html .



IEEE/The Open Group                  2017                             CXREF(1)
