add man pages, distribute utility programs in new d2x-common deb
authorBradley Bell <btb@icculus.org>
Sat, 2 Aug 2003 20:27:05 +0000 (20:27 +0000)
committerBradley Bell <btb@icculus.org>
Sat, 2 Aug 2003 20:27:05 +0000 (20:27 +0000)
21 files changed:
ChangeLog
Makefile.am
debian/changelog.in
debian/control
debian/d2x-common.dirs [new file with mode: 0644]
debian/d2x-common.install [new file with mode: 0644]
debian/d2x-common.manpages [new file with mode: 0644]
debian/d2x-gl.files [deleted file]
debian/d2x-gl.menu
debian/d2x-sdl.files [deleted file]
debian/d2x-sdl.menu
debian/rules
libmve/Makefile.am
libmve/mveplayer.1 [new file with mode: 0644]
utilities/Makefile.am
utilities/hogcreate.1 [new file with mode: 0644]
utilities/hogextract.1 [new file with mode: 0644]
utilities/mvlcreate.1 [new file with mode: 0644]
utilities/mvlextract.1 [new file with mode: 0644]
utilities/tex2txb.1 [new file with mode: 0644]
utilities/txb2tex.1 [new file with mode: 0644]

index 42e4921..8253f9d 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,4 +1,14 @@
-2003-08-02  Paolo Ulivi <pulivi@libero.it>
+2003-08-02  Paolo Ulivi <pulivi@libero.it> and Bradley Bell  <btb@icculus.org>
+
+       * Makefile.am, debian/changelog.in, debian/control,
+       debian/d2x-common.dirs, debian/d2x-common.install,
+       debian/d2x-common.manpages, debian/d2x-gl.files,
+       debian/d2x-gl.menu, debian/d2x-sdl.files, debian/d2x-sdl.menu,
+       debian/rules, libmve/Makefile.am, libmve/mveplayer.1,
+       utilities/Makefile.am, utilities/hogcreate.1,
+       utilities/hogextract.1, utilities/mvlcreate.1,
+       utilities/mvlextract.1, utilities/tex2txb.1, utilities/txb2tex.1:
+       add man pages, distribute utility programs in new d2x-common deb
 
        * rpm/d2x.spec.in: updated rpm spec file
 
index f42f95b..b5aa2cc 100644 (file)
@@ -1,4 +1,4 @@
-DIST_SUBDIRS = 2d 3d maths mem cfile iff texmap misc arch main libmve utilities
+DIST_SUBDIRS = 2d 3d maths mem cfile console iff texmap misc arch main libmve utilities
 
 SUBDIRS = ${DIST_SUBDIRS} @D2X_SUBDIRS@
 
index 2ccfd87..ac71208 100644 (file)
@@ -2,5 +2,5 @@ d2x (@VERSION@) unstable; urgency=low
 
   * Please see the file NEWS.
 
- -- Bradley Bell <bradleyb@u.washington.edu>  Tue,  5 Feb 2002 22:16:01 -0800
+ -- Bradley Bell <btb@icculus.org>  Tue,  2 Aug 2003 12:50:01 -0800
 
index 20bdd6e..d85e251 100644 (file)
@@ -2,19 +2,25 @@ Source: d2x
 Section: games
 Priority: extra
 Maintainer: Bradley Bell <bradleyb@u.washington.edu>
-Build-Depends: debhelper (>> 3.0.0), libsdl-dev, nasm, libgl-dev
+Build-Depends: debhelper (>= 4), libsdl-dev, nasm, libgl-dev
 Standards-Version: 3.5.0
 
+Package: d2x-common
+Architecture: any
+Suggests: d2x-sdl | d2x-gl
+Description: Descent II, common files
+ Descent II, common files.
+
 Package: d2x-sdl
 Architecture: any
 Depends: ${shlibs:Depends}
 Provides: d2x
-Description: Descent II
- Descent II
+Description: Descent II, SDL version
+ Descent II, SDL version.
 
 Package: d2x-gl
 Architecture: any
 Depends: ${shlibs:Depends}
 Provides: d2x
