Rename --{,un}sigend-chars to -f{,un}signed-char and document them in the manpage.
[cparser] / cparser.1
1 .\" Please adjust this date whenever revising the manpage.
2 .Dd December 16, 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 Use {} as replacement to avoid this warning.
144 .It Fl Werror
145 Treat warnings as errors, i.e. do not continue after parsing when a warning is encountered.
146 .It Fl Werror-implicit-function-declaration
147 Generate an error, when calling a function without a prior declaration.
148 .It Fl Wextra
149 Activate some more warnings.
150 In particular these are
151 .Fl Wempty-statement ,
152 .Fl Wunused-parameter ,
153 .Fl Wunused-value .
154 .It Fl Wfatal-errors
155 Immediately abort compilation when encountering an error.
156 .It Fl Wformat
157 Check format strings of char and wchar_t functions.
158 .It Fl Wimplicit
159 Activate
160 .Fl Wimplicit-function-declaration ,
161 .Fl Wimplicit-int .
162 .It Fl Wimplicit-function-declaration
163 Warn about calling a function without a prior declaration.
164 .It Fl Wimplicit-int
165 Warn about declarations whose declaration specifiers do not include a type specifier.
166 .It Fl Winit-self
167 Warn about uninitialized variables which are initialized with themselves.
168 .It Fl Wlong-long
169 Warn if the type 'long long' is used.
170 .It Fl Wmain
171 Warn if the type of 'main' 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**).
172 .It Fl Wmissing-declarations
173 Warn if a non-static function or a global variable without a storage class is defined without a prior declaration.
174 This is typically a sign of a missing #include or that the object should be static.
175 .It Fl Wmissing-noreturn
176 Warn about functions, which are candidates for the attribute 'noreturn'.
177 .It Fl Wmissing-prototypes
178 Warn if a global function is defined without a previous prototype declaration.
179 .It Fl Wmultichar
180 Warn if a multicharacter constant ('FOOF') is used.
181 .It Fl Wnested-externs
182 Warn if an 'extern' declaration is encountered within a function.
183 .It Fl Wparentheses
184 Warn if parentheses are omitted in certain contexts.
185 Warn if an assignment is used as condition, e.g. if\ (x\ =\ 23).
186 Warn if && without parentheses is used within ||, e.g. if\ (x\ ||\ y\ &&\ z).
187 Warn if it there may be confusion which 'if'-statement an 'else'-branch belongs to, e.g. if\ (x)\ if\ (y)\ {}\ else\ {}.
188 Warn if cascaded comparisons appear which do not have their mathematical meaning, e.g. if\ (23\ <=\ x\ <\ 42).
189 Warn if + or - is used as operand of << or >>, e.g. x\ +\ y\ <<\ z.
190 .It Fl Wredundant-decls
191 Warn about redundant declarations, i.e. multiple declarations of the same object or static forward declarations which have no use before their definition.
192 .It Fl Wunreachable-code
193 Warn when the compiler determines that a statement (or in some cases a part thereof) will never be executed.
194 .It Fl Wunused
195 Activate
196 .Fl Wunused-function ,
197 .Fl Wunused-label ,
198 .Fl Wunused-parameter ,
199 .Fl Wunused-value ,
200 .Fl Wunused-variable .
201 .It Fl Wunused-parameter
202 Warn when a parameter is never used or only ever read to calculate its own new value, e.g. x\ =\ x\ +\ 1.
203 .It Fl Wunused-variable
204 Warn when a variable is never used or only ever read to calculate its own new value, e.g. x\ =\ x\ +\ 1.
205 .It Fl w
206 Suppress all warnings.
207 .It Fl I Ar dir
208 Add the directory
209 .Ar dir
210 to the paths to be searched for include files.
211 .It Fl L Ar dir
212 Add the directory
213 .Ar dir
214 to the paths to be searched for libraries.
215 .It Fl D Ns Ar macro
216 Define the preprocessor macro
217 .Ar macro
218 which will expand to 1.
219 .It Fl D Ns Ar macro=defn
220 Define the preprocessor macro
221 .Ar macro
222 and set its expanded value to
223 .Ar defn .
224 .It Fl U Ns Ar macro
225 Undefine the preprocessor macro
226 .Ar macro .
227 .It Fl f Ar option
228 Set a frontend or optimizer option.
229 Use
230 .Fl fhelp
231 to get a list of supported optimizer options.
232 .It Fl finput-charset= Ns Ar encoding
233 Select the encoding of the input.
234 Supported value are
235 .Cm ISO_8859-1:1987
236 (aliases
237 .Cm CP819 ,
238 .Cm IBM819 ,
239 .Cm ISO-8859-1 ,
240 .Cm ISO8859-1 ,
241 .Cm ISO_8859-1 ,
242 .Cm csISOLatin1 ,
243 .Cm iso-ir-100 ,
244 .Cm l1
245 and
246 .Cm latin1 Ns
247 ),
248 .Cm ISO-8859-15
249 (aliases
250 .Cm ISO8859-15 ,
251 .Cm ISO_8859-15
252 and
253 .Cm Latin-9 Ns
254 ) and
255 .Cm UTF-8
256 (default).
257 Case is ignored.
258 .It Fl fsigned-char
259 Define
260 .Sq char
261 to have the same range, representation and behaviour as
262 .Sq signed char .
263 .It Fl funsigned-char
264 Define
265 .Sq char
266 to have the same range, representation and behaviour as
267 .Sq unsigned char .
268 .It Fl b Ar option
269 Set a backend option.
270 Use
271 .Fl bhelp
272 to get a list of supported options.
273 .It Fl l Ar library
274 Link with the specified library.
275 .It Fl o Ar outfile
276 Specify the output filename.
277 This is only valid when using a single input filename.
278 .Fl
279 as filename uses stdout for output.
280 .It Fl x Ar language
281 Overwrite the language auto-detection for the following filenames by the
282 specified
283 .Ar language .
284 Supported values are:
285 .Bl -tag -compact -width "assembler-with-cpp"
286 .It Cm assembler
287 Assembler file
288 .It Cm assembler-with-cpp
289 Assembler file, which needs to be preprocessed
290 .It Cm c
291 .It Cm c-header
292 C file
293 .It Cm c++
294 .It Cm c++-header
295 C++ file
296 .It Cm none
297 Revert to auto-detection
298 .El
299 .It Fl Wl, Ns Ar option
300 Pass
301 .Ar option
302 to the linker.
303 .It Fl Wp, Ns Ar option
304 Pass
305 .Ar option
306 to the preprocessor.
307 .El
308 .Sh SEE ALSO
309 .Xr gcc 1 ,
310 http://www.libfirm.org/
311 .Sh BUGS
312 Probably many - if you hit one, please report it.
313 .Pp
314 .Nm
315 needs to support more switches for better GCC compatibility.
316 .Pp
317 This manual page is incomplete.
318 .Sh AUTHORS
319 .An -nosplit
320 .Nm
321 was written by
322 .An Matthias Braun
323 .Aq matze@braunis.de ,
324 .An Christoph Mallon
325 .Aq christoph.mallon@gmx.de
326 and
327 .An Michael Beck .