Home | History | Annotate | Line # | Download | only in doc
cppopts.texi revision 1.1.1.2
      1 @c Copyright (C) 1999-2013 Free Software Foundation, Inc.
      2 @c This is part of the CPP and GCC manuals.
      3 @c For copying conditions, see the file gcc.texi.
      4 
      5 @c ---------------------------------------------------------------------
      6 @c Options affecting the preprocessor
      7 @c ---------------------------------------------------------------------
      8 
      9 @c If this file is included with the flag ``cppmanual'' set, it is
     10 @c formatted for inclusion in the CPP manual; otherwise the main GCC manual.
     11 
     12 @table @gcctabopt
     13 @item -D @var{name}
     14 @opindex D
     15 Predefine @var{name} as a macro, with definition @code{1}.
     16 
     17 @item -D @var{name}=@var{definition}
     18 The contents of @var{definition} are tokenized and processed as if
     19 they appeared during translation phase three in a @samp{#define}
     20 directive.  In particular, the definition will be truncated by
     21 embedded newline characters.
     22 
     23 If you are invoking the preprocessor from a shell or shell-like
     24 program you may need to use the shell's quoting syntax to protect
     25 characters such as spaces that have a meaning in the shell syntax.
     26 
     27 If you wish to define a function-like macro on the command line, write
     28 its argument list with surrounding parentheses before the equals sign
     29 (if any).  Parentheses are meaningful to most shells, so you will need
     30 to quote the option.  With @command{sh} and @command{csh},
     31 @option{-D'@var{name}(@var{args@dots{}})=@var{definition}'} works.
     32 
     33 @option{-D} and @option{-U} options are processed in the order they
     34 are given on the command line.  All @option{-imacros @var{file}} and
     35 @option{-include @var{file}} options are processed after all
     36 @option{-D} and @option{-U} options.
     37 
     38 @item -U @var{name}
     39 @opindex U
     40 Cancel any previous definition of @var{name}, either built in or
     41 provided with a @option{-D} option.
     42 
     43 @item -undef
     44 @opindex undef
     45 Do not predefine any system-specific or GCC-specific macros.  The
     46 standard predefined macros remain defined.
     47 @ifset cppmanual
     48 @xref{Standard Predefined Macros}.
     49 @end ifset
     50 
     51 @item -I @var{dir}
     52 @opindex I
     53 Add the directory @var{dir} to the list of directories to be searched
     54 for header files.
     55 @ifset cppmanual
     56 @xref{Search Path}.
     57 @end ifset
     58 Directories named by @option{-I} are searched before the standard
     59 system include directories.  If the directory @var{dir} is a standard
     60 system include directory, the option is ignored to ensure that the
     61 default search order for system directories and the special treatment
     62 of system headers are not defeated
     63 @ifset cppmanual
     64 (@pxref{System Headers})
     65 @end ifset
     66 .
     67 If @var{dir} begins with @code{=}, then the @code{=} will be replaced
     68 by the sysroot prefix; see @option{--sysroot} and @option{-isysroot}.
     69 
     70 @item -o @var{file}
     71 @opindex o
     72 Write output to @var{file}.  This is the same as specifying @var{file}
     73 as the second non-option argument to @command{cpp}.  @command{gcc} has a
     74 different interpretation of a second non-option argument, so you must
     75 use @option{-o} to specify the output file.
     76 
     77 @item -Wall
     78 @opindex Wall
     79 Turns on all optional warnings which are desirable for normal code.
     80 At present this is @option{-Wcomment}, @option{-Wtrigraphs},
     81 @option{-Wmultichar} and a warning about integer promotion causing a
     82 change of sign in @code{#if} expressions.  Note that many of the
     83 preprocessor's warnings are on by default and have no options to
     84 control them.
     85 
     86 @item -Wcomment
     87 @itemx -Wcomments
     88 @opindex Wcomment
     89 @opindex Wcomments
     90 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
     91 comment, or whenever a backslash-newline appears in a @samp{//} comment.
     92 (Both forms have the same effect.)
     93 
     94 @item -Wtrigraphs
     95 @opindex Wtrigraphs
     96 @anchor{Wtrigraphs}
     97 Most trigraphs in comments cannot affect the meaning of the program.
     98 However, a trigraph that would form an escaped newline (@samp{??/} at
     99 the end of a line) can, by changing where the comment begins or ends.
    100 Therefore, only trigraphs that would form escaped newlines produce
    101 warnings inside a comment.
    102 
    103 This option is implied by @option{-Wall}.  If @option{-Wall} is not
    104 given, this option is still enabled unless trigraphs are enabled.  To
    105 get trigraph conversion without warnings, but get the other
    106 @option{-Wall} warnings, use @samp{-trigraphs -Wall -Wno-trigraphs}.
    107 
    108 @item -Wtraditional
    109 @opindex Wtraditional
    110 Warn about certain constructs that behave differently in traditional and
    111 ISO C@.  Also warn about ISO C constructs that have no traditional C
    112 equivalent, and problematic constructs which should be avoided.
    113 @ifset cppmanual
    114 @xref{Traditional Mode}.
    115 @end ifset
    116 
    117 @item -Wundef
    118 @opindex Wundef
    119 Warn whenever an identifier which is not a macro is encountered in an
    120 @samp{#if} directive, outside of @samp{defined}.  Such identifiers are
    121 replaced with zero.
    122 
    123 @item -Wunused-macros
    124 @opindex Wunused-macros
    125 Warn about macros defined in the main file that are unused.  A macro
    126 is @dfn{used} if it is expanded or tested for existence at least once.
    127 The preprocessor will also warn if the macro has not been used at the
    128 time it is redefined or undefined.
    129 
    130 Built-in macros, macros defined on the command line, and macros
    131 defined in include files are not warned about.
    132 
    133 @emph{Note:} If a macro is actually used, but only used in skipped
    134 conditional blocks, then CPP will report it as unused.  To avoid the
    135 warning in such a case, you might improve the scope of the macro's
    136 definition by, for example, moving it into the first skipped block.
    137 Alternatively, you could provide a dummy use with something like:
    138 
    139 @smallexample
    140 #if defined the_macro_causing_the_warning
    141 #endif
    142 @end smallexample
    143 
    144 @item -Wendif-labels
    145 @opindex Wendif-labels
    146 Warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
    147 This usually happens in code of the form
    148 
    149 @smallexample
    150 #if FOO
    151 @dots{}
    152 #else FOO
    153 @dots{}
    154 #endif FOO
    155 @end smallexample
    156 
    157 @noindent
    158 The second and third @code{FOO} should be in comments, but often are not
    159 in older programs.  This warning is on by default.
    160 
    161 @item -Werror
    162 @opindex Werror
    163 Make all warnings into hard errors.  Source code which triggers warnings
    164 will be rejected.
    165 
    166 @item -Wsystem-headers
    167 @opindex Wsystem-headers
    168 Issue warnings for code in system headers.  These are normally unhelpful
    169 in finding bugs in your own code, therefore suppressed.  If you are
    170 responsible for the system library, you may want to see them.
    171 
    172 @item -w
    173 @opindex w
    174 Suppress all warnings, including those which GNU CPP issues by default.
    175 
    176 @item -pedantic
    177 @opindex pedantic
    178 Issue all the mandatory diagnostics listed in the C standard.  Some of
    179 them are left out by default, since they trigger frequently on harmless
    180 code.
    181 
    182 @item -pedantic-errors
    183 @opindex pedantic-errors
    184 Issue all the mandatory diagnostics, and make all mandatory diagnostics
    185 into errors.  This includes mandatory diagnostics that GCC issues
    186 without @samp{-pedantic} but treats as warnings.
    187 
    188 @item -M
    189 @opindex M
    190 @cindex @command{make}
    191 @cindex dependencies, @command{make}
    192 Instead of outputting the result of preprocessing, output a rule
    193 suitable for @command{make} describing the dependencies of the main
    194 source file.  The preprocessor outputs one @command{make} rule containing
    195 the object file name for that source file, a colon, and the names of all
    196 the included files, including those coming from @option{-include} or
    197 @option{-imacros} command line options.
    198 
    199 Unless specified explicitly (with @option{-MT} or @option{-MQ}), the
    200 object file name consists of the name of the source file with any
    201 suffix replaced with object file suffix and with any leading directory
    202 parts removed.  If there are many included files then the rule is
    203 split into several lines using @samp{\}-newline.  The rule has no
    204 commands.
    205 
    206 This option does not suppress the preprocessor's debug output, such as
    207 @option{-dM}.  To avoid mixing such debug output with the dependency
    208 rules you should explicitly specify the dependency output file with
    209 @option{-MF}, or use an environment variable like
    210 @env{DEPENDENCIES_OUTPUT} (@pxref{Environment Variables}).  Debug output
    211 will still be sent to the regular output stream as normal.
    212 
    213 Passing @option{-M} to the driver implies @option{-E}, and suppresses
    214 warnings with an implicit @option{-w}.
    215 
    216 @item -MM
    217 @opindex MM
    218 Like @option{-M} but do not mention header files that are found in
    219 system header directories, nor header files that are included,
    220 directly or indirectly, from such a header.
    221 
    222 This implies that the choice of angle brackets or double quotes in an
    223 @samp{#include} directive does not in itself determine whether that
    224 header will appear in @option{-MM} dependency output.  This is a
    225 slight change in semantics from GCC versions 3.0 and earlier.
    226 
    227 @anchor{dashMF}
    228 @item -MF @var{file}
    229 @opindex MF
    230 When used with @option{-M} or @option{-MM}, specifies a
    231 file to write the dependencies to.  If no @option{-MF} switch is given
    232 the preprocessor sends the rules to the same place it would have sent
    233 preprocessed output.
    234 
    235 When used with the driver options @option{-MD} or @option{-MMD},
    236 @option{-MF} overrides the default dependency output file.
    237 
    238 @item -MG
    239 @opindex MG
    240 In conjunction with an option such as @option{-M} requesting
    241 dependency generation, @option{-MG} assumes missing header files are
    242 generated files and adds them to the dependency list without raising
    243 an error.  The dependency filename is taken directly from the
    244 @code{#include} directive without prepending any path.  @option{-MG}
    245 also suppresses preprocessed output, as a missing header file renders
    246 this useless.
    247 
    248 This feature is used in automatic updating of makefiles.
    249 
    250 @item -MP
    251 @opindex MP
    252 This option instructs CPP to add a phony target for each dependency
    253 other than the main file, causing each to depend on nothing.  These
    254 dummy rules work around errors @command{make} gives if you remove header
    255 files without updating the @file{Makefile} to match.
    256 
    257 This is typical output:
    258 
    259 @smallexample
    260 test.o: test.c test.h
    261 
    262 test.h:
    263 @end smallexample
    264 
    265 @item -MT @var{target}
    266 @opindex MT
    267 
    268 Change the target of the rule emitted by dependency generation.  By
    269 default CPP takes the name of the main input file, deletes any
    270 directory components and any file suffix such as @samp{.c}, and
    271 appends the platform's usual object suffix.  The result is the target.
    272 
    273 An @option{-MT} option will set the target to be exactly the string you
    274 specify.  If you want multiple targets, you can specify them as a single
    275 argument to @option{-MT}, or use multiple @option{-MT} options.
    276 
    277 For example, @option{@w{-MT '$(objpfx)foo.o'}} might give
    278 
    279 @smallexample
    280 $(objpfx)foo.o: foo.c
    281 @end smallexample
    282 
    283 @item -MQ @var{target}
    284 @opindex MQ
    285 
    286 Same as @option{-MT}, but it quotes any characters which are special to
    287 Make.  @option{@w{-MQ '$(objpfx)foo.o'}} gives
    288 
    289 @smallexample
    290 $$(objpfx)foo.o: foo.c
    291 @end smallexample
    292 
    293 The default target is automatically quoted, as if it were given with
    294 @option{-MQ}.
    295 
    296 @item -MD
    297 @opindex MD
    298 @option{-MD} is equivalent to @option{-M -MF @var{file}}, except that
    299 @option{-E} is not implied.  The driver determines @var{file} based on
    300 whether an @option{-o} option is given.  If it is, the driver uses its
    301 argument but with a suffix of @file{.d}, otherwise it takes the name
    302 of the input file, removes any directory components and suffix, and
    303 applies a @file{.d} suffix.
    304 
    305 If @option{-MD} is used in conjunction with @option{-E}, any
    306 @option{-o} switch is understood to specify the dependency output file
    307 (@pxref{dashMF,,-MF}), but if used without @option{-E}, each @option{-o}
    308 is understood to specify a target object file.
    309 
    310 Since @option{-E} is not implied, @option{-MD} can be used to generate
    311 a dependency output file as a side-effect of the compilation process.
    312 
    313 @item -MMD
    314 @opindex MMD
    315 Like @option{-MD} except mention only user header files, not system
    316 header files.
    317 
    318 @ifclear cppmanual
    319 @item -fpch-deps
    320 @opindex fpch-deps
    321 When using precompiled headers (@pxref{Precompiled Headers}), this flag
    322 will cause the dependency-output flags to also list the files from the
    323 precompiled header's dependencies.  If not specified only the
    324 precompiled header would be listed and not the files that were used to
    325 create it because those files are not consulted when a precompiled
    326 header is used.
    327 
    328 @item -fpch-preprocess
    329 @opindex fpch-preprocess
    330 This option allows use of a precompiled header (@pxref{Precompiled
    331 Headers}) together with @option{-E}.  It inserts a special @code{#pragma},
    332 @code{#pragma GCC pch_preprocess "@var{filename}"} in the output to mark
    333 the place where the precompiled header was found, and its @var{filename}.
    334 When @option{-fpreprocessed} is in use, GCC recognizes this @code{#pragma}
    335 and loads the PCH@.
    336 
    337 This option is off by default, because the resulting preprocessed output
    338 is only really suitable as input to GCC@.  It is switched on by
    339 @option{-save-temps}.
    340 
    341 You should not write this @code{#pragma} in your own code, but it is
    342 safe to edit the filename if the PCH file is available in a different
    343 location.  The filename may be absolute or it may be relative to GCC's
    344 current directory.
    345 
    346 @end ifclear
    347 @item -x c
    348 @itemx -x c++
    349 @itemx -x objective-c
    350 @itemx -x assembler-with-cpp
    351 @opindex x
    352 Specify the source language: C, C++, Objective-C, or assembly.  This has
    353 nothing to do with standards conformance or extensions; it merely
    354 selects which base syntax to expect.  If you give none of these options,
    355 cpp will deduce the language from the extension of the source file:
    356 @samp{.c}, @samp{.cc}, @samp{.m}, or @samp{.S}.  Some other common
    357 extensions for C++ and assembly are also recognized.  If cpp does not
    358 recognize the extension, it will treat the file as C; this is the most
    359 generic mode.
    360 
    361 @emph{Note:} Previous versions of cpp accepted a @option{-lang} option
    362 which selected both the language and the standards conformance level.
    363 This option has been removed, because it conflicts with the @option{-l}
    364 option.
    365 
    366 @item -std=@var{standard}
    367 @itemx -ansi
    368 @opindex ansi
    369 @opindex std=
    370 Specify the standard to which the code should conform.  Currently CPP
    371 knows about C and C++ standards; others may be added in the future.
    372 
    373 @var{standard}
    374 may be one of:
    375 @table @code
    376 @item c90
    377 @itemx c89
    378 @itemx iso9899:1990
    379 The ISO C standard from 1990.  @samp{c90} is the customary shorthand for
    380 this version of the standard.
    381 
    382 The @option{-ansi} option is equivalent to @option{-std=c90}.
    383 
    384 @item iso9899:199409
    385 The 1990 C standard, as amended in 1994.
    386 
    387 @item iso9899:1999
    388 @itemx c99
    389 @itemx iso9899:199x
    390 @itemx c9x
    391 The revised ISO C standard, published in December 1999.  Before
    392 publication, this was known as C9X@.
    393 
    394 @item iso9899:2011
    395 @itemx c11
    396 @itemx c1x
    397 The revised ISO C standard, published in December 2011.  Before
    398 publication, this was known as C1X@.
    399 
    400 @item gnu90
    401 @itemx gnu89
    402 The 1990 C standard plus GNU extensions.  This is the default.
    403 
    404 @item gnu99
    405 @itemx gnu9x
    406 The 1999 C standard plus GNU extensions.
    407 
    408 @item gnu11
    409 @itemx gnu1x
    410 The 2011 C standard plus GNU extensions.
    411 
    412 @item c++98
    413 The 1998 ISO C++ standard plus amendments.
    414 
    415 @item gnu++98
    416 The same as @option{-std=c++98} plus GNU extensions.  This is the
    417 default for C++ code.
    418 @end table
    419 
    420 @item -I-
    421 @opindex I-
    422 Split the include path.  Any directories specified with @option{-I}
    423 options before @option{-I-} are searched only for headers requested with
    424 @code{@w{#include "@var{file}"}}; they are not searched for
    425 @code{@w{#include <@var{file}>}}.  If additional directories are
    426 specified with @option{-I} options after the @option{-I-}, those
    427 directories are searched for all @samp{#include} directives.
    428 
    429 In addition, @option{-I-} inhibits the use of the directory of the current
    430 file directory as the first search directory for @code{@w{#include
    431 "@var{file}"}}.
    432 @ifset cppmanual
    433 @xref{Search Path}.
    434 @end ifset
    435 This option has been deprecated.
    436 
    437 @item -nostdinc
    438 @opindex nostdinc
    439 Do not search the standard system directories for header files.
    440 Only the directories you have specified with @option{-I} options
    441 (and the directory of the current file, if appropriate) are searched.
    442 
    443 @item -nostdinc++
    444 @opindex nostdinc++
    445 Do not search for header files in the C++-specific standard directories,
    446 but do still search the other standard directories.  (This option is
    447 used when building the C++ library.)
    448 
    449 @item -include @var{file}
    450 @opindex include
    451 Process @var{file} as if @code{#include "file"} appeared as the first
    452 line of the primary source file.  However, the first directory searched
    453 for @var{file} is the preprocessor's working directory @emph{instead of}
    454 the directory containing the main source file.  If not found there, it
    455 is searched for in the remainder of the @code{#include "@dots{}"} search
    456 chain as normal.
    457 
    458 If multiple @option{-include} options are given, the files are included
    459 in the order they appear on the command line.
    460 
    461 @item -imacros @var{file}
    462 @opindex imacros
    463 Exactly like @option{-include}, except that any output produced by
    464 scanning @var{file} is thrown away.  Macros it defines remain defined.
    465 This allows you to acquire all the macros from a header without also
    466 processing its declarations.
    467 
    468 All files specified by @option{-imacros} are processed before all files
    469 specified by @option{-include}.
    470 
    471 @item -idirafter @var{dir}
    472 @opindex idirafter
    473 Search @var{dir} for header files, but do it @emph{after} all
    474 directories specified with @option{-I} and the standard system directories
    475 have been exhausted.  @var{dir} is treated as a system include directory.
    476 If @var{dir} begins with @code{=}, then the @code{=} will be replaced
    477 by the sysroot prefix; see @option{--sysroot} and @option{-isysroot}.
    478 
    479 @item -iprefix @var{prefix}
    480 @opindex iprefix
    481 Specify @var{prefix} as the prefix for subsequent @option{-iwithprefix}
    482 options.  If the prefix represents a directory, you should include the
    483 final @samp{/}.
    484 
    485 @item -iwithprefix @var{dir}
    486 @itemx -iwithprefixbefore @var{dir}
    487 @opindex iwithprefix
    488 @opindex iwithprefixbefore
    489 Append @var{dir} to the prefix specified previously with
    490 @option{-iprefix}, and add the resulting directory to the include search
    491 path.  @option{-iwithprefixbefore} puts it in the same place @option{-I}
    492 would; @option{-iwithprefix} puts it where @option{-idirafter} would.
    493 
    494 @item -isysroot @var{dir}
    495 @opindex isysroot
    496 This option is like the @option{--sysroot} option, but applies only to
    497 header files (except for Darwin targets, where it applies to both header
    498 files and libraries).  See the @option{--sysroot} option for more
    499 information.
    500 
    501 @item -imultilib @var{dir}
    502 @opindex imultilib
    503 Use @var{dir} as a subdirectory of the directory containing
    504 target-specific C++ headers.
    505 
    506 @item -isystem @var{dir}
    507 @opindex isystem
    508 Search @var{dir} for header files, after all directories specified by
    509 @option{-I} but before the standard system directories.  Mark it
    510 as a system directory, so that it gets the same special treatment as
    511 is applied to the standard system directories.
    512 @ifset cppmanual
    513 @xref{System Headers}.
    514 @end ifset
    515 If @var{dir} begins with @code{=}, then the @code{=} will be replaced
    516 by the sysroot prefix; see @option{--sysroot} and @option{-isysroot}.
    517 
    518 @item -cxx-isystem @var{dir}
    519 @opindex cxxisystem
    520 Search @var{dir} for C++ header files, after all directories specified by
    521 @option{-I} but before the standard system directories.  Mark it
    522 as a system directory, so that it gets the same special treatment as
    523 is applied to the standard system directories.
    524 @ifset cppmanual
    525 @xref{System Headers}.
    526 @end ifset
    527 
    528 @item -iquote @var{dir}
    529 @opindex iquote
    530 Search @var{dir} only for header files requested with
    531 @code{@w{#include "@var{file}"}}; they are not searched for
    532 @code{@w{#include <@var{file}>}}, before all directories specified by
    533 @option{-I} and before the standard system directories.
    534 @ifset cppmanual
    535 @xref{Search Path}.
    536 @end ifset
    537 If @var{dir} begins with @code{=}, then the @code{=} will be replaced
    538 by the sysroot prefix; see @option{--sysroot} and @option{-isysroot}.
    539 
    540 @item -fdirectives-only
    541 @opindex fdirectives-only
    542 When preprocessing, handle directives, but do not expand macros.
    543 
    544 The option's behavior depends on the @option{-E} and @option{-fpreprocessed}
    545 options.
    546 
    547 With @option{-E}, preprocessing is limited to the handling of directives
    548 such as @code{#define}, @code{#ifdef}, and @code{#error}.  Other
    549 preprocessor operations, such as macro expansion and trigraph
    550 conversion are not performed.  In addition, the @option{-dD} option is
    551 implicitly enabled.
    552 
    553 With @option{-fpreprocessed}, predefinition of command line and most
    554 builtin macros is disabled.  Macros such as @code{__LINE__}, which are
    555 contextually dependent, are handled normally.  This enables compilation of
    556 files previously preprocessed with @code{-E -fdirectives-only}.
    557 
    558 With both @option{-E} and @option{-fpreprocessed}, the rules for
    559 @option{-fpreprocessed} take precedence.  This enables full preprocessing of
    560 files previously preprocessed with @code{-E -fdirectives-only}.
    561 
    562 @item -iremap @var{src}:@var{dst}
    563 @opindex iremap
    564 Replace the prefix @var{src} in __FILE__ with @var{dst} at expansion time.
    565 This option can be specified more than once.  Processing stops at the first
    566 match.
    567 
    568 @item -fdollars-in-identifiers
    569 @opindex fdollars-in-identifiers
    570 @anchor{fdollars-in-identifiers}
    571 Accept @samp{$} in identifiers.
    572 @ifset cppmanual
    573 @xref{Identifier characters}.
    574 @end ifset
    575 
    576 @item -fextended-identifiers
    577 @opindex fextended-identifiers
    578 Accept universal character names in identifiers.  This option is
    579 experimental; in a future version of GCC, it will be enabled by
    580 default for C99 and C++.
    581 
    582 @item -fno-canonical-system-headers
    583 @opindex fno-canonical-system-headers
    584 When preprocessing, do not shorten system header paths with canonicalization.
    585 
    586 @item -fpreprocessed
    587 @opindex fpreprocessed
    588 Indicate to the preprocessor that the input file has already been
    589 preprocessed.  This suppresses things like macro expansion, trigraph
    590 conversion, escaped newline splicing, and processing of most directives.
    591 The preprocessor still recognizes and removes comments, so that you can
    592 pass a file preprocessed with @option{-C} to the compiler without
    593 problems.  In this mode the integrated preprocessor is little more than
    594 a tokenizer for the front ends.
    595 
    596 @option{-fpreprocessed} is implicit if the input file has one of the
    597 extensions @samp{.i}, @samp{.ii} or @samp{.mi}.  These are the
    598 extensions that GCC uses for preprocessed files created by
    599 @option{-save-temps}.
    600 
    601 @item -ftabstop=@var{width}
    602 @opindex ftabstop
    603 Set the distance between tab stops.  This helps the preprocessor report
    604 correct column numbers in warnings or errors, even if tabs appear on the
    605 line.  If the value is less than 1 or greater than 100, the option is
    606 ignored.  The default is 8.
    607 
    608 @item -fdebug-cpp
    609 @opindex fdebug-cpp
    610 This option is only useful for debugging GCC.  When used with
    611 @option{-E}, dumps debugging information about location maps.  Every
    612 token in the output is preceded by the dump of the map its location
    613 belongs to.  The dump of the map holding the location of a token would
    614 be:
    615 @smallexample
    616 @{@samp{P}:@file{/file/path};@samp{F}:@file{/includer/path};@samp{L}:@var{line_num};@samp{C}:@var{col_num};@samp{S}:@var{system_header_p};@samp{M}:@var{map_address};@samp{E}:@var{macro_expansion_p},@samp{loc}:@var{location}@}
    617 @end smallexample
    618 
    619 When used without @option{-E}, this option has no effect.
    620 
    621 @item -ftrack-macro-expansion@r{[}=@var{level}@r{]}
    622 @opindex ftrack-macro-expansion
    623 Track locations of tokens across macro expansions. This allows the
    624 compiler to emit diagnostic about the current macro expansion stack
    625 when a compilation error occurs in a macro expansion. Using this
    626 option makes the preprocessor and the compiler consume more
    627 memory. The @var{level} parameter can be used to choose the level of
    628 precision of token location tracking thus decreasing the memory
    629 consumption if necessary. Value @samp{0} of @var{level} de-activates
    630 this option just as if no @option{-ftrack-macro-expansion} was present
    631 on the command line. Value @samp{1} tracks tokens locations in a
    632 degraded mode for the sake of minimal memory overhead. In this mode
    633 all tokens resulting from the expansion of an argument of a
    634 function-like macro have the same location. Value @samp{2} tracks
    635 tokens locations completely. This value is the most memory hungry.
    636 When this option is given no argument, the default parameter value is
    637 @samp{2}.
    638 
    639 Note that -ftrack-macro-expansion=2 is activated by default.
    640 
    641 @item -fexec-charset=@var{charset}
    642 @opindex fexec-charset
    643 @cindex character set, execution
    644 Set the execution character set, used for string and character
    645 constants.  The default is UTF-8.  @var{charset} can be any encoding
    646 supported by the system's @code{iconv} library routine.
    647 
    648 @item -fwide-exec-charset=@var{charset}
    649 @opindex fwide-exec-charset
    650 @cindex character set, wide execution
    651 Set the wide execution character set, used for wide string and
    652 character constants.  The default is UTF-32 or UTF-16, whichever
    653 corresponds to the width of @code{wchar_t}.  As with
    654 @option{-fexec-charset}, @var{charset} can be any encoding supported
    655 by the system's @code{iconv} library routine; however, you will have
    656 problems with encodings that do not fit exactly in @code{wchar_t}.
    657 
    658 @item -finput-charset=@var{charset}
    659 @opindex finput-charset
    660 @cindex character set, input
    661 Set the input character set, used for translation from the character
    662 set of the input file to the source character set used by GCC@.  If the
    663 locale does not specify, or GCC cannot get this information from the
    664 locale, the default is UTF-8.  This can be overridden by either the locale
    665 or this command line option.  Currently the command line option takes
    666 precedence if there's a conflict.  @var{charset} can be any encoding
    667 supported by the system's @code{iconv} library routine.
    668 
    669 @item -fworking-directory
    670 @opindex fworking-directory
    671 @opindex fno-working-directory
    672 Enable generation of linemarkers in the preprocessor output that will
    673 let the compiler know the current working directory at the time of
    674 preprocessing.  When this option is enabled, the preprocessor will
    675 emit, after the initial linemarker, a second linemarker with the
    676 current working directory followed by two slashes.  GCC will use this
    677 directory, when it's present in the preprocessed input, as the
    678 directory emitted as the current working directory in some debugging
    679 information formats.  This option is implicitly enabled if debugging
    680 information is enabled, but this can be inhibited with the negated
    681 form @option{-fno-working-directory}.  If the @option{-P} flag is
    682 present in the command line, this option has no effect, since no
    683 @code{#line} directives are emitted whatsoever.
    684 
    685 @item -fno-show-column
    686 @opindex fno-show-column
    687 Do not print column numbers in diagnostics.  This may be necessary if
    688 diagnostics are being scanned by a program that does not understand the
    689 column numbers, such as @command{dejagnu}.
    690 
    691 @item -A @var{predicate}=@var{answer}
    692 @opindex A
    693 Make an assertion with the predicate @var{predicate} and answer
    694 @var{answer}.  This form is preferred to the older form @option{-A
    695 @var{predicate}(@var{answer})}, which is still supported, because
    696 it does not use shell special characters.
    697 @ifset cppmanual
    698 @xref{Obsolete Features}.
    699 @end ifset
    700 
    701 @item -A -@var{predicate}=@var{answer}
    702 Cancel an assertion with the predicate @var{predicate} and answer
    703 @var{answer}.
    704 
    705 @item -dCHARS
    706 @var{CHARS} is a sequence of one or more of the following characters,
    707 and must not be preceded by a space.  Other characters are interpreted
    708 by the compiler proper, or reserved for future versions of GCC, and so
    709 are silently ignored.  If you specify characters whose behavior
    710 conflicts, the result is undefined.
    711 
    712 @table @samp
    713 @item M
    714 @opindex dM
    715 Instead of the normal output, generate a list of @samp{#define}
    716 directives for all the macros defined during the execution of the
    717 preprocessor, including predefined macros.  This gives you a way of
    718 finding out what is predefined in your version of the preprocessor.
    719 Assuming you have no file @file{foo.h}, the command
    720 
    721 @smallexample
    722 touch foo.h; cpp -dM foo.h
    723 @end smallexample
    724 
    725 @noindent
    726 will show all the predefined macros.
    727 
    728 If you use @option{-dM} without the @option{-E} option, @option{-dM} is
    729 interpreted as a synonym for @option{-fdump-rtl-mach}.
    730 @xref{Debugging Options, , ,gcc}.
    731 
    732 @item D
    733 @opindex dD
    734 Like @samp{M} except in two respects: it does @emph{not} include the
    735 predefined macros, and it outputs @emph{both} the @samp{#define}
    736 directives and the result of preprocessing.  Both kinds of output go to
    737 the standard output file.
    738 
    739 @item N
    740 @opindex dN
    741 Like @samp{D}, but emit only the macro names, not their expansions.
    742 
    743 @item I
    744 @opindex dI
    745 Output @samp{#include} directives in addition to the result of
    746 preprocessing.
    747 
    748 @item U
    749 @opindex dU
    750 Like @samp{D} except that only macros that are expanded, or whose
    751 definedness is tested in preprocessor directives, are output; the
    752 output is delayed until the use or test of the macro; and
    753 @samp{#undef} directives are also output for macros tested but
    754 undefined at the time.
    755 @end table
    756 
    757 @item -P
    758 @opindex P
    759 Inhibit generation of linemarkers in the output from the preprocessor.
    760 This might be useful when running the preprocessor on something that is
    761 not C code, and will be sent to a program which might be confused by the
    762 linemarkers.
    763 @ifset cppmanual
    764 @xref{Preprocessor Output}.
    765 @end ifset
    766 
    767 @item -C
    768 @opindex C
    769 Do not discard comments.  All comments are passed through to the output
    770 file, except for comments in processed directives, which are deleted
    771 along with the directive.
    772 
    773 You should be prepared for side effects when using @option{-C}; it
    774 causes the preprocessor to treat comments as tokens in their own right.
    775 For example, comments appearing at the start of what would be a
    776 directive line have the effect of turning that line into an ordinary
    777 source line, since the first token on the line is no longer a @samp{#}.
    778 
    779 @item -CC
    780 Do not discard comments, including during macro expansion.  This is
    781 like @option{-C}, except that comments contained within macros are
    782 also passed through to the output file where the macro is expanded.
    783 
    784 In addition to the side-effects of the @option{-C} option, the
    785 @option{-CC} option causes all C++-style comments inside a macro
    786 to be converted to C-style comments.  This is to prevent later use
    787 of that macro from inadvertently commenting out the remainder of
    788 the source line.
    789 
    790 The @option{-CC} option is generally used to support lint comments.
    791 
    792 @item -traditional-cpp
    793 @opindex traditional-cpp
    794 Try to imitate the behavior of old-fashioned C preprocessors, as
    795 opposed to ISO C preprocessors.
    796 @ifset cppmanual
    797 @xref{Traditional Mode}.
    798 @end ifset
    799 
    800 @item -trigraphs
    801 @opindex trigraphs
    802 Process trigraph sequences.
    803 @ifset cppmanual
    804 @xref{Initial processing}.
    805 @end ifset
    806 @ifclear cppmanual
    807 These are three-character sequences, all starting with @samp{??}, that
    808 are defined by ISO C to stand for single characters.  For example,
    809 @samp{??/} stands for @samp{\}, so @samp{'??/n'} is a character
    810 constant for a newline.  By default, GCC ignores trigraphs, but in
    811 standard-conforming modes it converts them.  See the @option{-std} and
    812 @option{-ansi} options.
    813 
    814 The nine trigraphs and their replacements are
    815 
    816 @smallexample
    817 Trigraph:       ??(  ??)  ??<  ??>  ??=  ??/  ??'  ??!  ??-
    818 Replacement:      [    ]    @{    @}    #    \    ^    |    ~
    819 @end smallexample
    820 @end ifclear
    821 
    822 @item -remap
    823 @opindex remap
    824 Enable special code to work around file systems which only permit very
    825 short file names, such as MS-DOS@.
    826 
    827 @item --help
    828 @itemx --target-help
    829 @opindex help
    830 @opindex target-help
    831 Print text describing all the command line options instead of
    832 preprocessing anything.
    833 
    834 @item -v
    835 @opindex v
    836 Verbose mode.  Print out GNU CPP's version number at the beginning of
    837 execution, and report the final form of the include path.
    838 
    839 @item -H
    840 @opindex H
    841 Print the name of each header file used, in addition to other normal
    842 activities.  Each name is indented to show how deep in the
    843 @samp{#include} stack it is.  Precompiled header files are also
    844 printed, even if they are found to be invalid; an invalid precompiled
    845 header file is printed with @samp{...x} and a valid one with @samp{...!} .
    846 
    847 @item -version
    848 @itemx --version
    849 @opindex version
    850 Print out GNU CPP's version number.  With one dash, proceed to
    851 preprocess as normal.  With two dashes, exit immediately.
    852 @end table
    853