aboutsummaryrefslogtreecommitdiff
path: root/games/oblige/oblige.rst
blob: 1ba0a68f37a7fad196eaae30b9fea8e68db37b76 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
.. RST source for oblige(6) man page. Convert with:
..   rst2man.py oblige.rst > oblige.6
.. rst2man.py comes from the SBo development/docutils package.

.. |version| replace:: 6.20
.. |date| date::

======
oblige
======

-------------------------------------------
random level generator for Doom and Doom II
-------------------------------------------

:Manual section: 6
:Manual group: SlackBuilds.org
:Date: |date|
:Version: |version|

SYNOPSIS
========

oblige [*-options*]

DESCRIPTION
===========

**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, **oblige** is controlled by its GUI, but it can be used
noninteractively (see the **-b** option below).

OPTIONS
=======

--home <dir>
  Home directory, where B<oblige> looks for its config file, and creates
  temporary files. Default is *~/.oblige*.

--install <dir>
  Installation directory, where **oblige** looks for lua scripts and other
  data. Default is */usr/share/oblige*.

--config <file>

  Config file to use. Default is *~/.oblige/CONFIG.txt*. Not used in
  **--batch** mode.

--batch, **-b** *<output>*
  Batch mode (no GUI). Uses built-in default config (never reads the
  normal config file used by the GUI), but the **--load** option can be
  used to override the defaults. *output* will be a PWAD file and will
  be overwritten without prompting if it exists.

--load, **-l** *<file>*
  Load settings from a file. This is in the same format as
  *~/.oblige/CONFIG.txt*, and any settings in the loaded file will override
  the ones there. In **--batch** mode, "**--load ~/.oblige/CONFIG.txt**"
  will generate levels according to the settings configured by the GUI.

--keep, -k
  Keep random seed from loaded settings. Normally the seed stored in the
  config file is ignored, and a new seed is generated.

--debug, -d
  Enable verbose debugging messages in log.

--terminal, -t
  Print log messages to stdout (rather than *~/.oblige/LIGS.txt*). Disabled
  by default, unless in **--batch** mode.

--help, -h
  Show built-in help message.

.. other sections we might want, uncomment as needed.

.. FILES
.. =====

.. ENVIRONMENT
.. ===========

.. EXIT STATUS
.. ===========

.. BUGS
.. ====

.. EXAMPLES
.. ========

COPYRIGHT
=========

See the file /usr/doc/oblige-|version|/GPL.txt for license information.

AUTHORS
=======

**oblige** is (c) 2006-2015 by Andrew Apted.

This man page written for the SlackBuilds.org project
by B. Watson, and is licensed under the WTFPL.

SEE ALSO
========

`oblige-legacy4(6)`, an older version of **oblige** with a simpler
level-generation algorithm and support for other games including Heretic,
Hexen, and Quake.

The **oblige** home page: http://oblige.sourceforge.net