mirror of
https://github.com/Ponce/slackbuilds
synced 2024-11-22 19:44:21 +01:00
395 lines
14 KiB
Groff
395 lines
14 KiB
Groff
.\" 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 "ODAMEX 6"
|
|
.TH ODAMEX 6 "2014-08-28" "0.7.0" "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"
|
|
odamex \- Source port of Doom engine, with client/server multiplayer.
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
\&\fBodamex\fR [\fIoptions...\fR]
|
|
.PP
|
|
\&\fBodasrv\fR [\fIoptions...\fR]
|
|
.PP
|
|
\&\fBodalaunch\fR
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
Odamex (Online Doom Multiplayer Experience) is a modification of \s-1DOOM\s0
|
|
to allow players to compete with each other over the Internet using
|
|
a client/server architecture.
|
|
.PP
|
|
\&\fBodamex\fR is the client, also used for single-player games.
|
|
.PP
|
|
\&\fBodasrv\fR is the dedicated server (which runs in a tty).
|
|
.PP
|
|
\&\fBodalaunch\fR is the server browser, used for finding multiplayer games
|
|
on the 'net. It launches \fBodamex\fR with appropriate arguments.
|
|
.PP
|
|
\&\fBodamex\fR is a source port of the Doom engine. It requires the data (aka
|
|
\&\s-1WAD\s0) file from one or more of the supported games. See \fB\s-1WAD FILES\s0\fR,
|
|
below, for a full explanation.
|
|
.SH "OPTIONS"
|
|
.IX Header "OPTIONS"
|
|
Most of these options apply to both \fBodamex\fR and \fBodasrv\fR, the
|
|
exceptions being that \fBodasrv\fR doesn't accept options related to graphics
|
|
or sound, since it's just a console application.
|
|
.PP
|
|
\&\fBodalaunch\fR takes no command-line options.
|
|
.SS "File Options"
|
|
.IX Subsection "File Options"
|
|
.IP "\fB\-iwad\fR \fI<wadfile\fR>" 4
|
|
.IX Item "-iwad <wadfile>"
|
|
The \s-1IWAD\s0 file to use (in other words, which game to play). The
|
|
filename extension \fI.wad\fR or \fI.WAD\fR is not required, and the name is
|
|
case-insensitive. See \fB\s-1WAD FILES\s0\fR, below, for more information.
|
|
.IP "\fB\-waddir\fR \fI<dir[:dir]...\fR>" 4
|
|
.IX Item "-waddir <dir[:dir]...>"
|
|
Colon-separated list of directories to search for \s-1WAD\s0 files, including
|
|
the \s-1IWAD.\s0 See \fB\s-1WAD FILES\s0\fR, below, for more information.
|
|
.IP "\fB\-file\fR \fI<wadfile\fR>" 4
|
|
.IX Item "-file <wadfile>"
|
|
Add a \s-1PWAD \s0(patch \s-1WAD\s0). Used for custom levels, music, etc. Does \s-1NOT\s0
|
|
work if using the shareware \s-1IWAD \s0(doom1.wad).
|
|
.IP "\fB\-config\fR \fI<configfile\fR>" 4
|
|
.IX Item "-config <configfile>"
|
|
Use \fIconfigfile\fR instead of the default config file (which is \fI~/.odamex/odamex.cfg\fR).
|
|
.IP "\fB\-confile\fR \fI<scriptfile\fR>" 4
|
|
.IX Item "-confile <scriptfile>"
|
|
Execute the console commands in \fIscriptfile\fR at startup.
|
|
.IP "\fB\-deh\fR \fI<dehacked\-file\fR>" 4
|
|
.IX Item "-deh <dehacked-file>"
|
|
Load a .deh file. Used for game mods.
|
|
.IP "\fB\-bex\fR \fI<bex\-file\fR>" 4
|
|
.IX Item "-bex <bex-file>"
|
|
Load a .bex file. Used for game mods.
|
|
.SS "Game Options"
|
|
.IX Subsection "Game Options"
|
|
.IP "\fB\-warp\fR \fI<level\fR>" 4
|
|
.IX Item "-warp <level>"
|
|
Skip the intro, start the game at the given level. For Doom I and its
|
|
variants, the level is given as a 2\-digit number (episode and map,
|
|
e.g. \fB21\fR for episode 2, map 1). For Doom \s-1II\s0 and variants, the level
|
|
is just the level number.
|
|
.IP "\fB\-nomonsters\fR" 4
|
|
.IX Item "-nomonsters"
|
|
Self-explanatory. Usually used for multiplayer deathmatch games.
|
|
.IP "\fB\-timer\fR \fI<minutes\fR>" 4
|
|
.IX Item "-timer <minutes>"
|
|
Force levels to end after specified number of minutes.
|
|
.IP "\fB\-avg\fR" 4
|
|
.IX Item "-avg"
|
|
\&\*(L"Austin Virtual Gaming\*(R" mode, equivalent to \fB\-timer 20\fR.
|
|
.IP "\fB\-fast\fR" 4
|
|
.IX Item "-fast"
|
|
Fast monster mode (similar to \*(L"Nightmare\*(R" difficulty level).
|
|
.IP "\fB\-respawn\fR" 4
|
|
.IX Item "-respawn"
|
|
Monsters respawn after being killed (similar to \*(L"Nightmare\*(R" difficulty level).
|
|
.IP "\fB\-skill\fR \fI<skill\-level\fR>" 4
|
|
.IX Item "-skill <skill-level>"
|
|
Set skill level (useful with \fB\-warp\fR). Level is a number from 1 to 5,
|
|
where 1 is \*(L"I'm Too Young To Die\*(R" and 5 is \*(L"Nightmare\*(R".
|
|
.SS "Video/Audio Options"
|
|
.IX Subsection "Video/Audio Options"
|
|
.IP "\fB\-width\fR \fI<pixels\fR>, \fB\-height\fR \fI<pixels\fR>" 4
|
|
.IX Item "-width <pixels>, -height <pixels>"
|
|
Set video mode.
|
|
.IP "\fB\-novideo\fR, \fB\-nosound\fR, \fB\-nomusic\fR, \fB\-nomouse\fR" 4
|
|
.IX Item "-novideo, -nosound, -nomusic, -nomouse"
|
|
Disable various features.
|
|
.SS "Network Options"
|
|
.IX Subsection "Network Options"
|
|
.IP "\fB\-port\fR \fI<port\fR>" 4
|
|
.IX Item "-port <port>"
|
|
Set the \s-1UDP\s0 port to use for netplay. Default is 10667.
|
|
.IP "\fB\-connect\fR \fI<server\fR>" 4
|
|
.IX Item "-connect <server>"
|
|
Connect to netplay server \fIserver\fR on startup.
|
|
.IP "\fB\-maxclients\fR \fI<count\fR>" 4
|
|
.IX Item "-maxclients <count>"
|
|
Set maximum number of allowed clients for dedicated server.
|
|
.SS "Demo Options"
|
|
.IX Subsection "Demo Options"
|
|
.IP "\fB\-record\fR \fI<demoname\fR>" 4
|
|
.IX Item "-record <demoname>"
|
|
Record a single-player demo.
|
|
.IP "\fB\-playdemo\fR \fI<demoname\fR>" 4
|
|
.IX Item "-playdemo <demoname>"
|
|
Play a previously-recorded single-player demo.
|
|
.IP "\fB\-netrecord\fR \fI<demoname\fR>" 4
|
|
.IX Item "-netrecord <demoname>"
|
|
Record a network demo.
|
|
.IP "\fB\-netplay\fR \fI<demoname\fR>" 4
|
|
.IX Item "-netplay <demoname>"
|
|
Play a previously-recorded network demo.
|
|
.SS "Undocumented Options"
|
|
.IX Subsection "Undocumented Options"
|
|
These options were found by grepping the source code, and may change or
|
|
disappear in future releases.
|
|
.IP "\fB\-heapsize\fR \fI<size\fR>" 4
|
|
.IX Item "-heapsize <size>"
|
|
Set the heap size. Vestigial option left over from \s-1DOS\s0 Doom, probably
|
|
not very useful on modern systems.
|
|
.IP "\fB\-devparm\fR" 4
|
|
.IX Item "-devparm"
|
|
Run game in \*(L"developer\*(R" mode: Saves screenshots instead of showing the
|
|
help menu when F1 is pressed, shows \*(L"tics-per-frame\*(R" meter during play.
|
|
.IP "\fB\-blockmap\fR" 4
|
|
.IX Item "-blockmap"
|
|
Generate new blockmaps from level data, instead of using the blockmaps
|
|
loaded from .wad files. Allows playing levels with missing or bogus
|
|
blockmaps. There's no way to save the generated blockmaps.
|
|
.IP "\fB\-stepmode\fR" 4
|
|
.IX Item "-stepmode"
|
|
Used by the self-test scripts shipped with the odamex source, allows
|
|
a shell script to run multiple instances of odamex/odasrv one \*(L"step\*(R"
|
|
at a time.
|
|
.IP "\fB\-bits\fR \fI<depth\fR>" 4
|
|
.IX Item "-bits <depth>"
|
|
Set the bit depth. Actually the only supported value is 32, which has
|
|
the same effect as setting the vid_32pp cvar to 1. Any other value sets
|
|
vid_32pp to 0.
|
|
.IP "\fB\-fork\fR [\fI<pidfile\fR>]" 4
|
|
.IX Item "-fork [<pidfile>]"
|
|
\&\fBodasrv\fR only: fork and become a daemon, writing the server's \s-1PID\s0 to
|
|
\&\fI<pidfile\fR> (or ./doomsv.pid if not given).
|
|
.SH "WAD FILES"
|
|
.IX Header "WAD FILES"
|
|
\&\fBodamex\fR (and Doom-related games in general) load all game resources
|
|
such as graphics, sound, and levels from a file known as an \s-1IWAD\s0
|
|
file. \fBodamex\fR supports the following \s-1IWAD\s0 files:
|
|
.IP "\fBdoom2f.wad\fR, \fBdoom2.wad\fR" 4
|
|
.IX Item "doom2f.wad, doom2.wad"
|
|
Doom \s-1II\s0 v1.9
|
|
.IP "\fBdoom2bfg.wad\fR" 4
|
|
.IX Item "doom2bfg.wad"
|
|
Doom \s-1II BFG\s0 Edition (Steam)
|
|
.IP "\fBplutonia.wad\fR" 4
|
|
.IX Item "plutonia.wad"
|
|
Final Doom: The Plutonia Experiment v1.9
|
|
.IP "\fBtnt.wad\fR" 4
|
|
.IX Item "tnt.wad"
|
|
Final Doom: \s-1TNT\s0 Evilution v1.9
|
|
.IP "\fBdoomu.wad\fR, \fBdoom.wad\fR" 4
|
|
.IX Item "doomu.wad, doom.wad"
|
|
Ultimate Doom v1.9
|
|
.IP "\fBdoombfg.wad\fR" 4
|
|
.IX Item "doombfg.wad"
|
|
Doom \s-1BFG\s0 Edition (Steam)
|
|
.IP "\fBdoom1.wad\fR" 4
|
|
.IX Item "doom1.wad"
|
|
Shareware Doom v1.9
|
|
.IP "\fBfreedoom1.wad\fR, \fBfreedoomu.wad\fR, \fBfreedoom2.wad\fR, \fBfreedoom.wad\fR, \fBfreedm.wad\fR" 4
|
|
.IX Item "freedoom1.wad, freedoomu.wad, freedoom2.wad, freedoom.wad, freedm.wad"
|
|
FreeDoom v0.6.4 or newer
|
|
.IP "\fBchex.wad\fR" 4
|
|
.IX Item "chex.wad"
|
|
Chex Quest
|
|
.PP
|
|
There is no support for games based on modified Doom engines, such as
|
|
Heretic, Hexen, or Strife. \s-1IWAD\s0 files not in the above list, such as
|
|
older versions of Doom, Doom \s-1II,\s0 or FreeDoom, may or may not work. \*(L"Total
|
|
Conversions\*(R" such as HackX and Harmony are less likely to work. Chex
|
|
Quest 3 is known not to work.
|
|
.PP
|
|
If no \-iwad argument is given, \fBodamex\fR looks for each \s-1IWAD\s0 file
|
|
in the order listed above, and uses the first one found. If \-iwad is
|
|
given, \fBodamex\fR looks only for the named \s-1IWAD\s0 file. In either case,
|
|
the \s-1WAD\s0 filenames can be in all-lowercase or all-uppercase.
|
|
.PP
|
|
If \fBdoom2bfg.wad\fR is loaded, \fBodamex\fR also attempts to load
|
|
\&\fBnerve.wad\fR, which contains the \*(L"No Rest For The Living\*(R" expansion
|
|
episode.
|
|
.PP
|
|
\&\fBodamex\fR also requires the file \fBodamex.wad\fR, which is part of \fBodamex\fR
|
|
and is installed with it. This file must be found at runtime, or the
|
|
application will abort.
|
|
.PP
|
|
When searching for \s-1WAD\s0 files (odamex.wad, the \s-1IWAD,\s0 or a
|
|
\&\s-1PWAD\s0 for the \-file option), \fBodamex\fR searches the following directories,
|
|
in order:
|
|
.IP "\-" 4
|
|
The current directory.
|
|
.IP "\-" 4
|
|
The argument of the \-waddir option, if given.
|
|
.IP "\-" 4
|
|
The path(s) listed in the \fB\s-1DOOMWADDIR\s0\fR environment variable.
|
|
.IP "\-" 4
|
|
The path(s) listed in the \fB\s-1DOOMWADPATH\s0\fR environment variable.
|
|
.IP "\-" 4
|
|
The user's home directory.
|
|
.IP "\-" 4
|
|
The hard-coded path \fB/usr/share/games/doom\fR.
|
|
.IP "\-" 4
|
|
The hard-coded path \fB/usr/local/share/games/doom\fR.
|
|
.IP "\-" 4
|
|
The hard-coded path \fB/usr/local/share/doom\fR.
|
|
.IP "\-" 4
|
|
The contents of the \fBwaddirs\fR cvar (console variable).
|
|
.PP
|
|
The \-waddir option, the waddirs cvar, \s-1DOOMWADDIR,\s0 and \s-1DOOMWADPATH\s0 are
|
|
colon-separated lists of directories.
|
|
.SH "OTHER FILES"
|
|
.IX Header "OTHER FILES"
|
|
.IP "\fB~/.odamex/\fR" 4
|
|
.IX Item "~/.odamex/"
|
|
Config file \fBodamex.cfg\fR is located here. Will be created if it
|
|
doesn't already exist. Also, saved games and recorded demos are stored
|
|
here. Screenshots are created in the current directory from which
|
|
\&\fBodamex\fR was run.
|
|
.SH "ENVIRONMENT"
|
|
.IX Header "ENVIRONMENT"
|
|
.IP "\fB\s-1DOOMWADDIR\s0\fR, \fB\s-1DOOMWADPATH\s0\fR" 4
|
|
.IX Item "DOOMWADDIR, DOOMWADPATH"
|
|
Colon-separated lists of directories to search for \s-1WAD\s0 files.
|
|
.IP "\fB\s-1HOME\s0\fR" 4
|
|
.IX Item "HOME"
|
|
\&\s-1WAD\s0 files are also searched for here.
|
|
.IP "\fB\s-1SDL_VIDEODRIVER\s0\fR, \fB\s-1SDL_AUDIODRIVER\s0\fR" 4
|
|
.IX Item "SDL_VIDEODRIVER, SDL_AUDIODRIVER"
|
|
See the \s-1SDL\s0 documentation for use of these.
|
|
.SH "AUTHORS"
|
|
.IX Header "AUTHORS"
|
|
Dean \*(L"deathz0r\*(R" Joseph
|
|
.PP
|
|
Alex \*(L"AlexMax\*(R" Mayfield
|
|
.PP
|
|
Ralph \*(L"Ralphis\*(R" Vickers
|
|
.PP
|
|
This man page written by B. Watson for the SlackBuilds.org project,
|
|
but it may be freely used by anyone for any purpose.
|