]> git.pond.sub.org Git - empserver/commitdiff
Fix markup. Reorder so that options appear in alphabetical order.
authorMarkus Armbruster <armbru@pond.sub.org>
Wed, 11 Jul 2007 19:59:47 +0000 (19:59 +0000)
committerMarkus Armbruster <armbru@pond.sub.org>
Wed, 11 Jul 2007 19:59:47 +0000 (19:59 +0000)
Document -h and -v for fairland and files.  Supply proper .SA.  Minor
polishing.

man/emp_server.6
man/empire.6
man/fairland.6
man/files.6
man/pconfig.6

index 3e3bb5c9aa0916894916d4b282f8854c10f49d86..1175ce59ff880c33b817b7725389744ec67da7e2 100644 (file)
@@ -7,7 +7,7 @@ emp_server \- Empire server
 .SH SYNOPSIS
 .B emp_server
 [
-.BI \-dhpsv
+.B \-dhpsv
 ]
 [
 .BI \-e " configfile"
@@ -16,7 +16,7 @@ emp_server \- Empire server
 .br
 .B emp_server
 [
-.BI \-i
+.B \-i
 |
 .BI \-I " service-name"
 ]
@@ -26,12 +26,12 @@ emp_server \- Empire server
 .br
 .B emp_server
 [
-.BI \-r
+.B \-r
 |
 .BI \-R " service-name"
 ]\}
 .SH DESCRIPTION
-.I emp_server
+.B emp_server
 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
 pages within the game.
@@ -41,14 +41,11 @@ pages within the game.
 Debug mode.  This will prevent the server from forking itself into the
 background.  It will also make it abort when it detects an internal
 error.  You normally want to use this flag if you are running
-.I emp_server
+.B emp_server
 from within a debugger.
 .TP
 .BI \-e " configfile"
-Use game configuration specification in 
-.I configfile
-\&.  By default, the file "econfig" in the compiled-in data directory
-is used.
+Use game configuration in \fIconfigfile\fR.
 .TP
 .B \-h 
 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.\}
 .TP
 .B \-p
-Threading debug mode.  Implies -d.
+Threading debug mode.  Implies \fB-d\fR.
 .if \nw \{\
 .TP
 .B \-r
@@ -83,12 +80,12 @@ deprecated.
 .TP
 .B SIGHUP
 Request
-.I emp_server
+.B emp_server
 to reopen log files.  This allows proper log rotation.
 .TP
 .BR SIGINT ", " SIGTERM
 Request
-.I emp_server
+.B emp_server
 to shut down immediately.
 \}
 .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.\}
 .SH BUGS
 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
 Dave Pare, Jeff Bailey, Thomas Ruschak, Ken Stevens and Steve McClure
 are principal authors.  The full list of authors is too long to
-mention here.
+include here.
index ed5519f8736eb5d9650b3b38d107a06462294531..e395adb00a617c9a4309e5e1764bab8362b10c13 100644 (file)
@@ -4,23 +4,23 @@ empire \- Empire client
 .SH SYNOPSIS
 .B empire
 [
-.BI \-k
+.B \-k
 ]
 [
-.BI \-u
+.B \-u
 ]
 [
 .BI \-2 " outfile"
 ]
 [
-.IR country
+.I country
 [
-.IR password
+.I password
 ]
 ]
 .br
 .SH DESCRIPTION
-.I empire
+.B empire
 is a bare bones client to connect to the Empire server.  Empire is a
 global economic/political/military simulation game wherein players,
 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.
 .SH OPTIONS
 .TP
-.IR country
-the name of your country in the game
-.TP
-.IR password
-the password for your country in the game
-.TP
-.BI \-k
-if someone else is connected to your country, kill their connection
+.B \-k
+If someone else is connected to your country, kill their connection.
 .TP
-.BI \-u
-use UTF-8 rather than ASCII character set
+.B \-u
+Use UTF-8 rather than ASCII character set.
 .IP
 This requires server version 4.2.21 or later, and a terminal that
 understands UTF-8.
 .TP
 .BI \-2 " outfile"
-redirect output to 
-.I outfile
+Copy output to \fIoutfile\fR.
+.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
 The following environment variables affect the execution of the
 client:
