Less general name for PAK utility, added install targets for PAK utility, added manpa...
authorDale Weiler <killfieldengine@gmail.com>
Sun, 28 Apr 2013 03:41:03 +0000 (03:41 +0000)
committerDale Weiler <killfieldengine@gmail.com>
Sun, 28 Apr 2013 03:41:03 +0000 (03:41 +0000)
Makefile
doc/gmqpak.1 [new file with mode: 0644]

index 35b825a1f917a9d0a74898471f54c2a4d2db1d54..febebebbb4b397d244a2f36a93f96d9d87a36cbc 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -72,12 +72,12 @@ ifneq ("$(MINGW)", "")
        QCVM      = qcvm.exe
        GMQCC     = gmqcc.exe
        TESTSUITE = testsuite.exe
-       PAK       = pak.exe
+       PAK       = gmqpak.exe
 else
        QCVM      = qcvm
        GMQCC     = gmqcc
        TESTSUITE = testsuite
-       PAK       = pak
+       PAK       = gmqpak
 endif
 endif
 
@@ -214,23 +214,29 @@ depend:
                $(subst .o,.c,$(OBJ_P))
 
 #install rules
-install: install-gmqcc install-qcvm install-doc
+install: install-gmqcc install-qcvm install-gmqpak install-doc
 install-gmqcc: $(GMQCC)
        install -d -m755               $(DESTDIR)$(BINDIR)
        install    -m755  $(GMQCC)     $(DESTDIR)$(BINDIR)/$(GMQCC)
 install-qcvm: $(QCVM)
        install -d -m755               $(DESTDIR)$(BINDIR)
        install    -m755  $(QCVM)      $(DESTDIR)$(BINDIR)/$(QCVM)
+install-gmqpak: $(PAK)
+       install -d -m755               $(DESTDIR)$(BINDIR)
+       install    -m755  $(PAK)       $(DESTDIR)$(BINDIR)/$(PAK)
 install-doc:
        install -d -m755               $(DESTDIR)$(MANDIR)/man1
        install    -m644  doc/gmqcc.1  $(DESTDIR)$(MANDIR)/man1/
        install    -m644  doc/qcvm.1   $(DESTDIR)$(MANDIR)/man1/
+       install    -m644  doc/gmqpak.1 $(DESTDIR)$(MANDIR)/man1/
 
 uninstall:
-       rm $(DESTDIR)$(BINDIR)/gmqcc
-       rm $(DESTDIR)$(BINDIR)/qcvm
-       rm $(DESTDIR)$(MANDIR)/man1/doc/gmqcc.1
-       rm $(DESTDIR)$(MANDIR)/man1/doc/qcvm.1
+       rm -f $(DESTDIR)$(BINDIR)/gmqcc
+       rm -f $(DESTDIR)$(BINDIR)/qcvm
+       rm -f $(DESTDIR)$(BINDIR)/gmqpak
+       rm -f $(DESTDIR)$(MANDIR)/man1/doc/gmqcc.1
+       rm -f $(DESTDIR)$(MANDIR)/man1/doc/qcvm.1
+       rm -f $(DESTDIR)$(MANDIR)/man1/doc/gmqpak.1
 
 # DO NOT DELETE
 
diff --git a/doc/gmqpak.1 b/doc/gmqpak.1
new file mode 100644 (file)
index 0000000..967d432
--- /dev/null
@@ -0,0 +1,38 @@
+.\" gmqpak mdoc manpage
+.Dd April 27, 2013
+.Dt GMQPAK 2 PRM
+.Os
+.Sh NAME
+.Nm gmqpak
+.Nd A standalone Quake PAK utility
+.Sh SYNOPSIS
+.Nm gmqpak
+.Op Cm options
+.Op Cm files
+.Sh DESCRIPTION
+.Nm gmqpak
+Is a standalone Quake PAK file utility supporting the extraction of files,
+directories, or whole PAKs, as well as the opposite (creation of PAK files).
+.Sh OPTIONS
+.Bl -tag
+.It Fl -file Ar file
+Specify the PAK file to create or extract
+.It Fl -e
+Used to denote the extraction operation on a PAK file.
+.It Fl -c
+Used to denote the creation operation on a PAK file.
+.El
+.Sh EXAMPLES
+Here's some examples of how to use the utility to manipulate PAK files.
+.Bl -ohang
+.It Li gmqpak -file id1.pak -e
+.D1 extracts a PAK to ./
+.It Li gmqpak -file new.pak -c file1 dir/file2
+.D1 creates a PAK with the files specified
+.It Li gmqpak -file new1.pak -c directory.
+.D1 creates a PAK from files within the directory, including subdirectories and files.
+.Sh AUTHOR
+See <http://graphitemaster.github.com/gmqcc>.
+.Sh BUGS
+Please report bugs on <http://github.com/graphitemaster/gmqcc/issues>,
+or see <http://graphitemaster.github.com/gmqcc> on how to contact us.