Fix markup. Reorder so that options appear in alphabetical order.

Document -h and -v for fairland and files.  Supply proper .SA.  Minor
polishing.
This commit is contained in:
Markus Armbruster 2007-07-11 19:59:47 +00:00
parent 8da8e3fb3a
commit b8a1833438
5 changed files with 106 additions and 92 deletions

View file

@ -7,7 +7,7 @@ emp_server \- Empire server
.SH SYNOPSIS .SH SYNOPSIS
.B emp_server .B emp_server
[ [
.BI \-dhpsv .B \-dhpsv
] ]
[ [
.BI \-e " configfile" .BI \-e " configfile"
@ -16,7 +16,7 @@ emp_server \- Empire server
.br .br
.B emp_server .B emp_server
[ [
.BI \-i .B \-i
| |
.BI \-I " service-name" .BI \-I " service-name"
] ]
@ -26,12 +26,12 @@ emp_server \- Empire server
.br .br
.B emp_server .B emp_server
[ [
.BI \-r .B \-r
| |
.BI \-R " service-name" .BI \-R " service-name"
]\} ]\}
.SH DESCRIPTION .SH DESCRIPTION
.I emp_server .B emp_server
is a daemon which listens to the Empire port for players connecting to is a daemon which listens to the Empire port for players connecting to
the game. For more information on the game of Empire, see the info the game. For more information on the game of Empire, see the info
pages within the game. pages within the game.
@ -41,14 +41,11 @@ pages within the game.
Debug mode. This will prevent the server from forking itself into the Debug mode. This will prevent the server from forking itself into the
background. It will also make it abort when it detects an internal background. It will also make it abort when it detects an internal
error. You normally want to use this flag if you are running error. You normally want to use this flag if you are running
.I emp_server .B emp_server
from within a debugger. from within a debugger.
.TP .TP
.BI \-e " configfile" .BI \-e " configfile"
Use game configuration specification in Use game configuration in \fIconfigfile\fR.
.I configfile
\&. By default, the file "econfig" in the compiled-in data directory
is used.
.TP .TP
.B \-h .B \-h
Help. Print brief usage information and exit. Help. Print brief usage information and exit.
@ -61,7 +58,7 @@ Install as a Windows Service called "Empire Server".
Install as a Windows Service with the specified name.\} Install as a Windows Service with the specified name.\}
.TP .TP
.B \-p .B \-p
Threading debug mode. Implies -d. Threading debug mode. Implies \fB-d\fR.
.if \nw \{\ .if \nw \{\
.TP .TP
.B \-r .B \-r
@ -83,12 +80,12 @@ deprecated.
.TP .TP
.B SIGHUP .B SIGHUP
Request Request
.I emp_server .B emp_server
to reopen log files. This allows proper log rotation. to reopen log files. This allows proper log rotation.
.TP .TP
.BR SIGINT ", " SIGTERM .BR SIGINT ", " SIGTERM
Request Request
.I emp_server .B emp_server
to shut down immediately. to shut down immediately.
\} \}
.if \nw \{ .if \nw \{
@ -99,7 +96,9 @@ ones supplied during service installation. To modify the startup
parameters, you must remove the service and reinstall the service.\} parameters, you must remove the service and reinstall the service.\}
.SH BUGS .SH BUGS
Please report all bugs to the Wolfpack <wolfpack@wolfpackempire.com> Please report all bugs to the Wolfpack <wolfpack@wolfpackempire.com>
.SH "SEE ALSO"
\fIempire\fR(6), \fIfairland\fR(6), \fIfiles\fR(6), \fIpconfig\fR(6).
.SH AUTHORS .SH AUTHORS
Dave Pare, Jeff Bailey, Thomas Ruschak, Ken Stevens and Steve McClure Dave Pare, Jeff Bailey, Thomas Ruschak, Ken Stevens and Steve McClure
are principal authors. The full list of authors is too long to are principal authors. The full list of authors is too long to
mention here. include here.

View file

