Translations update
[openttd/fttd.git] / docs / openttd.6
blob4e04be32c1ea8368c7ec780a9e815d8120192d6a
1 .\"                                      Hey, EMACS: -*- nroff -*-
2 .\" Please adjust this date whenever revising the manpage.
3 .Dd October 13, 2014
4 .Dt OPENTTD 6
5 .Os
6 .Sh NAME
7 .Nm openttd
8 .Nd open source clone of the Microprose game \(lqTransport Tycoon Deluxe\(rq
9 .Sh SYNOPSIS
10 .Nm
11 .Op Fl efhx
12 .Op Fl b Ar blitter
13 .Op Fl c Ar config_file
14 .Op Fl d Op Ar level | Ar cat Ns = Ns Ar lvl Ns Op , Ns Ar ...
15 .Op Fl D Oo Ar host Oc Ns Op : Ns Ar port
16 .Op Fl g Op Ar savegame
17 .Op Fl G Ar seed
18 .Op Fl I Ar graphicsset
19 .Op Fl l Ar host Ns Op : Ns Ar port
20 .Op Fl m Ar driver
21 .Op Fl M Ar musicset
22 .Op Fl n Ar host Ns Oo : Ns Ar port Oc Ns Op # Ns Ar player
23 .Op Fl p Ar password
24 .Op Fl P Ar password
25 .Op Fl q Ar savegame
26 .Op Fl r Ar width Ns x Ns Ar height
27 .Op Fl s Ar driver
28 .Op Fl S Ar soundset
29 .Op Fl t Ar year
30 .Op Fl v Ar driver
31 .Sh OPTIONS
32 .Bl -tag -width "-n host[:port][#player]"
33 .It Fl b Ar blitter
34 Select the blitter
35 .Ar blitter ;
36 see
37 .Fl h
38 for a full list.
39 .It Fl c Ar config_file
40 Use
41 .Ar config_file
42 instead of
43 .Pa openttd.cfg .
44 .It Fl d Ar [level]
45 Set debug verbosity for all categories to
46 .Ar level ,
47 or 1 if omitted.
48 .It Fl d Ar cat Ns = Ns Ar lvl Ns Op , Ns Ar ...
49 Set debug verbosity to
50 .Ar lvl
51 for a specific category
52 .Ar cat .
53 .It Fl D Oo Ar host Oc Ns Op : Ns Ar port
54 Start a dedicated server.
55 .Pp
56 Network debug level will be set to 6.
57 If you want to change this, set
58 .Fl d
59 after setting
60 .Fl D .
61 .It Fl e
62 Start in world editor mode.
63 .It Fl f
64 Fork into background (dedicated server only, see
65 .Fl D ) .
66 .It Fl g Op Ar savegame
67 Load
68 .Ar savegame
69 at start or start a new game if omitted.
70 .Ar savegame
71 must be either an absolute path or one relative to the current path or one of
72 the search paths.
73 .It Fl G Ar seed
74 Seed the pseudo random number generator with
75 .Ar seed .
76 .It Fl h
77 Display a summary of all options and list all the available AIs, blitters,
78 sound, music and video drivers, graphics sets and sound sets.
79 .It Fl I Ar graphicsset
80 Select the graphics set
81 .Ar graphicsset ;
82 see
83 .Fl h
84 for a full list.
85 .It Fl l Ar host Ns Op : Ns Ar port
86 Redirect
87 .Fn DEBUG
88 output; see
89 .Fl D .
90 .It Fl m Ar driver
91 Select the music driver
92 .Ar driver ;
93 see
94 .Fl h
95 for a full list.
96 .It Fl M Ar musicset
97 Select the music set
98 .Ar musicset ;
99 see
100 .Fl h
101 for a full list.
102 .It Fl n Ar host Ns Oo : Ns Ar port Oc Ns Op # Ns Ar player
103 Join a network game, optionally specifying a port to connect to and player to
104 play as.
105 .It Fl p Ar password
106 Password used to join server.
107 Only useful with
108 .Fl n .
109 .It Fl P Ar password
110 Password used to join company.
111 Only useful with
112 .Fl n .
113 .It Fl q Ar savegame
114 Write some information about the specified savegame and exit.
115 .It Fl r Ar width Ns x Ns Ar height
116 Set the resolution to
117 .Ar width
118 \(mu
119 .Ar height
120 pixels.
121 .It Fl s Ar driver
122 Select the sound driver
123 .Ar driver ;
125 .Fl h
126 for a full list.
127 .It Fl S Ar soundset
128 Select the sound set
129 .Ar soundset ;
131 .Fl h
132 for a full list.
133 .It Fl t Ar year
134 Set the starting year to
135 .Ar year .
136 .It Fl v Ar driver
137 Select the video driver
138 .Ar driver ;
140 .Fl h
141 for a full list.
142 .It Fl x
143 Do not automatically save to config file on exit.
145 .Sh SEE ALSO
146 .Lk https://wiki.openttd.org "Wiki"
147 (includes community maintained manual),
148 .Lk https://forum.openttd.org "Forum",
149 .Lk https://www.openttd.org "News"
150 .Sh HISTORY
151 Transport Tycoon Deluxe was written by Chris Sawyer and published by Microprose.
153 is a free reimplementation.