]> git.xonotic.org Git - xonotic/gmqcc.git/blob - doc/gmqcc.1
Some man page changes
[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 built from the NIH realm of sarcastic wit
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
27 .RS
28 .IP 3
29 Highest optimization level
30 .IP 2
31 Default optimization level
32 .IP 1
33 Minimal optimization level
34 .IP 0
35 Disable optimization entierly
36 .RE
37 .TP
38 .BI "-a" filename
39 Append the specified files to the list of files to assemble using the QC-Assembler.
40 .TP
41 .BI "-s" filename
42 Append the specified file which is to be interpreted as a \fIprogs.src\fR file.
43 .TP
44 .BI "-std=" standard
45 Use the specified standard for parsing QC code. The following standards are available:
46 .IR gmqcc , qcc , fteqcc
47 .TP
48 .BI -W warning "\fR, " "" -Wno- warning
49 Enable or disable a warning.
50 .TP
51 .B -Wall
52 Enable all warnings. Overrides preceding -W parameters.
53 .TP
54 .B -fdarkplaces-string-table-bug
55 Patch the output file to work around a string-table bug in certain darkplaces versions.
56 .TP
57 .B -fomit-nullbytes
58 Changes the output format to be more efficient. Requires a patched engine. See the
59 proposal for a better file structure in the gmqcc source tree.
60 .TP
61 .B -nocolor
62 Disables colored output
63 .TP
64 .BI "-redirout=" file
65 Redirects standard output to a \fIfile\fR
66 .TP
67 .BI "-rediterr=" file
68 Redirects standard error to a \fIfile\fR