qf
/
quakeforge
mirror of https://git.code.sf.net/p/quake/quakeforge
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update qfcc man page.

This commit is contained in:
Jeff Teunissen 2001-12-14 05:33:00 +00:00
parent 9b4e21a914
commit 2185e0a92e
1 changed files with 16 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
tools/qfcc/doc/man/qfcc.1
View File

@ -32,7 +32,7 @@ qfcc \- The QuakeForge Code Compiler
.B qfcc
.RI [ options ]
.SH DESCRIPTION
\fBqfcc\fP compiles GameC source into a form that the QuakeForge server can
\fBqfcc\fP compiles Ruamoko source into a form that the QuakeForge server can
understand.
.SH OPTIONS
\fBqfcc\fP takes the following arguments:
@ -76,12 +76,12 @@ command line. Unsupported options are ignored. The following options are
supported by \fBqfcc\fP's \fB\-\-code\fP argument:
.TP
.B cow
Allow assignment to initialized globals. In QuakeC, a global that has been
initialized to a value is not a variable, but a named constant. However,
\fBqcc\fP never really enforced this. The \fBcow\fP option allows \fBqfcc\fP
to gracefully cope with QuakeC source that assigns values to initialized globals
in this manner. (also known as "copy on write" \(em never mind the bovine
connotations)
Allow assignment to initialized globals. In Quake-C and Ruamoko, a global that
has been initialized to a value is not a variable, but a named constant.
However, \fBqcc\fP never really enforced this. The \fBcow\fP option allows
\fBqfcc\fP to gracefully cope with QuakeC source that assigns values to
initialized globals in this manner. (also known as "copy on write" \(em never
mind the bovine connotations)
.TP
.B debug
Generate debug code for QuakeForge engines. The QuakeForge engine has the
@ -129,6 +129,12 @@ Turns on all warning options except \fBerror\fP.
Turns off all warning options except \fBerror\fP.
.SH "FAQ"
.TP
.B Where did the name Ruamoko come from?
In Maori mythology, Ruamoko is the youngest child of Ranginui, the Sky-father,
and Papatuanuku, the Earth-mother. Ruamoko is the god of volcanoes and
earthquakes \fB(Quake, get it?)\fP. For more information, see the Web site
\fBhttp://maori.com/kmst1.htm\fP.
.TP
.B qfcc is singing a bad 80s rap song to me. What's going on?
"ice ice baby" is QuakeForge-speak for "Internal Compiler Error". It usually
means there's a bug in qfcc, so please report it to the team.
@ -145,7 +151,6 @@ progs.src
.SH "SEE ALSO"
.BR quakeforge (1)
.SH AUTHORS
The original \fBqcc\fP program was written by Id Software, Inc. The members of
the QuakeForge Project have modified it to work with extensions to the QuakeC
language. To minimize confusion, the name of the language compiled by \fBqfcc\fP
is called GameC.
The original \fBqcc\fP program, for compiling the QuakeC language, was written
by Id Software, Inc. The members of the QuakeForge Project have modified it to
work with a new, but very similar language called \fBRuamoko\fP.