From 8c3e8cf083ab6a035271157cf79e2137aa4ad238 Mon Sep 17 00:00:00 2001 From: Ragnvald Maartmann-Moe IV Date: Sun, 25 Aug 2002 23:59:11 +0000 Subject: [PATCH] Add manpage for qfvis. --- tools/qfvis/.gitignore | 1 - tools/qfvis/qfvis.1 | 98 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 98 insertions(+), 1 deletion(-) create mode 100644 tools/qfvis/qfvis.1 diff --git a/tools/qfvis/.gitignore b/tools/qfvis/.gitignore index 47757fde6..3f1bd229e 100644 --- a/tools/qfvis/.gitignore +++ b/tools/qfvis/.gitignore @@ -2,4 +2,3 @@ .deps Makefile.in Makefile -qfvis.1 diff --git a/tools/qfvis/qfvis.1 b/tools/qfvis/qfvis.1 new file mode 100644 index 000000000..32514a629 --- /dev/null +++ b/tools/qfvis/qfvis.1 @@ -0,0 +1,98 @@ +.\" hey, Emacs: -*- nroff -*- +.\" qfbsp 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. +.\" +.\" This program is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. +.\" +.\" See the GNU General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public License +.\" along with this program; see the file COPYING. If not, write to: +.\" +.\" Free Software Foundation, Inc. +.\" 59 Temple Place, Suite 330 +.\" Boston, MA 02111-1307, USA +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins (default) +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.\" +.TH QFBSP 1 "24 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 +.SH SYNOPSIS +.B qfbsp +<\fBcommand\fP> [\fBoptions\fP] \fIARCHIVE\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. +.SH COMMANDS +\fBqfbsp\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. +.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. +.TP +.B \-q, \-\-quiet +Inhibit some of pak'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. +.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. +.SH "SEE ALSO" +.BR quakeforge (1), +.BR qfcc (1)