]> git.xonotic.org Git - xonotic/gmqcc.git/blob - doc/gmqcc.1
Added handler for -W
[xonotic/gmqcc.git] / doc / gmqcc.1
1 .\" Process with groff -man -Tascii file.3
2 .TH GMQCC 1 2012-07-12 "" "gmqcc Manual"
3 .SH NAME
4 gmqcc \- A Quake C compiler which tries to reduce suckiness.
5 .SH SYNOPSIS
6 .B gmqcc
7 [\fIOPTIONS\fR] [\fIfiles...\fR]
8 .SH DESCRIPTION
9 Traditionally, a QC compiler reads the file \fIprogs.src\fR which
10 in its first line contains the output filename, and the rest is a
11 list of QC source files that are to be compiled in order.
12 \fBgmqcc\fR optionally takes options to specify the output and
13 input files on the commandline, and also accepts assembly files.
14 .SH OPTIONS
15 \fBgmqcc\fR mostly tries to mimick gcc's commandline handling, though
16 there are also traditional long-options available.
17 .TP
18 .B "-h, --help"
19 Show a usage message and exit.
20 .TP
21 .BI "-o, --output=" filename
22 Specify the output filename. Defaults to progs.dat. This will overwrite
23 the output file listed in a \fIprogs.src\fR file in case such a file is used.
24 .TP
25 .BI "-O" n
26 Specify the optimization level, similar to gcc.
27 .TP
28 .BI "-a" filename
29 Append the specified files to the list of files to assemble using the QC-Assembler.
30 .TP
31 .BI "-s" filename
32 Append the specified file which is to be interpreted as a \fIprogs.src\fR file.
33 .TP
34 .BI "-std=" standard
35 Use the specified standard for parsing QC code. The following standards are available:
36 .IR gmqcc , qcc , fteqcc
37 .TP
38 .BI -W warning "\fR, " "" -Wno- warning
39 Enable or disable a warning.
40 .TP
41 .B -Wall
42 Enable all warnings. Overrides preceding -W parameters.
43 .TP
44 .B -fdarkplaces-string-table-bug
45 Patch the output file to work around a string-table bug in certain darkplaces versions.
46 .TP
47 .B -fomit-nullbytes
48 Changes the output format to be more efficient. Requires a patched engine. See the
49 proposal for a better file structure in the gmqcc source tree.