[scummvm-tools] 06/08: Add manpages for most of the smaller tools

Tue Jan 9 22:15:31 UTC 2018

This is an automated email from the git hooks/post-receive script.

skitt pushed a commit to branch master
in repository scummvm-tools.

commit c94b7af7dc5c6ce35089c52dee4ac274c5771487
Author: Stephen Kitt <skitt at debian.org>
Date:   Tue Jan 9 23:09:17 2018 +0100

    Add manpages for most of the smaller tools
---
 debian/changelog          |   1 +
 debian/construct_mohawk.6 |  24 ++++++++++
 debian/decine.6           |  34 +++++++++++++
 debian/decompile.6        | 118 ++++++++++++++++++++++++++++++++++++++++++++++
 debian/degob.6            |  68 ++++++++++++++++++++++++++
 debian/dekyra.6           |  33 +++++++++++++
 debian/deriven.6          |  22 +++++++++
 debian/descumm.6          |  78 ++++++++++++++++++++++++++++++
 debian/desword2.6         |  14 ++++++
 debian/extract_mohawk.6   |  47 ++++++++++++++++++
 debian/gob_loadcalc.6     |  18 +++++++
 debian/manpages           |  10 ++++
 12 files changed, 467 insertions(+)

diff --git a/debian/changelog b/debian/changelog
index 32b8ae8..e72c735 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -3,6 +3,7 @@ scummvm-tools (2.0.0-1) UNRELEASED; urgency=medium
   * New upstream release.
   * Switch to debhelper compatibility level 11.
   * Use a secure upstream URL in debian/watch.
+  * Add manpages for most of the smaller tools.
 
  -- Stephen Kitt <skitt at debian.org>  Sat, 09 Dec 2017 13:37:29 +0100
 
