slackbuilds/games/oblige/oblige.6

135 lines
3.6 KiB
Groff

.\" Man page generated from reStructuredText.
.
.TH OBLIGE 6 "2015-05-10" "6.20" "SlackBuilds.org"
.SH NAME
oblige \- random level generator for Doom and Doom II
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.\" RST source for oblige(6) man page. Convert with:
.
.\" rst2man.py oblige.rst > oblige.6
.
.\" rst2man.py comes from the SBo development/docutils package.
.
.SH SYNOPSIS
.sp
oblige [\fI\-options\fP]
.SH DESCRIPTION
.sp
\fBoblige\fP 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).
.sp
Normally, \fBoblige\fP is controlled by its GUI, but it can be used
noninteractively (see the \fB\-b\fP option below).
.SH OPTIONS
.INDENT 0.0
.TP
.BI \-\-home \ <dir>
Home directory, where B<oblige> looks for its config file, and creates
temporary files. Default is \fI~/.oblige\fP\&.
.TP
.BI \-\-install \ <dir>
Installation directory, where \fBoblige\fP looks for lua scripts and other
data. Default is \fI/usr/share/oblige\fP\&.
.TP
.BI \-\-config \ <file>
Config file to use. Default is \fI~/.oblige/CONFIG.txt\fP\&. Not used in
\fB\-\-batch\fP mode.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-batch, \fB\-b\fP \fI<output>\fP
Batch mode (no GUI). Uses built\-in default config (never reads the
normal config file used by the GUI), but the \fB\-\-load\fP option can be
used to override the defaults. \fIoutput\fP will be a PWAD file and will
be overwritten without prompting if it exists.
.TP
.B \-\-load, \fB\-l\fP \fI<file>\fP
Load settings from a file. This is in the same format as
\fI~/.oblige/CONFIG.txt\fP, and any settings in the loaded file will override
the ones there. In \fB\-\-batch\fP mode, "\fB\-\-load ~/.oblige/CONFIG.txt\fP"
will generate levels according to the settings configured by the GUI.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-keep\fP,\fB \-k
Keep random seed from loaded settings. Normally the seed stored in the
config file is ignored, and a new seed is generated.
.TP
.B \-\-debug\fP,\fB \-d
Enable verbose debugging messages in log.
.TP
.B \-\-terminal\fP,\fB \-t
Print log messages to stdout (rather than \fI~/.oblige/LIGS.txt\fP). Disabled
by default, unless in \fB\-\-batch\fP mode.
.TP
.B \-\-help\fP,\fB \-h
Show built\-in help message.
.UNINDENT
.\" other sections we might want, uncomment as needed.
.
.\" FILES
.
.\" =====
.
.\" ENVIRONMENT
.
.\" ===========
.
.\" EXIT STATUS
.
.\" ===========
.
.\" BUGS
.
.\" ====
.
.\" EXAMPLES
.
.\" ========
.
.SH COPYRIGHT
.sp
See the file /usr/doc/oblige\-6.20/GPL.txt for license information.
.SH AUTHORS
.sp
\fBoblige\fP is (c) 2006\-2015 by Andrew Apted.
.sp
This man page written for the SlackBuilds.org project
by B. Watson, and is licensed under the WTFPL.
.SH SEE ALSO
.sp
\fIoblige\-legacy4(6)\fP, an older version of \fBoblige\fP with a simpler
level\-generation algorithm and support for other games including Heretic,
Hexen, and Quake.
.sp
The \fBoblige\fP home page: \fI\%http://oblige.sourceforge.net\fP
.\" Generated by docutils manpage writer.
.