-Description: Descent II, GL-accelerated
- Descent II, GL-accelerated
+Description: Descent II, OpenGL version
+ Descent II, OpenGL version.
diff --git a/debian/d2x-common.dirs b/debian/d2x-common.dirs
new file mode 100644 (file)
index 0000000..e772481
--- /dev/null
@@ -0,0 +1 @@
+usr/bin
diff --git a/debian/d2x-common.install b/debian/d2x-common.install
new file mode 100644 (file)
index 0000000..ff27f00
--- /dev/null
@@ -0,0 +1,7 @@
+build_d2x-sdl/libmve/mveplayer     /usr/bin
+build_d2x-sdl/utilities/hogcreate  /usr/bin
+build_d2x-sdl/utilities/hogextract /usr/bin
+build_d2x-sdl/utilities/mvlcreate  /usr/bin
+build_d2x-sdl/utilities/mvlextract /usr/bin
+build_d2x-sdl/utilities/tex2txb    /usr/bin
+build_d2x-sdl/utilities/txb2tex    /usr/bin
diff --git a/debian/d2x-common.manpages b/debian/d2x-common.manpages
new file mode 100644 (file)
index 0000000..8f7a928
--- /dev/null
@@ -0,0 +1,7 @@
+libmve/mveplayer.1
+utilities/hogcreate.1
+utilities/hogextract.1
+utilities/mvlcreate.1
+utilities/mvlextract.1
+utilities/tex2txb.1
+utilities/txb2tex.1
diff --git a/debian/d2x-gl.files b/debian/d2x-gl.files
deleted file mode 100644 (file)
index 75de4a8..0000000
+++ /dev/null
@@ -1 +0,0 @@
-/usr/games/d2x-gl
index dfae069..8b854b8 100644 (file)
@@ -1,2 +1,2 @@
 ?package(d2x-gl):needs=X11 section=Games/Arcade\
-  title="d2x-gl" command="/usr/games/d2x-gl"
+  title="d2x-gl" command="xterm -e /usr/games/d2x-gl -fullscreen"
diff --git a/debian/d2x-sdl.files b/debian/d2x-sdl.files
deleted file mode 100644 (file)
index eb48ce7..0000000
+++ /dev/null
@@ -1 +0,0 @@
-usr/games/d2x-sdl
index 2d8bd97..91bb5be 100644 (file)
@@ -1,2 +1,2 @@
 ?package(d2x-sdl):needs=X11 section=Games/Arcade\
-  title="d2x-sdl" command="/usr/games/d2x-sdl"
+  title="d2x-sdl" command="xterm -e /usr/games/d2x-sdl -fullscreen"
index abd9fee..3c58084 100644 (file)
@@ -6,7 +6,7 @@
 #export DH_VERBOSE=1
 
 # This is the debhelper compatability version to use.
-export DH_COMPAT=3
+export DH_COMPAT=4
 
 configure: configure-stamp configure-gl-stamp
 configure-stamp:
@@ -34,6 +34,8 @@ build-stamp: configure-stamp
 
        # Add here commands to compile the package.
        cd build_d2x-sdl && $(MAKE)
+       cd build_d2x-sdl/libmve && $(MAKE) mveplayer
+       cd build_d2x-sdl/utilities && $(MAKE) utils
 
        touch build-stamp
 
@@ -77,6 +79,7 @@ binary-arch: build install
 #      dh_installdebconf       
        dh_installdocs -A NEWS
        dh_installexamples
+       dh_install
        dh_installmenu
 #      dh_installlogrotate
 #      dh_installemacsen
index 1c80f66..6ddb552 100644 (file)
@@ -2,8 +2,7 @@ EXTRA_PROGRAMS = mveplayer
 
 mveplayer_SOURCES = decoder16.c decoder8.c mve_audio.c mve_main.c mvelib.c mveplay.c
 
-mveplayer_CFLAGS = -DSTANDALONE
-
+mveplayer_MANS = mveplayer.1
 
 
 noinst_LIBRARIES = libmve.a
@@ -12,4 +11,4 @@ INCLUDES = -I$(top_srcdir)/include
 
 libmve_a_SOURCES = decoder16.c decoder8.c mve_audio.c mvelib.c mveplay.c
 