diff --git a/debian/construct_mohawk.6 b/debian/construct_mohawk.6
new file mode 100644
index 0000000..53086f0
--- /dev/null
+++ b/debian/construct_mohawk.6
@@ -0,0 +1,24 @@
+.TH construct_mohawk 6 "December 9, 2017" scummvm-tools
+.SH NAME
+construct_mohawk \- Mohawk archive construction tool
+.SH SYNOPSIS
+.B construct_mohawk
+.RI < "mohawk archive" >
+.RI < "binary resource file" >
+.RI [< "binary resource file" ">] ..."
+.SH DESCRIPTION
+.B construct_mohawk
+builds a Mohawk archive containing the given resource files. (Mohawk
+archives are used by the Brøderbund Mohawk engine, in games such as
+Myst, Riven, the Living Books series, the Carmen Sandiego series...)
+.PP
+.SH OPTIONS
+.B construct_mohawk
+accepts no options.
+.SH SEE ALSO
+.BR extract_mohawk (6)
+.SH AUTHORS
+This manual page was adapted from the program usage information by
+Stephen Kitt <skitt at debian.org>, for the Debian GNU/Linux system (but
+may be used by others). It was last modified for \fBscummvm-tools\fP
+version 2.0.
diff --git a/debian/decine.6 b/debian/decine.6
new file mode 100644
index 0000000..af23651
--- /dev/null
+++ b/debian/decine.6
@@ -0,0 +1,34 @@
+.TH decine 6 "December 9, 2017" scummvm-tools
+.SH NAME
+decine \- Delphine Cinematique engine script decompiler
+.SH SYNOPSIS
+.B decine
+.RI < type >
+.RI < version >
+.RI < filename "> ..."
+.SH DESCRIPTION
+.B decine
+decompiles scripts for Delphine's Cinematique engine. It supports at
+least Future Wars and Operation Stealth.
+.PP
+.I type
+is
+.B \-prc
+for prc files,
+.B \-rel
+for rel files.
+.PP
+.I version
+is
+.B \-v1
+for Future Wars,
+.B \-v2
+for Operation Stealth.
+.PP
+.I filename
+is the name of the script file to decode.
+.SH AUTHORS
+This manual page was adapted from the program usage information by
+Stephen Kitt <skitt at debian.org>, for the Debian GNU/Linux system (but
+may be used by others). It was last modified for \fBscummvm-tools\fP
+version 2.0.
diff --git a/debian/decompile.6 b/debian/decompile.6
new file mode 100644
index 0000000..e5f0f87
--- /dev/null
+++ b/debian/decompile.6
@@ -0,0 +1,118 @@
+.TH decompile 6 "December 9, 2017" scummvm-tools
+.SH NAME
+decompile \- Engine script decompiler
+.SH SYNOPSIS
+.B decompile \-h
+.br
+.B decompile \-l
+.br
+.B decompile \-h \-e
+.RI < engine >
+.br
+.B decompile
+.RB [ \-e
+.RI < engine >]
+.RB [ \-d
+.RI < file >]
+.RB [ \-g
+.RI < file >]
+.RB [ \-D ]
+.RB [ \-G ]
+.RB [ \-u ]
+.RB [ \-v
+.RI < variant >]
+.RB [ \-s ]
+.RI < file >
+.SH DESCRIPTION
+.B decompile
+decompiles scripts for a number of game engines.
+.PP
+.B decompile \-h
+or
+.B decompile \-\-help
+displays a short help summary.
+.PP
+.B decompile \-l
+or
+.B decompile \-\-list
+lists the supported game engines.
+.PP
+.B decompile \-h \-e
+or
+.B decompile \-\-help \-\-engine
+.RI < engine >
+lists the variants available for the given \fIengine\fP.
+.PP
+Other forms of the command decompile the given \fIfile\fP, using the
+game engine specified using the
+.B \-e
+or
+.B \-\-engine
+option:
+.TP
+.B groovie
+Groovie, as used by The 7th Guest and The 11th Hour;
+.TP
+.B kyra2
+Legend of Kyrandia: Hand of Fate;
+.TP
+.B scummv6
+SCUMM v6.
+.PP
+Variants are specified using the
+.B \-v
+or
+.B \-\-variant
+option:
+.TP
+.B t7g
+The 7th Guest (for the
+.B groovie
+engine);
+.TP
+.B v2
+version 2, from The 11th Hour onwards (for the
+.B groovie
+engine);
+.TP
+.B kyra2
+Legend of Kyrandia: Hand of Fate, floppy-disk version;
+.TP
+.B kyra2-talkie
+Legend of Kyrandia: Hand of Fate, CD-ROM (talkie) version.
+.SH OPTIONS
+.TP
+.BR \-d ", " \-\-dump\-disassembly " <" \fIfile\fP >
+dumps the disassembly to the given \fIfile\fP (standard out if
+\fIfile\fP is omitted).
+.TP
+.BR \-g ", " \-\-dump\-graph " <" \fIfile\fP >
+dumps the control flow graph, in
+.BR dot ( 1 )
+format, to the given \fIfile\fP (standard out if \fIfile\fP is
+omitted).
+.TP
+.BR \-D ", " \-\-only\-disassembly
+stops after disassembly; implies \fB\-d\fP.
+.TP
+.BR \-G ", " \-\-only\-graph
+stops after generating the control flow graph; implies \fB\-g\fP.
+.TP
+.BR \-u ", " \-\-show\-unreachable
+show the address and contents of unreachable groups in the script.
+.TP
+.BR \-s ", " \-\-no\-stack\-effect
+leaves out the stack effect when printing raw instructions.
+.PP
+Note that
+.B \-d
+or
+.B \-g
+without arguments
+.B must not
+be specified immediately before the input file.
+.SH AUTHORS
+This manual page was adapted from the program usage information by
+Stephen Kitt <skitt at debian.org>, for the Debian GNU/Linux system (but
+may be used by others). It was last modified for \fBscummvm-tools\fP
+version 2.0.
diff --git a/debian/degob.6 b/debian/degob.6
new file mode 100644
index 0000000..0b9931c
--- /dev/null
+++ b/debian/degob.6
@@ -0,0 +1,68 @@
+.TH degob 6 "December 9, 2017" scummvm-tools
+.SH NAME
+degob \- Coktel Vision TOT script decompiler
+.SH SYNOPSIS
+.B degob
+.RI < version >
+.RI < file.tot >
+.RB [ \-o " <" \fIoffset >]
+.RI [< file.ext >]
+.RI [< commun.ext >]
+.SH DESCRIPTION
+.B degob
+decompiles TOT scripts for Coktel Vision games.
+.PP
+.I version
+is one of the following:
+.TP
+.B Gob1
+Goblins 1
+.TP
+.B Gob2
+Gobliins 2
+.TP
+.B Gob3
+Gobliiins 3
+.TP
+.B Ween
+Ween: The Prophecy
+.TP
+.B Bargon
+Bargon Attack
+.TP
+.B Fascin
+Fascination
+.TP
+.B Lost
+Lost in Time
+.TP
+.B Woodruff
+The Bizarre Adventures of Woodruff and the Schnibble
+.TP
+.B Dynasty
+The Last Dynasty
+.TP
+.B Urban
+Urban Runner
+.TP
+.B Geisha
+Geisha
+.TP
+.B LittleRed
+Once Upon a Time: Little Red Riding Hood
+.PP
+If the script file calls \fBloadMult()\fP, the associated
+\fIfile.ext\fP must be supplied on the command line. Some scripts also
+require a \fIcommun.ext\fP. \fBdegob\fP will indicate which of these
+is required, if necessary.
+.PP
+The disassembled script is written to the standard output.
+.SH OPTIONS
+.TP
+.BR \-o " <" \fIoffset\fP
+starts the disassembly at the given \fioffset\fP.
+.SH AUTHORS
+This manual page was adapted from the program usage information by
+Stephen Kitt <skitt at debian.org>, for the Debian GNU/Linux system (but
+may be used by others). It was last modified for \fBscummvm-tools\fP
+version 2.0.
diff --git a/debian/dekyra.6 b/debian/dekyra.6
new file mode 100644
index 0000000..4cb07a3
--- /dev/null
+++ b/debian/dekyra.6
@@ -0,0 +1,33 @@
+.TH dekyra 6 "January 8, 2018" scummvm-tools
+.SH NAME
+dekyra \- Kyrandia script disassembler
+.SH SYNOPSIS
+.B dekyra
+.RB [ \-t ]
+.RB [ \-e
+.BR 1 | 2 ]
+.RB [ \-o
+.RI < output >]
+.RI < file >
+.SH DESCRIPTION
+.B dekyra
+disassembles Kyrandia scripts.
+.SH OPTIONS
+.TP
+.BR \-t
+displays only the text segment.
+.TP
+.BR \-e
+sets the engine version,
+.B 1
+for Kyrandia 1 (the default),
+.B 2
+for Kyrandia 2.
+.TP
+.BR \-o
+specifies the output filename (standard output by default).
+.SH AUTHORS
+This manual page was adapted from the program usage information by
+Stephen Kitt <skitt at debian.org>, for the Debian GNU/Linux system (but
+may be used by others). It was last modified for \fBscummvm-tools\fP
+version 2.0.
diff --git a/debian/deriven.6 b/debian/deriven.6
new file mode 100644
index 0000000..b567ede
--- /dev/null
+++ b/debian/deriven.6
@@ -0,0 +1,22 @@
+.TH deriven 6 "January 8, 2018" scummvm-tools
+.SH NAME
+deriven \- Mohawk script disassembler (as used in Riven)
+.SH SYNOPSIS
+.B deriven
+.RI < script >
+.BR CARD | HSPT
+.RI < id >
+.SH DESCRIPTION
+.B deriven
+disassembles Mohawk scripts, as used in Riven.
+.PP
+.B CARD
+disassembles the card whose identifier matches
+.IR id ,
+.B HSPT
+disassembles the hotspots for the card.
+.SH AUTHORS
+This manual page was adapted from the program usage information by
+Stephen Kitt <skitt at debian.org>, for the Debian GNU/Linux system (but
+may be used by others). It was last modified for \fBscummvm-tools\fP
+version 2.0.
diff --git a/debian/descumm.6 b/debian/descumm.6
new file mode 100644
index 0000000..8dc9855
--- /dev/null
+++ b/debian/descumm.6
@@ -0,0 +1,78 @@
+.TH descumm 6 "January 8, 2018" scummvm-tools
+.SH NAME
+descumm \- SCUMM script disassembler
+.SH SYNOPSIS
+.B descumm
+.BR \-0 | \-1 | \-2 | \-3 | \-n | \-z | \-4 | \-5 | \-6 | \-7 | \-8 | \-g < \fINNN\fP >
+.RB [ \-u ]
+.RB [ \-o ]
+.RB [ \-i ]
+.RB [ \-e ]
+.RB [ \-f ]
+.RB [ \-w ]
+.RB [ \-b ]
+.RB [ \-c ]
+.RB [ \-x ]
+.RB [ \-h ]
+.RI < script >
+.SH DESCRIPTION
+.B descumm
+disassembles SCUMM scripts.
+.PP
+The first argument determines the version:
+.TP
+.B \-0
+selects version 0 (Commodore 64)
+.TP
+.BR \-1 | \-2 | \-3
+selects version 1, 2, or 3 respectively, with no header
+.TP
+.BR \-n
+selects version 3, with Indy 3-specific hacks
+.TP
+.BR \-z
+selects version 3, with Zak-specific hacks
+.TP
+.BR \-4 | \-5 | \-6 | \-7 | \-8
+selects version 4 through 8 respectively
+.TP
+.BR \-g < \fINNN\fP >
+selects Humongous Entertainment version \fINNN\fP (always with three
+digits)
+.SH OPTIONS
+.TP
+.BR \-u
+the script is unblocked (has no headers); this is set by default for
+versions 0 through 3
+.TP
+.BR \-o
+always show offsets
+.TP
+.BR \-i
+don't output ifs
+.TP
+.BR \-e
+don't output else
+.TP
+.BR \-f
+don't output else-if
+.TP
+.BR \-w
+don't output while
+.TP
+.BR \-b
+don't output breaks
+.TP
+.BR \-c
+don't show opcodes
+.TP
+.BR \-x
+don't show offsets
+.TP
+.BR \-h
+halt on error
+.SH AUTHORS
+This manual page was adapted from the program usage information by
+Stephen Kitt <skitt at debian.org>, for the Debian GNU/Linux system (but
+may be used by others). It was last modified for \fBscummvm-tools\fP
+version 2.0.
diff --git a/debian/desword2.6 b/debian/desword2.6
new file mode 100644
index 0000000..e56d0c3
--- /dev/null
+++ b/debian/desword2.6
@@ -0,0 +1,14 @@
+.TH desword2 6 "January 9, 2018" scummvm-tools
+.SH NAME
+desword2 \- Broken Sword II script disassembler
+.SH SYNOPSIS
+.B desword2
+.RI < script >
+.SH DESCRIPTION
+.B desword2
+disassembles Broken Sword II scripts.
+.SH AUTHORS
+This manual page was adapted from the program usage information by
+Stephen Kitt <skitt at debian.org>, for the Debian GNU/Linux system (but
+may be used by others). It was last modified for \fBscummvm-tools\fP
+version 2.0.
diff --git a/debian/extract_mohawk.6 b/debian/extract_mohawk.6
new file mode 100644
index 0000000..13c6a08
--- /dev/null
+++ b/debian/extract_mohawk.6
@@ -0,0 +1,47 @@
+.TH extract_mohawk 6 "January 9, 2018" scummvm-tools
+.SH NAME
+extract_mohawk \- Mohawk archive extraction tool
+.SH SYNOPSIS
+.B extract_mohawk
+.RB [ \-\-raw | \-\-convert ]
+.RB [ \-\-ftindex | \-\-no\-ftindex ]
+.RB [ \-\-ftflags | \-\-no\-ftflags ]
+.RI < "mohawk archive" >
+.RI [< "tag id" >]
+.SH DESCRIPTION
+.B extract_mohawk
+extracts the resources contained in a Mohawk archive. (Mohawk
+archives are used by the Brøderbund Mohawk engine, in games such as
+Myst, Riven, the Living Books series, the Carmen Sandiego series...)
+.PP
+If
+.I tag id
+is specified, only matching resources are extracted.
+.SH OPTIONS
+.TP
+.B \-\-raw
+dumps resources as raw binary dumps (this is the default setting).
+.TP
+.B \-\-convert
+converts resources where possible.
+.TP
+.B \-\-ftindex
+prepends the file table index to extracted resource names (this is the
+default setting).
+.TP
+.B \-\-no\-ftindex
+doesn't prepend the file table index to extracted resource names.
+.TP
+.B \-\-ftflags
+prepends the file table flags to extracted resource names (this is the
+default setting).
+.TP
+.B \-\-no\-ftflags
+doesn't prepend the file table flags to the extracted resource names.
+.SH SEE ALSO
+.BR construct_mohawk (6)
+.SH AUTHORS
+This manual page was adapted from the program usage information by
+Stephen Kitt <skitt at debian.org>, for the Debian GNU/Linux system (but
+may be used by others). It was last modified for \fBscummvm-tools\fP
+version 2.0.
diff --git a/debian/gob_loadcalc.6 b/debian/gob_loadcalc.6
new file mode 100644
index 0000000..d2e1105
--- /dev/null
+++ b/debian/gob_loadcalc.6
@@ -0,0 +1,18 @@
+.TH gob_loadcalc 6 "January 9, 2018" scummvm-tools
+.SH NAME
+gob_loadcalc \- Gobliiins level load code calculator
+.SH SYNOPSIS
+.B gob_loadcalc
+.RI < level "> <" health >
+.SH DESCRIPTION
+.B gob_loadcalc
+calculates the level load code for a given
+.I level
+(between 0 and 23) and
+.I health
+(between 0 and 10).
+.SH AUTHORS
+This manual page was adapted from the program usage information by
+Stephen Kitt <skitt at debian.org>, for the Debian GNU/Linux system (but
+may be used by others). It was last modified for \fBscummvm-tools\fP
+version 2.0.
diff --git a/debian/manpages b/debian/manpages
new file mode 100644
index 0000000..71ee971
--- /dev/null
+++ b/debian/manpages
@@ -0,0 +1,10 @@
+debian/construct_mohawk.6
+debian/decine.6
+debian/decompile.6
+debian/degob.6
+debian/dekyra.6
+debian/deriven.6
+debian/descumm.6
+debian/desword2.6
+debian/extract_mohawk.6
+debian/gob_loadcalc.6

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-games/scummvm-tools.git

