woof/man/woof.template
Roman Fomin 8a7ed2ac6b
integrate documents generation from Chocolate Doom (#603)
* use docgen to generate CMDLINE.md

* generate plain text version of CMDLINE

* rename PROJECT_TARNAME->PROJECT_SHORTNAME, add man file generation

* document more parameters

* whitespace fix

* remove unused code

* simplify -complevel documentation

* use WORKING_DIRECTORY

* document more parameters, simplify -pistolstart

* change -speed category, document -blockmap

* fix -devparm description

* move -dog(s) -speed -beta -pistolstart to game category

* add woof-setup man, bash-completion generation

* -spechit parameter, more documentation fixes

* adjust the wording in woof.template

* remove redundant comments

* remove blank line

* remove another redundant comment

* fix PROJECT_SHORTNAME
2022-06-24 09:41:38 +02:00

52 lines
2.0 KiB
Plaintext

.TH @PROJECT_SHORTNAME@ 6
.SH NAME
@PROJECT_SHORTNAME@ \- Woof! is a continuation of Lee Killough's Doom source port MBF targeted
at modern systems
.SH SYNOPSIS
.B woof
[\fIOPTIONS\fR]
.SH DESCRIPTION
.PP
MBF stands for "Marine's Best Friend" and is widely regarded the successor
of the Boom source port by TeamTNT. It serves as the code base for popular
Doom source ports such as PrBoom+/DSDA-Doom or The Eternity Engine. As the
original engine was limited to run only under MS-DOS, it has been ported to
Windows by Team Eternity under the name WinMBF in 2004. Woof! is developed
based on the WinMBF code with the aim to make MBF more widely available and
convenient to use on modern systems.
.br
@content
.SH IWAD SEARCH PATHS
@include iwad_paths.man
.SH FILES
.TP
\fB$HOME/.local/share/@PROJECT_SHORTNAME@.cfg\fR
The main configuration file for @PROJECT_NAME@. See \fBdefault.cfg\fR(5).
.TP
\fB$HOME/.local/share/@PROJECT_SHORTNAME@/@PROJECT_SHORTNAME@sav*.dsg\fR
Savegame files.
.TP
\fB$HOME/.local/share/@PROJECT_SHORTNAME@/tranmap.dat\fR
Cached translucency table.
.TP
\fB/usr/share/@PROJECT_SHORTNAME@/autoload\fR, \fB$HOME/.local/share/@PROJECT_SHORTNAME@/autoload/\fR
WAD files and DEH patches in the subdirectories of these paths are added
automatically when a WAD file of the corresponding name is loaded.
.SH SEE ALSO
\fB@PROJECT_SHORTNAME@-setup\fR(6),
.SH AUTHOR
Woof! is written and maintained by Fabian Greffrath. It is based on
the MBF and WinMBF source codes, released by Lee Killough and Team Eternity,
respectively, and on the LinuxDoom source code, released by Id Software.
.SH COPYRIGHT
Copyright \(co id Software Inc;
Copyright \(co 1999 id Software, Chi Hoang, Lee Killough, Jim Flynn, Rand Phares, Ty Halderman;
Copyright \(co 2004 James Haley;
Copyright \(co 2005-2016 Simon Howard;
Copyright \(co 2020-2022 Fabian Greffrath;
Copyright \(co 2020-2022 Roman Fomin.
.br
This is free software. You may redistribute copies of it under the terms of
the GNU General Public License <http://www.gnu.org/licenses/gpl.html>.
There is NO WARRANTY, to the extent permitted by law.