Accept -W as alias for -Wextra.
[cparser] / cparser.1
1 .\" Please adjust this date whenever revising the manpage.
2 .Dd December 21, 2008
3 .Dt CPARSER 1
4 .Sh NAME
5 .Nm cparser
6 .Nd C compiler
7 .Sh SYNOPSIS
8 .Nm
9 .Op Fl c | S | E | -print-ast
10 .Op Fl -print-implicit-cast
11 .Op Fl -print-parenthesis
12 .Op Fl std= Ns Ar standard
13 .Op Fl - Ns Oo Cm no- Oc Ns Cm gcc
14 .Op Fl - Ns Oo Cm no- Oc Ns Cm ms
15 .Op Fl g
16 .Op Fl O Ns Ar level
17 .Op Fl W Ns Oo Cm no- Oc Ns Ar warn
18 .Op Fl w
19 .Op Fl I Ar dir
20 .Op Fl L Ar dir
21 .Op Fl D Ns Ar macro Ns Op Ar =defn
22 .Op Fl U Ns Ar macro
23 .Op Fl f Ar option
24 .Op Fl finput-charset= Ns Ar encoding
25 .Op Fl b Ar option
26 .Op Fl l Ar library
27 .Op Fl o Ar outfile
28 .Op Fl x Ar language
29 .Op Fl Wl, Ns Ar option
30 .Op Fl Wp, Ns Ar option
31 .Ar
32 .Sh DESCRIPTION
33 .Nm
34 is a C compiler, which can parse C90 and C99 as well as many GCC and some MSC extensions.
35 It also provides many useful analyses for warnings and generates concise messages in case of error.
36 It uses libFIRM for optimization and code generation.
37 The compiler driver is largely compatible with GCC.
38 .Sh OPTIONS
39 .Bl -tag
40 .It Fl c
41 Compile the input files to object files.
42 The default output filename is the input filename with the extension replaced by .o.
43 .It Fl S
44 Compile the input files to assembler.
45 The default output filename is the input filename with the extension replaced by .s.
46 .It Fl E
47 Preprocess the input file only.
48 By default the result is output to stdout.
49 .It Fl -print-ast
50 Output the abstract syntax tree of the parsed input file as C again.
51 .It Fl -print-implicit-cast
52 When using
53 .Fl -print-ast ,
54 show casts, which are inserted by the semantic checks.
55 .It Fl -print-parenthesis
56 When using
57 .Fl -print-ast ,
58 show all expressions fully parenthesized.
59 .It Fl std= Ns Ar standard
60 Select the language standard.
61 Supported values are:
62 .Bl -tag -compact -width "iso9899:1990"
63 .It Cm c89
64 .It Cm iso9899:1990
65 ISO C90
66 .It Cm gnu89
67 ISO C90 with GCC extensions
68 .It Cm c99
69 .It Cm iso9899:1999
70 ISO C99
71 .It Cm gnu99
72 ISO C99 with GCC extensions
73 .It Cm c++98
74 ISO C++ 1998.
75 Not supported yet.
76 .It Cm gnu++98
77 ISO C++ 1998 with GCC extensions.
78 Not supported yet.
79 .El
80 .It Fl - Ns Oo Cm no- Oc Ns Cm gcc
81 Disable/enable GCC extensions.
82 This switch supersedes
83 .Fl std .
84 .It Fl - Ns Oo Cm no- Oc Ns Cm ms
85 Disable/enable MSC extensions.
86 .It Fl g
87 When compiling C files, add debug information in
88 .Tn stabs
89 format.
90 .It Fl O Ns Ar level
91 .\" TODO expand
92 Select the optimization level.
93 Sensible values are between 0 and 4, inclusive.
94 .It Fl W Ns Oo Cm no- Oc Ns Ar warn
95 .\" TODO expand
96 Disable/enable a specific warning.
97 Every warning option has a corresponding
98 .Cm no-
99 switch to deactivate it.
100 .It Fl Waddress
101 Warn about suspicious use of addresses, like using the address of a function or variable as boolean condition or comparing with the address of a string literal.
102 .It Fl Waggregate-return
103 Warn about defining or calling a function, which returns a struct or union by value.
104 .It Fl Wall
105 Activate most warnings.
106 In particular these are
107 .Fl Waddress ,
108 .Fl Wattribute ,
109 .Fl Wchar-subscripts ,
110 .Fl Wcomment ,
111 .Fl Wempty-statement ,
112 .Fl Wformat ,
113 .Fl Wimplicit-function-declaration ,
114 .Fl Wimplicit-int ,
115 .Fl Winit-self ,
116 .Fl Wmain ,
117 .Fl Wnonnull ,
118 .Fl Wparentheses ,
119 .Fl Wpointer-arith ,
120 .Fl Wredundant-decls ,
121 .Fl Wreturn-type ,
122 .Fl Wshadow ,
123 .Fl Wsign-compare ,
124 .Fl Wstrict-prototypes ,
125 .Fl Wswitch-enum ,
126 .Fl Wunknown-pragmas ,
127 .Fl Wunreachable-code ,
128 .Fl Wunused-function ,
129 .Fl Wunused-label ,
130 .Fl Wunused-parameter ,
131 .Fl Wunused-value ,
132 .Fl Wunused-variable .
133 .It Fl Wcast-qual
134 Warn whenever a pointer cast removes qualifiers from the pointed-to type, e.g. casting a const char* to char*.
135 .It Fl Wchar-subscripts
136 Warn about using an expression of type char as array subscript, e.g. char\ c; arr[c].
137 .It Fl Wdeclaration-after-statement
138 Warn about mixing declarations and statements, which is not allowed prior to C99.
139 .It Fl Wdiv-by-zero
140 Warn about compile-time integer division by zero.
141 .It Fl Wempty-statement
142 Warn about empty statements, i.e. statements which only consist of a single
143 .Sq \&; .
144 Use {} as replacement to avoid this warning.
145 .It Fl Werror
146 Treat warnings as errors, i.e. do not continue after parsing when a warning is encountered.
147 .It Fl Werror-implicit-function-declaration
148 Generate an error, when calling a function without a prior declaration.
149 .It Fl Wextra
150 (Alias
151 .Fl W Ns )
152 Activate some more warnings.
153 In particular these are
154 .Fl Wempty-statement ,
155 .Fl Wunused-parameter ,
156 .Fl Wunused-value .
157 .It Fl Wfatal-errors
158 Immediately abort compilation when encountering an error.
159 .It Fl Wformat
160 Check format strings of char and wchar_t functions.
161 .It Fl Wimplicit
162 Activate
163 .Fl Wimplicit-function-declaration ,
164 .Fl Wimplicit-int .
165 .It Fl Wimplicit-function-declaration
166 Warn about calling a function without a prior declaration.
167 .It Fl Wimplicit-int
168 Warn about declarations whose declaration specifiers do not include a type specifier.
169 .It Fl Winit-self
170 Warn about uninitialized variables which are initialized with themselves.
171 .It Fl Wlong-long
172 Warn if the type
173 .Sq long long
174 is used.
175 .It Fl Wmain
176 Warn if the type of
177 .Sq main
178 is suspicious, i.e. if it is not a non-static function declared as either int\ main(void), int\ main(int,\ char**) or, as an extension, int\ main(int,\ char**,\ char**).
179 .It Fl Wmissing-declarations
180 Warn if a non-static function or a global variable without a storage class is defined without a prior declaration.
181 This is typically a sign of a missing #include or that the object should be static.
182 .It Fl Wmissing-noreturn
183 Warn about functions, which are candidates for the attribute
184 .Sq noreturn .
185 .It Fl Wmissing-prototypes
186 Warn if a global function is defined without a previous prototype declaration.
187 .It Fl Wmultichar
188 Warn if a multicharacter constant
189 .Pf ( Sq FOOF )
190 is used.
191 .It Fl Wnested-externs
192 Warn if an
193 .Sq extern
194 declaration is encountered within a function.
195 .It Fl Wparentheses
196 Warn if parentheses are omitted in certain contexts.
197 Warn if an assignment is used as condition, e.g. if\ (x\ =\ 23).
198 Warn if && without parentheses is used within ||, e.g. if\ (x\ ||\ y\ &&\ z).
199 Warn if it there may be confusion which
200 .Sq if Ns
201 -statement an
202 .Sq else Ns
203 -branch belongs to, e.g. if\ (x)\ if\ (y)\ {}\ else\ {}.
204 Warn if cascaded comparisons appear which do not have their mathematical meaning, e.g. if\ (23\ <=\ x\ <\ 42).
205 Warn if + or - is used as operand of << or >>, e.g. x\ +\ y\ <<\ z.
206 .It Fl Wredundant-decls
207 Warn about redundant declarations, i.e. multiple declarations of the same object or static forward declarations which have no use before their definition.
208 .It Fl Wshadow
209 Warn when a new declaration shadows another declaration with the same name in an outer scope.
210 .It Fl Wunreachable-code
211 Warn when the compiler determines that a statement (or in some cases a part thereof) will never be executed.
212 .It Fl Wunused
213 Activate
214 .Fl Wunused-function ,
215 .Fl Wunused-label ,
216 .Fl Wunused-parameter ,
217 .Fl Wunused-value ,
218 .Fl Wunused-variable .
219 .It Fl Wunused-parameter
220 Warn when a parameter is never used or only ever read to calculate its own new value, e.g. x\ =\ x\ +\ 1.
221 .It Fl Wunused-variable
222 Warn when a variable is never used or only ever read to calculate its own new value, e.g. x\ =\ x\ +\ 1.
223 .It Fl w
224 Suppress all warnings.
225 .It Fl I Ar dir
226 Add the directory
227 .Ar dir
228 to the paths to be searched for include files.
229 .It Fl L Ar dir
230 Add the directory
231 .Ar dir
232 to the paths to be searched for libraries.
233 .It Fl D Ns Ar macro
234 Define the preprocessor macro
235 .Ar macro
236 which will expand to 1.
237 .It Fl D Ns Ar macro=defn
238 Define the preprocessor macro
239 .Ar macro
240 and set its expanded value to
241 .Ar defn .
242 .It Fl U Ns Ar macro
243 Undefine the preprocessor macro
244 .Ar macro .
245 .It Fl f Ar option
246 Set a frontend or optimizer option.
247 Use
248 .Fl fhelp
249 to get a list of supported optimizer options.
250 .It Fl finput-charset= Ns Ar encoding
251 Select the encoding of the input.
252 Supported values are
253 .Cm ISO_8859-1:1987
254 (aliases
255 .Cm CP819 ,
256 .Cm IBM819 ,
257 .Cm ISO-8859-1 ,
258 .Cm ISO8859-1 ,
259 .Cm ISO_8859-1 ,
260 .Cm csISOLatin1 ,
261 .Cm iso-ir-100 ,
262 .Cm l1
263 and
264 .Cm latin1 Ns
265 ),
266 .Cm ISO-8859-15
267 (aliases
268 .Cm ISO8859-15 ,
269 .Cm ISO_8859-15
270 and
271 .Cm Latin-9 Ns
272 ),
273 .Cm windows-1252
274 (alias
275 .Cm cp1252 Ns
276 ) and
277 .Cm UTF-8
278 (default).
279 Case is ignored.
280 .It Fl f Ns Oo Cm no- Oc Ns Cm show-column
281 Show the column number in diagnostic messages.
282 .It Fl fsigned-char
283 Define
284 .Sq char
285 to have the same range, representation and behaviour as
286 .Sq signed char .
287 .It Fl funsigned-char
288 Define
289 .Sq char
290 to have the same range, representation and behaviour as
291 .Sq unsigned char .
292 .It Fl b Ar option
293 Set a backend option.
294 Use
295 .Fl bhelp
296 to get a list of supported options.
297 .It Fl l Ar library
298 Link with the specified library.
299 .It Fl o Ar outfile
300 Specify the output filename.
301 This is only valid when using a single input filename.
302 .Fl
303 as filename uses stdout for output.
304 .It Fl x Ar language
305 Overwrite the language auto-detection for the following filenames by the
306 specified
307 .Ar language .
308 Supported values are:
309 .Bl -tag -compact -width "assembler-with-cpp"
310 .It Cm assembler
311 Assembler file
312 .It Cm assembler-with-cpp
313 Assembler file, which needs to be preprocessed
314 .It Cm c
315 .It Cm c-header
316 C file
317 .It Cm c++
318 .It Cm c++-header
319 C++ file
320 .It Cm none
321 Revert to auto-detection
322 .El
323 .It Fl Wl, Ns Ar option
324 Pass
325 .Ar option
326 to the linker.
327 .It Fl Wp, Ns Ar option
328 Pass
329 .Ar option
330 to the preprocessor.
331 .El
332 .Sh SEE ALSO
333 .Xr gcc 1 ,
334 http://www.libfirm.org/
335 .Sh BUGS
336 Probably many - if you hit one, please report it.
337 .Pp
338 .Nm
339 needs to support more switches for better GCC compatibility.
340 .Pp
341 This manual page is incomplete.
342 .Sh AUTHORS
343 .An -nosplit
344 .Nm
345 was written by
346 .An Matthias Braun
347 .Aq matze@braunis.de ,
348 .An Christoph Mallon
349 .Aq christoph.mallon@gmx.de
350 and
351 .An Michael Beck .