doc: add documentation for bspinfo and bsputil

Signed-off-by: Kevin Shanahan <kmshanah@disenchant.net>

Makefile

@@ -510,7 +510,7 @@ $(DOC_DIR)/%.1:		man/%.1	$(BUILD_VER)	; $(do_man2man)
 $(DOC_DIR)/%.txt:	$(DOC_DIR)/%.1		; $(do_man2txt)
 $(DOC_DIR)/%.html:	$(DOC_DIR)/%.1		; $(do_man2html)
 
-SRC_DOCS = qbsp.1 light.1 vis.1
+SRC_DOCS = qbsp.1 light.1 vis.1 bsputil.1 bspinfo.1
 MAN_DOCS = $(patsubst %.1,$(DOC_DIR)/%.1,$(SRC_DOCS))
 HTML_DOCS = $(patsubst %.1,$(DOC_DIR)/%.html,$(SRC_DOCS))
 TEXT_DOCS = $(patsubst %.1,$(DOC_DIR)/%.txt,$(SRC_DOCS))
@@ -528,17 +528,9 @@ DIST_FILES = \
 	$(1)/README.txt \
 	$(1)/COPYING \
 	$(1)/changelog.txt \
-	$(1)/doc/qbsp.1 \
+	$(patsubst %.1,$(1)/doc/%.1,$(SRC_DOCS)) \
-	$(1)/doc/qbsp.txt \
+	$(patsubst %.1,$(1)/doc/%.txt,$(SRC_DOCS)) \
-	$(1)/doc/qbsp.html \
+	$(patsubst %.1,$(1)/doc/%.html,$(SRC_DOCS))
-	$(1)/doc/light.1 \
-	$(1)/doc/light.txt \
-	$(1)/doc/light.html \
-	$(1)/doc/vis.1 \
-	$(1)/doc/vis.txt \
-	$(1)/doc/vis.html
-
-
 
 # ----------------------------------------------------------------------------
 # OSX Packaging Tools

README.txt

@@ -20,12 +20,9 @@ Included utilities:
 
   vis     - Creates the potentially visible set (PVS) for a bsp.
 
-  bspinfo - Simple util to print out some stats about the data contained in a
+  bspinfo - Print stats about the data contained in a bsp file.
-            bsp file.
 
-  bsputil - Tool for working with a bsp file. Minimal features currently, but
+  bsputil - Simple tool for manipulation of bsp file data
-            it can extract the entities lump from a bsp file into a text file
-            and extract the textures to a .wad file.
 
 See the doc/ directory for more detailed descriptions of the various
 tools capabilities.  See changelog.txt for a brief overview of recent

changelog.txt

@@ -1,6 +1,6 @@
 Unreleased
 
-* 
+* Documentation added for bspinfo and bsputil
 
 2013-04-24 TyrUtils v0.9
 

man/bspinfo.1

@@ -0,0 +1,52 @@
+.\" Process this file with
+.\" groff -man -Tascii bspinfo.1
+.\"
+.TH BSPINFO 1 "TYR_VERSION" TYRUTILS
+
+.SH NAME
+bspinfo \- print basic information about a Quake BSP file
+
+.SH SYNOPSIS
+\fBbspinfo\fP BSPFILE
+
+.SH DESCRIPTION
+\fBbspinfo\fP will print a very basic summary of the internal data in
+\fIBSPFILE\fP.  The BSP version number is printed, followed by one
+line for each of the data types inside, giving the count and data size
+in bytes of each data type.
+
+If the filename \fIBSPFILE\fP does not have a .bsp extension,
+\fBbsputil\fP will look for a .bsp file by stripping the file
+extension from BSPFILE (if any) and appending ".bsp".
+
+.SH AUTHOR
+Written by Kevin Shanahan (aka Tyrann)
+.br
+Based on source provided by id Software
+.br
+http://disenchant.net
+.br
+
+.SH REPORTING BUGS
+Please send bug reports to tyrann@disenchant.net.
+.br
+Improvements to the documentation are welcome and encouraged.
+
+.SH COPYRIGHT
+Copyright (C) 2013 Kevin Shanahan
+.br
+Copyright (C) 1997 id Software
+.br
+License GPLv2+:  GNU GPL version 2 or later
+.br
+<http://gnu.org/licenses/gpl2.html>.
+.PP
+This is free software: you are free to change and redistribute it.  There is
+NO WARRANTY, to the extent permitted by law.
+
+.SH "SEE ALSO"
+\fBqbsp\fP(1)
+\fBlight\fP(1)
+\fBvis\fP(1)
+\fBbsputil\fP(1)
+\fBquake\fP(6)

