games/oblige: Added man page.

Signed-off-by: Willy Sudiarto Raharjo <willysr@slackbuilds.org>

3 files changed, 310 insertions, 1 deletions

diff --git a/games/oblige/oblige.6 b/games/oblige/oblige.6
new file mode 100644
index 0000000000..c71d9c9bd3
--- /dev/null
+++ b/games/oblige/oblige.6
@@ -0,0 +1,210 @@
+.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" Set up some character translations and predefined strings.  \*(-- will
+.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
+.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
+.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
+.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
+.\" nothing in troff, for use with C<>.
+.tr \(*W-
+.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
+.ie n \{\
+.    ds -- \(*W-
+.    ds PI pi
+.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
+.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
+.    ds L" ""
+.    ds R" ""
+.    ds C` ""
+.    ds C' ""
+'br\}
+.el\{\
+.    ds -- \|\(em\|
+.    ds PI \(*p
+.    ds L" ``
+.    ds R" ''
+.    ds C`
+.    ds C'
+'br\}
+.\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\"
+.\" If the F register is turned on, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
+.\" entries marked with X<> in POD.  Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.\"
+.\" Avoid warning from groff about undefined register 'F'.
+.de IX
+..
+.nr rF 0
+.if \n(.g .if rF .nr rF 1
+.if (\n(rF:(\n(.g==0)) \{
+.    if \nF \{
+.        de IX
+.        tm Index:\\$1\t\\n%\t"\\$2"
+..
+.        if !\nF==2 \{
+.            nr % 0
+.            nr F 2
+.        \}
+.    \}
+.\}
+.rr rF
+.\"
+.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
+.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
+.    \" fudge factors for nroff and troff
+.if n \{\
+.    ds #H 0
+.    ds #V .8m
+.    ds #F .3m
+.    ds #[ \f1
+.    ds #] \fP
+.\}
+.if t \{\
+.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
+.    ds #V .6m
+.    ds #F 0
+.    ds #[ \&
+.    ds #] \&
+.\}
+.    \" simple accents for nroff and troff
+.if n \{\
+.    ds ' \&
+.    ds ` \&
+.    ds ^ \&
+.    ds , \&
+.    ds ~ ~
+.    ds /
+.\}
+.if t \{\
+.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
+.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
+.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
+.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
+.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
+.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
+.\}
+.    \" troff and (daisy-wheel) nroff accents
+.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
+.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
+.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
+.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
+.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
+.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
+.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
+.ds ae a\h'-(\w'a'u*4/10)'e
+.ds Ae A\h'-(\w'A'u*4/10)'E
+.    \" corrections for vroff
+.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
+.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
+.    \" for low resolution devices (crt and lpr)
+.if \n(.H>23 .if \n(.V>19 \
+\{\
+.    ds : e
+.    ds 8 ss
+.    ds o a
+.    ds d- d\h'-1'\(ga
+.    ds D- D\h'-1'\(hy
+.    ds th \o'bp'
+.    ds Th \o'LP'
+.    ds ae ae
+.    ds Ae AE
+.\}
+.rm #[ #] #H #V #F C
+.\" ========================================================================
+.\"
+.IX Title "OBLIGE 6"
+.TH OBLIGE 6 "2014-09-16" "6.10" "SlackBuilds.org"
+.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
+.SH "NAME"
+oblige \- random level generator for Doom and Doom II
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+\&\fBoblige\fR [\-options]
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+\&\fBoblige\fR creates a patch \s-1WAD\s0 file for use with Doom or Doom \s-1II,\s0
+containing one or more randomly-generated levels. The generated \s-1WAD\s0
+files are ready to play (no separate node-building pass is needed).
+.PP
+Normally, \fBoblige\fR is controlled by its \s-1GUI,\s0 but it can be used
+noninteractively (see the \fB\-b\fR option below).
+.SH "OPTIONS"
+.IX Header "OPTIONS"
+.IP "\fB\-\-home\fR <dir>" 4
+.IX Item "--home <dir>"
+Home directory, where \fBoblige\fR looks for its config file, and creates
+temporary files. Default is \fI~/.oblige\fR.
+.IP "\fB\-\-install\fR <dir>" 4
+.IX Item "--install <dir>"
+Installation directory, where \fBoblige\fR looks for lua scripts and other
+data. Default is \fI/usr/share/oblige\fR.
+.IP "\fB\-\-config\fR <file>" 4
+.IX Item "--config <file>"
+Config file to use. Default is \fI~/.oblige/CONFIG.txt\fR. Not used in
+\&\fB\-\-batch\fR mode.
+.IP "\fB\-b,\-\-batch\fR <output>" 4
+.IX Item "-b,--batch <output>"
+Batch mode (no \s-1GUI\s0). Uses built-in default config (never reads the
+normal config file used by the \s-1GUI\s0), but the \fB\-\-load\fR option can be
+used to override the defaults. \fIoutput\fR will be a \s-1PWAD\s0 file and will
+be overwritten without prompting if it exists.
+.IP "\fB\-l,\-\-load\fR <file>" 4
+.IX Item "-l,--load <file>"
+Load settings from a file. This is in the same format as
+\&\fI~/.oblige/CONFIG.txt\fR, and any settings in the loaded file will override
+the ones there. In \fB\-\-batch\fR mode, "\fB\-\-load ~/.oblige/CONFIG.txt\fR"
+will generate levels according to the settings configured by the \s-1GUI.\s0
+.IP "\fB\-k,\-\-keep\fR" 4
+.IX Item "-k,--keep"
+Keep random seed from loaded settings. Normally the seed stored in the
+config file is ignored, and a new seed is generated.
+.IP "\fB\-d,\-\-debug\fR" 4
+.IX Item "-d,--debug"
+Enable verbose debugging messages in log.
+.IP "\fB\-t,\-\-terminal\fR" 4
+.IX Item "-t,--terminal"
+Print log messages to stdout (rather than \fI~/.oblige/LIGS.txt\fR). Disabled
+by default, unless in \fB\-\-batch\fR mode.
+.IP "\fB\-h,\-\-help\fR" 4
+.IX Item "-h,--help"
+Show built-in help message.
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+\&\fBoblige\-legacy4\fR(6), an older version of \fBoblige\fR with a simpler
+level-generation algorithm and support for other games including Heretic,
+Hexen, and Quake.
+.PP
+The \fBoblige\fR home page: \fIhttp://oblige.sourceforge.net\fR
+.SH "LICENSE"
+.IX Header "LICENSE"
+This program is free software, under the terms of the \s-1GNU\s0 General Public
+License, and comes with \s-1ABSOLUTELY NO WARRANTY. \s0 See the documentation
+for more details, or visit http://www.gnu.org/licenses/gpl\-2.0.txt
+.SH "AUTHOR"
+.IX Header "AUTHOR"
+\&\fBoblige\fR is (c) 2006\-2014 by Andrew Apted.
+.PP
+This man page created by B. Watson, for the SlackBuilds.org project.
diff --git a/games/oblige/oblige.SlackBuild b/games/oblige/oblige.SlackBuild
index 873df17ac7..384ff93a02 100644
--- a/games/oblige/oblige.SlackBuild
+++ b/games/oblige/oblige.SlackBuild
@@ -6,6 +6,9 @@
 
 # Licensed under the WTFPL. See http://www.wtfpl.net/txt/copying/ for details.
 
+# 20140916 bkw: bump BUILD to 2.
+# add man page.
+
 # 20140827 bkw: version bump, reset BUILD to 1.
 # oblige 6.10 is nice, but it *only* supports the Doom games, so I'll
 # add an oblige-legacy4 build for the old version.
@@ -17,7 +20,7 @@
 
 PRGNAM=oblige
 VERSION=${VERSION:-6.10}
-BUILD=${BUILD:-1}
+BUILD=${BUILD:-2}
 TAG=${TAG:-_SBo}
 
 if [ -z "$ARCH" ]; then
@@ -75,6 +78,10 @@ sed -i '1i#include <unistd.h>' gui/lib_util.cc
 make INSTALL_PREFIX=/usr OPTIMISE="$SLKCFLAGS" FLTK_CONFIG=fltk13-config
 make install INSTALL_PREFIX=$PKG/usr
 
+# man page written for this build (based on --help output)
+mkdir -p $PKG/usr/man/man6
+gzip -9c < $CWD/$PRGNAM.6 > $PKG/usr/man/man6/$PRGNAM.6.gz
+
 mkdir -p $PKG/usr/share/pixmaps $PKG/usr/share/applications
 cat $CWD/$PRGNAM.png > $PKG/usr/share/pixmaps/$PRGNAM.png
 cat $CWD/$PRGNAM.desktop > $PKG/usr/share/applications/$PRGNAM.desktop
diff --git a/games/oblige/oblige.pod b/games/oblige/oblige.pod
new file mode 100644
index 0000000000..00d977c7e3
--- /dev/null
+++ b/games/oblige/oblige.pod
@@ -0,0 +1,92 @@
+# pod source for oblige man page. convert with:
+# pod2man --stderr -s6 -cSlackBuilds.org -r6.10 oblige.pod > oblige.6
+
+=head1 NAME
+
+oblige - random level generator for Doom and Doom II
+
+=head1 SYNOPSIS
+
+B<oblige> [-options]
+
+=head1 DESCRIPTION
+
+B<oblige> creates a patch WAD file for use with Doom or Doom II,
+containing one or more randomly-generated levels. The generated WAD
+files are ready to play (no separate node-building pass is needed).
+
+Normally, B<oblige> is controlled by its GUI, but it can be used
+noninteractively (see the B<-b> option below).
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<--home> <dir>
+
+Home directory, where B<oblige> looks for its config file, and creates
+temporary files. Default is I<~/.oblige>.
+
+=item B<--install> <dir>
+
+Installation directory, where B<oblige> looks for lua scripts and other
+data. Default is I</usr/share/oblige>.
+
+=item B<--config> <file>
+
+Config file to use. Default is I<~/.oblige/CONFIG.txt>. Not used in
+B<--batch> mode.
+
+=item B<-b,--batch> <output>
+
+Batch mode (no GUI). Uses built-in default config (never reads the
+normal config file used by the GUI), but the B<--load> option can be
+used to override the defaults. I<output> will be a PWAD file and will
+be overwritten without prompting if it exists.
+
+=item B<-l,--load> <file>
+
+Load settings from a file. This is in the same format as
+I<~/.oblige/CONFIG.txt>, and any settings in the loaded file will override
+the ones there. In B<--batch> mode, "B<--load ~/.oblige/CONFIG.txt>"
+will generate levels according to the settings configured by the GUI.
+
+=item B<-k,--keep>
+
+Keep random seed from loaded settings. Normally the seed stored in the
+config file is ignored, and a new seed is generated.
+
+=item B<-d,--debug>
+
+Enable verbose debugging messages in log.
+
+=item B<-t,--terminal>
+
+Print log messages to stdout (rather than I<~/.oblige/LIGS.txt>). Disabled
+by default, unless in B<--batch> mode.
+
+=item B<-h,--help>
+
+Show built-in help message.
+
+=back
+
+=head1 SEE ALSO
+
+B<oblige-legacy4>(6), an older version of B<oblige> with a simpler
+level-generation algorithm and support for other games including Heretic,
+Hexen, and Quake.
+
+The B<oblige> home page: I<http://oblige.sourceforge.net>
+
+=head1 LICENSE
+
+This program is free software, under the terms of the GNU General Public
+License, and comes with ABSOLUTELY NO WARRANTY.  See the documentation
+for more details, or visit http://www.gnu.org/licenses/gpl-2.0.txt
+
+=head1 AUTHOR
+
+B<oblige> is (c) 2006-2014 by Andrew Apted.
+
+This man page created by B. Watson, for the SlackBuilds.org project.