]> git.mxchange.org Git - flightgear.git/blobdiff - man/fgfs.1.in
Updated to document the new 3d positional tags that are available for
[flightgear.git] / man / fgfs.1.in
index 6253006fc7cad2deffb63fc5fa5b13554b7be1eb..8d8b15f724ac9ed81caaca07b81f34c5136cb547 100644 (file)
@@ -1,4 +1,4 @@
-.\" Copyright (C) 2001 Cameron Moore
+.\" Copyright (C) 2002 Cameron Moore
 .\"
 .\" This program is free software; you can redistribute it and/or
 .\" modify it under the terms of the GNU General Public License
@@ -16,7 +16,7 @@
 .\" Or try here: http://www.fsf.org/copyleft/gpl.html
 .\"
 .Id $Id$
-.TH FGFS 1 "August 2001" "@VERSION@" "@PACKAGE@"
+.TH FGFS 1 "October 2003" "@VERSION@" "@PACKAGE@"
 .SH NAME
 fgfs \- FlightGear Flight Simulator
 .SH SYNOPSIS
@@ -29,6 +29,10 @@ simulator framework for the development and pursuit of interesting
 flight simulator ideas.
 .SH OPTIONS
 .TP
+.BI "--adf=" "[rotation:]frequency"
+Specify the initial ADF radio frequency.  Optionally may be preceded by a
+card rotation.
+.TP
 .BI "--aero=" "name"
 Specify aerodynamics model to load.
 .TP
@@ -45,6 +49,9 @@ Specify starting postion by airport ID.
 .BI "--altitude=" "value"
 Specify starting altitude (in feet unless --units-meters specified).
 .TP
+.BI "--atc610x"
+Enable atc610x interface.
+.TP
 .BI "--atlas=" "medium" "," "direction" "," "hz" "," "options" "," "..."
 Open an IO connection using the Atlas protocol.
 .TP
@@ -54,8 +61,18 @@ Specify the bits per pixel for the renderer.
 .BI "--browser-app=" "path"
 Specify location of your web browser.
 .TP
-.BI "--clouds-asl=" "altitude"
-Specify altitude of cloud layer above sea level.
+.BI "--callsign=" "value"
+Specify a unique name for multiplayer play.
+.TP
+.BI "--ceiling=" "value[:thickness]"
+Create an overcast ceiling (feet above sea level).  May optionally specify
+a thickness (feet) which defaults to 2000.
+.TP
+.BI "--com1=" "frequency"
+Set the initial COM1 radio frequency.
+.TP
+.BI "--com2=" "frequency"
+Set the initial COM2 radio frequency.
 .TP
 .BI "--config=" "path"
 Load additional properties from path.  Multiple instances of this
@@ -64,15 +81,28 @@ option are recognized.
 .BI "--control=" "mode"
 Primary control mode (joystick, keyboard, mouse).
 .TP
+.BI "--dme=" "{nav1|nav2|frequency}"
+Specify the NAV radio from which to slave the ADF or set its internal
+frequency.
+.TP
 .B "--disable-anti-alias-hud"
 Disable anti-aliased HUD.
 .TP
 .B "--disable-auto-coordination"
 Disable auto coordination between aileron and rudder.
 .TP
+.B "--disable-clock-freeze"
+Disable clock freezing so that time advances normally.
+.TP
 .B "--disable-clouds"
 Disable cloud rendering.
 .TP
+.B "--disable-distance-attenuation"
+Disable runway light distance attenuation.
+.TP
+.B "--disable-enhanced-lighting"
+Disable enhanced runway lighting.
+.TP
 .B "--disable-freeze"
 Start out in a running state.
 .TP
@@ -85,8 +115,14 @@ Disable fullscreen mode.
 .B "--disable-game-mode"
 Disable fullscreen game mode.
 .TP
+.B "--disable-horizon-effect"
+Disable celestial body growth illusion near the horizon..
+.TP
 .B "--disable-hud"
-Disable HUD.
+Disable 2D HUD.
+.TP
+.B "--disable-hud-3d"
+Disable 3D HUD.
 .TP
 .B "--disable-intro-music"
 Disable introduction music.
@@ -100,12 +136,18 @@ Disable Multi-pilot mode.
 .B "--disable-panel"
 Disable instrument panel.
 .TP
+.B "--disable-random-objects"
+Disable random scenery objects (buildings, trees, etc).
+.TP
 .B "--disable-skyblend"
 Disable sky blending.
 .TP
 .B "--disable-sound"
 Disable sound effects.
 .TP
+.B "--disable-specular-highlight"
+Disable specular reflections on textured objects.
+.TP
 .B "--disable-splash-screen"
 Disable splash screen.
 .TP
@@ -121,9 +163,18 @@ Enable anti-aliased HUD.
 .B "--enable-auto-coordination"
 Enable auto coordination between aileron and rudder.
 .TP
+.B "--enable-clock-freeze"
+Enable clock freezing so that time does not advance.
+.TP
 .B "--enable-clouds"
 Enable cloud rendering.
 .TP
