]> git.mxchange.org Git - flightgear.git/blob - man/fgfs.1.in
{fatal,modal}MessageBox: Use Qt on Linux when available
[flightgear.git] / man / fgfs.1.in
1 .\" Copyright (C) 2002 Cameron Moore
2 .\"
3 .\" This program is free software; you can redistribute it and/or
4 .\" modify it under the terms of the GNU General Public License
5 .\" as published by the Free Software Foundation; either version 2
6 .\" of the License, or (at your option) any later version.
7 .\"
8 .\" This program is distributed in the hope that it will be useful,
9 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
10 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 .\" GNU General Public License for more details.
12 .\"
13 .\" You should have received a copy of the GNU General Public License
14 .\" along with this program; if not, write to the Free Software
15 .\" Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
16 .\" Or try here: http://www.fsf.org/copyleft/gpl.html
17 .\"
18 .TH FGFS 1 "February 2012" "@VERSION@" "@PACKAGE@"
19 .SH NAME
20 fgfs \- FlightGear Flight Simulator
21 .SH SYNOPSIS
22 .B "fgfs "
23 [ option ] ...
24 .SH DESCRIPTION
25 .B FlightGear
26 is a free, open-source, multi-platform, and sophisticated flight
27 simulator framework for the development and pursuit of interesting
28 flight simulator ideas.
29 For more information visit <http://www.flightgear.org>.
30 .SH OPTIONS
31 .TP
32 .BI "--adf=" "[rotation:]frequency"
33 Specify the initial ADF radio frequency.  Optionally may be preceded by a
34 card rotation.
35 .TP
36 .BI "--aero=" "name"
37 Specify aerodynamics model to load.
38 .TP
39 .BI "--aircraft=" "name"
40 Specify aircraft to load.
41 .TP
42 .BI "--aircraft-dir=" "path"
43 Specify the exact directory to use for the aircraft (normally not required,
44 but may be useful for testing).
45 .TP
46 .BI "--airport=" "id"
47 Specify starting postion by airport ID.
48 .TP
49 .BI "--altitude=" "value"
50 Specify starting altitude (in feet unless \-\-units\-meters specified).
51 .TP
52 .BI "--atc610x"
53 Enable atc610x interface.
54 .TP
55 .BI "--atlas=" "medium" "," "direction" "," "hz" "," "options" "," "..."
56 Open an IO connection using the Atlas protocol.
57 .TP
58 .BI "--bpp=" "depth"
59 Specify the bits per pixel for the renderer.
60 .TP
61 .BI "--browser-app=" "path"
62 Specify location of your web browser.
63 .TP
64 .BI "--callsign=" "value"
65 Specify a unique name for multiplayer play.
66 .TP
67 .BI "--ceiling=" "value[:thickness]"
68 Create an overcast ceiling (feet above sea level).  May optionally specify
69 a thickness (feet) which defaults to 2000.
70 .TP
71 .BI "--com1=" "frequency"
72 Set the initial COM1 radio frequency.
73 .TP
74 .BI "--com2=" "frequency"
75 Set the initial COM2 radio frequency.
76 .TP
77 .BI "--config=" "path"
78 Load additional properties from path.  Multiple instances of this
79 option are recognized.
80 .TP
81 .BI "--dme=" "{nav1|nav2|frequency}"
82 Specify the NAV radio from which to slave the ADF or set its internal
83 frequency.
84 .TP
85 .B "--disable-anti-alias-hud"
86 Disable anti-aliased HUD.
87 .TP
88 .B "--disable-auto-coordination"
89 Disable auto coordination between aileron and rudder.
90 .TP
91 .B "--disable-clock-freeze"
92 Disable clock freezing so that time advances normally.
93 .TP
94 .B "--disable-clouds"
95 Disable cloud rendering.
96 .TP
97 .B "--disable-distance-attenuation"
98 Disable runway light distance attenuation.
99 .TP
100 .B "--disable-enhanced-lighting"
101 Disable enhanced runway lighting.
102 .TP
103 .B "--disable-freeze"
104 Start out in a running state.
105 .TP
106 .B "--disable-fuel-freeze"
107 Disable fuel freeze (enabling fuel consumption).
108 .TP
109 .B "--disable-fullscreen"
110 Disable fullscreen mode.
111 .TP
112 .B "--disable-horizon-effect"
113 Disable celestial body growth illusion near the horizon..
114 .TP
115 .B "--disable-hud"
116 Disable 2D HUD.
117 .TP
118 .B "--disable-hud-3d"
119 Disable 3D HUD.
120 .TP
121 .B "--disable-mouse-pointer"
122 Disable extra mouse pointer.
123 .TP
124 .B "--disable-panel"
125 Disable instrument panel.
126 .TP
127 .B "--disable-random-objects"
128 Disable random scenery objects (buildings, trees, etc).
129 .TP
130 .B "--disable-sound"
131 Disable sound effects.
132 .TP
133 .B "--disable-specular-highlight"
134 Disable specular reflections on textured objects.
135 .TP
136 .B "--disable-splash-screen"
137 Disable splash screen.
138 .TP
139 .B "--disable-wireframe"
140 Disable wireframe drawing mode.
141 .TP
142 .B "--enable-anti-alias-hud"
143 Enable anti-aliased HUD.
144 .TP
145 .B "--enable-auto-coordination"
146 Enable auto coordination between aileron and rudder.
147 .TP
148 .B "--enable-clock-freeze"
149 Enable clock freezing so that time does not advance.
150 .TP
151 .B "--enable-clouds"
152 Enable cloud rendering.
153 .TP
154 .B "--enable-distance-attenuation"
155 Enable runway light distance attenuation.
156 .TP
157 .B "--enable-enhanced-lighting"
158 Enable enhanced runway lighting.
159 .TP
160 .B "--enable-freeze"
161 Start out in a frozen state.
162 .TP
163 .B "--enable-fuel-freeze"
164 Enable fuel freeze (disabling fuel consumption).
165 .TP
166 .B "--enable-fullscreen"
167 Enable fullscreen mode.
168 .TP
169 .B "--enable-horizon-effect"
170 Enable celestial body growth illusion near the horizon.
171 .TP
172 .B "--enable-hud"
173 Enable 2D HUD.
174 .TP
175 .B "--enable-hud-3d"
176 Enable 3D HUD.
177 .TP
178 .B "--enable-mouse-pointer"
179 Enable extra mouse pointer (i.e. for full screen voodoo/voodoo-II
180 based cards.)
181 .TP
182 .B "--enable-panel"
183 Enable instrument panel.
184 .TP
185 .B "--enable-random-objects"
186 Enable random scenery objects (buildings, trees, etc).
187 .TP
188 .B "--enable-sound"
189 Enable sound effects.
190 .TP
191 .B "--enable-specular-highlight"
192 Enable specular reflections on textured objects.
193 .TP
194 .B "--enable-splash-screen"
195 Enable splash screen.
196 .TP
197 .B "--enable-wireframe"
198 Enable wireframe drawing mode.
199 .TP
200 .BI "--failure=" "system"
201 Fail a system on the aircraft.  System may be one of pitot, static, vacuum,
202 or electrical.  Multiple instances allowed.
203 .TP
204 .BI "--fdm=" "name"
205 Specify the flight dynamics model to use.  Name may be one of jsb, larcsim,
206 yasim, magic, balloon, ada, external, or null.
207 .TP
208 .BI "--fg-aircraft=" "path"
209 Specify an additional path to search for aircraft directories. (can be repeated)
210 .TP
211 .BI "--fg-root=" "path"
212 Specify the root path for data files.
213 .TP
214 .BI "--fg-scenery=" "path"
215 Specify the base path for scenery data.
216 .TP
217 .BI "--fix=" "ID"
218 Specify starting position relative to a fix.
219 .TP
220 .BI "--flight-plan=" "file"
221 Read all waypoints from the specified file.
222 .TP
223 .B "--fog-disable"
224 Disable fog rendering.
225 .TP
226 .B "--fog-fastest"
227 Enable fastest fog rendering.
228 .TP
229 .B "--fog-nicest"
230 Enable nicest fog rendering.
231 .TP
232 .BI "--fov=" "degrees"
233 Specify initial field of view angle (degrees).
234 .TP
235 .BI "--garmin=" "medium" "," "direction" "," "hz" "," "options" "," "..."
236 Open an IO connection using the Garmin GPS protocol.
237 .TP
238 .BI "--generic=" "params"
239 Open connection using the serial port protocol.  See README.IO for details.
240 .TP
241 .BI "--geometry=" "WxH"
242 Specify window geometry (ie. 640x480, 800x600, etc).
243 .TP
244 .BI "--heading=" "degrees"
245 Specify heading or yaw angle (degrees).
246 .TP
247 .BR "--help" ", " "-h"
248 Show a brief help message.  Use \-\-verbose,\-v for a full listing of options.
249 .TP
250 .BI "--httpd=" "port"
251 Start an HTTP server on the specified port.
252 .TP
253 .B "--hud-culled"
254 HUD displays percentage of triangles culled.
255 .TP
256 .B "--hud-tris"
257 HUD displays number of triangles rendered.
258 .TP
259 .B "--in-air"
260 Start up in the air.  This is implied when specifying an initial
261 altitude above ground level.
262 .TP
263 .BI "--joyclient=" "medium" "," "direction" "," "hz" "," "options" "," "..."
264 Open an IO connection to an Agwagon joystick.
265 .TP
266 .BI "--jpg-httpd=" "port"
267 Start a screen shot HTTP server on the specified port.
268 .TP
269 .BI "--lat=" "degrees"
270 Specify starting latitude (degrees).
271 .TP
272 .BI "--log-level=" "value"
273 Set log level for this session (1..5 where 1=verbose, 5=quiet).
274 .TP
275 .BI "--lon=" "degrees"
276 Specify starting longitude (degrees).
277 .TP
278 .BI "--mach=" "value"
279 Specify initial mach number.
280 .TP
281 .BI "--model-hz=" "n"
282 Run the FDM at this rate (iterations per second).
283 .TP
284 .BI "--multiplay=" "direction,hz,address,port"
285 Specify multiplayer communication settings.  Multiple instances allowed.
286 .TP
287 .BI "--native-ctrls=" "medium" "," "direction" "," "hz" "," "options" "," "..."
288 Open an IO connection using the FlightGear Native Controls protocol.
289 .TP
290 .BI "--native-fdm=" "medium" "," "direction" "," "hz" "," "options" "," "..."
291 Open an IO connection using the FlightGear Native FDM protocol.
292 .TP
293 .BI "--native=" "medium" "," "direction" "," "hz" "," "options" "," "..."
294 Open an IO connection using the FlightGear Native protocol.
295 .TP
296 .BI "--nav1=" "[radial:]frequency"
297 Specify the initial NAV1 radio frequency.  Optionally may be preceded by a
298 radial value.
299 .TP
300 .BI "--nav2=" "[radial:]frequency"
301 Specify the initial NAV2 radio frequency.  Optionally may be preceded by a
302 radial value.
303 .TP
304 .BI "--ndb=" "ID"
305 Specify starting position relative to an NDB.
306 .TP
307 .BI "--nmea=" "medium" "," "direction" "," "hz" "," "options" "," "..."
308 Open an IO connection using the NMEA protocol.
309 .TP
310 .B "--notrim"
311 Do not attempt to trim the model when initializing the JSBSim FDM.
312 .TP
313 .BI "--offset-azimuth=" "degrees"
314 specify heading to threshhold (degrees).
315 .TP
316 .BI "--offset-distance=" "nm"
317 Specify distance to threshhold (nautical miles).
318 .TP
319 .B "--on-ground"
320 Start up at ground level.
321 .TP
322 .BI "--opengc=" "medium" "," "direction" "," "hz" "," "options" "," "..."
323 Open an IO connect to an OpenGC host.
324 .TP
325 .BI "--pitch=" "degrees"
326 Specify pitch angle (degrees).
327 .TP
328 .BI "--props=" "medium" "," "direction" "," "hz" "," "options" "," "..."
329 Specify an IO device in which to provide an interactive property manager.
330 .TP
331 .BI "--prop:name=" "value"
332 set property <name> to <value>.
333 .TP
334 .BI "--pve=" "medium" "," "direction" "," "hz" "," "options" "," "..."
335 Open an IO connection using the PVE (Provision Entertainment) protocol.
336 .TP
337 .B "--random-wind"
338 Randomize initial wind parameters.  See also: \-\-wind.
339 .TP
340 .BI "--ray=" "medium" "," "direction" "," "hz" "," "options" "," "..."
341 Open an IO connection to a "RayWoodworth" motion chair.
342 .TP
343 .BI "--roll=" "degrees"
344 Specify roll angle (degrees).
345 .TP
346 .BI "--rul=" "medium" "," "direction" "," "hz" "," "options" "," "..."
347 Open an IO connection using the RUL protocol.
348 .TP
349 .B "--shading-flat"
350 Enable flat shading.
351 .TP
352 .B "--shading-smooth"
353 Enable smooth shading.
354 .TP
355 .B "--show-aircraft"
356 Show a listing of all available aircraft.
357 .TP
358 .BI "--speed=" "n"
359 Run the FDM "n" times faster than real-time.
360 .TP
361 .BI "--start-date-gmt=" "yyyy:mm:dd:hh:mm:ss"
362 Specify a starting date/time with respect to GMT (Greenwich Mean Time).
363 .TP
364 .BI "--start-date-lat=" "yyyy:mm:dd:hh:mm:ss"
365 Specify a starting date/time with respect to Local Aircraft Time.
366 .TP
367 .BI "--start-date-sys=" "yyyy:mm:dd:hh:mm:ss"
368 Specify a starting date/time with respect to your local system time.
369 .TP
370 .BI "--telnet=" "port"
371 Start a telnet interface to the property manager on the specified port.
372 .TP
373 .BI "--timeofday=" "value"
374 Specify a time of day.  Value may be one of dawn, dusk, noon, or midnight.
375 .TP
376 .B "--time-match-local"
377 Synchronize time with local real-world time.
378 .TP
379 .B "--time-match-real"
380 Synchronize time with the real-world time.
381 .TP
382 .BI "--time-offset=" "[+-]hh:mm:ss"
383 Specify a time offset with respect to the current time.
384 .TP
385 .BI "--trace-read=" "property"
386 Trace the reads for a property.  Multiple instances allowed.
387 .TP
388 .BI "--trace-write=" "property"
389 Trace the writes for a property.  Multiple instances allowed.
390 .TP
391 .BI "--turbulence=" "value"
392 Specify turbulence from 0.0 (calm) to 1.0 (severe).
393 .TP
394 .BI "--uBody=" "value"
395 Specify velocity along the body X axis (feet per second unless
396 \-\-units\-meters specified).
397 .TP
398 .B "--units-feet"
399 Use feet instead of meters.  Affects other options as well as the
400 values displayed by the HUD.
401 .TP
402 .B "--units-meters"
403 Use meters instead of feet.  Affects other options as well as the
404 values displayed by the HUD.
405 .TP
406 .BI "--vBody=" "value"
407 Specify velocity along the body Y axis (feet per second unless
408 \-\-units\-meters specified).
409 .TP
410 .BI "--vc=" "knots"
411 Specify initial airspeed (knots).
412 .TP
413 .BI "--view-offset=" "value"
414 Specify the default forward view direction as an offset from straight
415 ahead.  Allowable values are LEFT, RIGHT, CENTER, or a specific number
416 of degrees.
417 .TP
418 .B "--verbose, -v"
419 Show verbose help message.
420 .TP
421 .BI "--visibility-miles=" "value"
422 Specify initial visibility (miles).
423 .TP
424 .BI "--visibility=" "value"
425 Specify initial visibility (meters).
426 .TP
427 .BI "--vor=" "ID"
428 Specify starting position relative to a VOR.
429 .TP
430 .BI "--wBody=" "value"
431 Specify velocity along the body Z axis (feet per second unless
432 \-\-units-meters specified).
433 .TP
434 .BI "--wind=" "DIR@SPEED"
435 Specify wind coming from DIR (degrees) at SPEED (knots).  Values may be
436 specified as a range by using a colon separator; for example, 180:220@10:15.
437 .TP
438 .BI "--wp=" "ID[@alt]"
439 Specify a waypoint for the GC autopilot.  Multiple instances of this
440 option are recognized in build a route.
441 .SH ENVIRONMENT
442 .TP
443 .B $FG_ROOT
444 Path used to locate data files.
445 .SH FILES
446 ~/.fgfsrc
447 .RS
448 Per user configuration file.
449 .RE
450 .TP
451 $FG_ROOT/system.fgfsrc
452 .RS
453 System-wide configuration file in command line format.
454 .RE
455 .TP
456 $FG_ROOT/preferences.xml
457 .RS
458 System-wide configuration file in XML format.
459 .RE
460 .TP
461 $FG_ROOT/keyboard.xml
462 .RS
463 Keyboard bindings.
464 .RE
465 .TP
466 $FG_ROOT/Input/Joysticks/
467 .RS
468 Joystick bindings.
469 .RE
470 .TP
471 $FG_ROOT/mice.xml
472 .RS
473 Mouse bindings.
474 .RE
475 .SH BUGS
476 Send bug reports to <flightgear\-devel@lists.sourceforge.net> or visit
477 <http://code.google.com/p/flightgear\-bugs>.
478 .SH SEE ALSO
479 fgjs(1), fgpanel(1), js_demo(1), terrasync(1)
480 .SH AUTHORS
481 Curt L. Olson, et al.  See
482 .I Thanks
483 file for a list of contributors.