fruitjam-doom/man/doom.template
Jonathan Dowland e0b8a7e0a9 overhaul manpages, add parameters
This is in order to better support derivative engines.

Rework the manpages to be parameterized with @PROGRAM_PREFIX@ and
@PACKAGE_NAME@. Alter the `docgen` generator to substitute those
parameters. Supply those parameters via the autofoo Makefile.

Adjust the fixed path chocolate-server.6 to be generated from
server.template, similar to doom.template -> chocolate-doom.6.

Further work is required, not least renaming chocolate-setup.6,
but several further parameterizations.
2018-01-09 17:19:49 +00:00

43 lines
1.5 KiB
Text

.TH @PROGRAM_SPREFIX@\-doom 6
.SH NAME
@PROGRAM_SPREFIX@\-doom \- historically compatible Doom engine
.SH SYNOPSIS
.B @PROGRAM_SPREFIX@\-doom
[\fIOPTIONS\fR]
.SH DESCRIPTION
.PP
@PACKAGE_NAME@ is a port of Id Software's 1993 game "Doom" that is designed
to behave as similar to the original DOS version of Doom as is possible.
.br
@content
.SH IWAD SEARCH PATHS
@include iwad_paths.man
.SH ENVIRONMENT
This section describes environment variables that control @PACKAGE_NAME@'s
behavior.
@include environ.man
.SH FILES
.TP
\fB$HOME/.local/share/@PROGRAM_SPREFIX@\-doom/default.cfg\fR
The main configuration file for @PACKAGE_NAME@. See \fBdefault.cfg\fR(5).
.TP
\fB$HOME/.local/share/@PROGRAM_SPREFIX@\-doom/@PROGRAM_SPREFIX@\-doom.cfg\fR
Extra configuration values that are specific to @PACKAGE_NAME@ and not
present in Vanilla Doom. See \fB@PROGRAM_SPREFIX@\-doom.cfg\fR(5).
.SH SEE ALSO
\fB@PROGRAM_SPREFIX@\-server\fR(6),
\fB@PROGRAM_SPREFIX@\-setup\fR(6),
\fB@PROGRAM_SPREFIX@\-heretic\fR(6),
\fB@PROGRAM_SPREFIX@\-hexen\fR(6),
\fB@PROGRAM_SPREFIX@\-strife\fR(6)
.SH AUTHOR
Chocolate Doom is written and maintained by Simon Howard. It is based on
the LinuxDoom source code, released by Id Software.
.SH COPYRIGHT
Copyright \(co id Software Inc.
Copyright \(co 2005-2016 Simon Howard.
.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.