qf/quakeforge
0
0
Fork 0
mirror of https://git.code.sf.net/p/quake/quakeforge synced 2024-11-26 06:10:56 +00:00
Code Issues Projects Releases Packages Wiki Activity

Updated manpages.

Browse source
This commit is contained in:
Ragnvald Maartmann-Moe IV 2002-08-26 23:02:17 +00:00
parent 7f5c99efdc
commit 9b9a68db9e
2 changed files with 53 additions and 98 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

78
tools/qflight/qflight.1
View file

@ -1,5 +1,5 @@
.\" hey, Emacs: -*- nroff -*-
.\" qfbsp is free software; you can redistribute it and/or modify
.\" qflight 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.
@ -28,71 +28,51 @@
.\" .sp <n> insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.\"
.TH QFBSP 1 "24 August, 2002" QuakeForge "QuakeForge User's Manual"
.TH QFLIGHT 1 "25 August, 2002" QuakeForge "QuakeForge User's Manual"
.\" Please update the above date whenever this man page is modified.
.SH NAME
pak \- The QuakeForge BSP Tool
qflight \- The QuakeForge Light Tool
.SH SYNOPSIS
.B qfbsp
<\fBcommand\fP> [\fBoptions\fP] \fIARCHIVE\fP \fIFILE\fP...
.B qflight
<\fBcommand\fP> [\fBoptions\fP] \fIFILE\fP...
.SH DESCRIPTION
\fBqfbsp\fP is a utility for managing pack (*.pak) archives. The format used is
compatible with Quake and Quake II. Pak archives are a convenient way to store
groups of related files. Some engines allow pak archives to be compressed
internally.
\fBqflight\fP Takes a .bsp file generated by qfbsp and does light casting from all the static lights in the map.
.SH COMMANDS
\fBqfbsp\fP accepts the following arguments as a command. Only one command may be
\fBqflight\fP accepts the following arguments as a command. Only one command may be
used at a time.
.TP
.B \-c, \-\-create
Create an archive. Overwrites any contents the archive may have had.
.TP
.B \-t, \-\-test
Test an archive for valid formatting.
.TP
.B \-x, \-\-extract
Extract an archive. Overwrites any files in the current directory with the same
names as those inside the archive.
.TP
.B \-h, \-\-help
Show summary of options.
.TP
.B \-V, \-\-version
Show the version of pak.
Show the version of qflight.
.SH OPTIONS
\fBpak\fP takes the following arguments as options.
.TP
.B \-f, \-\-file ARCHIVE
Use ARCHIVE as the archive filename, instead of the first non-option argument.
This option is provided for compatibility with older versions of \fBpak\fP.
.TP
.B \-p, \-\-pad
Can be useful when creating an archive. File space is padded to a 4\-byte
boundary, assisting in the speed of loading files from the archive. The file
data itself is not changed.
\fBqflight\fP takes the following arguments as options.
.TP
.B \-q, \-\-quiet
Inhibit some of pak's normal output.
Inhibit some of qflight's normal output.
.TP
.B \-v, \-\-verbose
Display more output than usual.
.SH "EXIT STATUS"
\fBpak\fP returns a zero exit status when it has completed a command
successfully (without error). Otherwise, it returns a non-zero exit status.
.SH BUGS
.PP
The program does not currently handle compression or decompression. This
is planned for a future version.
.PP
The program does not currently handle extraction of individual files inside an
archive. This is planned for a future version.
.PP
The program cannot modify an archive once it has been created.
.TP
.B \-t, \-\-threads (n)
The number of threads to use.
.TP
.B \-e, \-\-extra
By default qflight takes one sample from each light point, running with "-extra" enabled takes four samples and averages them.
This gives smoother lighting/shadows but takes four times as long.
.TP
.B \-d, \-\-distance (n)
Scales the fade distance of ALL lights. n>1 fades faster, n<1 fades slower.
.TP
.B \-r, \-\-range (n)
Scales the brightness range of ALL lights without affecting their fade distance.
n>.5 makes them brighter, n<.5 makes them darker.
.TP
.SH AUTHORS
Bill Currie (taniwha@quakeforge.net) wrote most of the program.
.PP
Jeff Teunissen (deek@quakeforge.net) wrote the command-line interface and the
documentation.
Colin Thompson (colinjamesthompson@tiscali.co.uk) ported this to quakeforge from
the original id Software quake utils release.
.SH "SEE ALSO"
.BR quakeforge (1),
.BR qfcc (1)
.BR qfbsp (1),
.BR qfvis (1)