-EXTRA_DIST = decoders.h mve_audio.h mvelib.h
+EXTRA_DIST = decoders.h mve_audio.h mvelib.h $(mveplayer_MANS)
diff --git a/libmve/mveplayer.1 b/libmve/mveplayer.1
new file mode 100644 (file)
index 0000000..8fe79ee
--- /dev/null
@@ -0,0 +1,69 @@
+.\"                                      Hey, EMACS: -*- nroff -*-
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH MVEPLAYER 1 "July 10, 2003"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh        disable hyphenation
+.\" .hy        enable hyphenation
+.\" .ad l      left justify
+.\" .ad b      justify to both left and right margins
+.\" .nf        disable filling
+.\" .fi        enable filling
+.\" .br        insert line break
+.\" .sp <n>    insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+mveplayer \- Standalone MVE movie player.
+.SH SYNOPSIS
+.B mveplayer
+.RI [ options ]
+.RI filename.mv[e|l]
+.br
+.SH DESCRIPTION
+This manual page documents briefly the
+.B mveplayer
+command.
+This manual page was written for the Debian distribution
+because the original program does not have a manual page.
+.PP
+.B mveplayer
+is a standalone player for MVE movie files, like that found in the
+DESCENT II videogame and played by the D2X package. It supports all MVE
+files around, so if you find one that doesn't work, please report this as
+a bug. Note that the MVE files found in the Macintosh version of Descent II
+are not really MVE files, they appear to be some sort of quicktime-related
+format.
+
+If you give to
+.B mveplayer
+the name of an MVL file, i.e. an archive containing one ore more MVE files,
+it will print the full contents of the archive to stdout.
+
+You'll find some MVE files as part of the Descent II Registered datafiles.
+.SH OPTIONS
+A summary of options is included below.  These command-line options do
+not appear to be documented elsewhere, so the only authoritive source is
+the source code itself.
+.TP
+.B \-h
+Usage screen.
+.TP
+.B \-f
+Fullscreen mode.
+.TP
+.B \-l
+Loop mode. Loop forever or until you press the Esc key.
+.TP
+.B \-s \fP\fIspeed factor\fP
+A decimal integer indicating the requested speed factor.
+.SH SEE ALSO
+.BR mvlextract (1),
+.BR mvlcreate (1),
+.BR hogextract (1),
+.BR hogcreate (1).
+.SH AUTHOR
+This manual page was written by Paolo Ulivi <pulivi@libero.it>,
+for the Debian GNU/Linux system (but may be used by others).
index 50b24b9..6950e54 100644 (file)
@@ -1,17 +1,28 @@
 EXTRA_PROGRAMS = hogcreate hogextract mvlcreate mvlextract txb2tex tex2txb
 
 hogcreate_SOURCES = hogcreate.c
+hogcreate_MANS = hogcreate.1
 
 hogextract_SOURCES = hogextract.c
+hogextract_MANS = hogextract.1
 
 mvlcreate_SOURCES = mvlcreate.c
+mvlcreate_MANS = mvlcreate.1
 
 mvlextract_SOURCES = mvlextract.c
+mvlextract_MANS = mvlextract.1
 
 txb2tex_SOURCES = txb2tex.c
+txb2tex_MANS = txb2tex.1
 
 tex2txb_SOURCES = tex2txb.c
+tex2txb_MANS = tex2txb.1
 
 utils: $(EXTRA_PROGRAMS)
 
+EXTRA_DIST = \
+       $(hogcreate_MANS) $(hogextract_MANS) \
+       $(mvlcreate_MANS) $(mvlextract_MANS) \
+       $(txb2tex_MANS) $(tex2txb_MANS)
+
 .PHONY: utils
