Makefiles for docs.

This commit is contained in:
Jeff Teunissen 2002-01-05 18:46:05 +00:00
parent 1e57bcdca2
commit 33b6429aa7
5 changed files with 43 additions and 26 deletions

2
tools/qfcc/doc/.gitignore vendored Normal file
View file

@ -0,0 +1,2 @@
Makefile
Makefile.in

View file

@ -0,0 +1,5 @@
AUTOMAKE_OPTIONS= foreign
SUBDIRS= man
EXTRA_DIST= expressions.txt

2
tools/qfcc/doc/man/.gitignore vendored Normal file
View file

@ -0,0 +1,2 @@
Makefile
Makefile.in

View file

@ -0,0 +1,3 @@
AUTOMAKE_OPTIONS= foreign
man_MANS=qfcc.1

View file

@ -6,15 +6,16 @@
.\" .\"
.\" This program is distributed in the hope that it will be useful, .\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
.\" GNU General Public License for more details. .\"
.\" See the GNU General Public License for more details.
.\" .\"
.\" You should have received a copy of the GNU General Public License .\" You should have received a copy of the GNU General Public License
.\" along with this program; see the file COPYING. If not, write to .\" along with this program; see the file COPYING. If not, write to:
.\" the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
.\" .\"
.TH QFCC 1 "October 26, 2001" QuakeForge "QuakeForge Developer's Manual" .\" Free Software Foundation, Inc.
.\" Please update the above date whenever this man page is modified. .\" 59 Temple Place, Suite 330
.\" Boston, MA 02111-1307, USA
.\" .\"
.\" Some roff macros, for reference: .\" Some roff macros, for reference:
.\" .nh disable hyphenation .\" .nh disable hyphenation
@ -26,6 +27,9 @@
.\" .br insert line break .\" .br insert line break
.\" .sp <n> insert n+1 empty lines .\" .sp <n> insert n+1 empty lines
.\" for manpage-specific macros, see man(7) .\" for manpage-specific macros, see man(7)
.\"
.TH QFCC 1 "14 December, 2001" QuakeForge "QuakeForge Developer's Manual"
.\" Please update the above date whenever this man page is modified.
.SH NAME .SH NAME
qfcc \- The QuakeForge Code Compiler qfcc \- The QuakeForge Code Compiler
.SH SYNOPSIS .SH SYNOPSIS
@ -76,8 +80,8 @@ command line. Unsupported options are ignored. The following options are
supported by \fBqfcc\fP's \fB\-\-code\fP argument: supported by \fBqfcc\fP's \fB\-\-code\fP argument:
.TP .TP
.B cow .B cow
Allow assignment to initialized globals. In Quake-C and Ruamoko, a global that Allow assignment to initialized globals. In Quake-C and Ruamoko, a global
has been initialized to a value is not a variable, but a named constant. 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 However, \fBqcc\fP never really enforced this. The \fBcow\fP option allows
\fBqfcc\fP to gracefully cope with QuakeC source that assigns values to \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 initialized globals in this manner. (also known as "copy on write" \(em never
@ -92,8 +96,8 @@ if your output file is "progs.dat", the symbol file will be "progs.sym".
.TP .TP
.B v6only .B v6only
Restrict the compiler to only version 6 progs (original Quake/QuakeWorld) Restrict the compiler to only version 6 progs (original Quake/QuakeWorld)
features. This means that the compiled data file should be able to run on older features. This means that the compiled data file should be able to run on
servers, as long as you have not used any QuakeForge-specific built-in older servers, as long as you have not used any QuakeForge-specific built-in
functions. Also disables some of the compiler's features (like integers and functions. Also disables some of the compiler's features (like integers and
string manipulation support). string manipulation support).
.SH "WARNING OPTIONS" .SH "WARNING OPTIONS"
@ -103,24 +107,25 @@ line. Unsupported options are ignored. The following options are supported by
.TP .TP
.B cow .B cow
Emit a warning when the source assigns a value to a named constant. See the Emit a warning when the source assigns a value to a named constant. See the
description of the \fBcow\fP code option above for a description of what this means. description of the \fBcow\fP code option above for a description of what this
means.
.TP .TP
.B undef-function .B undef\-function
Emit a warning when a function is called, but has not yet been defined. Emit a warning when a function is called, but has not yet been defined.
.TP .TP
.B uninited-var .B uninited\-var
Emit a warning when a variable is read from that has not been initalized to a Emit a warning when a variable is read from that has not been initalized to a
value. value.
.TP .TP
.B vararg-integer .B vararg\-integer
Emit a warning when a function that takes a variable number of arguments is Emit a warning when a function that takes a variable number of arguments is
passed a constant of an integer type. passed a constant of an integer type.
.TP .TP
.B error .B error
Promote warnings to errors. Promote warnings to errors.
.PP .PP
Any of the above can be prefixed with \fBno-\fP to negate its meaning. There are Any of the above can be prefixed with \fBno\-\fP to negate its meaning. There
also two special options: are also two special options:
.TP .TP
.B all .B all
Turns on all warning options except \fBerror\fP. Turns on all warning options except \fBerror\fP.
@ -130,22 +135,22 @@ Turns off all warning options except \fBerror\fP.
.SH "FAQ" .SH "FAQ"
.TP .TP
.B Where did the name Ruamoko come from? .B Where did the name Ruamoko come from?
In Maori mythology, Ruamoko is the youngest child of Ranginui, the Sky-father, In Maori mythology, Ruamoko is the youngest child of Ranginui, the
and Papatuanuku, the Earth-mother. Ruamoko is the god of volcanoes and Sky\-father, and Papatuanuku, the Earth\-mother. Ruamoko is the god of
earthquakes \fB(Quake, get it?)\fP. For more information, see the Web site volcanoes and earthquakes \fB(Quake, get it?)\fP. For more information, see
\fBhttp://maori.com/kmst1.htm\fP. the Web site at <\fBhttp://maori.com/kmst1.htm\fP>.
.TP .TP
.B qfcc is singing a bad 80s rap song to me. What's going on? .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 "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. means there's a bug in qfcc, so please report it to the team.
.TP .TP
.B qfcc is mooing at me. What's wrong with you people? .B qfcc is mooing at me. What's wrong with you people?
The compiler doesn't like being treated like a slab of beef. Seriously, the code The compiler doesn't like being treated like a slab of beef. Seriously, the
you are trying to compile is using constants as if they weren't. Normally, qfcc code you are trying to compile is using constants as if they weren't.
would just stop and tell the code to sit in the corner for a while, but you told Normally, qfcc would just stop and tell the code to sit in the corner for a
it not to do that by passing the \fBcow\fP option to \fB\-\-code\fP, so it has while, but you told it not to do that by passing the \fBcow\fP option to
its revenge by mooing out a warning. Or something like that. To disable the \fB\-\-code\fP, so it has its revenge by mooing out a warning. Or something
warning, pass \fBno-cow\fP to \fB\-\-warn\fP. like that. To disable the warning, pass \fBno-cow\fP to \fB\-\-warn\fP.
.SH "FILES" .SH "FILES"
progs.src progs.src
.SH "SEE ALSO" .SH "SEE ALSO"