(svn r27012) -Change: improvements to the man page (bentley)

docs/openttd.6

@@ -1,112 +1,153 @@
 .\"                                      Hey, EMACS: -*- nroff -*-
 .\" Please adjust this date whenever revising the manpage.
-.Dd May 31, 2011
+.Dd October 13, 2014
 .Dt OPENTTD 6
+.Os
 .Sh NAME
 .Nm openttd
-.Nd An open source clone of the Microprose game "Transport Tycoon Deluxe"
+.Nd open source clone of the Microprose game
+.Dq Transport Tycoon Deluxe
 .Sh SYNOPSIS
 .Nm
 .Op Fl efhx
 .Op Fl b Ar blitter
 .Op Fl c Ar config_file
-.Op Fl d Ar [level | cat=lvl[,...]]
+.Op Fl d Op Ar level | Ar cat Ns = Ns Ar lvl Ns Op , Ns Ar ...
-.Op Fl D Ar [host][:port]
+.Op Fl D Oo Ar host Oc Ns Op : Ns Ar port
-.Op Fl g Ar [savegame]
+.Op Fl g Op Ar savegame
 .Op Fl G Ar seed
 .Op Fl I Ar graphicsset
-.Op Fl l Ar host[:port]
+.Op Fl l Ar host Ns Op : Ns Ar port
 .Op Fl m Ar driver
 .Op Fl M Ar musicset
-.Op Fl n Ar host[:port][#player]
+.Op Fl n Ar host Ns Oo : Ns Ar port Oc Ns Op # Ns Ar player
 .Op Fl p Ar password
 .Op Fl P Ar password
 .Op Fl q Ar savegame
-.Op Fl r Ar widthxheight
+.Op Fl r Ar width Ns x Ns Ar height
 .Op Fl s Ar driver
 .Op Fl S Ar soundset
 .Op Fl t Ar year
 .Op Fl v Ar driver
 .Sh OPTIONS
-.Bl -tag -width ".Fl n Ar host[:port][#player]"
+.Bl -tag -width "-n host[:port][#player]"
 .It Fl b Ar blitter
-Set the blitter, see
+Select the blitter
+.Ar blitter ;
+see
 .Fl h
-for a full list
+for a full list.
 .It Fl c Ar config_file
-Use 'config_file' instead of 'openttd.cfg'
+Use
+.Ar config_file
+instead of
+.Pa openttd.cfg .
 .It Fl d Ar [level]
 Set debug verbosity for all categories to
-.Ar level
+.Ar level ,
-or 1 if omitted
+or 1 if omitted.
-.It Fl d Ar cat=level[,...]
+.It Fl d Ar cat Ns = Ns Ar lvl Ns Op , Ns Ar ...
-Set debug verbosity for a specific category
+Set debug verbosity to
-.It Fl D Ar [host][:port]
+.Ar lvl
-Start a dedicated server. Sets network debug level to 6. If you want to change this, use
+for a specific category
+.Ar cat .
+.It Fl D Oo Ar host Oc Ns Op : Ns Ar port
+Start a dedicated server.
+.Pp
+Network debug level will be set to 6.
+If you want to change this, set
 .Fl d
-after
+after setting
-.Fl D
+.Fl D .
-.It Fl G Ar seed
-Seed the pseudo random number generator
 .It Fl e
-Start in world editor mode
+Start in world editor mode.
 .It Fl f
 Fork into background (dedicated server only, see
-.Fl D )
+.Fl D ) .
-.It Fl g Ar [savegame]
+.It Fl g Op Ar savegame
 Load
 .Ar savegame
-at start or start a new game if omitted. The
+at start or start a new game if omitted.
 .Ar savegame
-must be either absolute or relative to the current path or one of the search paths.
+must be either an absolute path or one relative to the current path or one of
+the search paths.
+.It Fl G Ar seed
+Seed the pseudo random number generator with
+.Ar seed .
 .It Fl h
-Display a summary of all options and lists all the available AIs, blitters, sound, music and video drivers, graphics sets and sound sets.
+Display a summary of all options and list all the available AIs, blitters,
+sound, music and video drivers, graphics sets and sound sets.
 .It Fl I Ar graphicsset
-Set the graphics set, see
+Select the graphics set
+.Ar graphicsset ;
+see
 .Fl h
-for a full list
+for a full list.
-.It Fl l Ar host[:port]
+.It Fl l Ar host Ns Op : Ns Ar port
-Redirect DEBUG(), See
+Redirect
-.Fl D
+.Fn DEBUG
+output; see
+.Fl D .
 .It Fl m Ar driver
-Set the music driver, see
+Select the music driver
+.Ar driver ;
+see
 .Fl h
-for a full list
+for a full list.
 .It Fl M Ar musicset
-Set the music set, see
+Select the music set
+.Ar musicset ;
+see
 .Fl h
-for a full list
+for a full list.
-.It Fl n Ar host[:port][#player]
+.It Fl n Ar host Ns Oo : Ns Ar port Oc Ns Op # Ns Ar player
-Join a network game, optionally specify a port to connect to and player to play as
+Join a network game, optionally specifying a port to connect to and player to
+play as.
 .It Fl p Ar password
-Password used to join server. Only useful with
+Password used to join server.
-.Fl n
+Only useful with
+.Fl n .
 .It Fl P Ar password
-Password used to join company. Only useful with
+Password used to join company.
-.Fl n
+Only useful with
+.Fl n .
 .It Fl q Ar savegame
-Write some information about the savegame and exit
+Write some information about the specified savegame and exit.
-.It Fl r Ar widthxheight
+.It Fl r Ar width Ns x Ns Ar height
-Set the resolution
+Set the resolution to
+.Ar width
+\(mu
+.Ar height
+pixels.
 .It Fl s Ar driver
-Set the sound driver, see
+Select the sound driver
+.Ar driver ;
+see
 .Fl h
-for a full list
+for a full list.
 .It Fl S Ar soundset
-Set the sound set, see
+Select the sound set
+.Ar soundset ;
+see
 .Fl h
-for a full list
+for a full list.
 .It Fl t Ar year
-Set the starting year
+Set the starting year to
+.Ar year .
 .It Fl v Ar driver
-Set the video driver, see
+Select the video driver
+.Ar driver ;
+see
 .Fl h
-for a full list
+for a full list.
 .It Fl x
-Do not automatically save to config file on exit
+Do not automatically save to config file on exit.
 .El
 .Sh SEE ALSO
-http://wiki.openttd.org/, http://www.openttd.org
+.Lk https://wiki.openttd.org "Wiki"
+(includes community maintained manual),
+.Lk https://forum.openttd.org "Forum",
+.Lk https://www.openttd.org "News"
 .Sh HISTORY
 Transport Tycoon Deluxe was written by Chris Sawyer and published by Microprose.
 .Nm