+.B "--enable-distance-attenuation"
+Enable runway light distance attenuation.
+.TP
+.B "--enable-enhanced-lighting"
+Enable enhanced runway lighting.
+.TP
 .B "--enable-freeze"
 Start out in a frozen state.
 .TP
@@ -136,8 +187,14 @@ Enable fullscreen mode.
 .B "--enable-game-mode"
 Enable fullscreen game mode.
 .TP
+.B "--enable-horizon-effect"
+Enable celestial body growth illusion near the horizon.
+.TP
 .B "--enable-hud"
-Enable HUD.
+Enable 2D HUD.
+.TP
+.B "--enable-hud-3d"
+Enable 3D HUD.
 .TP
 .B "--enable-intro-music"
 Enable introduction music.
@@ -152,12 +209,18 @@ Enable Multi-pilot mode.
 .B "--enable-panel"
 Enable instrument panel.
 .TP
+.B "--enable-random-objects"
+Enable random scenery objects (buildings, trees, etc).
+.TP
 .B "--enable-skyblend"
 Enable sky blending.
 .TP
 .B "--enable-sound"
 Enable sound effects.
 .TP
+.B "--enable-specular-highlight"
+Enable specular reflections on textured objects.
+.TP
 .B "--enable-splash-screen"
 Enable splash screen.
 .TP
@@ -167,9 +230,13 @@ Enable textures.
 .B "--enable-wireframe"
 Enable wireframe drawing mode.
 .TP
+.BI "--failure=" "system"
+Fail a system on the aircraft.  System may be one of pitot, static, vacuum,
+or electrical.  Multiple instances allowed.
+.TP
 .BI "--fdm=" "name"
-Specify the flight dynamics model to use.  Can be one of jsb, larcsim, yasim,
-magic, balloon, ada, external, or null.
+Specify the flight dynamics model to use.  Name may be one of jsb, larcsim,
+yasim, magic, balloon, ada, external, or null.
 .TP
 .BI "--fg-root=" "path"
 Specify the root path for data files.
@@ -177,6 +244,9 @@ Specify the root path for data files.
 .BI "--fg-scenery=" "path"
 Specify the base path for scenery data.
 .TP
+.BI "--fix=" "ID"
+Specify starting position relative to a fix.
+.TP
 .BI "--flight-plan=" "file"
 Read all waypoints from the specified file.
 .TP
@@ -195,6 +265,9 @@ Specify initial field of view angle (degrees).
 .BI "--garmin=" "medium" "," "direction" "," "hz" "," "options" "," "..."
 Open an IO connection using the Garmin GPS protocol.
 .TP
+.BI "--generic=" "params"
+Open connection using the serial port protocol.  See README.IO for details.
+.TP
 .BI "--geometry=" "WxH"
 Specify window geometry (ie. 640x480, 800x600, etc).
 .TP
@@ -202,7 +275,7 @@ Specify window geometry (ie. 640x480, 800x600, etc).
 Specify heading or yaw angle (degrees).
 .TP
 .BR "--help" ", " "-h"
-Show help message.
+Show a brief help message.  Use --verbose,-v for a full listing of options.
 .TP
 .BI "--httpd=" "port"
 Start an HTTP server on the specified port.
@@ -218,7 +291,7 @@ Start up in the air.  This is implied when specifying an initial
 altitude above ground level.
 .TP
 .BI "--joyclient=" "medium" "," "direction" "," "hz" "," "options" "," "..."
-Open an IO connection to an Agwagon joystick
+Open an IO connection to an Agwagon joystick.
 .TP
 .BI "--jpg-httpd=" "port"
 Start a screen shot HTTP server on the specified port.
@@ -226,6 +299,9 @@ Start a screen shot HTTP server on the specified port.
 .BI "--lat=" "degrees"
 Specify starting latitude (degrees).
 .TP
+.BI "--log-level=" "value"
+Set log level for this session (1..5 where 1=verbose, 5=quiet).
+.TP
 .BI "--lon=" "degrees"
 Specify starting longitude (degrees).
 .TP
@@ -235,6 +311,9 @@ Specify initial mach number.
 .BI "--model-hz=" "n"
 Run the FDM at this rate (iterations per second).
 .TP
+.BI "--multiplay=" "direction,hz,address,port"
+Specify multiplayer communication settings.  Multiple instances allowed.
+.TP
 .BI "--native-ctrls=" "medium" "," "direction" "," "hz" "," "options" "," "..."
 Open an IO connection using the FlightGear Native Controls protocol.
 .TP
@@ -244,6 +323,17 @@ Open an IO connection using the FlightGear Native FDM protocol.
 .BI "--native=" "medium" "," "direction" "," "hz" "," "options" "," "..."
 Open an IO connection using the FlightGear Native protocol.
 .TP
