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