amd64 fixes
[btb/d2x.git] / utilities / hogextract.1
1 .\"                                      Hey, EMACS: -*- nroff -*-
2 .\" First parameter, NAME, should be all caps
3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
4 .\" other parameters are allowed: see man(7), man(1)
5 .TH HOGEXTRACT 1 "July 10, 2003"
6 .\" Please adjust this date whenever revising the manpage.
7 .\"
8 .\" Some roff macros, for reference:
9 .\" .nh        disable hyphenation
10 .\" .hy        enable hyphenation
11 .\" .ad l      left justify
12 .\" .ad b      justify to both left and right margins
13 .\" .nf        disable filling
14 .\" .fi        enable filling
15 .\" .br        insert line break
16 .\" .sp <n>    insert n+1 empty lines
17 .\" for manpage-specific macros, see man(7)
18 .SH NAME
19 hogextract \- Extracts files from the given HOG archive into the current
20 directory.
21 .SH SYNOPSIS
22 .B hogextract
23 .RI [ options ]
24 .RI hogfile
25 .RI [ filename ]
26 .br
27 .SH DESCRIPTION
28 This manual page documents briefly the
29 .B hogextract
30 command.
31 This manual page was written for the Debian distribution
32 because the original program does not have a manual page.
33 .PP
34 .B hogextract
35 is an utility to extract all the files contained in HOG archives, like that
36 found in the DESCENT II videogame and played by the D2X package.
37 It supports all HOG files around, so if you find one that doesn't work,
38 please report this as a bug.
39
40 HOG archives are files with a .hog extension, and contains all of the data
41 which constitutes a DESCENT II's level.
42
43 You'll find some HOG files as part of the Descent II datafiles.
44 .SH OPTIONS
45 A summary of options is included below.  These command-line options do
46 not appear to be documented elsewhere, so the only authoritive source is
47 the source code itself.
48 .TP
49 .B v
50 Don't extract, print a listing of all files to stdout.
51 .SH SEE ALSO
52 .BR hogcreate (1),
53 .BR mvlcreate (1),
54 .BR mveplayer (1).
55 .SH AUTHOR
56 The command was first created by Josh Cogliati in 1999, then modified by
57 Bradley Bell in 2002 for use with the D2X package.
58
59 This manual page was written by Paolo Ulivi <pulivi@libero.it>,
60 for the Debian GNU/Linux system (but may be used by others).