summaryrefslogtreecommitdiff
path: root/games/oblige/oblige.6
blob: c71d9c9bd371a0582dcd1c6f8e0c267c5128abed (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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
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.