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