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