tools/cxref/INSTALL

   1              C Cross Referencing & Documentation tool Version 1.5g
   2              =====================================================
   3
   4 To install the program, do the following:
   5
   6 1) Run ./configure
   7
   8    The cxref specific options that you can use are:
   9
  10    --enable-us-paper    - Enable US paper size instead of A4
  11
  12    --with-cxref-cpp     - This forces the cxref-cpp program to be compiled and
  13                           used instead of gcc.
  14    --without-cxref-cpp  - This forces the cxref-cpp program not to be compiled
  15                           and gcc will be used instead.
  16
  17    (Normally the configure script will check if the gcc version that you are
  18     using works the same as cxref-cpp and uses that if it is.  The above two
  19     options allow forcing to either use cxref-cpp or gcc in all cases).
  20
  21    The list of generic configure options can be seen by using the --help option.
  22
  23    The most useful one is --prefix which allows the installation directory to
  24    be specified.  For example './configure --prefix=/usr/local' will install all
  25    of the files under 'bin' and 'man/man*' subdirectories of '/usr/local'.
  26
  27
  28 2) Run 'make'         in this directory to make all of the programs
  29        'make docs'    in this directory to make the README & documents
  30        'make install' in this directory to install the program.
  31
  32        To install the files with a different root directory you can use
  33        'make install DESTDIR=/some/directory/'.  This will prefix all of
  34        the installation directories with '/some/directory/'.
  35
  36
  37 3) Print README.ps, read README.dvi or browse README.html to understand how to
  38    use the program.