tools/cxref/cpp/cxref-cpp.man

   1 .\" $Header$
   2 .\"
   3 .\"  C Cross Referencing & Documenting tool - Version 1.5g
   4 .\"
   5 .\"  Manual page for cxref-cpp
   6 .\"
   7 .\"  Written by Andrew M. Bishop
   8 .\"
   9 .\"  This file Copyright 1996,1997,2004 Andrew M. Bishop
  10 .\"  It may be distributed under the GNU Public License, version 2, or
  11 .\"  any higher version.  See section COPYING of the GNU Public license
  12 .\"  for conditions under which this file may be redistributed.
  13 .\"
  14 .TH cxref-cpp 1 "May 9, 2004"
  15 .SH NAME
  16 cxref-cpp - A modified C preprocessor to use with cxref.
  17
  18 .SH SYNOPSIS
  19 .B cxref-cpp
  20 .I ...
  21
  22 .SH DESCRIPTION
  23
  24 To improve the output that is available for the source code for
  25 cross-referencing a modified version of the GNU CPP v2.7.2 is supplied (named
  26 cxref-cpp).
  27
  28 This modified C preprocessor allows for a finer control over some features of
  29 the preprocessing that are not important for a compiler.  In a standard
  30 preprocessor, the preprocessor directives are intended for use only by the
  31 preprocessor, so passing the information through is not important.
  32
  33 With cxref-cpp, there are some features that are different to the standard GNU
  34 CPP:
  35
  36 .IP
  37 Compared to gcc versions earlier than version 2.8.0 there is an extra option
  38 that will output the #include lines from the source file.  In version 2.8.0 and
  39 later this option is present.
  40 .IP
  41 Comments trailing a #include or a #define are not preserved by all versions of
  42 gcc even if the -C option is used.  This is not important while compiling, but
  43 is useful for documenting.
  44 .IP
  45 The cxref-cpp program will take on the personality of the installed version of
  46 gcc so that the gcc header files can be parsed.  This means that it includes the
  47 same default include directory paths and macro definitions.  The file that
  48 contains these definitions is called cxref-cpp.defines and is installed by the
  49 cxref-cpp-configure program or specified by the -cxref-cpp-defines command line
  50 option.
  51 .LP
  52
  53 .SH OPTIONS
  54
  55 The same as for gcc, apart from '-cxref-cpp-defines' described above.
  56
  57 .SH SEE ALSO
  58
  59 cxref(1), cxref-cpp-configure(1), gcc(1)