quakeforge/tools/pak/pak.1

80 lines
2.7 KiB
Groff
Raw Normal View History

.\" hey, Emacs: -*- nroff -*-
.\" pak 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 <n> insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.\"
.TH PAK 1 "03 May, 2002" QuakeForge "QuakeForge User's Manual"
.\" Please update the above date whenever this man page is modified.
.SH NAME
pak \- The QuakeForge Packfile Tool
.SH SYNOPSIS
.B pak
<\fIcommand\fP> [\fIoption\fP]... \fIARCHIVE\fP \fIFILE\fP...
.SH DESCRIPTION
\fBpak\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
\fBpak\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.
.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 \-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.
.TP
.B \-q, \-\-quiet
Inhibit some of pak's normal output.
.TP
.B \-v, \-\-verbose
Display more output than usual.
.SH "SEE ALSO"
.BR quakeforge (1)
.SH AUTHORS
\fBpak\fP was written by Bill Currie <taniwha@quakeforge.net> for QuakeForge.
Jeff Teunissen <deek@quakeforge.net> has also work on it, mostly in the
interface.