]> git.pond.sub.org Git - empserver/blobdiff - man/empire.6
Make: Get SHELL from Autoconf
[empserver] / man / empire.6
index ed5519f8736eb5d9650b3b38d107a06462294531..764811e6751c29855c357a39520fdda12cb3c9aa 100644 (file)
@@ -1,26 +1,17 @@
-.TH EMP_CLIENT 6
+.TH EMPIRE 6
 .SH NAME
 empire \- Empire client
 .SH SYNOPSIS
 .B empire
-[
-.BI \-k
-]
-[
-.BI \-u
-]
-[
-.BI \-2 " outfile"
-]
-[
-.IR country
-[
-.IR password
-]
-]
+[\fB\-hkruv\fP]
+[\fB\-2\fP \fIoutfile\fP]
+[\fB\-H\fP \fIhistfile\fP]
+[\fB\-s\fP \fI[host:]port\fP]
+[\fIcountry\fP
+[\fIpassword\fP]]
 .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,33 +22,59 @@ 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
+.B \-h
+Help.  Print brief usage information and exit.
+.TP
+.BI \-H " histfile"
+Load command history from \fIhistfile\fP, and save it back.  Default
+is '~/.empire_history' without \fB\-r\fP, and none with \fB-r\fP.  You
+might want to protect your history file from prying eyes.
+.IP
+Only available when compiled the GNU \fBreadline\fP library.
+.TP
+.B \-k
+If someone else is connected to your country, kill their connection.
 .TP
-.IR password
-the password for your country in the game
+.B \-r
+Restricted mode: disable redirections and execute command.  This is
+useful when you want to grant somebody access to just Empire, but not
+to the host system's user account that runs the client.  Be careful
+with \fB\-H\fP and \fB\-2\fP then.
 .TP
-.BI \-k
-if someone else is connected to your country, kill their connection
+.BI \-s " [host:]port"
+Specify server \fIhost\fR and \fIport\fR.
 .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
+.B \-v
+Print version information and exit.
+.TP
 .BI \-2 " outfile"
-redirect output to 
-.I outfile
+Append log of session 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.
+\fIWarning:\fR the password passed here is visible to other users on
+the same machine!
 .SH ENVIRONMENT VARIABLES
 The following environment variables affect the execution of the
 client:
 .TP
 .I EMPIREHOST
 Specifies the host to connect to, i.e. where the server runs.
+Only effective if no host specified via \-s.
 .TP
 .I EMPIREPORT
 Specifies the port number or service name to connect to.
+Only effective if no port specified via \-s.
 .TP
 .I COUNTRY
 The name of your country in the game.
@@ -68,27 +85,45 @@ representative.
 .TP
 .I LOGNAME
 Your user name.
+.TP
+.I INPUTRC
+The filename for the \fBreadline\fP startup file, overriding the
+default of \fI~/.inputrc\fP (see \fBREADLINE\fP below).
+.SH READLINE
+When compiled with the GNU \fBreadline\fP library, the client supports
+fancy line editing and persistent history.  Its application name for
+application-specific settings is \fBEmpire\fP.  See the readline
+documentation for details.
+.SH "SEE ALSO"
+\fIemp_server\fR(6), \fIreadline\fR(3).
+.SH FILES
+.TP
+.I ~/.inputrc
+Individual \fBreadline\fP initialization file
 .SH AUTHORS
 .nf
-Primary Author is Dave Pare (mr-frog@scam.berkeley.edu)
+Primary Author is Dave Pare <mr-frog@scam.berkeley.edu>
 Secondary authors/contributors may include:
-James Anderson (jwa@k.cs.cmu.edu)
-Jeff Anton (anton@postgres.berkeley.edu)
-Phill Everson (everson@compsci.bristol.ac.uk)
-Steven Grimm (koreth@ucscb.UCSC.EDU)
-Lewis R. Jansen (lrj@helios.tn.cornell.edu)
-Mike St. Johns (stjohns@edn-vax.arpa)
-Nick Lai (lai@cs.ucla.edu)
-Shelley Louie (slouie@cory.berekely.edu)
-Steve McClure (ionica@empire.cx)
-Chris Metcalf (metcalf-christopher@yale.arpa)
-Dave Muir Sharnoff (muir@cogsci.berkeley.edu)
-Keith Muller (muller@sdcc7.ucsd.edu)
-Chuck Musciano (chuck@trantor.harris-atd.com)
-Jeff Okamoto (okamoto%hpccc@hplabs.hp.com)
-Julian Onions (jpo@computer-science.nottingham.ac.uk)
-Kurt Pires (kjpires@ic.berkeley.edu)
-Jim Reuter (reuter@decwrl.dec.com)
-Peter Vukovich (peterv@monet.berkeley.edu)
-Jeff Wallace (jeffw@scam.berkeley.edu)
-John Yockey (johny@verinet.com)
+James Anderson <jwa@k.cs.cmu.edu>
+Jeff Anton <anton@postgres.berkeley.edu>
+Markus Armbruster <armbru@pond.sub.org>
+Phill Everson <everson@compsci.bristol.ac.uk>
+Steven Grimm <koreth@ucscb.UCSC.EDU>
+Martin Haukeli <martin.haukeli@gmail.com>
+Lewis R. Jansen <lrj@helios.tn.cornell.edu>
+Mike St. Johns <stjohns@edn-vax.arpa>
+Ron Koenderink <rkoenderink@yahoo.ca>
+Nick Lai <lai@cs.ucla.edu>
+Shelley Louie <slouie@cory.berekely.edu>
+Steve McClure <ionica@empire.cx>
+Chris Metcalf <metcalf-christopher@yale.arpa>
+Dave Muir Sharnoff <muir@cogsci.berkeley.edu>
+Keith Muller <muller@sdcc7.ucsd.edu>
+Chuck Musciano <chuck@trantor.harris-atd.com>
+Jeff Okamoto <okamoto%hpccc@hplabs.hp.com>
+Julian Onions <jpo@computer-science.nottingham.ac.uk>
+Kurt Pires <kjpires@ic.berkeley.edu>
+Jim Reuter <reuter@decwrl.dec.com>
+Peter Vukovich <peterv@monet.berkeley.edu>
+Jeff Wallace <jeffw@scam.berkeley.edu>
+John Yockey <johny@verinet.com>