man/bsputil.1

@@ -0,0 +1,62 @@
+.\" Process this file with
+.\" groff -man -Tascii bsputil.1
+.\"
+.TH BSPUTIL 1 "TYR_VERSION" TYRUTILS
+
+.SH NAME
+bsputil \- utiltiy for working with Quake BSP files
+
+.SH SYNOPSIS
+\fBbsputil\fP [OPTION]... BSPFILE
+
+.SH DESCRIPTION
+\fBbsputil is a small utility for basic manipulation of Quake BSP files.
+
+.SH OPTIONS
+.IP "\fB\--extract-textures\fP"
+Extract the texture data from \fIBSPFILE\fP and create a Quake WAD
+file.  The output filename is generated from \fIBSPFILE\fP by
+stripping the .bsp extension and adding the .wad extension.
+.IP "\fB\--extract-entities\fP"
+Extract the entity data from \fIBSPFILE\fP and create a plain
+text .ent file.  The output filename is generated from \fIBSPFILE\fP
+by stripping the .bsp extension and adding the .ent extension.
+.IP "\fB\--check\fP"
+Load \fIBSPFILE\fP into memory and run a set of tests to check that
+all internal data structures are self-consistent.  Currently the tests
+are very basic and not all warnings will result in errors from all
+versions of the Quake engine.  This option is not targeted at level
+designers, but is intended to assist with development of the
+\fBqbsp\fP tool and check that a "clean" bsp file is generated.
+
+.SH AUTHOR
+Written by Kevin Shanahan (aka Tyrann)
+.br
+Based on source provided by id Software
+.br
+http://disenchant.net
+.br
+
+.SH REPORTING BUGS
+Please send bug reports to tyrann@disenchant.net.
+.br
+Improvements to the documentation are welcome and encouraged.
+
+.SH COPYRIGHT
+Copyright (C) 2013 Kevin Shanahan
+.br
+Copyright (C) 1997 id Software
+.br
+License GPLv2+:  GNU GPL version 2 or later
+.br
+<http://gnu.org/licenses/gpl2.html>.
+.PP
+This is free software: you are free to change and redistribute it.  There is
+NO WARRANTY, to the extent permitted by law.
+
+.SH "SEE ALSO"
+\fBqbsp\fP(1)
+\fBlight\fP(1)
+\fBvis\fP(1)
+\fBbspinfo\fP(1)
+\fBquake\fP(6)

man/light.1

@@ -212,4 +212,6 @@ NO WARRANTY, to the extent permitted by law.
 .SH "SEE ALSO"
 \fBqbsp\fP(1)
 \fBvis\fP(1)
+\fBbspinfo\fP(1)
+\fBbsputil\fP(1)
 \fBquake\fP(6)

man/qbsp.1

@@ -180,4 +180,6 @@ NO WARRANTY, to the extent permitted by law.
 .SH "SEE ALSO"
 \fBlight\fP(1)
 \fBvis\fP(1)
+\fBbspinfo\fP(1)
+\fBbsputil\fP(1)
 \fBquake\fP(6)

man/vis.1

@@ -1,5 +1,5 @@
 .\" Process this file with
-.\" groff -man -Tascii qbsp.1
+.\" groff -man -Tascii vis.1
 .\"
 .TH VIS 1 "TYR_VERSION" TYRUTILS
 
@@ -80,4 +80,6 @@ NO WARRANTY, to the extent permitted by law.
 .SH "SEE ALSO"
 \fBqbsp\fP(1)
 \fBlight\fP(1)
+\fBbspinfo\fP(1)
+\fBbsputil\fP(1)
 \fBquake\fP(6)