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