Changeset - r27792:08474b1ace68
[Not reviewed]
master
0 2 0
Rubidium - 11 months ago 2023-07-25 20:27:23
rubidium@openttd.org
Change: improve wording of help (host instead of IP) and update man page
2 files changed with 22 insertions and 14 deletions:
0 comments (0 inline, 0 general)
docs/openttd.6
Show inline comments
 
.\"                                      Hey, EMACS: -*- nroff -*-
 
.\" Please adjust this date whenever revising the manpage.
 
.Dd October 13, 2014
 
.Dd August 12, 2023
 
.Dt OPENTTD 6
 
.Os
 
.Sh NAME
 
.Nm openttd
 
.Nd open source clone of the Microprose game \(lqTransport Tycoon Deluxe\(rq
 
.Sh SYNOPSIS
 
.Nm
 
.Op Fl efhx
 
.Op Fl efhQxX
 
.Op Fl b Ar blitter
 
.Op Fl c Ar config_file
 
.Op Fl d Op Ar level | Ar cat Ns = Ns Ar lvl Ns Op , Ns Ar ...
 
.Op Fl D Oo Ar host Oc Ns Op : Ns Ar port
 
.Op Fl g Op Ar savegame
 
.Op Fl G Ar seed
 
.Op Fl I Ar graphicsset
 
.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 Ns Oo : Ns Ar port Oc Ns Op # Ns Ar player
 
.Op Fl n Ar host Ns Oo : Ns Ar port Oc Ns Op # Ns Ar company
 
.Op Fl p Ar password
 
.Op Fl P Ar password
 
.Op Fl q Ar savegame
 
.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 "-n host[:port][#player]"
 
.Bl -tag -width "-n host[:port][#company]"
 
.It Fl b Ar blitter
 
Select the blitter
 
.Ar blitter ;
 
see
 
.Fl h
 
for a full list.
 
.It Fl c Ar config_file
 
Use
 
.Ar config_file
 
instead of
 
.Pa openttd.cfg .
 
.It Fl d Ar [level]
 
@@ -74,53 +74,59 @@ the search paths.
 
Seed the pseudo random number generator with
 
.Ar seed .
 
.It Fl h
 
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
 
Select the graphics set
 
.Ar graphicsset ;
 
see
 
.Fl h
 
for a full list.
 
.It Fl l Ar host Ns Op : Ns Ar port
 
Redirect
 
.Fn DEBUG
 
output; see
 
.Fl D .
 
Redirect debug output; see
 
.Fl d .
 
.It Fl m Ar driver
 
Select the music driver
 
.Ar driver ;
 
see
 
.Fl h
 
for a full list.
 
.It Fl M Ar musicset
 
Select the music set
 
.Ar musicset ;
 
see
 
.Fl h
 
for a full list.
 
.It Fl n Ar host Ns Oo : Ns Ar port Oc Ns Op # Ns Ar player
 
Join a network game, optionally specifying a port to connect to and player to
 
.It Fl n Ar host Ns Oo : Ns Ar port Oc Ns Op # Ns Ar company
 
Join a network game, optionally specifying a port to connect to and company to
 
play as.
 
.It Fl p Ar password
 
Password used to join server.
 
Only useful with
 
.Fl n .
 
.It Fl P Ar password
 
Password used to join company.
 
Only useful with
 
.Fl n .
 
.It Fl q Ar savegame
 
Write some information about the specified savegame and exit.
 
.It Fl Q
 
Don't scan for/load NewGRF files on startup.
 
.Pp
 
Passing
 
.Fl Q
 
twice (so,
 
.Fl QQ
 
) will disable NewGRF scanning/loading entirely.
 
.It Fl r Ar width Ns x Ns Ar height
 
Set the resolution to
 
.Ar width
 
\(mu
 
.Ar height
 
pixels.
 
.It Fl s Ar driver
 
Select the sound driver
 
.Ar driver ;
 
see
 
.Fl h
 
for a full list.
 
@@ -132,22 +138,24 @@ see
 
for a full list.
 
.It Fl t Ar year
 
Set the starting year to
 
.Ar year .
 
.It Fl v Ar driver
 
Select the video driver
 
.Ar driver ;
 
see
 
.Fl h
 
for a full list.
 
.It Fl x
 
Do not automatically save to config file on exit.
 
.It Fl X
 
Do not use global folders to search for files.
 
.El
 
.Sh SEE ALSO
 
.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
 
is a free reimplementation.
src/openttd.cpp
Show inline comments
 
@@ -157,29 +157,29 @@ static void ShowHelp()
 
		"Command line options:\n"
 
		"  -v drv              = Set video driver (see below)\n"
 
		"  -s drv              = Set sound driver (see below)\n"
 
		"  -m drv              = Set music driver (see below)\n"
 
		"  -b drv              = Set the blitter to use (see below)\n"
 
		"  -r res              = Set resolution (for instance 800x600)\n"
 
		"  -h                  = Display this help text\n"
 
		"  -t year             = Set starting year\n"
 
		"  -d [[fac=]lvl[,...]]= Debug mode\n"
 
		"  -e                  = Start Editor\n"
 
		"  -g [savegame]       = Start new/save game immediately\n"
 
		"  -G seed             = Set random seed\n"
 
		"  -n ip[:port][#company]= Join network game\n"
 
		"  -n host[:port][#company]= Join network game\n"
 
		"  -p password         = Password to join server\n"
 
		"  -P password         = Password to join company\n"
 
		"  -D [ip][:port]      = Start dedicated server\n"
 
		"  -l ip[:port]        = Redirect Debug()\n"
 
		"  -D [host][:port]    = Start dedicated server\n"
 
		"  -l host[:port]      = Redirect Debug()\n"
 
#if !defined(_WIN32)
 
		"  -f                  = Fork into the background (dedicated only)\n"
 
#endif
 
		"  -I graphics_set     = Force the graphics set (see below)\n"
 
		"  -S sounds_set       = Force the sounds set (see below)\n"
 
		"  -M music_set        = Force the music set (see below)\n"
 
		"  -c config_file      = Use 'config_file' instead of 'openttd.cfg'\n"
 
		"  -x                  = Never save configuration changes to disk\n"
 
		"  -X                  = Don't use global folders to search for files\n"
 
		"  -q savegame         = Write some information about the savegame and exit\n"
 
		"  -Q                  = Don't scan for/load NewGRF files on startup\n"
 
		"  -QQ                 = Disable NewGRF scanning/loading entirely\n"
 
@@ -539,25 +539,25 @@ int openttd_main(int argc, char *argv[])
 
			musicdriver = "null";
 
			sounddriver = "null";
 
			videodriver = "dedicated";
 
			blitter = "null";
 
			dedicated = true;
 
			SetDebugString("net=4", ShowInfoI);
 
			if (mgo.opt != nullptr) {
 
				scanner->dedicated_host = ParseFullConnectionString(mgo.opt, scanner->dedicated_port);
 
			}
 
			break;
 
		case 'f': _dedicated_forks = true; break;
 
		case 'n':
 
			scanner->connection_string = mgo.opt; // IP:port#company parameter
 
			scanner->connection_string = mgo.opt; // host:port#company parameter
 
			break;
 
		case 'l':
 
			debuglog_conn = mgo.opt;
 
			break;
 
		case 'p':
 
			scanner->join_server_password = mgo.opt;
 
			break;
 
		case 'P':
 
			scanner->join_company_password = mgo.opt;
 
			break;
 
		case 'r': ParseResolution(&resolution, mgo.opt); break;
 
		case 't': scanner->startyear = atoi(mgo.opt); break;
0 comments (0 inline, 0 general)