home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 4 / FreshFish_May-June1994.bin / bbs / gnu / gcc-2.5.8-bin.lha / man / cat1 / cccp.0 next >
Encoding:
Text File  |  1994-02-08  |  16.2 KB  |  463 lines
  1.  
  2.  
  3.  
  4. cpp(1)                      GNU Tools                      cpp(1)
  5.  
  6.  
  7.  
  8. NAME
  9.      cccp, cpp - The GNU C-Compatible Compiler Preprocessor.
  10.  
  11. SYNOPSIS
  12.      cccp [-$] [-A_p_r_e_d_i_c_a_t_e[(_v_a_l_u_e)]] [-C] [-D_n_a_m_e[=_d_e_f_i_n_i_t_i_o_n]]
  13.           [-dD] [-dM] [-I _d_i_r_e_c_t_o_r_y] [-H] [-I-] [-imacros _f_i_l_e]
  14.           [-include _f_i_l_e] [-idirafter _d_i_r] [-iprefix _p_r_e_f_i_x]
  15.           [-iwithprefix _d_i_r] [-lang-c] [-lang-c++] [-lang-objc]
  16.           [-lang-objc++] [-lint] [-M] [-MD] [-MM] [-MMD]
  17.           [-nostdinc] [-nostdinc++] [-P] [-pedantic]
  18.           [-pedantic-errors] [-traditional] [-trigraphs] [-U_n_a_m_e]
  19.           [-undef] [-Wtrigraphs] [-Wcomment] [-Wall]
  20.           [-Wtraditional]
  21.           [_i_n_f_i_l_e|-] [_o_u_t_f_i_l_e|-]
  22.  
  23. DESCRIPTION
  24.      The C preprocessor is a _m_a_c_r_o _p_r_o_c_e_s_s_o_r  that  is  used  au-
  25.      tomatically  by the C compiler to transform your program be-
  26.      fore actual compilation.  It is called a macro processor be-
  27.      cause it allows you to define _m_a_c_r_o_s, which are brief abbre-
  28.      viations for longer constructs.
  29.  
  30.      The C preprocessor provides four  separate  facilities  that
  31.      you can use as you see fit:
  32.  
  33.      o+    Inclusion of header files.  These are files of declara-
  34.           tions that can be substituted into your program.
  35.  
  36.      o+    Macro expansion.  You can define _m_a_c_r_o_s, which are  ab-
  37.           breviations for arbitrary fragments of C code, and then
  38.           the C preprocessor will replace the macros  with  their
  39.           definitions throughout the program.
  40.  
  41.      o+    Conditional compilation.   Using  special  preprocessor
  42.           commands,  you can include or exclude parts of the pro-
  43.           gram according to various conditions.
  44.  
  45.      o+    Line control.  If you use a program to combine or rear-
  46.           range  source  files into an intermediate file which is
  47.           then compiled, you can use line control to  inform  the
  48.           compiler  of  where  each  source  line originally came
  49.           from.
  50.  
  51.      C preprocessors vary in some details.  For a  full  explana-
  52.      tion   of   the  GNU  C  preprocessor,  see  the  info  file
  53.      `cpp.info', or the manual _T_h_e _C _P_r_e_p_r_o_c_e_s_s_o_r.  Both of these
  54.      are   built   from   the  same  documentation  source  file,
  55.      `cpp.texinfo'.  The GNU C preprocessor provides  a  superset
  56.      of the features of ANSI Standard C.
  57.  
  58.      ANSI Standard C requires the rejection of many harmless con-
  59.      structs  commonly used by today's C programs.  Such incompa-
  60.  
  61.  
  62.  
  63. GNU Tools            Last change: 30apr1993                     1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. cpp(1)                      GNU Tools                      cpp(1)
  71.  
  72.  
  73.  
  74.      tibility would be inconvenient  for  users,  so  the  GNU  C
  75.      preprocessor is configured to accept these constructs by de-
  76.      fault.  Strictly speaking, to get ANSI Standard C, you  must
  77.      use  the options `-trigraphs', `-undef' and `-pedantic', but
  78.      in practice the consequences of having strict ANSI  Standard
  79.      C make it undesirable to do this.
  80.  
  81.      Most often when you use the C preprocessor you will not have
  82.      to invoke it explicitly: the C compiler will do so automati-
  83.      cally.  However, the preprocessor is sometimes useful  indi-
  84.      vidually.
  85.  
  86.      When you call the  preprocessor  individually,  either  name
  87.      (cpp or cccp) will do-they are completely synonymous.
  88.  
  89.      The C preprocessor expects two file names as arguments,  _i_n_-
  90.      _f_i_l_e  and  _o_u_t_f_i_l_e.   The preprocessor reads _i_n_f_i_l_e together
  91.      with any other files it specifies with `#include'.  All  the
  92.      output  generated  by the combined input files is written in
  93.      _o_u_t_f_i_l_e.
  94.  
  95.      Either _i_n_f_i_l_e or _o_u_t_f_i_l_e may be `-', which as  _i_n_f_i_l_e  means
  96.      to read from standard input and as _o_u_t_f_i_l_e means to write to
  97.      standard output.  Also, if _o_u_t_f_i_l_e or both  file  names  are
  98.      omitted, the standard output and standard input are used for
  99.      the omitted file names.
  100.  
  101. OPTIONS
  102.      Here is a table of command options accepted by the C prepro-
  103.      cessor.  These  options can also be given when compiling a C
  104.      program; they are passed along automatically to the  prepro-
  105.      cessor when it is invoked by the compiler.
  106.  
  107.      -P   Inhibit generation of `#'-lines with line-number infor-
  108.           mation in the output from the preprocessor.  This might
  109.           be useful when running the  preprocessor  on  something
  110.           that  is not C code and will be sent to a program which
  111.           might be confused by the `#'-lines.
  112.  
  113.      -C   Do not discard comments: pass them through to the  out-
  114.           put  file.   Comments appearing in arguments of a macro
  115.           call will be copied to the output before the  expansion
  116.           of the macro call.
  117.  
  118.      -traditional
  119.           Try to imitate the behavior of old-fashioned C, as  op-
  120.           posed to ANSI C.
  121.  
  122.      -trigraphs
  123.           Process ANSI standard trigraph  sequences.   These  are
  124.           three-character sequences, all starting with `??', that
  125.           are defined by ANSI C to stand for  single  characters.
  126.  
  127.  
  128.  
  129. GNU Tools            Last change: 30apr1993                     2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. cpp(1)                      GNU Tools                      cpp(1)
  137.  
  138.  
  139.  
  140.           For  example,  `??/'  stands  for `\', so `'??/n'' is a
  141.           character constant for a newline.   Strictly  speaking,
  142.           the GNU C preprocessor does not support all programs in
  143.           ANSI Standard C unless `-trigraphs' is used, but if you
  144.           ever notice the difference it will be with relief.
  145.  
  146.           You don't want to know any more about trigraphs.
  147.  
  148.      -pedantic
  149.           Issue warnings required by the ANSI C standard in  cer-
  150.           tain  cases such as when text other than a comment fol-
  151.           lows `#else' or `#endif'.
  152.  
  153.      -pedantic-errors
  154.           Like `-pedantic', except that errors are produced rath-
  155.           er than warnings.
  156.  
  157.      -Wtrigraphs
  158.           Warn if any trigraphs are  encountered  (assuming  they
  159.           are enabled).
  160.  
  161.      -Wcomment
  162.  
  163.      -Wcomments
  164.           Warn whenever a comment-start sequence `/*' appears  in
  165.           a comment.  (Both forms have the same effect).
  166.  
  167.      -Wall
  168.           Requests both `-Wtrigraphs' and  `-Wcomment'  (but  not
  169.           `-Wtraditional').
  170.  
  171.      -Wtraditional
  172.           Warn about certain constructs that  behave  differently
  173.           in traditional and ANSI C.
  174.  
  175.      -I _d_i_r_e_c_t_o_r_y
  176.            Add the directory _d_i_r_e_c_t_o_r_y to the end of the list  of
  177.           directories  to be searched for header files.  This can
  178.           be used to override a system header file,  substituting
  179.           your  own version, since these directories are searched
  180.           before the system header file directories.  If you  use
  181.           more  than one `-I' option, the directories are scanned
  182.           in left-to-right order; the standard system directories
  183.           come after.
  184.  
  185.      -I-  Any directories specified with `-I' options before  the
  186.           `-I-'  option  are  searched only for the case of `#in-
  187.           clude _f_i_l_e"';  they  are  not  searched  for  `#include
  188.           <_f_i_l_e>'.
  189.  
  190.           If additional directories are specified with  `-I'  op-
  191.           tions  after  the `-I-', these directories are searched
  192.  
  193.  
  194.  
  195. GNU Tools            Last change: 30apr1993                     3
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. cpp(1)                      GNU Tools                      cpp(1)
  203.  
  204.  
  205.  
  206.           for all `#include' directives.
  207.  
  208.           In addition, the `-I-' option inhibits the use  of  the
  209.           current  directory  as  the  first search directory for
  210.           `#include _f_i_l_e"'.  Therefore, the current directory  is
  211.           searched only if it is requested explicitly with `-I.'.
  212.           Specifying both `-I-' and `-I.' allows you  to  control
  213.           precisely  which  directories  are  searched before the
  214.           current one and which are searched after.
  215.  
  216.      -nostdinc
  217.           Do not  search  the  standard  system  directories  for
  218.           header  files.  Only the directories you have specified
  219.           with `-I' options (and the current  directory,  if  ap-
  220.           propriate) are searched.
  221.  
  222.      -nostdinc++
  223.           Do not search for header  files  in  the  C++  specific
  224.           standard  directories,  but  do  still search the other
  225.           standard directories.  (This option is used when build-
  226.           ing libg++.)
  227.  
  228.      -D _n_a_m_e
  229.            Predefine _n_a_m_e as a macro, with definition `1'.
  230.  
  231.      -D _n_a_m_e=_d_e_f_i_n_i_t_i_o_n
  232.            Predefine _n_a_m_e as a macro, with definition _d_e_f_i_n_i_t_i_o_n.
  233.           There  are  no  restrictions on the contents of _d_e_f_i_n_i_-
  234.           _t_i_o_n, but if you are invoking the preprocessor  from  a
  235.           shell  or  shell-like  program  you may need to use the
  236.           shell's quoting syntax to protect  characters  such  as
  237.           spaces that have a meaning in the shell syntax.  If you
  238.           use more than one `-D' for the same _n_a_m_e, the rightmost
  239.           definition takes effect.
  240.  
  241.      -U _n_a_m_e
  242.            Do not predefine _n_a_m_e.  If  both  `-U'  and  `-D'  are
  243.           specified for one name, the `-U' beats the `-D' and the
  244.           name is not predefined.
  245.  
  246.      -undef
  247.           Do not predefine any nonstandard macros.
  248.  
  249.      -A _n_a_m_e(value)
  250.           Assert (in the same way as  the  #assert  command)  the
  251.           predicate  _n_a_m_e  with tokenlist _v_a_l_u_e.  Remember to es-
  252.           cape or quote the parentheses on shell command lines.
  253.  
  254.           You can use `-A-' to disable all predefined assertions;
  255.           it also undefines all predefined macros.
  256.  
  257.      -dM  Instead of outputting the result of preprocessing, out-
  258.  
  259.  
  260.  
  261. GNU Tools            Last change: 30apr1993                     4
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. cpp(1)                      GNU Tools                      cpp(1)
  269.  
  270.  
  271.  
  272.           put a list of `#define' commands for all the macros de-
  273.           fined during the execution of the preprocessor, includ-
  274.           ing predefined macros.  This gives you a way of finding
  275.           out what is predefined in your version of  the  prepro-
  276.           cessor; assuming you have no file `foo.h', the command
  277.  
  278.           touch foo.h; cpp -dM foo.h
  279.  
  280.           will show the values of any predefined macros.
  281.  
  282.      -dD  Like `-dM' except in two respects: it does _n_o_t  include
  283.           the  predefined  macros,  and it outputs _b_o_t_h the `#de-
  284.           fine' commands and the result of  preprocessing.   Both
  285.           kinds of output go to the standard output file.
  286.  
  287.      -M   Instead of outputting the result of preprocessing, out-
  288.           put  a  rule suitable for make describing the dependen-
  289.           cies of the main source file.  The preprocessor outputs
  290.           one  make rule containing the object file name for that
  291.           source file, a colon, and the names of all the included
  292.           files.   If there are many included files then the rule
  293.           is split into several lines using `'-newline.
  294.  
  295.           This  feature  is  used  in   automatic   updating   of
  296.           makefiles.
  297.  
  298.      -MM  Like `-M' but mention  only  the  files  included  with
  299.           `#include  "_f_i_l_e"'.   System header files included with
  300.           `#include <_f_i_l_e>' are omitted.
  301.  
  302.      -MD  Like `-M' but the dependency information is written  to
  303.           files  with  names  made by replacing `.c' with `.d' at
  304.           the end of the input file names.  This is  in  addition
  305.           to compiling the file as specified-`-MD' does not inhi-
  306.           bit ordinary compilation the way `-M' does.
  307.  
  308.           In Mach, you can use the utility md to merge  the  `.d'
  309.           files  into a single dependency file suitable for using
  310.           with the `make' command.
  311.  
  312.      -MMD Like `-MD' except mention only user header  files,  not
  313.           system header files.
  314.  
  315.      -H   Print the name of each header file used, in addition to
  316.           other normal activities.
  317.  
  318.      -imacros _f_i_l_e
  319.            Process _f_i_l_e as input, discarding the  resulting  out-
  320.           put, before processing the regular input file.  Because
  321.           the output generated from _f_i_l_e is discarded,  the  only
  322.           effect of `-imacros _f_i_l_e' is to make the macros defined
  323.           in _f_i_l_e available for  use  in  the  main  input.   The
  324.  
  325.  
  326.  
  327. GNU Tools            Last change: 30apr1993                     5
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334. cpp(1)                      GNU Tools                      cpp(1)
  335.  
  336.  
  337.  
  338.           preprocessor evaluates any `-D' and `-U' options on the
  339.           command line before processing `-imacros _f_i_l_e' .
  340.  
  341.      -include _f_i_l_e
  342.           Process _f_i_l_e as input, and include  all  the  resulting
  343.           output, before processing the regular input file.
  344.  
  345.      -idirafter _d_i_r
  346.            Add the directory _d_i_r to the second include path.  The
  347.           directories  on  the  second  include path are searched
  348.           when a header file is not found in any  of  the  direc-
  349.           tories in the main include path (the one that `-I' adds
  350.           to).
  351.  
  352.      -iprefix _p_r_e_f_i_x
  353.            Specify _p_r_e_f_i_x as the prefix for  subsequent  `-iwith-
  354.           prefix' options.
  355.  
  356.      -iwithprefix _d_i_r
  357.            Add a directory  to  the  second  include  path.   The
  358.           directory's  name  is  made by concatenating _p_r_e_f_i_x and
  359.           _d_i_r, where _p_r_e_f_i_x was specified previously with `-ipre-
  360.           fix'.
  361.  
  362.      -lang-c
  363.  
  364.      -lang-c++
  365.  
  366.      -lang-objc
  367.  
  368.      -lang-objc++
  369.           Specify the source  language.   `-lang-c++'  makes  the
  370.           preprocessor  handle  C++  comment syntax, and includes
  371.           extra default include directories for C++, and  `-lang-
  372.           objc'  enables  the  Objective  C  `#import' directive.
  373.           `-lang-c' explicitly turns off  both  of  these  exten-
  374.           sions, and `-lang-objc++' enables both.
  375.  
  376.           These options are generated by the compiler driver gcc,
  377.           but not passed from the `gcc' command line.
  378.  
  379.      -lint
  380.           Look for commands to the program checker lint  embedded
  381.           in  comments, and emit them preceded by `#pragma lint'.
  382.           For example, the comment  `/*  NOTREACHED  */'  becomes
  383.           `#pragma lint NOTREACHED'.
  384.  
  385.           This option is available only when you call cpp direct-
  386.           ly; gcc will not pass it from its command line.
  387.  
  388.      -$   Forbid the use of `$' in identifiers.  This is required
  389.           for  ANSI conformance.  gcc automatically supplies this
  390.  
  391.  
  392.  
  393. GNU Tools            Last change: 30apr1993                     6
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400. cpp(1)                      GNU Tools                      cpp(1)
  401.  
  402.  
  403.  
  404.           option to the preprocessor if you specify `-ansi',  but
  405.           gcc  doesn't recognize the `-$' option itself-to use it
  406.           without the other effects of `-ansi', you must call the
  407.           preprocessor directly.
  408.  
  409. SEE ALSO
  410.      `Cpp' entry in info; _T_h_e _C _P_r_e_p_r_o_c_e_s_s_o_r, Richard  M.  Stall-
  411.      man.
  412.      gcc(1); `Gcc' entry in info; _U_s_i_n_g _a_n_d _P_o_r_t_i_n_g _G_N_U  _C_C  (_f_o_r
  413.      _v_e_r_s_i_o_n _2._0), Richard M. Stallman.
  414.  
  415. COPYING
  416.      Copyright (c) 1991, 1992,  1993  Free  Software  Foundation,
  417.      Inc.
  418.  
  419.      Permission is granted to make and distribute verbatim copies
  420.      of  this  manual provided the copyright notice and this per-
  421.      mission notice are preserved on all copies.
  422.  
  423.      Permission is granted to copy and distribute  modified  ver-
  424.      sions of this manual under the conditions for verbatim copy-
  425.      ing, provided that the entire resulting derived work is dis-
  426.      tributed under the terms of a permission notice identical to
  427.      this one.
  428.  
  429.      Permission is granted to copy and distribute translations of
  430.      this  manual  into  another language, under the above condi-
  431.      tions for modified versions, except that this permission no-
  432.      tice  may  be  included in translations approved by the Free
  433.      Software Foundation instead of in the original English.
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459. GNU Tools            Last change: 30apr1993                     7
  460.  
  461.  
  462.  
  463.