aboutsummaryrefslogtreecommitdiff
path: root/games/oblige/oblige.pod
diff options
context:
space:
mode:
Diffstat (limited to 'games/oblige/oblige.pod')
-rw-r--r--games/oblige/oblige.pod92
1 files changed, 92 insertions, 0 deletions
diff --git a/games/oblige/oblige.pod b/games/oblige/oblige.pod
new file mode 100644
index 000000000000..00d977c7e373
--- /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.