Skip to content

Commit 8c84ce0

Browse files
uqsSupSuper
uqs
authored and
SupSuper
committed
Rewrite manpage using mdoc macros, add -master flag and a bit of
history. This uses semantic markup instead of the nonsense that xmlto produces. It passes `mandoc -Tlint`, except for the "legacy" date format. If I would've had googled before, I might've found https://openxcom.org/forum/index.php?topic=396.0 which has a perfectly fine mdoc manpage already (though with a bit less detail). This will give all *nix systems access to a manpage w/o the need to install xmlto (and potentially all of LaTeX etc).
1 parent 56f3a55 commit 8c84ce0

1 file changed

Lines changed: 80 additions & 80 deletions

File tree

‎docs/openxcom.6‎

Lines changed: 80 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -1,86 +1,86 @@
1-
'\" t
2-
.\" Title: openxcom
3-
.\" Author: [see the "AUTHOR" section]
4-
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
5-
.\" Date: 2014.06.12
6-
.\" Manual: User\*(Aqs Manual
7-
.\" Source: 1.0
8-
.\" Language: English
9-
.\"
10-
.TH "OPENXCOM" "6" "2014\&.06\&.12" "1\&.0" "User\*(Aqs Manual"
11-
.\" -----------------------------------------------------------------
12-
.\" * Define some portability stuff
13-
.\" -----------------------------------------------------------------
14-
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15-
.\" http://bugs.debian.org/507673
16-
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17-
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18-
.ie \n(.g .ds Aq \(aq
19-
.el .ds Aq '
20-
.\" -----------------------------------------------------------------
21-
.\" * set default formatting
22-
.\" -----------------------------------------------------------------
23-
.\" disable hyphenation
24-
.nh
25-
.\" disable justification (adjust text to left margin only)
26-
.ad l
27-
.\" -----------------------------------------------------------------
28-
.\" * MAIN CONTENT STARTS HERE *
29-
.\" -----------------------------------------------------------------
30-
.SH "NAME"
31-
openxcom \- An open\-source clone of the original "UFO: Enemy Unknown"
32-
.SH "SYNOPSIS"
33-
.HP \w'\fBopenxcom\fR\ 'u
34-
\fBopenxcom\fR [\fIOPTIONS\fR]
35-
.SH "DESCRIPTION"
36-
.PP
37-
\fBopenxcom\fR
38-
is an open\-source clone of the popular UFO: Enemy Unknown (X\-Com: UFO Defense in USA) videogame by Microprose, licensed under the GPL and written in C++ / SDL\&.
39-
.SH "OPTIONS"
40-
.PP
41-
\fB\-data\fR \fIPATH\fR
42-
.RS 4
1+
.Dd 2014-06-12
2+
.Dt OPENXCOM 6
3+
.Os
4+
.Sh NAME
5+
.Nm openxcom
6+
.Nd An open-source reimplementation of the original
7+
.Dq UFO: Enemy Unknown
8+
game
9+
.Sh SYNOPSIS
10+
.Nm
11+
.Op Fl \? | help
12+
.Op Fl data Ar path
13+
.Op Fl user Ar path
14+
.Op Fl cfg Ar path
15+
.Op Fl master Ar mod
16+
.Op Fl KEY Ar VALUE
17+
.Sh DESCRIPTION
18+
.Nm openxcom
19+
is an open-source reimplementation of the popular
20+
.Dq UFO: Enemy Unknown
21+
game also known as
22+
.Dq X-COM: UFO Defense
23+
in North America, and its sequel
24+
.Dq X-COM: Terror from the Deep
25+
by publisher
26+
.An MicroProse .
27+
It is licensed under the GPL and written in C++ / SDL.
28+
.Pp
29+
The options are as follows:
30+
.Bl -tag -width Ds
31+
.It Fl ?, Fl help
32+
show command-line help
33+
.It Fl data Ar path
4334
use
44-
\fIPATH\fR
45-
as the default Data Folder instead of auto\-detecting
46-
.RE
47-
.PP
48-
\fB\-user\fR \fIPATH\fR
49-
.RS 4
35+
.Ar path
36+
as the default Data Folder instead of auto-detecting
37+
.It Fl user Ar path
5038
use
51-
\fIPATH\fR
52-
as the default User Folder instead of auto\-detecting
53-
.RE
54-
.PP
55-
\fB\-cfg\fR \fIPATH\fR
56-
.RS 4
39+
.Ar path
40+
as the default User Folder instead of auto-detecting
41+
.It Fl cfg Ar path
5742
use
58-
\fIPATH\fR
59-
as the default Config Folder instead of auto\-detecting
60-
.RE
61-
.PP
62-
\fB\-\fR\fB\fIKEY\fR\fR \fIVALUE\fR
63-
.RS 4
43+
.Ar path
44+
as the default Config Folder instead of auto-detecting
45+
.It Fl master Ar mod
46+
set
47+
.Ar mod
48+
the current master mod (eg.\&
49+
.Fl master
50+
.Ar xcom2 )
51+
.It Fl KEY Ar VALUE
6452
set option
65-
\fIKEY\fR
53+
.Ar KEY
6654
to
67-
\fIVALUE\fR
55+
.Ar VALUE
6856
instead of default/loaded value (eg\&.
69-
\-displayWidth 640)
70-
.RE
71-
.PP
72-
\fB\-help\fR, \fB\-?\fR
73-
.RS 4
74-
show command\-line help
75-
.RE
76-
.SH "AUTHOR"
77-
.PP
78-
OpenXcom Developers
79-
.SH "SEE ALSO"
80-
.PP
81-
\m[blue]\fB\%https://openxcom.org\fR\m[],
82-
\m[blue]\fB\%http://ufopaedia.org/index.php?title=OpenXcom\fR\m[]
83-
.SH "COPYRIGHT"
84-
.br
85-
Copyright \(co 2014 OpenXcom Developers
86-
.br
57+
.Fl displayWidth
58+
.Ar 640
59+
).
60+
See
61+
.Pa src/Engine/Options.cpp
62+
for a list of all potential options.
63+
.El
64+
.Sh INSTALLATION
65+
.Nm OpenXcom
66+
requires a vanilla copy of the X-COM resources -- from either or both of the original games.
67+
Please refer to the
68+
.Pa README.md
69+
for the default search paths and the exact directory layout, as well as information on the Mod support.
70+
.Sh SEE ALSO
71+
.Lk https://openxcom.org ,
72+
.Lk https://ufopaedia.org/index.php?title=OpenXcom
73+
.Sh HISTORY
74+
.An MicroProse
75+
releases
76+
.Dq UFO: Enemy Unknown
77+
in 1994, followed by
78+
.Dq X-COM: Terror from the Deep
79+
in 1995 with various sequels following.
80+
The
81+
.Nm OpenXcom
82+
project sees the light of day in 2010.
83+
.Sh COPYRIGHT
84+
Copyright \(co 2020 OpenXcom Developers
85+
.Sh AUTHORS
86+
.An OpenXcom Developers

0 commit comments

Comments
 (0)