@@ -68,6 +68,8 @@ representative.
 .TP
 .I LOGNAME
 Your user name.
+.SH "SEE ALSO"
+\fIemp_server\fR(6).
 .SH AUTHORS
 .nf
 Primary Author is Dave Pare (mr-frog@scam.berkeley.edu)
index 10534b7ffe0b8bed8d8243d430038e57ce003c3c..0b8717cdf05960b6009beb152df285d2d2202506 100644 (file)
@@ -4,40 +4,40 @@ fairland \- Empire land generator
 .SH SYNOPSIS
 .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
-.IR sc
+.I nc
+.I sc
 [
-.IR ni
-]
+.I ni
 [
-.IR is
-]
+.I is
 [
-.IR sp
-]
+.I sp
 [
-.IR pm
-]
+.I pm
 [
-.IR di
-]
+.I di
 [
-.IR id
+.I id
+]
+]
+]
+]
+]
 ]
 .br
 .SH DESCRIPTION
-.I fairland
+.B fairland
 is a program which creates land and ore for Empire.  It
 should be run after 
 .I files 
@@ -54,6 +54,12 @@ get nearly any kind of map you want by choosing the right arguments.
 .B \-a 
 mark the continents with a * so that you can tell them from the islands
 .TP
+.BI \-e " configfile"
+Use game configuration in \fIconfigfile\fR.
+.TP
+.B \-h 
+Help.  Print brief usage information and exit.
+.TP
 .B \-i
 islands will crash into each other and merge
 .TP
@@ -66,20 +72,7 @@ program) to set the resources.
 .B \-q
 run quietly without printing anything to the terminal
 .TP
-.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
-.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
+.BI \-R " seed"
 Use
 .I seed
 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
 along with the map.
 .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
 .TP
-.IR sc 
+.I sc 
 continent size
 .TP
-.IR ni 
+.I ni 
 number of islands (optional, default = nc)
 .TP
-.IR is 
+.I is 
 average size of islands (optional, default = sc/2)
 .TP
-.IR sp 
+.I sp 
 spike percentage: 0 = round, 100 = snake (default = 10)
 .TP
-.IR pm 
+.I pm 
 the percentage of land that is mountain (default = 0)
 .TP
-.IR di 
+.I di 
 the minimum distance between continents (default = 2)
 .TP
-.IR id 
+.I id 
 minimum distance from islands to continents (default = 1)
-
 .SH AUTHOR
 Ken Stevens <chidren@empire.net>
-
index 89101ec3d91c34871da3a9b29da5d2ceca38431f..c394c133a4569532dfb99b826184de212ef42b75 100644 (file)
@@ -4,26 +4,30 @@ files \- Empire file initialization
 .SH SYNOPSIS
 .B files
 [
-.BI \-e\ configfile
+.B \-fhv
 ]
 [
-.BI \-f
+.BI \-e " configfile"
 ]
 .br
 .SH DESCRIPTION
-.I files
+.B files
 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
 caution when running this program.
 .SH OPTIONS
 .TP
-.BI \-e\ configfile
-causes
-.I files
-to use the game configuration specified in 
-.I configfile
-(by default, the file "econfig" in the data directory is used)
+.BI \-e " configfile"
+Use game configuration in \fIconfigfile\fR.
 .TP
-.BI \-f
+.B \-f
 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).
index d79c4ff23544c62d95a7f1af44fed00d86f0af00..ad2dab3890ac3c055f4dd66cd4c0814099523e0d 100644 (file)
@@ -1,28 +1,36 @@
 .TH PCONFIG 1
 .SH NAME
-pconfig \- Print configuration
+pconfig \- Print Empire configuration
 .SH SYNOPSIS
 .B pconfig
 [
-.IR configfile
+.I configfile
 ]
 .br
 .SH DESCRIPTION
-.I pconfig
+.B pconfig
 creates an "econfig" file which may be used with the \-e argument with
 most Empire programs.  By default, Empire programs look for a file
 called "econfig" in the data directory, but the 
-.I pconfig
+.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.
+.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 OPTIONS
+.SH OPERANDS
 .TP
-.BI configfile
-causes
-.I pconfig
-to use the game configuration specified in 
 .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
 Julian Onions <j.onions@nexor.co.uk>