]> git.mxchange.org Git - flightgear.git/blob - man/fgfs.1.in
Update man pages.
[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 aircraft model directory relative to the path of the
44 executable.  This is used for UIUC aircraft only.
45 .TP
46 .BI "--airport-id=" "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 "--control=" "mode"
82 Primary control mode (joystick, keyboard, mouse).
83 .TP
84 .BI "--dme=" "{nav1|nav2|frequency}"
85 Specify the NAV radio from which to slave the ADF or set its internal
86 frequency.
87 .TP
88 .B "--disable-anti-alias-hud"
89 Disable anti-aliased HUD.
90 .TP
91 .B "--disable-auto-coordination"
92 Disable auto coordination between aileron and rudder.
93 .TP
94 .B "--disable-clock-freeze"
95 Disable clock freezing so that time advances normally.
96 .TP
97 .B "--disable-clouds"
98 Disable cloud rendering.
99 .TP
100 .B "--disable-distance-attenuation"
101 Disable runway light distance attenuation.
102 .TP
103 .B "--disable-enhanced-lighting"
104 Disable enhanced runway lighting.
105 .TP
106 .B "--disable-freeze"
107 Start out in a running state.
108 .TP
109 .B "--disable-fuel-freeze"
110 Disable fuel freeze (enabling fuel consumption).
111 .TP
112 .B "--disable-fullscreen"
113 Disable fullscreen mode.
114 .TP
115 .B "--disable-game-mode"
116 Disable fullscreen game mode.
117 .TP
118 .B "--disable-horizon-effect"
119 Disable celestial body growth illusion near the horizon..
120 .TP
121 .B "--disable-hud"
122 Disable 2D HUD.
123 .TP
124 .B "--disable-hud-3d"
125 Disable 3D HUD.
126 .TP
127 .B "--disable-intro-music"
128 Disable introduction music.
129 .TP
130 .B "--disable-mouse-pointer"
131 Disable extra mouse pointer.
132 .TP
133 .B "--disable-network-olk"
134 Disable Multi-pilot mode.
135 .TP
136 .B "--disable-panel"
137 Disable instrument panel.
138 .TP
139 .B "--disable-random-objects"
140 Disable random scenery objects (buildings, trees, etc).
141 .TP
142 .B "--disable-skyblend"
143 Disable sky blending.
144 .TP
145 .B "--disable-sound"
146 Disable sound effects.
147 .TP
148 .B "--disable-specular-highlight"
149 Disable specular reflections on textured objects.
150 .TP
151 .B "--disable-splash-screen"
152 Disable splash screen.
153 .TP
154 .B "--disable-textures"
155 Disable textures.
156 .TP
157 .B "--disable-wireframe"
158 Disable wireframe drawing mode.
159 .TP
160 .B "--enable-anti-alias-hud"
161 Enable anti-aliased HUD.
162 .TP
163 .B "--enable-auto-coordination"
164 Enable auto coordination between aileron and rudder.
165 .TP
166 .B "--enable-clock-freeze"
167 Enable clock freezing so that time does not advance.
168 .TP
169 .B "--enable-clouds"
170 Enable cloud rendering.
171 .TP
172 .B "--enable-distance-attenuation"
173 Enable runway light distance attenuation.
174 .TP
175 .B "--enable-enhanced-lighting"
176 Enable enhanced runway lighting.
177 .TP
178 .B "--enable-freeze"
179 Start out in a frozen state.
180 .TP
181 .B "--enable-fuel-freeze"
182 Enable fuel freeze (disabling fuel consumption).
183 .TP
184 .B "--enable-fullscreen"
185 Enable fullscreen mode.
186 .TP
187 .B "--enable-game-mode"
188 Enable fullscreen game mode.
189 .TP
190 .B "--enable-horizon-effect"
191 Enable celestial body growth illusion near the horizon.
192 .TP
193 .B "--enable-hud"
194 Enable 2D HUD.
195 .TP
196 .B "--enable-hud-3d"
197 Enable 3D HUD.
198 .TP
199 .B "--enable-intro-music"
200 Enable introduction music.
201 .TP
202 .B "--enable-mouse-pointer"
203 Enable extra mouse pointer (i.e. for full screen voodoo/voodoo-II
204 based cards.)
205 .TP
206 .B "--enable-network-olk"
207 Enable Multi-pilot mode.
208 .TP
209 .B "--enable-panel"
210 Enable instrument panel.
211 .TP
212 .B "--enable-random-objects"
213 Enable random scenery objects (buildings, trees, etc).
214 .TP
215 .B "--enable-skyblend"
216 Enable sky blending.
217 .TP
218 .B "--enable-sound"
219 Enable sound effects.
220 .TP
221 .B "--enable-specular-highlight"
222 Enable specular reflections on textured objects.
223 .TP
224 .B "--enable-splash-screen"
225 Enable splash screen.
226 .TP
227 .B "--enable-textures"
228 Enable textures.
229 .TP
230 .B "--enable-wireframe"
231 Enable wireframe drawing mode.
232 .TP
233 .BI "--failure=" "system"
234 Fail a system on the aircraft.  System may be one of pitot, static, vacuum,
235 or electrical.  Multiple instances allowed.
236 .TP
237 .BI "--fdm=" "name"
238 Specify the flight dynamics model to use.  Name may be one of jsb, larcsim,
239 yasim, magic, balloon, ada, external, or null.
240 .TP
241 .BI "--fg-root=" "path"
242 Specify the root path for data files.
243 .TP
244 .BI "--fg-scenery=" "path"
245 Specify the base path for scenery data.
246 .TP
247 .BI "--fix=" "ID"
248 Specify starting position relative to a fix.
249 .TP
250 .BI "--flight-plan=" "file"
251 Read all waypoints from the specified file.
252 .TP
253 .B "--fog-disable"
254 Disable fog rendering.
255 .TP
256 .B "--fog-fastest"
257 Enable fastest fog rendering.
258 .TP
259 .B "--fog-nicest"
260 Enable nicest fog rendering.
261 .TP
262 .BI "--fov=" "degrees"
263 Specify initial field of view angle (degrees).
264 .TP
265 .BI "--garmin=" "medium" "," "direction" "," "hz" "," "options" "," "..."
266 Open an IO connection using the Garmin GPS protocol.
267 .TP
268 .BI "--generic=" "params"
269 Open connection using the serial port protocol.  See README.IO for details.
270 .TP
271 .BI "--geometry=" "WxH"
272 Specify window geometry (ie. 640x480, 800x600, etc).
273 .TP
274 .BI "--heading=" "degrees"
275 Specify heading or yaw angle (degrees).
276 .TP
277 .BR "--help" ", " "-h"
278 Show a brief help message.  Use --verbose,-v for a full listing of options.
279 .TP
280 .BI "--httpd=" "port"
281 Start an HTTP server on the specified port.
282 .TP
283 .B "--hud-culled"
284 HUD displays percentage of triangles culled.
285 .TP
286 .B "--hud-tris"
287 HUD displays number of triangles rendered.
288 .TP
289 .B "--in-air"
290 Start up in the air.  This is implied when specifying an initial
291 altitude above ground level.
292 .TP
293 .BI "--joyclient=" "medium" "," "direction" "," "hz" "," "options" "," "..."
294 Open an IO connection to an Agwagon joystick.
295 .TP
296 .BI "--jpg-httpd=" "port"
297 Start a screen shot HTTP server on the specified port.
298 .TP
299 .BI "--lat=" "degrees"
300 Specify starting latitude (degrees).
301 .TP
302 .BI "--log-level=" "value"
303 Set log level for this session (1..5 where 1=verbose, 5=quiet).
304 .TP
305 .BI "--lon=" "degrees"
306 Specify starting longitude (degrees).
307 .TP
308 .BI "--mach=" "value"
309 Specify initial mach number.
310 .TP
311 .BI "--model-hz=" "n"
312 Run the FDM at this rate (iterations per second).
313 .TP
314 .BI "--multiplay=" "direction,hz,address,port"
315 Specify multiplayer communication settings.  Multiple instances allowed.
316 .TP
317 .BI "--native-ctrls=" "medium" "," "direction" "," "hz" "," "options" "," "..."
318 Open an IO connection using the FlightGear Native Controls protocol.
319 .TP
320 .BI "--native-fdm=" "medium" "," "direction" "," "hz" "," "options" "," "..."
321 Open an IO connection using the FlightGear Native FDM protocol.
322 .TP
323 .BI "--native=" "medium" "," "direction" "," "hz" "," "options" "," "..."
324 Open an IO connection using the FlightGear Native protocol.
325 .TP
326 .BI "--nav1=" "[radial:]frequency"
327 Specify the initial NAV1 radio frequency.  Optionally may be preceded by a
328 radial value.
329 .TP
330 .BI "--nav2=" "[radial:]frequency"
331 Specify the initial NAV2 radio frequency.  Optionally may be preceded by a
332 radial value.
333 .TP
334 .BI "--ndb=" "ID"
335 Specify starting position relative to an NDB.
336 .TP
337 .B "--net-hud"
338 Enable network information in the HUD.
339 .TP
340 .BI "--net-id=" "name"
341 Specify your callsign.
342 .TP
343 .BI "--nmea=" "medium" "," "direction" "," "hz" "," "options" "," "..."
344 Open an IO connection using the NMEA protocol.
345 .TP
346 .B "--notrim"
347 Do not attempt to trim the model when initializing the JSBSim FDM.
348 .TP
349 .BI "--offset-azimuth=" "degrees"
350 specify heading to threshhold (degrees).
351 .TP
352 .BI "--offset-distance=" "nm"
353 Specify distance to threshhold (nautical miles).
354 .TP
355 .B "--on-ground"
356 Start up at ground level.
357 .TP
358 .BI "--opengc=" "medium" "," "direction" "," "hz" "," "options" "," "..."
359 Open an IO connect to an OpenGC host.
360 .TP
361 .BI "--pitch=" "degrees"
362 Specify pitch angle (degrees).
363 .TP
364 .BI "--props=" "medium" "," "direction" "," "hz" "," "options" "," "..."
365 Specify an IO device in which to provide an interactive property manager.
366 .TP
367 .BI "--prop:name=" "value"
368 set property <name> to <value>.
369 .TP
370 .BI "--pve=" "medium" "," "direction" "," "hz" "," "options" "," "..."
371 Open an IO connection using the PVE (Provision Entertainment) protocol.
372 .TP
373 .B "--random-wind"
374 Randomize initial wind parameters.  See also: --wind.
375 .TP
376 .BI "--ray=" "medium" "," "direction" "," "hz" "," "options" "," "..."
377 Open an IO connection to a "RayWoodworth" motion chair.
378 .TP
379 .BI "--roll=" "degrees"
380 Specify roll angle (degrees).
381 .TP
382 .BI "--rul=" "medium" "," "direction" "," "hz" "," "options" "," "..."
383 Open an IO connection using the RUL protocol.
384 .TP
385 .B "--shading-flat"
386 Enable flat shading.
387 .TP
388 .B "--shading-smooth"
389 Enable smooth shading.
390 .TP
391 .B "--show-aircraft"
392 Show a listing of all available aircraft.
393 .TP
394 .BI "--speed=" "n"
395 Run the FDM "n" times faster than real-time.
396 .TP
397 .BI "--start-date-gmt=" "yyyy:mm:dd:hh:mm:ss"
398 Specify a starting date/time with respect to GMT (Greenwich Mean Time).
399 .TP
400 .BI "--start-date-lat=" "yyyy:mm:dd:hh:mm:ss"
401 Specify a starting date/time with respect to Local Aircraft Time.
402 .TP
403 .BI "--start-date-sys=" "yyyy:mm:dd:hh:mm:ss"
404 Specify a starting date/time with respect to your local system time.
405 .TP
406 .BI "--telnet=" "port"
407 Start a telnet interface to the property manager on the specified port.
408 .TP
409 .BI "--timeofday=" "value"
410 Specify a time of day.  Value may be one of dawn, dusk, noon, or midnight.
411 .TP
412 .B "--time-match-local"
413 Synchronize time with local real-world time.
414 .TP
415 .B "--time-match-real"
416 Synchronize time with the real-world time.
417 .TP
418 .BI "--time-offset=" "[+-]hh:mm:ss"
419 Specify a time offset with respect to the current time.
420 .TP
421 .BI "--trace-read=" "property"
422 Trace the reads for a property.  Multiple instances allowed.
423 .TP
424 .BI "--trace-write=" "property"
425 Trace the writes for a property.  Multiple instances allowed.
426 .TP
427 .BI "--turbulence=" "value"
428 Specify turbulence from 0.0 (calm) to 1.0 (severe).
429 .TP
430 .BI "--uBody=" "value"
431 Specify velocity along the body X axis (feet per second unless
432 --units-meters specified).
433 .TP
434 .B "--units-feet"
435 Use feet instead of meters.  Affects other options as well as the
436 values displayed by the HUD.
437 .TP
438 .B "--units-meters"
439 Use meters instead of feet.  Affects other options as well as the
440 values displayed by the HUD.
441 .TP
442 .BI "--vBody=" "value"
443 Specify velocity along the body Y axis (feet per second unless
444 --units-meters specified).
445 .TP
446 .BI "--vc=" "knots"
447 Specify initial airspeed (knots).
448 .TP
449 .BI "--view-offset=" "value"
450 Specify the default forward view direction as an offset from straight
451 ahead.  Allowable values are LEFT, RIGHT, CENTER, or a specific number
452 of degrees.
453 .TP
454 .B "--verbose, -v"
455 Show verbose help message.
456 .TP
457 .BI "--visibility-miles=" "value"
458 Specify initial visibility (miles).
459 .TP
460 .BI "--visibility=" "value"
461 Specify initial visibility (meters).
462 .TP
463 .BI "--vor=" "ID"
464 Specify starting position relative to a VOR.
465 .TP
466 .BI "--wBody=" "value"
467 Specify velocity along the body Z axis (feet per second unless
468 --units-meters specified).
469 .TP
470 .BI "--wind=" "DIR@SPEED"
471 Specify wind coming from DIR (degrees) at SPEED (knots).  Values may be
472 specified as a range by using a colon separator; for example, 180:220@10:15.
473 .TP
474 .BI "--wp=" "ID[@alt]"
475 Specify a waypoint for the GC autopilot.  Multiple instances of this
476 option are recognized in build a route.
477 .SH ENVIRONMENT
478 .TP
479 .B $FG_ROOT
480 Path used to locate data files.
481 .SH FILES
482 ~/.fgfsrc
483 .RS
484 Per user configuration file.
485 .RE
486 .TP
487 $FG_ROOT/system.fgfsrc
488 .RS
489 System-wide configuration file in command line format.
490 .RE
491 .TP
492 $FG_ROOT/preferences.xml
493 .RS
494 System-wide configuration file in XML format.
495 .RE
496 .TP
497 $FG_ROOT/keyboard.xml
498 .RS
499 Keyboard bindings.
500 .RE
501 .TP
502 $FG_ROOT/Input/Joysticks/
503 .RS
504 Joystick bindings.
505 .RE
506 .TP
507 $FG_ROOT/mice.xml
508 .RS
509 Mouse bindings.
510 .RE
511 .SH BUGS
512 Send bug reports to <flightgear-devel@lists.sourceforge.net> or visit
513 <http://code.google.com/p/flightgear-bugs>.
514 .SH SEE ALSO
515 fgjs(1), fgpanel(1), js_demo(1), terrasync(1)
516 .SH AUTHORS
517 Curt L. Olson, et al.  See
518 .I Thanks
519 file for a list of contributors.