'\" t
.\"     Title: freedoom2
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 03/08/2017
.\"    Manual: \ \&
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "FREEDOOM2" "6" "03/08/2017" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
freedoom2 \- Automatically launch Freedoom with an engine
.SH "SYNOPSIS"
.sp
\fBfreedoom2\fR [\fI\-p\fR \fIPORT\fR|\fI\-\-\fR] [\fIARGS\fR]
.SH "DESCRIPTION"
.sp
Freedoom is a project to create a complete free\-content game based on the \fIDoom\fR engine (often called \(lqsource ports\(rq or simply \(lqports\(rq), which itself is free software\&. In addition, it maintains compatibility with \fIDoom\fR itself and is capable of playing the wide variety of modifications (\(lqmods\(rq) 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\&. Only accepted as the first argument, you may pass \fI\-p PORT\fR, which will run Freedoom using the \fIPORT\fR specified\&. As an alternative, you may make a symbolic link named $HOME/\&.doomport to your preferred port\&. A port specified on the command line explicitly overrides $HOME/\&.doomport, whereas the existence of the symbolic link will override the detection of port based on a hard\-coded list\&.
.sp
Additional arguments passed to the program, or after specifying \fI\-\-\fR as the first option, will be passed to the engine being called\&. This can allow you to use options such as \fI\-file\fR 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\&.