'\" t
.\"     Title: freedoom2
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.20
.\"      Date: 2024-02-02
.\"    Manual: \ \&
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "FREEDOOM2" "6" "2024-02-02" "\ \&" "\ \&"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "NAME"
freedoom2 \- Automatically launch Freedoom with an engine
.SH "SYNOPSIS"
.sp
\fBfreedoom2\fP [\fI\-p\fP \fIDOOMPORT\fP|\fI\-\-\fP] [\fIARGS\fP]
.SH "DESCRIPTION"
.sp
Freedoom is a project to create a complete free\-content game based on
the \fIDoom\fP engine (often called “source ports” or simply “ports”),
which itself is free software.  In addition, it maintains
compatibility with \fIDoom\fP itself and is capable of playing the wide
variety of modifications (“mods”) that have been released by an
active community since 1993.
.sp
This command is a simple shell script to assist in running Freedoom,
which is not a game engine itself nor part of any engine project, but
playing Freedoom should remain simple.  The script tries to
automatically select an engine based on a hard\-coded list, but three
overrides are available, in order of precedence: command\-line
argument, environment variable, and a $HOME/.doomport symbolic link.
Passing \fI\-p DOOMPORT\fP runs Freedoom using the \fIDOOMPORT\fP specified.
Setting the \fIDOOMPORT\fP environment variable is similar, running the
engine specified in the variable.  An additional permanent setting is
via the $HOME/.doomport symbolic link, which may point to an
executable to run.
.sp
Additional arguments passed to the program, or after specifying \fI\-\-\fP
as the first option, will be passed to the engine being called.  This
can allow you to use options such as \fI\-file\fP to load mods or anything
else available with the engine of choice.
.SH "COPYRIGHT"
.sp
Freedoom is licensed under a permissive three\-clause BSD license.  For
details, see the source tree or the COPYING/COPYRIGHT file that
was installed by distribution packaging.
.sp
This manual page and the launcher script are both placed under the
public domain.
.SH "SEE ALSO"
.sp
chocolate\-doom(6), crispy\-doom(6), prboom\-plus(6)
.sp
.URL "https://doomwiki.org/wiki/Parameter" "" ""