Cleanups
[xonotic/gmqcc.git] / doc / gmqpak.1
1 .\" gmqpak mdoc manpage
2 .Dd April 27, 2013
3 .Dt GMQPAK 2 PRM
4 .Os
5 .Sh NAME
6 .Nm gmqpak
7 .Nd A standalone Quake PAK utility
8 .Sh SYNOPSIS
9 .Nm gmqpak
10 .Op Cm options
11 .Op Cm files
12 .Sh DESCRIPTION
13 .Nm gmqpak
14 Is a standalone Quake PAK file utility supporting the extraction of files,
15 directories, or whole PAKs, as well as the opposite (creation of PAK files).
16 .Sh OPTIONS
17 .Bl -tag
18 .It Fl -file Ar file
19 Specify the PAK file to create or extract
20 .It Fl -e
21 Used to denote the extraction operation on a PAK file.
22 .It Fl -c
23 Used to denote the creation operation on a PAK file.
24 .El
25 .Sh EXAMPLES
26 Here's some examples of how to use the utility to manipulate PAK files.
27 .Bl -ohang
28 .It Li gmqpak -file id1.pak -e
29 .D1 extracts a PAK to ./
30 .It Li gmqpak -file new.pak -c file1 dir/file2
31 .D1 creates a PAK with the files specified
32 .It Li gmqpak -file new1.pak -c directory.
33 .D1 creates a PAK from files within the directory, including subdirectories and files.
34 .Sh AUTHOR
35 See <http://graphitemaster.github.com/gmqcc>.
36 .Sh BUGS
37 Please report bugs on <http://github.com/graphitemaster/gmqcc/issues>,
38 or see <http://graphitemaster.github.com/gmqcc> on how to contact us.