Imported Debian patch 2.9.0-5
[debian/cc1111] / debian / manpages / sdcpp.1
1 .TH SDCPP 1 
2 .SH NAME
3 sdcpp \- C preprocessor for SDCC
4 .SH SYNOPSIS
5 .B sdcppold
6 .I "[options] filename"
7 .SH "DESCRIPTION"
8 This manual page documents briefly the
9 .BR sdccp
10 command.
11 This manual page was written for the Debian GNU/Linux distribution
12 because the original program does not have a manual page.
13 Instead, you can read the documentation in
14 /usr/share/doc/sdcc-doc.
15 .PP
16 .B SDCC
17 is a Freeware, retargettable, optimizing ANSI-C compiler
18 designed for 8 bit Microprocessors.
19 .SH OPTIONS
20 .TP
21 .BI "\-include " "<file>"
22 Include the contents of
23 .I <file>\c
24 \& before other files.
25 .TP
26 .BI "\-imacros " "<file>"
27 Accept definition of macros in 
28 .I <file>\c
29 \&.
30 .TP
31 .BI "\-iprefix " "<path>"
32 Specify 
33 .I <path>\c
34 \& as a prefix for next two options.
35 .TP
36 .BI "\-iwithprefix " "<dir>"
37 Add 
38 .I <dir>\c
39 \& to the end of the system include path.
40 .TP
41 .BI "\-iwithprefixbefore " "<dir>"
42 Add 
43 .I <dir>\c
44 \& to the end of the main include path.
45 .TP
46 .BI "\-isystem " "<dir>"
47 Add 
48 .I <dir>\c
49 \& to the start of the system include path.
50 .TP
51 .BI "\-idirafter " "<dir>"
52 Add 
53 .I <dir>\c
54 \& to the end of the system include path.
55 .TP
56 .BI "-I " "<dir>"   
57 Add 
58 .I <dir>\c
59 \& to the end of the main include path.
60 .TP
61 .B "\-I\-"
62 Fine-grained include path control; see info docs.
63 .TP
64 .B "\-nostdinc"
65 Do not search system include directories (dirs specified with 
66 .B -isystem\c
67 \& will still be used).
68 .TP
69 .B "\-nostdinc++"
70 Do not search system include directories for C++.
71 .TP
72 .BI "-o " "<file>"
73 Put output into 
74 .I <file>\c
75 \&.
76 .TP
77 .B "\-pedantic"
78 Issue all warnings demanded by strict ISO C.
79 .TP
80 .B "\-pedantic-errors"
81 Issue 
82 .I \-pedantic\c
83 \& warnings as errors instead.
84 .TP
85 .B "\-trigraphs"
86 Support ISO C trigraphs.
87 .TP
88 .B "\-lang-c"
89 Assume that the input sources are in C.
90 .TP
91 .B "\-lang-c89"
92 Assume that the input sources are in C89.
93 .TP
94 .B "\-lang-c++"
95 Assume that the input sources are in C++.
96 .TP
97 .B "\-lang-objc"
98 Assume that the input sources are in ObjectiveC.
99 .TP
100 .B "\-lang-objc++"
101 Assume that the input sources are in ObjectiveC++.
102 .TP
103 .B "\-lang-asm"
104 Assume that the input sources are in assembler.
105 .TP
106 .BI "\-std=" "<std name>"
107 Specify the conformance standard; one of: 
108 gnu89, gnu99, c89, c99, iso9899:1990,
109 iso9899:199409, iso9899:1999
110 .TP
111 .B "\-+"
112 Allow parsing of C++ style features.
113 .TP
114 .B "\-w"
115 Inhibit warning messages.
116 .TP
117 .B "\-Wtrigraphs"
118 Warn if trigraphs are encountered.
119 .TP
120 .B "\-Wno-trigraphs"
121 Do not warn about trigraphs.
122 .TP
123 .B "\-Wcomment{s}"
124 Warn if one comment starts inside another.
125 .TP
126 .B "\-Wno-comment{s}"
127 Do not warn about comments.
128 .TP
129 .B "\-Wtraditional"
130 Warn about features not present in traditional C;
131 .TP
132 .B "\-Wno-traditional"
133 Do not warn about traditional C;
134 .TP
135 .B "\-Wundef"
136 Warn if an undefined macro is used by #if.
137 .TP
138 .B "\-Wno-undef"
139 Do not warn about testing undefined macros.
140 .TP
141 .B "\-Wimport"
142 Warn about the use of the #import directive.
143 .TP
144 .B "\-Wno-import"
145 Do not warn about the use of #import.
146 .TP
147 .B "\-Werror"
148 Treat all warnings as errors.
149 .TP
150 .B "\-Wno-error"
151 Do not treat warnings as errors.
152 .TP
153 .B "\-Wsystem-headers"
154 Do not suppress warnings from system headers.
155 .TP
156 .B "\-Wno-system-headers"
157 Suppress warnings from system headers.
158 .TP
159 .B "\-Wall"
160 Enable all preprocessor warnings.
161 .TP
162 .B "\-M"
163 Generate make dependencies.
164 .TP
165 .B "\-MM"                       
166 As 
167 .B "\-M"\c
168 \&, but ignore system header files.
169 .TP
170 .BI "\-MF " "<file>"
171 Write dependency output to the given file.
172 .TP
173 .B "\-MG"
174 Treat missing header file as generated files.
175 .TP
176 .B "\-MP"
177 Generate phony targets for all headers.
178 .TP
179 .BI "\-MQ " "<target>"
180 Add a MAKE-quoted target.
181 .TP
182 .BI "\-MT " "<target>"
183 Add an unquoted target.
184 .TP
185 .BI "\-D" "<macro>"                 
186 Define a 
187 .I <macro>\c
188 \& with string '1' as its value.
189 .TP
190 .BI "\-D" "<macro>=<val>"           
191 Define a 
192 .I <macro>\c
193 \& with 
194 .I <val>\c
195 \& as its value.
196 .TP
197 .BI "\-A" "<question> (<answer>)"   
198 Assert the 
199 .I <answer>\c
200 \& to 
201 .I <question>\c
202 \&.
203 .TP
204 .BI "\-A\-" "<question> (<answer>)"
205 Disable
206 .I <answer>\c
207 \& to 
208 .I <question>\c
209 \&.
210 .TP 
211 .BI "-U" "<macro>"
212 Undefine 
213 .I <macro>\c
214 \&.
215 .TP
216 .B "\-H"
217 Print the name of header files as they are used.
218 .TP
219 .B "\-C"
220 Do not discard comments.
221 .TP
222 .B "\-dM"
223 Display a list of macro definitions active at end.
224 .TP
225 .B "\-dD"
226 Preserve macro definitions in output.
227 .TP
228 .B "\-dN"
229 As 
230 .B \-dD\c
231 \& except that only the names are preserved.
232 .TP
233 .B "\-dI"
234 Include #include directives in the output.
235 .TP
236 .B "\-fpreprocessed"
237 Treat the input file as already preprocessed.
238 .TP
239 .BI "\-ftabstop=" "<number>"
240 Distance between tab stops for column reporting.
241 .TP
242 .B "\-P"
243 Do not generate #line directives.
244 .TP
245 .B "\-$"
246 Do not allow '$' in identifiers.
247 .TP
248 .B "\-remap"
249 Remap file names when including files.
250 .TP
251 .B "\-v or \-\-version"
252 Display the version number.
253 .TP
254 .B "\-h or \-\-help"
255 Show summary of options.
256
257 .SH AUTHOR
258 This manual page was written by Aurelien Jarno <aurel32@debian.org>,
259 for the Debian GNU/Linux system (but may be used by others).