.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program; if not, write to the Free Software
-.\" Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+.\" Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
.\" Or try here: http://www.fsf.org/copyleft/gpl.html
.\"
-.Id $Id$
-.TH FGFS 1 "January 2002" "@VERSION@" "@PACKAGE@"
+.TH FGFS 1 "February 2012" "@VERSION@" "@PACKAGE@"
.SH NAME
fgfs \- FlightGear Flight Simulator
.SH SYNOPSIS
is a free, open-source, multi-platform, and sophisticated flight
simulator framework for the development and pursuit of interesting
flight simulator ideas.
+For more information visit <http://www.flightgear.org>.
.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
Specify aircraft to load.
.TP
.BI "--aircraft-dir=" "path"
-Specify the aircraft model directory relative to the path of the
-executable. This is used for UIUC aircraft only.
+Specify the exact directory to use for the aircraft (normally not required,
+but may be useful for testing).
.TP
-.BI "--airport-id=" "id"
+.BI "--airport=" "id"
Specify starting postion by airport ID.
.TP
.BI "--altitude=" "value"
-Specify starting altitude (in feet unless --units-meters specified).
+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.
.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
option are recognized.
.TP
-.BI "--control=" "mode"
-Primary control mode (joystick, keyboard, mouse).
+.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.
.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
.B "--disable-fullscreen"
Disable fullscreen mode.
.TP
-.B "--disable-game-mode"
-Disable fullscreen game mode.
+.B "--disable-horizon-effect"
+Disable celestial body growth illusion near the horizon..
.TP
.B "--disable-hud"
-Disable HUD.
+Disable 2D HUD.
.TP
-.B "--disable-intro-music"
-Disable introduction music.
+.B "--disable-hud-3d"
+Disable 3D HUD.
.TP
.B "--disable-mouse-pointer"
Disable extra mouse pointer.
.TP
-.B "--disable-network-olk"
-Disable Multi-pilot mode.
-.TP
.B "--disable-panel"
Disable instrument panel.
.TP
-.B "--disable-skyblend"
-Disable sky blending.
+.B "--disable-random-objects"
+Disable random scenery objects (buildings, trees, etc).
.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
-.B "--disable-textures"
-Disable textures.
-.TP
.B "--disable-wireframe"
Disable wireframe drawing mode.
.TP
.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
.B "--enable-fullscreen"
Enable fullscreen mode.
.TP
-.B "--enable-game-mode"
-Enable fullscreen game mode.
+.B "--enable-horizon-effect"
+Enable celestial body growth illusion near the horizon.
.TP
.B "--enable-hud"
-Enable HUD.
+Enable 2D HUD.
.TP
-.B "--enable-intro-music"
-Enable introduction music.
+.B "--enable-hud-3d"
+Enable 3D HUD.
.TP
.B "--enable-mouse-pointer"
Enable extra mouse pointer (i.e. for full screen voodoo/voodoo-II
based cards.)
.TP
-.B "--enable-network-olk"
-Enable Multi-pilot mode.
-.TP
.B "--enable-panel"
Enable instrument panel.
.TP
-.B "--enable-skyblend"
-Enable sky blending.
+.B "--enable-random-objects"
+Enable random scenery objects (buildings, trees, etc).
.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
-.B "--enable-textures"
-Enable textures.
-.TP
.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-aircraft=" "path"
+Specify an additional path to search for aircraft directories. (can be repeated)
.TP
.BI "--fg-root=" "path"
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
.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
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.
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.
.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
.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
.BI "--native=" "medium" "," "direction" "," "hz" "," "options" "," "..."
Open an IO connection using the FlightGear Native protocol.
.TP
-.B "--net-hud"
-Enable network information in the HUD.
+.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 "--net-id=" "name"
-Specify your callsign.
+.BI "--ndb=" "ID"
+Specify starting position relative to an NDB.
.TP
.BI "--nmea=" "medium" "," "direction" "," "hz" "," "options" "," "..."
Open an IO connection using the NMEA protocol.
.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).
.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
.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
.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).
+\-\-units\-meters specified).
.TP
.B "--units-feet"
Use feet instead of meters. Affects other options as well as the
.TP
.BI "--vBody=" "value"
Specify velocity along the body Y axis (feet per second unless
---units-meters specified).
+\-\-units\-meters specified).
.TP
.BI "--vc=" "knots"
Specify initial airspeed (knots).
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).
+\-\-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
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>.
+Send bug reports to <flightgear\-devel@lists.sourceforge.net> or visit
+<http://code.google.com/p/flightgear\-bugs>.
.SH SEE ALSO
-fgjs(1)
+fgjs(1), fgpanel(1), js_demo(1), terrasync(1)
.SH AUTHORS
Curt L. Olson, et al. See
.I Thanks
projects / flightgear.git / blobdiff