File: faucc.1.xml

package info (click to toggle)
faucc 20090220-1
  • links: PTS
  • area: main
  • in suites: squeeze, wheezy
  • size: 1,356 kB
  • ctags: 2,846
  • sloc: ansic: 38,010; yacc: 1,595; xml: 519; lex: 378; makefile: 120; sh: 101
file content (534 lines) | stat: -rw-r--r-- 11,991 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
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
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
<?xml version="1.0" encoding="UTF-8"?>
<!-- vi:set ts=4: -->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
                   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [

	<!ENTITY binary "faucc">
]>
<!-- 
  $Id: faucc.1.xml,v 1.5 2009-01-29 14:23:46 potyra Exp $
  
 Copyright (C) 2009 FAUcc Team <info@faumachine.org>.
 This program is free software. You can redistribute it and/or modify it
 under the terms of the GNU General Public License, either version 2 of
 the License, or (at your option) any later version. See COPYING.

-->
<refentry>
	<refentryinfo>
		<address>
			<email>&lt;info@faumachine.org&gt;</email>
		</address>
		<corpauthor>FAUcc Team</corpauthor>
		<copyright>
			<year>2009</year>
			<holder>
				FAUcc Team.
				Developed at Friedrich Alexander University 
				Erlangen-Nuremberg.
			</holder>
		</copyright>
		<legalnotice>
			<para>
				FAUcc comes with ABSOLUTELY NO WARRANTY.
				FAUcc is free software; you can redistribute
				it and/or modify it under the terms of the GNU
				General Public License as published by the
				Free Software Foundation; either version 2 of
				the License, or (at your option) any later 
				version. See COPYING for details.
			</para>
		</legalnotice>
	</refentryinfo>
	<refmeta>
		<refentrytitle>FAUCC</refentrytitle>
		<manvolnum>1</manvolnum>
	</refmeta>
	<refnamediv>
    		<refname>&binary;</refname>
		<refpurpose>
			C compiler generating Intel code for 16 bit/32 bit CPUs.
		</refpurpose>
	</refnamediv>
	<refsynopsisdiv>
		<cmdsynopsis>
			<command>&binary;</command>
			<arg>
				<option>
					-B
					<replaceable>path</replaceable>
				</option>
			</arg>
			<arg>
				<option>
					-D
					<replaceable>MACRO</replaceable></option><arg><option>=<replaceable>def</replaceable></option></arg>
			</arg>
	      	<arg><option> -E </option></arg>
			<arg>
				<option>
					-I
					<replaceable>path</replaceable>
				</option>
			</arg>
			<arg>
				<option>
					-L
					<replaceable>path</replaceable>
				</option>
			</arg>
			<arg><option> -MD </option></arg>
			<arg>
				<option>-MF
					<replaceable>file</replaceable>
				</option>
			</arg>
			<arg><option> -MP </option></arg>
			<arg>
				<option>
					-MT
					<replaceable>target</replaceable>
				</option>
			</arg>
			<arg>
				<option>
					-O
					<replaceable>level</replaceable>
				</option>
			</arg>
			<arg><option> -S </option></arg>
			<arg>
				<option>
					-T
					<replaceable>script</replaceable>
				</option>
			</arg>
			<arg>
				<option>
					-U
					<replaceable>macro</replaceable>
				</option>
			</arg>
			<arg>
				<option>
					-Wl,<replaceable>arg</replaceable>
				</option>
			</arg>
			<arg>
				<option>
					-Xlinker
					<replaceable>arg</replaceable>
				</option>
			</arg>
			<arg>
				<option>
					-b
					<replaceable>arch</replaceable>
				</option>
			</arg>
			<arg>
				<option>
					-c
				</option>
			</arg>
			<arg>
				<option>
					-f
					<replaceable>arg</replaceable>
				</option>
			</arg>
			<arg>
				<option>
					-m
					<replaceable>arch</replaceable>
				</option>
			</arg>
			<arg><option> -nostdlib </option></arg>
			<arg>
				<option>
					-o
					<replaceable>output</replaceable>
				</option>
			</arg>
			<arg><option> -print-lib-faucc-file-name </option></arg>
			<arg><option> --freestanding </option></arg>
			<arg><option> --no-stack-protector </option></arg>
			<arg choice="req" rep="repeat">
				<option>
					<replaceable>file</replaceable>
				</option>
			</arg>
		</cmdsynopsis>
	</refsynopsisdiv>
	<refsect1>
	<!-- FIXME from here on -->
	<title>DESCRIPTION</title>
		<para>
			<command>&binary;</command> is a C compiler, that can generate
			Intel 16 bit or 32 bit Code.
		</para>
	</refsect1>
	<refsect1>
		<title>OPTIONS</title>
		<para>
			<command>&binary;</command> tries to mimic the options of 
			<command>gcc</command>. A number of options will be passed
			to the C preprocessor <command>cpp</command> or to the 
			linker (done via a call to the c-compiler <command>gcc</command>)
			in unmodified form.
		</para>
		<variablelist>
			<varlistentry>
				<term>
					<option>-B</option>
					<replaceable>path</replaceable>
				</term>
				<listitem>
					<para>Override the directory prefix where
					<command>cc1</command> is looked up with
					<replaceable>path</replaceable>.
					</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-D</option>
					<replaceable>MACRO</replaceable>,
					<option>-D
						<replaceable>MACRO</replaceable>=<replaceable>def</replaceable>
					</option>
				</term>
				<listitem>
					<para>
					Define <replaceable>MACRO</replaceable> with the optional
					initial	definition <replaceable>def</replaceable>.
					If <replaceable>def</replaceable> is omitted, it defaults
					to <constant>1</constant>.
					</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-E</option>
				</term>
				<listitem>
					<para>
						Only perform preprocessing, but do not run the 
						compiler.
					</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-I</option>
					<replaceable>path</replaceable>
				</term>
				<listitem>
					<para>
						Add <replaceable>path</replaceable> to the include 
						path in which header files are searched.
					</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-L</option>
					<replaceable>path</replaceable>
				</term>
				<listitem>
					<para>
						Add <replaceable>path</replaceable> to the library
						search path, in which the linker will look for 
						libraries.
					</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-MD</option>
				</term>
				<listitem>
					<para>
						Output dependency information while preprocessing.
					</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-MF</option>,
					<replaceable>file</replaceable>
				</term>
				<listitem>
					<para>
						Output dependency information while preprocessing
						to <replaceable>file</replaceable>.
					</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-MP</option>,
				</term>
				<listitem>
					<para>
						When the preprocessor should output dependency
						information, it will generate PHONY targets for 
						each dependency.
					</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-MT</option>
					<replaceable>target</replaceable>
				</term>
				<listitem>
					<para>
						When the preprocessor should output dependency
						information, use <replaceable>target</replaceable>
						as the dependency rule target.
					</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-O</option>
					<replaceable>level</replaceable>
				</term>
				<listitem>
					<para>
						Currently ignored.<!-- FIXME -->
					</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-S</option>
				</term>
				<listitem>
					<para>
						Output assembly code.
					</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-T</option>
					<replaceable>script</replaceable>
				</term>
				<listitem>
					<para>
						Use <replaceable>script</replaceable> as linker 
						script.
					</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-U</option>
					<replaceable>macro</replaceable>
				</term>
				<listitem>
					<para>
						Undefine a previously defined
						<replaceable>macro</replaceable>.
					</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-Wl,</option><replaceable>arg</replaceable>
				</term>
				<term>
					<option>-Xlinker</option> <replaceable>arg</replaceable>
				</term>
				<listitem>
					<para>
						Pass <replaceable>arg</replaceable> to the linker.
					</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-b</option> <replaceable>arch</replaceable>
				</term>
				<listitem>
					<para>
						Generate code for <replaceable>arch</replaceable> 
						(either <constant>i286</constant> or
						<constant>i386</constant>)
					</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-c</option>
				</term>
				<listitem>
					<para>
						Perform compilation, but do not link.
					</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-f</option>
					<replaceable>arg</replaceable>
				</term>
				<listitem>
					<para>
						Pass code generation argument
						<replaceable>arg</replaceable> to the compiler.
						See the <command>cc1</command> man page for
						possible arguments.
					</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-m</option>
					<replaceable>arch</replaceable>
				</term>
				<listitem>
					<para>
						Currently ignored. <!-- FIXME -->
					</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-nostdlib</option>
				</term>
				<listitem>
					<para>
						With this option, the linker will only search 
						for libraries that are passed as command line
						arguments.
					</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-o</option>
					<replaceable>file</replaceable>
				</term>
				<listitem>
					<para>
						Write output to <replaceable>file</replaceable>.
					</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-print-libfaucc-file-name</option>
				</term>
				<listitem>
					<para>
						Print the full path of the internal compiler
						library <filename>libfaucc.a</filename>.
					</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-static</option>
				</term>
				<listitem>
					<para>
						Perform static linking.
					</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<!-- FIXME -->
				<term>
					<option>--freestanding</option>
				</term>
				<term>
					<option>--no-stack-protector</option>
				</term>
				<listitem>
					<para>
						Currently ignored.
					</para>
				</listitem>
			</varlistentry>
		</variablelist>
	</refsect1>
	<refsect1>
		<title>EXAMPLES</title>
		<variablelist>
			<varlistentry>
				<term>
					<command>
						&binary; -c hello-world.c -o hello-world.o
					</command>
				</term>
				<listitem>
					<para>

					Compile the program <filename>hello-world.c</filename> 
					and output the object as 
					<filename>hello-wolrd.o</filename>.
					</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<command>
						&binary; -S -b i286 -o test.s test.c
					</command>
				</term>
				<listitem>
					<para>
					Compile the program <filename>test.c</filename>
					to 16 bit code and output the assembly listing
					to <filename>test.s</filename>, but do not assemble or
					link the result yet.
					</para>
				</listitem>
			</varlistentry>

		</variablelist>
	</refsect1>
	<refsect1>
		<title>SEE ALSO</title>
		<para>
        	<simplelist type="inline">
				<member>
					<citerefentry>
						<refentrytitle>cc1</refentrytitle>
						<manvolnum>1</manvolnum>
					</citerefentry>
				</member>
                <member>
					<citerefentry>
						<refentrytitle>cpp</refentrytitle>
						<manvolnum>1</manvolnum>
					</citerefentry>
				</member>
				<member>
					<citerefentry>
						<refentrytitle>gcc</refentrytitle>
						<manvolnum>1</manvolnum>
					</citerefentry>
				</member>
				<member>
					<citerefentry>
						<refentrytitle>ld</refentrytitle>
						<manvolnum>1</manvolnum>
					</citerefentry>
				</member>
			</simplelist>
		</para>
	</refsect1>
	<refsect1>
		<title>CONTACT</title>
		<para>
			Please report all bugs to FAUcc Team
			<email>info@faumachine.org</email>.
			<ulink url="http://www.faumachine.org">FAUcc Homepage
			</ulink>.
		</para>
	</refsect1>
</refentry>