diff --git a/utilities/hogcreate.1 b/utilities/hogcreate.1
new file mode 100644 (file)
index 0000000..339aefb
--- /dev/null
@@ -0,0 +1,49 @@
+.\"                                      Hey, EMACS: -*- nroff -*-
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH HOGCREATE 1 "July 10, 2003"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh        disable hyphenation
+.\" .hy        enable hyphenation
+.\" .ad l      left justify
+.\" .ad b      justify to both left and right margins
+.\" .nf        disable filling
+.\" .fi        enable filling
+.\" .br        insert line break
+.\" .sp <n>    insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+hogcreate \- Creates an HOG archive using all the files in the current
+directory.
+.SH SYNOPSIS
+.B hogcreate
+.RI filename.hog
+.br
+.SH DESCRIPTION
+This manual page documents briefly the
+.B hogcreate
+command.
+This manual page was written for the Debian distribution
+because the original program does not have a manual page.
+.PP
+.B hogcreate
+is an utility to create HOG files, like that found in the DESCENT II
+videogame and played by the D2X package.
+
+HOG archives are files with a .hog extension, and contains all of the data
+which constitutes a DESCENT II's level.
+
+You'll find some HOG files as part of the Descent II datafiles.
+.SH SEE ALSO
+.BR hogextract (1),
+.BR mvlextract (1),
+.BR mveplayer (1).
+.SH AUTHOR
+The command was first created by Josh Cogliati in 1999, then modified by
+Bradley Bell in 2002 for use with the D2X package.
+
+This manual page was written by Paolo Ulivi <pulivi@libero.it>,
+for the Debian GNU/Linux system (but may be used by others).
diff --git a/utilities/hogextract.1 b/utilities/hogextract.1
new file mode 100644 (file)
index 0000000..5385533
--- /dev/null
@@ -0,0 +1,60 @@
+.\"                                      Hey, EMACS: -*- nroff -*-
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH HOGEXTRACT 1 "July 10, 2003"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh        disable hyphenation
+.\" .hy        enable hyphenation
+.\" .ad l      left justify
+.\" .ad b      justify to both left and right margins
+.\" .nf        disable filling
+.\" .fi        enable filling
+.\" .br        insert line break
+.\" .sp <n>    insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+hogextract \- Extracts files from the given HOG archive into the current
+directory.
+.SH SYNOPSIS
+.B hogextract
+.RI [ options ]
+.RI hogfile
+.RI [ filename ]
+.br
+.SH DESCRIPTION
+This manual page documents briefly the
+.B hogextract
+command.
+This manual page was written for the Debian distribution
+because the original program does not have a manual page.
+.PP
+.B hogextract
+is an utility to extract all the files contained in HOG archives, like that
+found in the DESCENT II videogame and played by the D2X package.
+It supports all HOG files around, so if you find one that doesn't work,
+please report this as a bug.
+
+HOG archives are files with a .hog extension, and contains all of the data
+which constitutes a DESCENT II's level.
+
+You'll find some HOG files as part of the Descent II datafiles.
+.SH OPTIONS
+A summary of options is included below.  These command-line options do
+not appear to be documented elsewhere, so the only authoritive source is
+the source code itself.
+.TP
+.B v
+Don't extract, print a listing of all files to stdout.
+.SH SEE ALSO
+.BR hogcreate (1),
+.BR mvlcreate (1),
+.BR mveplayer (1).
+.SH AUTHOR
+The command was first created by Josh Cogliati in 1999, then modified by
+Bradley Bell in 2002 for use with the D2X package.
+
+This manual page was written by Paolo Ulivi <pulivi@libero.it>,
+for the Debian GNU/Linux system (but may be used by others).
diff --git a/utilities/mvlcreate.1 b/utilities/mvlcreate.1
new file mode 100644 (file)
index 0000000..51fe5da
--- /dev/null
@@ -0,0 +1,46 @@
+.\"                                      Hey, EMACS: -*- nroff -*-
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH MVLCREATE 1 "July 10, 2003"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh        disable hyphenation
+.\" .hy        enable hyphenation
+.\" .ad l      left justify
+.\" .ad b      justify to both left and right margins
+.\" .nf        disable filling
+.\" .fi        enable filling
+.\" .br        insert line break
+.\" .sp <n>    insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+mvlcreate \- Creates an MVL archive using all the MVE (movie) files in the
+current directory.
+.SH SYNOPSIS
+.B mvlcreate
+.RI filename.mvl
+.br
+.SH DESCRIPTION
+This manual page documents briefly the
+.B mvlcreate
+command.
+This manual page was written for the Debian distribution
+because the original program does not have a manual page.
+.PP
+.B mvlcreate
+is an utility to create MVL files, like that found in the DESCENT II
+videogame and played by the D2X package. MVL archives are files with a .mvl
+extension which contains one or more MVE (movie) files.
+
+You'll find some MVL/MVE files as part of the Descent II Registered datafiles.
+.SH SEE ALSO
+.BR mvlextract (1),
+.BR mveplayer (1).
+.SH AUTHOR
+The command was first created by Josh Cogliati in 1999, then modified by
+Bradley Bell in 2002 for use with the D2X package.
+
+This manual page was written by Paolo Ulivi <pulivi@libero.it>,
+for the Debian GNU/Linux system (but may be used by others).
diff --git a/utilities/mvlextract.1 b/utilities/mvlextract.1
new file mode 100644 (file)
index 0000000..9f8d536
--- /dev/null
@@ -0,0 +1,56 @@
+.\"                                      Hey, EMACS: -*- nroff -*-
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH MVLEXTRACT 1 "July 10, 2003"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh        disable hyphenation
+.\" .hy        enable hyphenation
+.\" .ad l      left justify
+.\" .ad b      justify to both left and right margins
+.\" .nf        disable filling
+.\" .fi        enable filling
+.\" .br        insert line break
+.\" .sp <n>    insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+mvlextract \- Extracts all MVE (movie) files from the given MVL archive into the
+current directory.
+.SH SYNOPSIS
+.B mvlextract
+.RI [ options ]
+.RI mvlfile
+.RI [ filename ]
+.br
+.SH DESCRIPTION
+This manual page documents briefly the
+.B mvlextract
+command.
+This manual page was written for the Debian distribution
+because the original program does not have a manual page.
+.PP
+.B mvlextract
+is an utility to extract MVE movie files, like that found in the
+DESCENT II videogame and played by the D2X package, archived in a MVL file,
+i.e. a file with a .mvl extension. It supports all MVL files around, so if
+you find one that doesn't work, please report this as a bug.
+
+You'll find some MVL files as part of the Descent II Registered datafiles.
+.SH OPTIONS
+A summary of options is included below.  These command-line options do
+not appear to be documented elsewhere, so the only authoritive source is
+the source code itself.
+.TP
+.B v
+Don't extract, print a listing of all MVE files to stdout.
+.SH SEE ALSO
+.BR mvlcreate (1),
+.BR mveplayer (1).
+.SH AUTHOR
+The command was first created by Josh Cogliati in 1999, then modified by
+Bradley Bell in 2002 for use with the D2X package.
+
+This manual page was written by Paolo Ulivi <pulivi@libero.it>,
+for the Debian GNU/Linux system (but may be used by others).
diff --git a/utilities/tex2txb.1 b/utilities/tex2txb.1
new file mode 100644 (file)
index 0000000..262296d
--- /dev/null
@@ -0,0 +1,48 @@
+.\"                                      Hey, EMACS: -*- nroff -*-
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH TEX2TXB 1 "July 10, 2003"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh        disable hyphenation
+.\" .hy        enable hyphenation
+.\" .ad l      left justify
+.\" .ad b      justify to both left and right margins
+.\" .nf        disable filling
+.\" .fi        enable filling
+.\" .br        insert line break
+.\" .sp <n>    insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+tex2txb \- ASCII to TXB converter for Descent and Descent II HOG files.
+.SH SYNOPSIS
+.B tex2txb
+.RI filename.tex
+.RI filename.txb
+.br
+.SH DESCRIPTION
+This manual page documents briefly the
+.B tex2txb
+command.
+This manual page was written for the Debian distribution
+because the original program does not have a manual page.
+.PP
+.B tex2txb
+is a text to TXB converter for Descent and Descent II HOG files.
+It converts an ASCII text file to a TXB entry for an HOG file; that
+entry can then be included in an HOG file using the command
+.BR hogcreate (1).
+.SH SEE ALSO
+.BR txb2tex (1),
+.BR mvlextract (1),
+.BR mvlcreate (1),
+.BR hogextract (1),
+.BR hogcreate (1).
+.SH AUTHOR
+The command was first created by Bryan Aamot in 1995, then modified by
+Bradley Bell in 2002 for use with the D2X package.
+
+This manual page was written by Paolo Ulivi <pulivi@libero.it>,
+for the Debian GNU/Linux system (but may be used by others).
diff --git a/utilities/txb2tex.1 b/utilities/txb2tex.1
new file mode 100644 (file)
index 0000000..6559e03
--- /dev/null
@@ -0,0 +1,49 @@
+.\"                                      Hey, EMACS: -*- nroff -*-
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH TXB2TEX 1 "July 10, 2003"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh        disable hyphenation
+.\" .hy        enable hyphenation
+.\" .ad l      left justify
+.\" .ad b      justify to both left and right margins
+.\" .nf        disable filling
+.\" .fi        enable filling
+.\" .br        insert line break
+.\" .sp <n>    insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+txb2tex \- TXB to ASCII converter for Descent and Descent II HOG files.
+.SH SYNOPSIS
+.B txb2tex
+.RI filename.txb
+.RI filename.tex
+.br
+.SH DESCRIPTION
+This manual page documents briefly the
+.B txb2tex
+command.
+This manual page was written for the Debian distribution
+because the original program does not have a manual page.
+.PP
+.B txb2tex
+is a TXB to text converter for Descent and Descent II HOG files.
+It converts a TXB entry from an HOG file to an ASCII text file;
+that entry can then be modified and re\-included in an HOG file
+using the command
+.BR hogcreate (1).
+.SH SEE ALSO
+.BR tex2txb (1),
+.BR mvlextract (1),
+.BR mvlcreate (1),
+.BR hogextract (1),
+.BR hogcreate (1).
+.SH AUTHOR
+The command was first created by Bryan Aamot in 1995, then modified by
+Bradley Bell in 2002 for use with the D2X package.
+
+This manual page was written by Paolo Ulivi <pulivi@libero.it>,
+for the Debian GNU/Linux system (but may be used by others).