+.BI "--nav1=" "[radial:]frequency"
+Specify the initial NAV1 radio frequency.  Optionally may be preceded by a
+radial value.
+.TP
+.BI "--nav2=" "[radial:]frequency"
+Specify the initial NAV2 radio frequency.  Optionally may be preceded by a
+radial value.
+.TP
+.BI "--ndb=" "ID"
+Specify starting position relative to an NDB.
+.TP
 .B "--net-hud"
 Enable network information in the HUD.
 .TP
@@ -280,8 +370,11 @@ set property <name> to <value>.
 .BI "--pve=" "medium" "," "direction" "," "hz" "," "options" "," "..."
 Open an IO connection using the PVE (Provision Entertainment) protocol.
 .TP
+.B "--random-wind"
+Randomize initial wind parameters.  See also: --wind.
+.TP
 .BI "--ray=" "medium" "," "direction" "," "hz" "," "options" "," "..."
-Open an IO connection to a "RayWoodworth" motion chair
+Open an IO connection to a "RayWoodworth" motion chair.
 .TP
 .BI "--roll=" "degrees"
 Specify roll angle (degrees).
@@ -295,6 +388,9 @@ Enable flat shading.
 .B "--shading-smooth"
 Enable smooth shading.
 .TP
+.B "--show-aircraft"
+Show a listing of all available aircraft.
+.TP
 .BI "--speed=" "n"
 Run the FDM "n" times faster than real-time.
 .TP
@@ -307,6 +403,12 @@ Specify a starting date/time with respect to Local Aircraft Time.
 .BI "--start-date-sys=" "yyyy:mm:dd:hh:mm:ss"
 Specify a starting date/time with respect to your local system time.
 .TP
+.BI "--telnet=" "port"
+Start a telnet interface to the property manager on the specified port.
+.TP
+.BI "--timeofday=" "value"
+Specify a time of day.  Value may be one of dawn, dusk, noon, or midnight.
+.TP
 .B "--time-match-local"
 Synchronize time with local real-world time.
 .TP
@@ -314,8 +416,7 @@ Synchronize time with local real-world time.
 Synchronize time with the real-world time.
 .TP
 .BI "--time-offset=" "[+-]hh:mm:ss"
-Specify a time offset with respect to the current time.  May be used in
-conjunction with other --time-* options.
+Specify a time offset with respect to the current time.
 .TP
 .BI "--trace-read=" "property"
 Trace the reads for a property.  Multiple instances allowed.
@@ -323,6 +424,9 @@ Trace the reads for a property.  Multiple instances allowed.
 .BI "--trace-write=" "property"
 Trace the writes for a property.  Multiple instances allowed.
 .TP
+.BI "--turbulence=" "value"
+Specify turbulence from 0.0 (calm) to 1.0 (severe).
+.TP
 .BI "--uBody=" "value"
 Specify velocity along the body X axis (feet per second unless
 --units-meters specified).
@@ -347,25 +451,32 @@ Specify the default forward view direction as an offset from straight
 ahead.  Allowable values are LEFT, RIGHT, CENTER, or a specific number
 of degrees.
 .TP
+.B "--verbose, -v"
+Show verbose help message.
+.TP
 .BI "--visibility-miles=" "value"
 Specify initial visibility (miles).
 .TP
 .BI "--visibility=" "value"
 Specify initial visibility (meters).
 .TP
+.BI "--vor=" "ID"
+Specify starting position relative to a VOR.
+.TP
 .BI "--wBody=" "value"
 Specify velocity along the body Z axis (feet per second unless
 --units-meters specified).
 .TP
 .BI "--wind=" "DIR@SPEED"
-Specify wind coming from DIR (degrees) at SPEED (knots).
+Specify wind coming from DIR (degrees) at SPEED (knots).  Values may be
+specified as a range by using a colon separator; for example, 180:220@10:15.
 .TP
 .BI "--wp=" "ID[@alt]"
 Specify a waypoint for the GC autopilot.  Multiple instances of this
 option are recognized in build a route.
 .SH ENVIRONMENT
 .TP
-.B $FGROOT
+.B $FG_ROOT
 Path used to locate data files.
 .SH FILES
 ~/.fgfsrc
@@ -373,24 +484,29 @@ Path used to locate data files.
 Per user configuration file.
 .RE
 .TP
-$FGROOT/system.fgfsrc
+$FG_ROOT/system.fgfsrc
+.RS
+System-wide configuration file in command line format.
+.RE
+.TP
+$FG_ROOT/preferences.xml
 .RS
-System-wide configuration file in command line format
+System-wide configuration file in XML format.
 .RE
 .TP
-$FGROOT/preferences.xml
+$FG_ROOT/keyboard.xml
 .RS
-System-wide configuration file in XML format
+Keyboard bindings.
 .RE
 .TP
-$FGROOT/keyboard.xml
+$FG_ROOT/Input/Joysticks/
 .RS
-Keyboard bindings
+Joystick bindings.
 .RE
 .TP
-$FGROOT/joystick.xml
+$FG_ROOT/mice.xml
 .RS
-Joystick bindings
+Mouse bindings.
 .RE
 .SH BUGS
 Send bug reports to <flightgear-devel@flightgear.org>.