@ -4,23 +4,23 @@ empire \- Empire client
.SH SYNOPSIS .SH SYNOPSIS
.B empire .B empire
[ [
.BI \-k .B \-k
] ]
[ [
.BI \-u .B \-u
] ]
[ [
.BI \-2 " outfile" .BI \-2 " outfile"
] ]
[ [
.IR country .I country
[ [
.IR password .I password
] ]
] ]
.br .br
.SH DESCRIPTION .SH DESCRIPTION
.I empire .B empire
is a bare bones client to connect to the Empire server. Empire is a is a bare bones client to connect to the Empire server. Empire is a
global economic/political/military simulation game wherein players, global economic/political/military simulation game wherein players,
representing national governments, make "real-time" decisions representing national governments, make "real-time" decisions
@ -31,24 +31,24 @@ WARNING -- This game is not only addictive but often peels back
the thin veneer of civilization that hides the maniac within. the thin veneer of civilization that hides the maniac within.
.SH OPTIONS .SH OPTIONS
.TP .TP
.IR country .B \-k
the name of your country in the game If someone else is connected to your country, kill their connection.
.TP .TP
.IR password .B \-u
the password for your country in the game Use UTF-8 rather than ASCII character set.
.TP
.BI \-k
if someone else is connected to your country, kill their connection
.TP
.BI \-u
use UTF-8 rather than ASCII character set
.IP .IP
This requires server version 4.2.21 or later, and a terminal that This requires server version 4.2.21 or later, and a terminal that
understands UTF-8. understands UTF-8.
.TP .TP
.BI \-2 " outfile" .BI \-2 " outfile"
redirect output to Copy output to \fIoutfile\fR.
.I outfile .SH OPERANDS
.TP
.I country
The name of your country in the game.
.TP
.I password
The password for your country in the game.
.SH ENVIRONMENT VARIABLES .SH ENVIRONMENT VARIABLES
The following environment variables affect the execution of the The following environment variables affect the execution of the
client: client:
@ -68,6 +68,8 @@ representative.
.TP .TP
.I LOGNAME .I LOGNAME
Your user name. Your user name.
.SH "SEE ALSO"
\fIemp_server\fR(6).
.SH AUTHORS .SH AUTHORS
.nf .nf
Primary Author is Dave Pare (mr-frog@scam.berkeley.edu) Primary Author is Dave Pare (mr-frog@scam.berkeley.edu)

View file

@ -4,40 +4,40 @@ fairland \- Empire land generator
.SH SYNOPSIS .SH SYNOPSIS
.B fairland .B fairland
[ [
.BI \-aioq .B \-ahioqv
] ]
[ [
.BI \-s\ scriptout .BI \-e " configfile"
] ]
[ [
.BI \-e\ configfile .BI \-R " seed"
] ]
[ [
.BI \-R\ seed .BI \-s " scriptout"
] ]
.IR nc .I nc
.IR sc .I sc
[ [
.IR ni .I ni
[
.I is
[
.I sp
[
.I pm
[
.I di
[
.I id
] ]
[
.IR is
] ]
[
.IR sp
] ]
[
.IR pm
] ]
[
.IR di
] ]
[
.IR id
] ]
.br .br
.SH DESCRIPTION .SH DESCRIPTION
.I fairland .B fairland
is a program which creates land and ore for Empire. It is a program which creates land and ore for Empire. It
should be run after should be run after
.I files .I files
@ -54,6 +54,12 @@ get nearly any kind of map you want by choosing the right arguments.
.B \-a .B \-a
mark the continents with a * so that you can tell them from the islands mark the continents with a * so that you can tell them from the islands
.TP .TP
.BI \-e " configfile"
Use game configuration in \fIconfigfile\fR.
.TP
.B \-h
Help. Print brief usage information and exit.
.TP
.B \-i .B \-i
islands will crash into each other and merge islands will crash into each other and merge
.TP .TP
@ -66,20 +72,7 @@ program) to set the resources.
.B \-q .B \-q
run quietly without printing anything to the terminal run quietly without printing anything to the terminal
.TP .TP
.BI \-s\ scriptout .BI \-R " seed"
writes a script for placing capitol to the file
.I scriptout
(If you don't specify this argument, then the script will be written
to "newcap_script".)
.TP
.BI \-e\ configfile
causes
.I fairland
to use the game configuration specified in
.I configfile
(by default, the file "econfig" in the data directory is used)
.TP
.BI \-R\ seed
Use Use
.I seed .I seed
as seed for the pseudo-random number generator. This can be used to reproduce as seed for the pseudo-random number generator. This can be used to reproduce
@ -87,30 +80,38 @@ a previously created world. (by default the current time and process id of
the server are used as seed.) The seed used to generate a world is printed the server are used as seed.) The seed used to generate a world is printed
along with the map. along with the map.
.TP .TP
.IR nc .BI \-s " scriptout"
writes a script for placing capitol to the file
.I scriptout
(If you don't specify this argument, then the script will be written
to "newcap_script".)
.TP
.B \-v
Print version information and exit.
.SH OPERANDS
.TP
.I nc
number of continents number of continents
.TP .TP
.IR sc .I sc
continent size continent size
.TP .TP
.IR ni .I ni
number of islands (optional, default = nc) number of islands (optional, default = nc)
.TP .TP
.IR is .I is
average size of islands (optional, default = sc/2) average size of islands (optional, default = sc/2)
.TP .TP
.IR sp .I sp
spike percentage: 0 = round, 100 = snake (default = 10) spike percentage: 0 = round, 100 = snake (default = 10)
.TP .TP
.IR pm .I pm
the percentage of land that is mountain (default = 0) the percentage of land that is mountain (default = 0)
.TP .TP
.IR di .I di
the minimum distance between continents (default = 2) the minimum distance between continents (default = 2)
.TP .TP
.IR id .I id
minimum distance from islands to continents (default = 1) minimum distance from islands to continents (default = 1)
.SH AUTHOR .SH AUTHOR
Ken Stevens <chidren@empire.net> Ken Stevens <chidren@empire.net>