73
tools/qfvis/qfvis.1
View file

@ -1,5 +1,5 @@
.\" hey, Emacs: -*- nroff -*-
.\" qfbsp is free software; you can redistribute it and/or modify
.\" qfvis 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.
@ -28,71 +28,46 @@
.\" .sp <n> insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.\"
.TH QFBSP 1 "24 August, 2002" QuakeForge "QuakeForge User's Manual"
.TH QFVIS 1 "25 August, 2002" QuakeForge "QuakeForge User's Manual"
.\" Please update the above date whenever this man page is modified.
.SH NAME
pak \- The QuakeForge BSP Tool
qfvis \- The QuakeForge VIS Tool
.SH SYNOPSIS
.B qfbsp
<\fBcommand\fP> [\fBoptions\fP] \fIARCHIVE\fP \fIFILE\fP...
.B qfvis
<\fBcommand\fP> [\fBoptions\fP] \fIFILE\fP...
.SH DESCRIPTION
\fBqfbsp\fP is a utility for managing pack (*.pak) archives. The format used is
compatible with Quake and Quake II. Pak archives are a convenient way to store
groups of related files. Some engines allow pak archives to be compressed
internally.
\fBqfvis\fP Generates the PVS (Potential Visible Set) & PHS (Potential Hearable Set) for a .bsp file.
.SH COMMANDS
\fBqfbsp\fP accepts the following arguments as a command. Only one command may be
\fBqfvis\fP accepts the following arguments as a command. Only one command may be
used at a time.
.TP
.B \-c, \-\-create
Create an archive. Overwrites any contents the archive may have had.
.TP
.B \-t, \-\-test
Test an archive for valid formatting.
.TP
.B \-x, \-\-extract
Extract an archive. Overwrites any files in the current directory with the same
names as those inside the archive.
.TP
.B \-h, \-\-help
Show summary of options.
.TP
.B \-V, \-\-version
Show the version of pak.
Show the version of qfvis.
.SH OPTIONS
\fBpak\fP takes the following arguments as options.
.TP
.B \-f, \-\-file ARCHIVE
Use ARCHIVE as the archive filename, instead of the first non-option argument.
This option is provided for compatibility with older versions of \fBpak\fP.
.TP
.B \-p, \-\-pad
Can be useful when creating an archive. File space is padded to a 4\-byte
boundary, assisting in the speed of loading files from the archive. The file
data itself is not changed.
\fBqfvis\fP takes the following arguments as options.
.TP
.B \-q, \-\-quiet
Inhibit some of pak's normal output.
Inhibit some of qflight's normal output.
.TP
.B \-v, \-\-verbose
Display more output than usual.
.SH "EXIT STATUS"
\fBpak\fP returns a zero exit status when it has completed a command
successfully (without error). Otherwise, it returns a non-zero exit status.
.SH BUGS
.PP
The program does not currently handle compression or decompression. This
is planned for a future version.
.PP
The program does not currently handle extraction of individual files inside an
archive. This is planned for a future version.
.PP
The program cannot modify an archive once it has been created.
.TP
.B \-t, \-\-threads (n)
The number of threads to use.
.TP
.B \-m, \-\-minimal
Performs only minimal vis'ing, useful for map testing.
.TP
.B \-l, \-\-level (n)
Scales the fade distance of ALL lights. n>1 fades faster, n<1 fades slower.
.TP
.SH AUTHORS
Bill Currie (taniwha@quakeforge.net) wrote most of the program.
.PP
Jeff Teunissen (deek@quakeforge.net) wrote the command-line interface and the
documentation.
Colin Thompson (colinjamesthompson@tiscali.co.uk) ported this to quakeforge from
the original id Software quake utils release.
.SH "SEE ALSO"
.BR quakeforge (1),
.BR qfcc (1)
.BR qfbsp (1),
.BR qflight (1)