Move arguments behind options in the synopsis.

Fix typesetting of option arguments.

Document environment variables more clearly, and without assuming csh
syntax.
This commit is contained in:
Markus Armbruster 2004-12-21 12:48:46 +00:00
parent 75189a496d
commit 479c0471fe

View file

@ -5,17 +5,17 @@ empire \- Empire client
.SH SYNOPSIS .SH SYNOPSIS
.B empire .B empire
[ [
.IR country
[
.IR password
]
]
[
.BI \-k .BI \-k
] ]
[ [
.BI \-2\ outfile .BI \-2\ outfile
] ]
[
.IR country
[
.IR password
]
]
.br .br
.SH DESCRIPTION .SH DESCRIPTION
.I empire .I empire
@ -38,21 +38,28 @@ the password for your country in the game
.BI \-k .BI \-k
if someone else is connected to your country, kill their connection if someone else is connected to your country, kill their connection
.TP .TP
.BI \-2\ outfile .BI \-2 " outfile"
redirect output to redirect output to
.I outfile .I outfile
.SH ENVIRONMENT VARIABLES .SH ENVIRONMENT VARIABLES
setenv EMPIREHOST server-machine to access the game on server-machine. The following environment variables affect the execution of the
.PP client:
setenv EMPIREPORT port-number to access the game on port-number. .TP
(the person running the game should tell you what this is... if not, .I EMPIREHOST
you should have the right default already.) Specifies the host to connect to, i.e. where the server runs.
.PP .TP
setenv COUNTRY country-name (optional) .I EMPIREPORT
.PP Specifies the port number or service name to connect to.
setenv PLAYER representative-name (optional) .TP
.PP .I COUNTRY
setenv LOGNAME username (optional) The name of your country in the game.
.TP
.I PLAYER
The password for your country in the game, also known as your
representative.
.TP
.I LOGNAME
Your user name.
.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)