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