tools/cxref/cpp/README.man

   1 .\" $Header$
   2 .\"
   3 .\"  C Cross Referencing & Documenting tool - Version 1.4
   4 .\"
   5 .\"  Manual page for cxref-cpp
   6 .\"
   7 .\"  Written by Andrew M. Bishop
   8 .\"
   9 .\"  This file Copyright 1996,1997 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 "April 27, 1997"
  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 a modified version of the GNU CPP V2.7.2
  25 is supplied (named cxref-cpp).
  26
  27 This modified C preprocessor allows for a finer control over some features of
  28 the preprocessing that are not important for a compiler.  In a standard
  29 preprocessor, the preprocessor directives are intended for use only by the
  30 preprocessor, so passing the information through is not important.
  31
  32 With cxref-cpp, there are two features that are different to the standard GNU
  33 CPP:
  34
  35 .IP
  36 The #include directives from the file are output in the same way as the #defines
  37 are output.  An extra flag has been added to cpp to do this, '-dI', it works in
  38 the same way as the existing '-dD' flag for #defines.
  39 .IP
  40 Comments trailing a #include or a #define are dropped with GNU CPP even if -C is
  41 used. This is not important while compiling, but is useful for documenting.
  42 .LP
  43
  44 .SH OPTIONS
  45
  46 The same as for gcc, apart from '-dI' described above.
  47
  48 .SH SEE ALSO
  49
  50 cxref(1), gcc(1)