View file

@ -4,26 +4,30 @@ files \- Empire file initialization
.SH SYNOPSIS .SH SYNOPSIS
.B files .B files
[ [
.BI \-e\ configfile .B \-fhv
] ]
[ [
.BI \-f .BI \-e " configfile"
] ]
.br .br
.SH DESCRIPTION .SH DESCRIPTION
.I files .B files
creates all of the files which are required by creates all of the files which are required by
.I emp_server .B emp_server
to run a game. It will destroy all previous game data, so excercise to run a game. It will destroy all previous game data, so excercise
caution when running this program. caution when running this program.
.SH OPTIONS .SH OPTIONS
.TP .TP
.BI \-e\ configfile .BI \-e " configfile"
causes Use game configuration in \fIconfigfile\fR.
.I files
to use the game configuration specified in
.I configfile
(by default, the file "econfig" in the data directory is used)
.TP .TP
.BI \-f .B \-f
Clobber existing game data without asking for confirmation. Clobber existing game data without asking for confirmation.
.TP
.B \-h
Help. Print brief usage information and exit.
.TP
.B \-v
Print version information and exit.
.SH "SEE ALSO"
\fIemp_server\fR(6).

View file

@ -1,28 +1,36 @@
.TH PCONFIG 1 .TH PCONFIG 1
.SH NAME .SH NAME
pconfig \- Print configuration pconfig \- Print Empire configuration
.SH SYNOPSIS .SH SYNOPSIS
.B pconfig .B pconfig
[ [
.IR configfile .I configfile
] ]
.br .br
.SH DESCRIPTION .SH DESCRIPTION
.I pconfig .B pconfig
creates an "econfig" file which may be used with the \-e argument with creates an "econfig" file which may be used with the \-e argument with
most Empire programs. By default, Empire programs look for a file most Empire programs. By default, Empire programs look for a file
called "econfig" in the data directory, but the called "econfig" in the data directory, but the
.I pconfig .B pconfig
program may be used to create an alternate Empire configuration file. program may be used to create an alternate Empire configuration file.
After you have created an "econfig" file, you can edit the game After you have created an "econfig" file, you can edit the game
configuration data in the file which the server uses to control configuration data in the file which the server uses to control
various parameters for the game. various parameters for the game.
.SH OPTIONS .B pconfig
program may be used to create an alternate Empire configuration file.
After you have created an "econfig" file, you can edit the game
configuration data in the file which the server uses to control
various parameters for the game.
.SH OPERANDS
.TP .TP
.BI configfile
causes
.I pconfig
to use the game configuration specified in
.I configfile .I configfile
makes
.B pconfig
use the game configuration specified in
.I configfile
instead of compiled-in defaults.
.SH "SEE ALSO"
\fIemp_server\fR(6).
.SH AUTHOR .SH AUTHOR
Julian Onions <j.onions@nexor.co.uk> Julian Onions <j.onions@nexor.co.uk>