FGFS-4.1/flightgear
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

first commit

Browse Source
This commit is contained in:
Your Name
2022-10-20 20:29:11 +08:00
commit 4d531f8044
3238 changed files with 1387862 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
man/man1/CMakeLists.txt
+49
View File
@@ -0,0 +1,49 @@
include(GNUInstallDirs)
set(MANPAGES
fgfs.1
)
if(ENABLE_FGCOM)
list(APPEND MANPAGES fgcom.1)
endif(ENABLE_FGCOM)
if(ENABLE_FGELEV)
list(APPEND MANPAGES fgelev.1)
endif(ENABLE_FGELEV)
if(ENABLE_FGJS)
list(APPEND MANPAGES fgjs.1)
endif(ENABLE_FGJS)
if(WITH_FGPANEL)
list(APPEND MANPAGES fgpanel.1)
endif()
if(ENABLE_FGQCANVAS)
list(APPEND MANPAGES fgqcanvas.1)
endif(ENABLE_FGQCANVAS)
if(ENABLE_FGVIEWER)
list(APPEND MANPAGES fgviewer.1)
endif(ENABLE_FGVIEWER)
if(ENABLE_GPSSMOOTH)
list(APPEND MANPAGES GPSsmooth.1 MIDGsmooth.1 UGsmooth.1)
endif(ENABLE_GPSSMOOTH)
if(ENABLE_JS_DEMO)
list(APPEND MANPAGES js_demo.1)
endif(ENABLE_JS_DEMO)
if(ENABLE_JSBSIM)
list(APPEND MANPAGES JSBSim.1)
endif(ENABLE_JSBSIM)
if(ENABLE_METAR)
list(APPEND MANPAGES metar.1)
endif(ENABLE_METAR)
foreach(man ${MANPAGES})
install(FILES ${man} DESTINATION ${CMAKE_INSTALL_MANDIR}/man1
COMPONENT doc)
endforeach()
man/man1/GPSsmooth.1
+69
View File
@@ -0,0 +1,69 @@
.\" Copyright (C) 2017 Alessandro Menti
.\"
.\" This program is free software; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License
.\" as published by the Free Software Foundation; either version 2
.\" of the License, or (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
.\" Or try here: http://www.fsf.org/copyleft/gpl.html
.\"
.TH GPSSMOOTH 1 2017-06-04 FlightGear "FlightGear man pages"
.SH NAME
GPSsmooth \- send NMEA-formatted GPS data to a FlightGear instance
.SH SYNOPSIS
\fBGPSsmooth\fR \fB\-\-help\fR | \fB\-\-file\fR \fIfile_name\fR
[\fB\-\-hertz\fR \fIhertz\fR] [\fB\-\-host\fR \fIhostname\fR]
[\fB\-\-broadcast\fR] [\fB\-\-fdm\-port\fR \fIport\fR] [\fB\-\-ctrls\-port\fR
\fIport\fR]
.SH DESCRIPTION
.B GPSsmooth
is a utility that reads a text file containing GPS data in NMEA format, parses
it and sends it to a FlightGear instance for replaying.
.SH OPTIONS
.TP
\fB\-\-help\fR
Display usage information and exit.
.TP
\fB\-\-file\fR \fIfile_name\fR
Read GPS data from \fIfile_name\fR. This option is mandatory if \fB\-\-help\fR
is not specified.
.TP
\fB\-\-hertz\fR \fIhertz\fR
Specify the frequency to use for sending data to the FlightGear instance.
By default, events are sent at a frequency of \fB60\fR Hz.
.TP
\fB\-\-host\fR \fIhostname\fR
Send the data to the FlightGear instance running on \fIhostname\fR.
If \fB\-\-host\fR is not specified, the default is to send the data to
\fBlocalhost\fR.
.TP
\fB\-\-broadcast\fR
Send flight data model and control data as broadcast packets.
.TP
\fB\-\-fdm\-port\fR \fIport\fR
Set the port flight data model data should be sent to. By default, data is sent
to port \fB5505\fR.
.TP
\fB\-\-ctrls\-port\fR \fIport\fR
Set the port control data should be sent to. By default, data is sent to port
\fB5506\fR.
.SH "EXIT STATUS"
.B GPSsmooth
exits with
.B 0
on success, with
.B \-1
if the syntax of the command-line arguments is wrong or an error occurs.
.SH "SEE ALSO"
.BR fgfs (1),
.BR MIDGsmooth (1),
.BR UGsmooth (1)
man/man1/JSBSim.1
+99
View File
@@ -0,0 +1,99 @@
.\" Copyright (C) 2017 Alessandro Menti
.\"
.\" This program is free software; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License
.\" as published by the Free Software Foundation; either version 2
.\" of the License, or (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
.\" Or try here: http://www.fsf.org/copyleft/gpl.html
.\"
.TH JSBSIM 1 2017-06-25 FlightGear "FlightGear man pages"
.SH NAME
JSBSim \- standalone version of the JSBSim open source flight dynamics model
.SH SYNOPSIS
\fBJSBSim\fR \fI<script filename>\fR \fI<output filenames>\fR \fI<options>\fR
.SH DESCRIPTION
.B JSBSim
is a standalone version of the JSBSim open source flight dynamics model
library that, given a script file, runs the simulation and outputs the results
to one or more files.
.SH OPTIONS
.TP
\fB\-\-help\fR
Display usage information and exit.
.TP
\fB\-\-version\fR
Display the JSBSim version number and exit.
.TP
\fB\-\-outputlogfile=\fIfilename\fR
Output the processed data to \fIfilename\fR.
.TP
\fB\-\-logdirectivefile=\fIfilename\fR
Use the data logging directives specified in \fIfilename\fR. This option may be
specified multiple times.
.TP
\fB\-\-root=\fIpath\fR
Use \fIpath\fR as the JSBSim root directory (the directory where the aircraft
model resides, containing the \fBaircraft\fR, \fBengine\fR... subdirectories).
.TP
\fB\-\-aircraft=\fIfilename\fR
Use the aircraft model specified in \fIfilename\fR.
.TP
\fB\-\-script=\fIfilename\fR
Run the simulation script specified in \fIfilename\fR.
This option is incompatible with \fB\-\-catalog\fR.
.TP
\fB\-\-realtime\fR
Run the simulation in actual real world time.
.TP
\fB\-\-nice\fR[\fB=\fIsleep period\fR]
Reduce CPU usage by pausing the simulation between frames for
\fIsleep period\fR nanoseconds. If \fIsleep period\fR is not given, it is set
to \fB0.01\fR nanoseconds.
.TP
\fB\-\-nohighlight\fR
Do not colorize the output.
.TP
\fB\-\-suspend\fR
Suspend the simulation after initializing it.
.TP
\fB\-\-initfile=\fIfilename\fR
Use the initialization file \fIfilename\fR.
.TP
\fB\-\-catalog\fR[\fB=\fIaircraft\fR]
Print all properties for the aircraft model (\fIaircraft\fR, if the model name
is passed as an argument, or for the model loaded via the initialization file).
This option is incompatible with \fB\-\-script\fR.
.TP
\fB\-\-property=\fIname\fB=\fIvalue\fR
Set the property named \fIname\fR to \fIvalue\fR.
.TP
\fB\-\-simulation\-rate=\fIrate\fR
Set the simulation rate (dT) to \fIrate\fR. If \fIrate\fR is less than \fB1\fR,
it is interpreted as a time step size in seconds; otherwise, it is interpreted
as a rate in Hertz.
.TP
\fB\-\-end=\fItime\fR
Set the simulation end time to \fItime\fR.
.SH "EXIT STATUS"
.B JSBSim
exits with
.B 0
on success, with
.B 1
if the syntax of the command-line arguments is wrong or an error occurs.
.SH "SEE ALSO"
.BR fgfs (1),
.UR http://\:jsbsim.sourceforge.net/
the JSBSim Web site
.UE
man/man1/MIDGsmooth.1
+83
View File
@@ -0,0 +1,83 @@
.\" Copyright (C) 2017 Alessandro Menti
.\"
.\" This program is free software; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License
.\" as published by the Free Software Foundation; either version 2
.\" of the License, or (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
.\" Or try here: http://www.fsf.org/copyleft/gpl.html
.\"
.TH MIDGSMOOTH 1 2017-06-25 FlightGear "FlightGear man pages"
.SH NAME
MIDGsmooth \- send MIDG-formatted GPS data to a FlightGear instance
.SH SYNOPSIS
\fBMIDGsmooth\fR \fB\-\-help\fR
| \fB\-\-infile\fR \fIinfile_name\fR [\fIoptions\fR]...
| \fB\-\-serial\fR \fIdev_name\fR \fB\-\-outfile\fR \fIoutfile_name\fR
[\fIoptions\fR]...
.SH DESCRIPTION
.B MIDGsmooth
is a utility that reads GPS data in MIDG format from a text file or from an
MIDG device connected to the serial port, parses it and sends it to a
FlightGear instance for replaying.
.SH OPTIONS
.TP
\fB\-\-help\fR
Display usage information and exit.
.TP
\fB\-\-infile\fR \fIinfile_name\fR
Read GPS data from \fIinfile_name\fR.
.TP
\fB\-\-serial\fR \fIdev_name\fR
Read GPS data from the serial device named \fIdev_name\fR.
.TP
\fB\-\-outfile\fR \fIoutfile_name\fR
Save the data retrieved from the device to \fIoutfile_name\fR.
.TP
\fB\-\-hertz\fR \fIfrequency\fR
Specify the frequency to use for sending data to the FlightGear instance.
By default, events are sent at a frequency of \fB60\fR Hz.
.TP
\fB\-\-host\fR \fIhostname\fR
Send the data to the FlightGear instance running on \fIhostname\fR.
If \fB\-\-host\fR is not specified, the default is to send the data to
\fBlocalhost\fR.
.TP
\fB\-\-skip\-seconds\fR \fIseconds\fR
Do not transmit the first \fIseconds\fR seconds of data.
This option is ignored when reading GPS data from a serial device.
.TP
\fB\-\-broadcast\fR
Send flight data model and control data as broadcast packets.
.TP
\fB\-\-fdm\-port\fR \fIport\fR
Set the port flight data model data should be sent to. By default, data is sent
to port \fB5505\fR.
.TP
\fB\-\-ctrls\-port\fR \fIport\fR
Set the port control data should be sent to. By default, data is sent to port
\fB5506\fR.
.TP
\fB\-\-altitude\-offset\fR \fImeters\fR
Add the specified offset (in meters) to the altitude sent to FlightGear.
.SH "EXIT STATUS"
.B MIDGsmooth
exits with
.B 0
on success, with
.B \-1\fR
if the syntax of the command-line arguments is wrong or an error occurs.
.SH "SEE ALSO"
.BR fgfs (1),
.BR GPSsmooth (1),
.BR UGsmooth (1)
man/man1/UGsmooth.1
+114
View File
@@ -0,0 +1,114 @@
.\" Copyright (C) 2017 Alessandro Menti
.\"
.\" This program is free software; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License
.\" as published by the Free Software Foundation; either version 2
.\" of the License, or (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
.\" Or try here: http://www.fsf.org/copyleft/gpl.html
.\"
.TH UGSMOOTH 1 2017-06-25 FlightGear "FlightGear man pages"
.SH NAME
UGsmooth \- send UGear-formatted GPS data to a FlightGear instance
.SH SYNOPSIS
\fBUGsmooth\fR \fB\-\-help\fR
| \fB\-\-infile\fR \fIinfile_name\fR [\fIoptions\fR]...
| \fB\-\-flight\fR \fIflight_dir\fR [\fIoptions\fR]...
| \fB\-\-serial\fR \fIdev_name\fR \fB\-\-outfile\fR \fIoutfile_name\fR [\fIoptions\fR]...
.SH DESCRIPTION
.B UGsmooth
is a utility that reads GPS data in UGear format from a text file, a directory
containing flight data or from a device connected to the serial port, parses it
and sends it to a FlightGear instance for replaying.
.SH OPTIONS
.TP
\fB\-\-help\fR
Display usage information and exit.
.TP
\fB\-\-infile\fR \fIinfile_name\fR
Read GPS data from \fIinfile_name\fR.
.TP
\fB\-\-flight\fR \fIflight_dir\fR
Read GPS data from the flight directory named \fIflight_dir\fR.
.TP
\fB\-\-serial\fR \fIdev_name\fR
Read GPS data from the serial device named \fIdev_name\fR.
.TP
\fB\-\-outfile\fR \fIoutfile_name\fR
Save the data retrieved from the device to \fIoutfile_name\fR.
.TP
\fB\-\-hertz\fR \fIfrequency\fR
Specify the frequency to use for sending data to the FlightGear instance.
By default, events are sent at a frequency of \fB60\fR Hz.
.TP
\fB\-\-host\fR \fIhostname\fR
Send the data to the FlightGear instance running on \fIhostname\fR.
If \fB\-\-host\fR is not specified, the default is to send the data to
\fBlocalhost\fR.
.TP
\fB\-\-broadcast\fR
Send flight data model and control data as broadcast packets.
.TP
\fB\-\-opengc\-port\fR \fIport\fR
Set the port OpenGC data should be sent to. By default, data is sent to port
\fB6000\fR.
.TP
\fB\-\-fdm\-port\fR \fIport\fR
Set the port flight data model data should be sent to. By default, data is sent
to port \fB5505\fR.
.TP
\fB\-\-ctrls\-port\fR \fIport\fR
Set the port control data should be sent to. By default, data is sent to port
\fB5506\fR.
.TP
\fB\-\-groundtrack\-heading\fR
Calculate the aircraft heading from the GPS velocity instead of using the raw
heading recorded by the device.
.TP
\fB\-\-ground\-speed\fR
Calculate the ground speed from the GPS velocity instead of using the raw speed
recorded by the device.
.TP
\fB\-\-estimate\-control\-deflections\fR
Estimate control deflections from the angular velocities instead of using the
raw deflections recorded by the device.
.TP
\fB\-\-altitude\-offset\fR \fImeters\fR
Add the specified offset (in meters) to the altitude sent to FlightGear.
.TP
\fB\-\-skip\-seconds\fR \fIseconds\fR
Do not transmit the first \fIseconds\fR seconds of data.
This option is ignored when reading GPS data from a serial device.
.TP
\fB\-\-no\-real\-time\fR
Do not update the elapsed time.
.TP
\fB\-\-ignore\-checksum\fR
Do not discard data with invalid checksums.
This option is ignored when reading GPS data from a flight directory.
.TP
\fB\-\-sg\-swap\fR
Activate the special double swap logic for the (non-standard) stargate double
format.
.SH "EXIT STATUS"
.B UGsmooth
exits with
.B 0
on success, with
.B \-1
if the syntax of the command-line arguments is wrong or an error occurs.
.SH "SEE ALSO"
.BR fgfs (1),
.BR GPSsmooth (1),
.BR MIDGsmooth (1)
man/man1/fgcom.1
+150
View File
@@ -0,0 +1,150 @@
.\" Copyright (C) 2017 Alessandro Menti
.\"
.\" This program is free software; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License
.\" as published by the Free Software Foundation; either version 2
.\" of the License, or (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
.\" Or try here: http://www.fsf.org/copyleft/gpl.html
.\"
.TH FGCOM 1 2017-06-04 FlightGear "FlightGear man pages"
.SH NAME
fgcom \- VoIP client for the FlightGear radio infrastructure
.SH SYNOPSIS
\fBfgcom\fR [\fB\-\-server=\fIserver\fR] [\fB\-\-host=\fIlisteninghost\fR]
[\fB\-\-port=\fIport\fR] [\fB\-\-callsign=\fIcallsign\fR]
[\fB\-\-frequency=\fIfrequency\fR] [\fB\-\-atis=\fIfrequency\fR]
[\fB\-\-airport=\fIcode\fR] [\fB\-\-username=\fIuser\fR]
[\fB\-\-password=\fIpass\fR] [\fB\-\-silence\-threshold=\fIthreshold\fR]
[\fB\-\-debug\fR] [\fB\-\-help\fR] [\fB\-\-version\fR]
.SH DESCRIPTION
.B fgcom
is the FlightGear utility used for connecting to multiplayer voice servers.
.PP
It is usually not necessary to run
.B fgcom
from the command line, as it is already integrated into FlightGear, with the
exception of a few specific cases (such as recording ATIS messages or
performing a radio check, see the
.B EXAMPLE
section).
.SH OPTIONS
.TP
\fB\-\-server=\fIserver\fR
Connect to the FGCom server \fIserver\fR. By default, FGCom tries to connect to
\fBfgcom.flightgear.org\fR.
.TP
\fB\-\-host=\fIlisteninghost\fR, \fB\-\-port=\fIport\fR
Listen on the network interface having the IP address \fIlisteninghost\fR, on
port \fIport\fR. By default, FGCom listens on the loopback interface
(\fB127.0.0.1\fR) on port \fB16661\fR.
The specified port can be used by an instance of FlightGear to communicate with
FGCom and update the pilot position as they fly.
.TP
\fB\-\-callsign=\fIcallsign\fR
Use the callsign \fIcallsign\fR during the session. By default, FGCom uses
\fBguest\fR as callsign.
.TP
\fB\-\-frequency=\fIfrequency\fR
Set the active radio frequency to \fIfrequency\fR. The frequency must be
written in the format \fIxxx.xxx\fR and must be given in MHz.
.TP
\fB\-\-atis=\fIfrequency\fR
Record an ATIS message on \fIfrequency\fR MHz. The frequency must be written in
the format \fIxxx.xxx\fR and must be given in MHz.
.TP
\fB\-\-airport=\fIcode\fR
Position the pilot/controller to the airport having the ICAO code \fIcode\fR.
Since some radio frequencies might be reused across the world, it is essential
to set the pilot/controller position correctly to make the FGCom server able to
determine the correct voice channel. Always use this flag if you are not
connecting a FlightGear instance to FGCom.
.TP
\fB\-\-username=\fIuser\fR, \fB\-\-password=\fIpass\fR
Log in to the FGCom server using the username \fIuser\fR and the password
\fIpass\fR.
.TP
\fB\-\-silence-threshold=\fIthreshold\fR
Set the silence threshold to \fIthreshold\fR dB. The value must be between
\fB-60\fR and \fB0\fR. The default is \fB-35.0\fR dB.
The silence threshold is the level below which the sound captured by the
microphone is considered background noise (and, thus, filtered out by FGCom).
Setting the silence threshold to \fB-60\fR turns the filter off; setting it
to \fB0\fR filters everything (mutes the microphone).
.TP
\fB\-\-debug\fR
Enable debug output for troubleshooting purposes.
.TP
\fB\-\-help\fR
Display usage information and exit.
.TP
\fB\-\-version\fR
Display the FGCom version and exit.
.SH "EXIT STATUS"
.B fgcom
exits with
.B EXIT_SUCCESS
on success, with
.B EXIT_FAILURE
if the syntax of the command-line arguments is wrong or an error occurs.
.SH NOTES
FGCom understands several special frequencies used for testing purposes or
general chatting:
.IP \(bu 3
\fB121.000 MHz\fR, \fB121.500 MHz\fR: "guard" frequencies reserved for
emergency communications;
.IP \(bu 3
\fB123.450 MHz\fR, \fB123.500 MHz\fR, \fB122.750 MHz\fR: general chat
frequencies;
.IP \(bu 3
\fB700.000 MHz\fR: radio station frequency. Depending on the FGCom server in
use, a recorded radio message will be played;
.IP \(bu 3
\fB723.340 MHz\fR: French Air Patrol communication frequency;
.IP \(bu 3
\fB910.000 MHz\fR: echo test frequency. Your voice will be echoed back after a
short delay, to allow you to check that your microphone, speakers/headset and
that your connection to the FGCom server works. The test is limited to a
maximum of 65 seconds, after which you will be automatically disconnected;
.IP \(bu 3
\fB911.000 MHz\fR: "music on hold". The frequency continuously plays background
music, allowing you to check that your connection to the FGCom server works.
.SH BUGS
.IP \(bu 3
At the time of writing, there is no mechanism in place to update the
frequencies used by FGCom with the ones used in the real world, should those
change. The former, thus, might not always correspond to the latter. Always use
the frequencies listed in FlightGear under \fBAI\fR -> \fBATC Services in
Range\fR instead of the ones published on aeronautical charts.
.SH EXAMPLE
Connect to the default FGCom server, switch to the San Francisco International
Airport (\fIKSFO\fR) ground frequency (\fI121.800 MHz\fR) and allow FlightGear
to update the current pilot position by sending it to port \fI16661\fR (the
default one):
$ \fBfgcom --frequency=121.800 --airport=KSFO\fR
Perform a radio check by connecting to the echo test frequency:
$ \fBfgcom --frequency=910.000\fR
Record an ATIS message on the San Francisco International Airport (\fIKSFO\fR)
ATIS frequency (\fI118.850 MHz\fR):
$ \fBfgcom --atis=118.850 --airport=KSFO\fR
.SH "SEE ALSO"
.BR fgfs (1),
.UR http://\:wiki.flightgear.org/\:FGCom_3.0
the FlightGear wiki "FGCom 3.0" page
.UE
man/man1/fgelev.1
+135
View File
@@ -0,0 +1,135 @@
.\" Copyright (C) 2017 Alessandro Menti
.\"
.\" This program is free software; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License
.\" as published by the Free Software Foundation; either version 2
.\" of the License, or (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
.\" Or try here: http://www.fsf.org/copyleft/gpl.html
.\"
.TH FGELEV 1 2020-11-15 FlightGear "FlightGear man pages"
.SH NAME
fgelev \- Compute FlightGear scenery elevation for a given list of points
.SH SYNOPSIS
\fBfgelev\fR [\fB\-\-expire\fR \fInum\fR] [\fB\-\-print\-solidness\fR]
[\fB\-\-fg\-root\fR \fIrootdir\fR] [\fB\-\-fg\-scenery\fR \fIscenerydir\fR]
[--tile-file osgbfilename] [--use-vpb]
.SH DESCRIPTION
.B fgelev
is a standalone utility that, given a list of points on standard input, prints
the corresponding elevation for each of them on standard output. It can also
(optionally) print whether the material covering that point is solid or not.
The list of points must be in the following form:
\fIid lon lat\fR
where \fIid\fR is an arbitrary identifier for the point, \fIlon\fR is the
longitude of the point and \fIlat\fR is the latitude of the point. Positive
longitudes (latitudes) correspond to points located in the Eastern (Northern)
hemisphere; negative ones correspond to points located in the Western
(Southern) hemisphere.
The list of elevations returned by
.B fgelev
is in the following form:
\fIid: elev solid\fR
where \fIid\fR is the identifier of the point passed as input, \fIelev\fR is
the elevation of the point in meters (or \fB-1000\fR if the elevation of the
given point was not found) and \fIsolid\fR is:
.IP \(bu 3
the string
.B solid
if the parameter
.B \-\-print\-solidness
was passed to
.B fgelev
and the material covering the point is solid;
.IP \(bu 3
the string
.B \-
if the parameter
.B \-\-print\-solidness
was passed to
.B fgelev
and the material covering the point is not solid;
.IP \(bu 3
absent if the parameter
.B \-\-print\-solidness
was not passed to \fBfgelev\fR.
.SH OPTIONS
.TP
\fB\-\-expire\fR \fInum\fR
To speed up elevation data retrieval,
.B fgelev
uses an internal cache. This option lets the user specify the number of
requests after which, if a point was not queried in them, it should be marked
as expired. By default,
.B fgelev
expires points not queried in the last \fB10\fR requests.
.TP
\fB\-\-print\-solidness\fR
Require
.B fgelev
to print the solidness of the material covering the queried point. See the
.B DESCRIPTION
section for more details.
.TP
\fB\-\-fg\-root\fR \fIrootdir\fR
Set the FlightGear data root directory (\fB$FG_ROOT\fR) to \fIrootdir\fR. If
this option is not set,
.B fgelev
uses the path specified in the
.B FG_ROOT
environment variable or, absent that, the FlightGear data directory chosen at
the time the program was compiled.
.TP
\fB\-\-fg\-scenery\fR \fIscenerydir\fR
Set the FlightGear scenery directory (\fB$FG_SCENERY\fR) to \fIscenerydir\fR.
If this option is not set,
.B fgelev
uses the path specified in the
.B FG_SCENERY
environment variable or, absent that, the
.B Scenery
subdirectory inside \fB$FG_ROOT\fR.
.TP
\fB\-\-tile\-file\fR \fIosgbfilename\fR
Use a specific tile file when searching for elevation details, instead
of scanning through the whole world.
.TP
\fB\-\-use\-vpb\fR
If specified, enables WS3.0 scenery behaviour, searching under the vpb/
subdirectory.
.SH "EXIT STATUS"
.B fgelev
exits with
.B EXIT_SUCCESS
on success, with
.B EXIT_FAILURE
if it is unable to read data from standard input or to load the scenery.
.SH ENVIRONMENT
.IP "\fBFG_ROOT\fR" 4
If
.B FG_ROOT
is set and
.B \-\-fg\-root
is not set, it specifies the root data directory to use.
.IP "\fBFG_SCENERY\fR" 4
If
.B FG_SCENERY
is set and
.B \-\-fg\-scenery
is not set, it specifies the scenery directory to use.
.SH "SEE ALSO"
.BR fgfs (1)
man/man1/fgfs.1
+853
View File
@@ -0,0 +1,853 @@
.\" Copyright (C) 2002 Cameron Moore
.\" Copyright (C) 2017 Alessandro Menti
.\"
.\" This program is free software; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License
.\" as published by the Free Software Foundation; either version 2
.\" of the License, or (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
.\" Or try here: http://www.fsf.org/copyleft/gpl.html
.\"
.TH FGFS 1 2017-06-25 FlightGear "FlightGear man pages"
.SH NAME
fgfs \- the FlightGear flight simulator
.SH SYNOPSIS
\fBfgfs\fR [\fIoptions...\fR]
.SH DESCRIPTION
.B fgfs
is the main executable for FlightGear, a free, open-source, multi-platform and
sophisticated flight simulator framework for the development and pursuit of
interesting flight simulator ideas.
.SH OPTIONS
Options are first read from the command-line arguments passed to \fBfgfs\fR.
The program then checks for the existence of \fI~/.fgfsrc.\fIhostname\fR (where
.I hostname
is the hostname of the machine) and of \fI~/.fgfsrc\fR; if at least one of
those files exists, it is read and parsed (see the
.BR fgfsrc (5)
man page for the full specifications of the file format).
If conflicting options are given, the ones read last will prevail.
.SS "General options"
.TP
\fB\-\-help\fR, \fB\-h\fR
Display usage information about the most relevant command-line options and
exit.
.TP
\fB\-\-verbose\fR, \fB\-v\fR
When combined with \fB\-\-help\fR/\fB\-h\fR, display usage information about
all command-line options, not just the most relevant ones.
.TP
\fB\-\-version\fR
Display version information about
.B fgfs
and some of the libraries used by the program (SimGear, OpenSceneGraph, PLIB),
then exit.
.TP
\fB\-\-fg\-root=\fIpath\fR
Set the FlightGear data root directory (\fB$FG_ROOT\fR) to \fIpath\fR. If this
option is not set,
.B fgfs
uses the path specified in the
.B FG_ROOT
environment variable or, absent that, the FlightGear data directory chosen at
the time the program was compiled.
.TP
\fB\-\-fg\-scenery=\fIpath\fR
Set the FlightGear scenery directories (\fB$FG_SCENERY\fR) to \fIpath\fR.
You can specify multiple directories by separating them with colons (\fB:\fR),
as in \fI/first/path\fB:\fI/second/path\fR (on Microsoft Windows operating
systems, multiple paths should be separated by semicolons instead): in that
case,
.B fgfs
will follow the order the paths are written in to search for scenery files,
stopping as soon as a match is found.
If this option is not set,
.B fgfs
uses the path specified in the
.B FG_SCENERY
environment variable or, absent that, the
.B Scenery
subdirectory inside \fB$FG_ROOT\fR.
.TP
\fB\-\-fg\-aircraft=\fIpath\fR
Load additional aircraft from \fIpath\fR besides the
.B Aircraft
subdirectory inside \fB$FG_ROOT\fR. Alternatively, you can use
.B \-\-aircraft\-dir
to target a specific aircraft in a given directory.
.TP
\fB\-\-download\-dir=\fIpath\fR
Store aircraft and scenery downloaded via the simulator in \fIpath\fR.
The TerraSync directory may be specifically set with the
.B \-\-terrasync\-dir
option.
.TP
\fB\-\-allow\-nasal\-read=\fIdirs\fR
Allow Nasal aircraft scripts to read files from the directories listed in
\fIdirs\fR (separate multiple paths with colons, or semicolons on Microsoft
Windows operating systems).
By default, Nasal scripts are allowed to read data only from \fB$FG_ROOT\fR
and \fB$FG_HOME\fR, as a security measure.
.TP
\fB\-\-read\-only\fR
Make \fB$FG_HOME\fR (the location where user-specific FlightGear data is
stored) read-only.
.TP
\fB\-\-language=\fIcode\fR
Set the language used by the simulator to \fIcode\fR, where \fIcode\fR is an
ISO 639-1 two-letter locale code (for example, \fBen\fR or \fBit\fR).
.TP
\fB\-\-restore\-defaults\fR
Reset all user settings to their defaults.
.TP
\fB\-\-enable\-save\-on\-exit\fR, \fB\-\-disable\-save\-on\-exit\fR
Save/do not save user settings when the program exits.
.TP
\fB\-\-ignore\-autosave\fR
Ignore the user settings saved the previous time FlightGear was run. This
option implies \fB\-\-disable\-save\-on\-exit\fR.
.TP
\fB\-\-browser\-app=\fIpath\fR
Use the Web browser specified in \fIpath\fR to open aircraft documentation.
.TP
\fB\-\-prop:\fR[\fItype\fB:\fR]\fIname\fB=\fIvalue\fR
Set the property \fIname\fR to \fIvalue\fR. You can optionally specify the
property type by setting \fItype\fR to \fBstring\fR, \fBdouble\fR, \fBfloat\fR,
\fBlong\fR, \fBint\fR or \fBbool\fR.
.TP
\fB\-\-config=\fIpath\fR
Load additional configuration directives from \fIpath\fR. The file should
follow the format described in
.BR fgfsrc (5).
.TP
\fB\-\-no\-default\-config\fR
Do not load any configuration files unless they were explicitly specified with
\fB\-\-config\fR.
.TP
\fB\-\-units\-feet\fR
Use feet as the internal measure unit for distances.
.TP
\fB\-\-units\-meters\fR
Use meters as the internal measure unit for distances.
.TP
\fB\-\-console\fR
Display a console window for simulator/aircraft debugging purposes.
This option is recognized only on Microsoft Windows operating systems; on
other systems, debug messages are always printed to standard output/standard
error.
.TP
\fB\-\-launcher\fR
Start the FlightGear Launcher, a graphical Qt-based interface to the simulator.
This option is available only if FlightGear was compiled with Qt support
enabled.
.TP
\fB\-\-json\-report\fR
Print a report in JSON format on the standard output. The report will give
useful information for debugging purposes, such as the FlightGear version,
the scenery/aircraft paths in use, the TerraSync and the data download
directories and the paths to navigation data files.
.SS Features
.TP
\fB\-\-enable\-panel\fR, \fB\-\-disable\-panel\fR
Enable/disable the pop-up aircraft instrument panel if the chosen airplane has
it.
.TP
\fB\-\-enable\-hud\fR, \fB\-\-disable\-hud\fR
Enable/disable the heads-up display (HUD) if the chosen airplane has it.
.TP
\fB\-\-enable\-anti\-alias\-hud\fR, \fB\-\-disable\-anti\-alias\-hud\fR
Enable/disable heads-up display antialiasing.
.TP
\fB\-\-enable\-hud\-3d\fR, \fB\-\-disable\-hud\-3d\fR
Enable/disable the 3D version of the heads-up display.
.TP
\fB\-\-hud\-tris\fR
Display the number of triangles rendered when painting the heads-up display.
.TP
\fB\-\-hud\-culled\fR
Display the number of triangles culled when painting the heads-up display.
.TP
\fB\-\-enable\-random\-objects\fR, \fB\-\-disable\-random\-objects\fR
Show/hide random scenery objects, such as buildings. Scenery objects increase
realism, but require more resources (memory and graphic card power).
.TP
\fB\-\-enable\-random\-vegetation\fR, \fB\-\-disable\-random\-vegetation\fR
Show/hide random vegetation.
.TP
\fB\-\-enable\-random\-buildings\fR, \fB\-\-disable\-random\-buildings\fR
Show/hide random buildings.
.TP
\fB\-\-enable\-ai\-models\fR, \fB\-\-disable\-ai\-models\fR
Enable/disable the internal AI subsystem, which is required for multiplayer
gaming, AI traffic and many other animations. \fBDisabling the internal AI
subsystem is deprecated.\fR
.TP
\fB\-\-enable\-ai\-traffic\fR, \fB\-\-disable\-ai\-traffic\fR
Enable/disable artificial plane traffic.
.TP
\fB\-\-ai\-scenario=\fIscenario\fR
Add and enable the AI scenario \fIscenario\fR. This option may be repeated
multiple times to enable multiple scenarios.
.TP
\fB\-\-enable\-freeze\fR
Start the simulator in a frozen (paused) state.
.TP
\fB\-\-disable\-freeze\fR
Start the simulator in a running (unpaused) state.
.TP
\fB\-\-enable\-fuel\-freeze\fR
Do not consume any fuel (keep its quantity in the tanks constant).
.TP
\fB\-\-disable\-fuel\-freeze\fR
Consume fuel normally.
.TP
\fB\-\-enable\-clock\-freeze\fR
Do not let the clock advance while running the simulation.
.TP
\fB\-\-disable\-clock\-freeze\fR
Let the clock advance normally.
.TP
\fB\-\-failure=pitot\fR|\fBstatic\fR|\fBvacuum\fR|\fBelectrical\fR
Fail the aircraft pitot, static, vacuum or electrical systems. This option may
be repeated multiple times to fail more than one system.
.TP
\fB\-\-load\-tape=\fItape\fR
Load and replay the flight recorder tape \fItape\fR.
.SS "Audio options"
.TP
\fB\-\-show\-sound\-devices\fR
Show a list of available audio devices and exit.
.TP
\fB\-\-sound\-device=\fIname\fR
Set the sound device to use to \fIname\fR, where
.I name
is the device name shown by the
.B \-\-show\-sound\-devices
option.
.TP
\fB\-\-enable\-sound\fR, \fB\-\-disable\-sound\fR
Enable/disable sound in the simulator.
.SS "Rendering options"
.TP
\fB\-\-terrain\-engine=tilecache\fR|\fBpagedLOD\fR
Choose the terrain engine to use. \fBtilecache\fR is the "traditional" terrain
engine (recommended); \fBpagedLOD\fR is a new, experimental terrain engine
designed to minimize memory usage by loading more detailed versions of scenery
objects on demand.
The \fBpagedLOD\fR engine is available only if FlightGear was compiled with
GDAL support.
.TP
\fB\-\-lod\-levels=\fIlevels\fR
Set the level of detail levels to \fIlevels\fR, where \fIlevels\fR is a
space\-separated list of numeric levels. This option is available only if the
terrain engine in use is \fBpagedLOD\fR.
.TP
\fB\-\-lod\-res=\fIresolution\fR
Set the terrain mesh resolution to \fIresolution\fR. This option is available
only if the terrain engine in use is \fBpagedLOD\fR.
.TP
\fB\-\-lod\-texturing=bluemarble\fR|\fBraster\fR|\fBdebug\fR
Set the terrain texture method. This option is available only if the terrain
engine in use is \fBpagedLOD\fR.
.TP
\fB\-\-lod\-range\-mult=\fImultiplier\fR
Set the range multiplier (the breakpoint from a low to a high level of detail)
to \fImultiplier\fR. This option is available only if the terrain engine in
use is \fBpagedLOD\fR.
.TP
\fB\-\-enable\-splash\-screen\fR, \fB\-\-disable\-splash\-screen\fR
Show/hide the simulator splash screen while loading the aircraft/scenery.
.TP
\fB\-\-enable\-mouse\-pointer\fR, \fB\-\-disable\-mouse\-pointer\fR
Force enable display/do not force display the mouse pointer at startup.
.TP
\fB\-\-max\-fps=\fIfrequency\fR
Limit the maximum frame rate of the simulator to \fIfrequency\fR Hz (frames per
second).
.TP
\fB\-\-bpp=\fIdepth\fR
Use a color depth of \fIdepth\fR bits per pixel to display the aircraft and
scenery.
.TP
\fB\-\-fog\-disable\fR, \fB\-\-fog\-fastest\fR, \fB\-\-fog\-nicest\fR
Choose the fog/haze rendering technique.
.B \-\-fog\-disable
will disable fog/haze entirely;
.B \-\-fog\-fastest
will explicitly ask the graphics card driver to choose the most efficient, but
possibly less accurate, fog/haze rendering algorithm;
.B \-\-fog\-nicest
will leave the algorithm choice to the driver, leading to higher quality
results.
.TP
\fB\-\-enable\-enhanced\-lighting\fR, \fB\-\-disable\-enhanced\-lighting\fR
Enable/disable enhanced runway lighting. \fBThis option is deprecated.\fR
.TP
\fB\-\-enable\-distance\-attenuation\fR, \fB\-\-disable\-distance\-attenuation\fR
Enable/disable runway light distance attenuation (the runway lights become
less intense as distance increases).
.TP
\fB\-\-enable\-horizon\-effect\fR, \fB\-\-disable\-horizon\-effect\fR
Enable/disable the celestial body growth illusion near the horizon.
.TP
\fB\-\-enable\-specular\-highlight\fR, \fB\-\-disable\-specular\-highlight\fR
Enable/disable specular reflections on textured objects.
.TP
\fB\-\-fov=\fIdegrees\fR
Set the field of view angle (FOV) to \fIdegrees\fR. High field of view angles
allow you to see a wider part of the world; low angles allow you to "zoom in"
on details.
.TP
\fB\-\-aspect\-ratio\-multiplier=\fIfactor\fR
Set the horizontal and vertical aspect ratio multiplier to \fIfactor\fR.
.TP
\fB\-\-enable\-fullscreen\fR, \fB\-\-disable\-fullscreen\fR
Enable/disable fullscreen mode.
.TP
\fB\-\-shading\-flat\fR, \fB\-\-shading\-smooth\fR
Use flat/smooth shading. If flat shading is active, the simulator uses the same
color to paint the face of an object: this is faster, but makes edges more
pronounced. Smooth shading smooths color changes between vertices, leading to
higher-quality results, at an expense in performance.
.TP
\fB\-\-materials\-file=\fIfile\fR
Load the definitions of the materials used to render the scenery from
\fIfile\fR. By default, materials are loaded from
\fI$FG_ROOT/regions/materials.xml\fR.
.TP
\fB\-\-texture\-filtering=\fIvalue\fR
Set the anisotropic texture filtering to \fIvalue\fR. The acceptable values are
\fB1\fR (default), \fB2\fR, \fB4\fR, \fB8\fR or \fB16\fR.
.TP
\fB\-\-enable\-wireframe\fR, \fB\-\-disable\-wireframe\fR
Enable/disable the wireframe drawing mode (in which only object edges are
painted).
.TP
\fB\-\-geometry=\fIwidth\fBx\fIheight\fR
Set the window geometry (size) to \fIwidth\fBx\fIheight\fR (both \fIwidth\fR
and \fIheight\fR are in pixels).
.TP
\fB\-\-view\-offset=LEFT\fR|\fBRIGHT\fR|\fBCENTER\fR|\fIvalue\fR
Specify the default forward view direction as an offset from straight ahead.
The allowed values are \fBLEFT\fR (-90°), \fBRIGHT\fR (90°), \fBCENTER\fR (0°)
or a specific number in degrees.
.SS "Aircraft options"
.TP
\fB\-\-aircraft=\fIname\fR, \fB\-\-vehicle=\fIname\fR
Load an aircraft/vehicle from a set file named \fRname\fI\-set.xml\fR. The file
is searched for in \fI$FG_ROOT/Aircraft\fR, in the directory pointed to by the
environment variable \fBFG_AIRCRAFT\fR and in the directories passed to
.BR fgfs (1)
using the \fB\-\-fg\-aircraft\fR option.
.TP
\fB\-\-aircraft\-dir=\fIpath\fR
Explicitly specify the directory in which the \fB\-set.xml\fR file should be
searched for. If this argument is used, the path cache stored in
\fI~/.fgfs/autosave_X_Y.xml\fR, the directories passed with the
\fB\-\-fg\-aircraft\fR option and the directory specified in the
\fBFG_AIRCRAFT\fR environment variable are not taken into account.
.TP
\fB\-\-show\-aircraft\fR
Print a list of available aircraft and exit.
.TP
\fB\-\-min\-status=alpha\fR|\fBbeta\fR|\fBearly-production\fR|\fBproduction\fR
Do not list aircraft having a status level (development status) lower than the
one specified. See
.UR http://\:wiki.flightgear.org/\:Aircraft_rating_system
the FlightGear wiki "Aircraft rating system" page
.UE
for an extended description of aircraft ratings.
.TP
\fB\-\-fdm=jsb\fR|\fBlarcsim\fR|\fByasim\fR|\fBmagic\fR|\fBballoon\fR|\fBada\fR|\fBexternal\fR|\fBnull\fR
Select the core flight dynamics model to use among the following ones:
.RS 7
.IP \(bu 3
\fBjsb\fR: the
.UR http://\:www.jsbsim.org/
JSBSim flight dynamics model
.UE ,
which takes a data\-driven approach to modeling: given the performance data for
an aircraft (mass and balance, ground reactions, propulsions, aerodynamics...),
it assembles it together to produce the global aircraft dynamics;
.IP \(bu 3
\fBlarcsim\fR: the
.UR http://\:www.jsbsim.org/
LaRCsim flight dynamics model
.UE ,
the original model used in FlightGear up to 2000, developed at NASA, now
inactive;
.IP \(bu 3
\fByasim\fR: the
.UR http://\:wiki.flightgear.org/\:YASim
YASim flight dynamics model
.UE ,
which, given the physical and flying characteristics of an aircraft, attempts
to solve for them;
.IP \(bu 3
\fBmagic\fR: the "Magic Carpet" flight model;
.IP \(bu 3
\fBballoon\fR: a hot air balloon simulation;
.IP \(bu 3
\fBada\fR: an externally-driven flight dynamics model designed by the
Aeronautical Development Agency of Bangalore, India;
.IP \(bu 3
\fBexternal\fR/\fBnull\fR: use an external flight dynamics model (the
\fBexternal\fR option has the same meaning as \fBnull\fR and is maintained for
backward compatibility purposes).
.RE
.TP
\fB\-\-aero=\fIname\fR
Load the aircraft aerodynamics model from the file \fRname\fI.xml\fR in the
aircraft directory.
.TP
\fB\-\-model\-hz=\fIn\fR
Run the flight dynamics model at a frequency of \fIn\fR Hz (\fIn\fR times per
second).
.TP
\fB\-\-speed=\fIn\fR
Run the flight dynamics model \fIn\fR times faster than real time.
.TP
\fB\-\-trim\fR, \fB\-\-notrim\fR
Trim/do not attempt to trim the model. This option is only valid if the flight
dynamics module in use is JSBSim.
.TP
\fB\-\-on\-ground\fR
Start the aircraft on the ground. This is the default option.
.TP
\fB\-\-in\-air\fR
Start the aircraft in the air. This option is implied if \fB\-\-altitude\fR
is specified.
.TP
\fB\-\-enable\-auto\-coordination\fR, \fB\-\-disable\-auto\-coordination\fR
Enable/disable auto coordination (joint control of rudder and ailerons).
.TP
\fB\-\-livery=\fIname\fR
Load the aircraft livery from a file named \fIname\fR.
.TP
\fB\-\-state=\fIvalue\fR
Set the initial aircraft state to \fIvalue\fR. The states that can be used are
aircraft\-dependent.
.SS "Time options"
.TP
\fB\-\-timeofday=real\fR|\fBdawn\fR|\fBmorning\fR|\fBnoon\fR|\fBafternoon\fR|\fBdusk\fR|\fBevening\fR|\fBmidnight\fR
Start the simulator at the specified time of day:
.RS 7
.IP \(bu 3
\fBreal\fR: real clock time;
.IP \(bu 3
\fBdawn\fR: the time when the Sun is 90° E on the horizon;
.IP \(bu 3
\fBmorning\fR: the time when the Sun is 75° E on the horizon;
.IP \(bu 3
\fBnoon\fR: the time when the Sun is 0° on the horizon;
.IP \(bu 3
\fBafternoon\fR: the time when the Sun is 75° W on the horizon;
.IP \(bu 3
\fBdusk\fR: the time when the Sun is 90° W on the horizon;
.IP \(bu 3
\fBevening\fR: the time when the Sun is 100° W on the horizon;
.IP \(bu 3
\fBmidnight\fR: the time when the Sun is 180° on the horizon.
.RE
.TP
\fB\-\-season=summer\fR|\fBwinter\fR
Load summer/winter textures.
.TP
\fB\-\-time\-offset=\fR[\fB+\fR|\fB-\fR]\fIhh\fB:\fImm\fB:\fIss\fR
Add a time offset to the startup time specified with the \fB\-\-timeofday\fR
option.
.TP
\fB\-\-time\-match\-real\fR
Synchronize the simulator time with real world GMT time.
.TP
\fB\-\-time\-match\-local\fR
Synchronize the simulator time with real world local time.
.TP
\fB\-\-start\-date\-sys=\fIyyyy\fB:\fImm\fB:\fIdd\fB:\fIhh\fB:\fImm\fB:\fIss\fR
Specify the simulator starting date and time with respect to the local timezone
of the system.
.TP
\fB\-\-start\-date\-gmt=\fIyyyy\fB:\fImm\fB:\fIdd\fB:\fIhh\fB:\fImm\fB:\fIss\fR
Specify the simulator starting date and time with respect to the Greenwich Mean
Time.
.TP
\fB\-\-start\-date\-lat=\fIyyyy\fB:\fImm\fB:\fIdd\fB:\fIhh\fB:\fImm\fB:\fIss\fR
Specify the simulator starting date and time with respect to the timezone of
the starting airport.
.SS "Initial position and orientation"
.TP
\fB\-\-airport=\fIID\fR
Start the simulator at the airport having \fIID\fR as its ICAO code.
.TP
\fB\-\-parking\-id=\fIname\fR
Place the aircraft at the parking position \fIname\fR. This option requires the
\fB\-\-airport\fR option to be present.
.TP
\fB\-\-runway=\fInumber\fR
Place the aircraft on runway \fInumber\fR. This option requires the
\fB\-\-airport\fR option to be present.
.TP
\fB\-\-carrier=\fIname\fR|\fIID\fR
Place the aircraft on the AI carrier named \fIname\fR/having the ID \fIID\fR.
.TP
\fB\-\-parkpos=\fIname\fR
Place the aircraft at the starting position \fIname\fR. This option requires
the \fB\-\-carrier\fR option to be present.
.TP
\fB\-\-vor=\fIID\fR
Place the aircraft over the VOR \fIID\fR.
.TP
\fB\-\-vor\-frequency=\fIfrequency\fR
Set the frequency of the VOR to \fIfrequency\fR. This option requires the
\fB\-\-vor\fR option to be present.
.TP
\fB\-\-ndb=\fIID\fR
Place the aircraft over the NDB \fIID\fR.
.TP
\fB\-\-ndb\-frequency=\fIfrequency\fR
Set the frequency of the NDB to \fIfrequency\fR. This option requires the
\fB\-\-ndb\fR option to be present.
.TP
\fB\-\-fix=\fIID\fR
Place the aircraft over the fix \fIID\fR.
.TP
\fB\-\-offset\-distance=\fInm\fR
Place the aircraft \fInm\fR statute miles away from the reference point
specified by the previous options.
.TP
\fB\-\-offset\-azimuth=\fIdegrees\fR
Place the aircraft at a heading of \fIdegrees\fR degrees with respect to the
reference point specified by the previous options.
.TP
\fB\-\-lon=\fIdegrees\fR, \fB\-\-lat=\fIdegrees\fR
Place the aircraft at the point with the coordinates (\fIlat\fR, \fIlon\fR).
Northern longitudes/eastern latitudes must be positive; southern
longitudes/western latitudes must be negative.
.TP
\fB\-\-altitude=\fIvalue\fR
Place the aircraft at an altitude of \fIvalue\fR feet (meters if the
\fB\-\-units\-meters\fR option was specified).
.TP
\fB\-\-heading=\fIdegrees\fR
Specify the initial heading (yaw) angle (psi) of the aircraft.
.TP
\fB\-\-roll=\fIdegrees\fR
Specify the initial roll angle (phi) of the aircraft.
.TP
\fB\-\-pitch=\fIdegrees\fR
Specify the initial pitch angle (theta) of the aircraft.
.TP
\fB\-\-uBody=\fIunits_per_sec\fR
Specify the initial velocity along the body X axis.
.TP
\fB\-\-vBody=\fIunits_per_sec\fR
Specify the initial velocity along the body Y axis.
.TP
\fB\-\-wBody=\fIunits_per_sec\fR
Specify the initial velocity along the body Z axis.
.TP
\fB\-\-vNorth=\fIunits_per_sec\fR
Specify the initial velocity along the body North-South axis.
.TP
\fB\-\-vEast=\fIunits_per_sec\fR
Specify the initial velocity along the body West-East axis.
.TP
\fB\-\-vDown=\fIunits_per_sec\fR
Specify the initial velocity along the body vertical axis.
.TP
\fB\-\-vc=\fIknots\fR
Set the initial airspeed of the aircraft to \fIknots\fR knots.
.TP
\fB\-\-mach=\fInumber\fR
Set the initial airspeed of the aircraft to Mach \fInumber\fR.
.TP
\fB\-\-glideslope=\fIdegrees\fR
Set the flight path angle to \fIdegrees\fR degrees. The value can be positive.
.TP
\fB\-\-roc=\fIfpm\fR
Set the initial rate of climb to \fIfpm\fR feet per minute. The value can be
negative.
.SS "Route/waypoint options"
.TP
\fB\-\-wp=\fIID\fR[\fB@\fIalt\fR]
Enter the waypoint (VOR, NDB, fix) \fIID\fR into the autopilot. The optional
part \fB@\fIalt\fR can be used to specify the altitude at which \fIID\fR
should be crossed.
.TP
\fB\-\-flight\-plan=\fIfile\fR
Read a flight plan from \fIfile\fR.
.SS "Avionics options"
.TP
\fB\-\-com1=\fIfrequency\fR
Set the COM1 frequency to \fIfrequency\fR MHz.
.TP
\fB\-\-com2=\fIfrequency\fR
Set the COM2 frequency to \fIfrequency\fR MHz.
.TP
\fB\-\-nav1=\fR[\fIradial\fB:\fR]\fIfrequency\fR
Set the NAV1 frequency to \fIfrequency\fR MHz. You can optionally specify a
radial by prefixing the frequency with the heading and a colon.
.TP
\fB\-\-nav2=\fR[\fIradial\fB:\fR]\fIfrequency\fR
Set the NAV2 frequency to \fIfrequency\fR MHz. You can optionally specify a
radial by prefixing the frequency with the heading and a colon.
.TP
\fB\-\-adf1=\fR[\fIrotation\fB:\fR]\fIfrequency\fR, \fB\-\-adf=\fR[\fIrotation\fB:\fR]\fIfrequency\fR
Set the ADF1 frequency to \fIfrequency\fR kHz. You can optionally specify the
rotation angle of its compass card by prefixing the frequency with the angle and
a colon. \fBThe \-\-adf option is deprecated.\fR
.TP
\fB\-\-adf2=\fR[\fIrotation\fB:\fR]\fIfrequency\fR
Set the ADF2 frequency to \fIfrequency\fR kHz. You can optionally specify the
rotation angle of its compass card by prefixing the frequency with the angle and
a colon.
.TP
\fB\-\-dme=nav1\fR|\fBnav2\fR|\fIfrequency\fR
Slave the automatic direction finder to the NAV1/NAV2 radio or set its internal
frequency to \fIfrequency\fR.
.SS "Environment options"
.TP
\fB\-\-metar=\fIMETAR\fR
Simulate the weather conditions described by the METAR string \fIMETAR\fR. This
option implies \fB\-\-disable\-real\-weather\-fetch\fR.
.TP
\fB\-\-enable\-real\-weather\-fetch\fR, \fB\-\-disable\-real\-weather\-fetch\fR
Enable/disable METAR-based real weather fetching. This feature requires an
active Internet connection.
.TP
\fB\-\-enable\-clouds\fR, \fB\-\-disable\-clouds\fR
Enable/disable 2D (flat) cloud layers.
.TP
\fB\-\-enable\-clouds3d\fR, \fB\-\-disable\-clouds3d\fR
Enable/disable 3D (volumetric) cloud layers.
.TP
\fB\-\-visibility=\fImeters\fR
Set the initial visibility to \fImeters\fR meters.
.TP
\fB\-\-visibility\-miles=\fImiles\fR
Set the initial visibility to \fImiles\fR miles.
.TP
\fB\-\-wind=\fIdir\fR[\fB:\fImaxdir\fR]\fB@\fIspeed\fR[\fB:\fIgust\fR]
Specify the direction the wind blows from (\fIdir\fR) and its speed (\fIspeed\fR
knots). If the wind is not meant to blow from a fixed direction, but rather
from a range of directions, specify the range as \fIdir\fB:\fImaxdir\fR, where
\fIdir\fR and \fImaxdir\fR are the minimum and maximum angles in degrees. If
you want the simulator to model wind gusts as well, set \fIgust\fR to their
maximum intensity in knots.
.TP
\fB\-\-random\-wind\fR
Randomize the direction and speed of the wind.
.TP
\fB\-\-turbulence=\fIintensity\fR
Set the turbulence intensity to \fIintensity\fR. The intensity can range from
\fB0.0\fR (calm) to \fB1.0\fR (severe).
.TP
\fB\-\-ceiling=\fIft_asl\fR[\fB:\fIthickness_ft\fR]
Create an overcast ceiling at a height of \fIft_asl\fR feet above the mean sea
level. You can optionally specify a thickness by appending a colon (\fB:\fR)
and the desired thickness in feet; if you omit it, the simulator will default
to 2000 ft.
.SS "Network options"
.TP
\fB\-\-callsign=\fIvalue\fR
Set the multiplayer callsign to \fIvalue\fR. The callsign must be at most ten
characters long and must contain only numbers, letters of the English alphabet,
dashes (\fB\-\fR) and underscores (\fB_\fR); longer callsigns are truncated,
and characters not matching those listed above are replaced with dashes.
.TP
\fB\-\-multiplay=\fR{\fBin\fR|\fBout\fR}\fB,\fIhz\fB,\fIaddress\fB,\fIport\fR
Specify the multiplayer communication settings.
The first field specifies whether the settings apply to inbound (\fBin\fR) or
outbound (\fBout\fR) communications. The second field (\fIhz\fR) specifies the
frequency (in Hz, times per second) at which data should be sent. The third
field (\fIaddress\fR) must be set to the IP address of the network interface
that FlightGear should use to send/receive data, or left blank to let the
simulator use all available interfaces. The fourth field (\fIport\fR) should be
set to the port to use (usually \fB5000\fR).
.TP
\fB\-\-proxy=\fR[\fIusername\fB:\fIpassword\fB@\fR]\fIhost\fB:\fIport\fR
Specify the proxy server and port to use. The username and password are
optional; if they are present, they should be given as MD5 hashes.
This option is only useful if \fB\-\-real\-weather\-fetch\fR is enabled.
.TP
\fB\-\-httpd=\fR[\fIaddress\fB:\fR]\fIport\fR
Enable the Phi interface (HTTP server) on the specified address and port. The
address is optional.
.TP
\fB\-\-telnet=\fIport\fR
Enable the Telnet interface on the specified port.
.TP
\fB\-\-jpg\-httpd=\fIport\fR
Enable the screenshot HTTP server interface on the specified port. \fBThis
option is deprecated: use the Phi interface instead.\fR
.TP
\fB\-\-enable\-terrasync\fR, \fB\-\-disable\-terrasync\fR
Enable/disable automatic scenery/object downloads.
.TP
\fB\-\-terrasync\-dir=\fIdirectory\fR
Set the directory where the downloaded scenery will be stored to
\fIdirectory\fR.
.TP
\fB\-\-enable\-fgcom\fR, \fB\-\-disable\-fgcom\fR
Enable/disable the FGCom (voice ATC) integration.
.SS "I/O options"
.TP
\fB\-\-generic=\fIparams\fR, \fB\-\-atlas=\fIparams\fR, \fB\-\-atcsim=\fIparams\fR, \fB\-\-AV400=\fIparams\fR, \fB\-\-AV400Sim=\fIparams\fR, \fB\-\-AV400WSimA=\fIparams\fR, \fB\-\-AV400WSimB=\fIparams\fR, \fB\-\-garmin=\fIparams\fR, \fB\-\-hla=\fIparams\fR, \fB\-\-hla\-local=\fIparams\fR, \fB\-\-igc=\fIparams\fR, \fB\-\-joyclient=\fIparams\fR, \fB\-\-jsclient=\fIparams\fR, \fB\-\-native\-ctrls=\fIparams\fR, \fB\-\-native\-gui=\fIparams\fR, \fB\-\-native\-fdm=\fIparams\fR, \fB\-\-native=\fIparams\fR, \fB\-\-nmea=\fIparams\fR, \fB\-\-opengc=\fIparams\fR, \fB\-\-props=\fIparams\fR, \fB\-\-pve=\fIparams\fR, \fB\-\-ray=\fIparams\fR, \fB\-\-rul=\fIparams\fR
Open a connection to drive external programs or hardware.
Specify the protocol by using the correct command\-line option:
.RS 7
.IP \(bu 3
\fBgeneric\fR: a predefined communication interface and a preselected
communication protocol;
.IP \(bu 3
\fBatlas\fR: the Atlas protocol;
.IP \(bu 3
\fBatcsim\fR: the ATCsim (atc610x) protocol;
.IP \(bu 3
\fBAV400\fR: the Garmin AV400 protocol, required to drive a Garmin 196/296
series GPS;
.IP \(bu 3
\fBAV400Sim\fR: the set of AV400 strings required to drive a Garmin 400-series
GPS;
.IP \(bu 3
\fBAV400WSimA\fR, \fBAV400WSimB\fR: the set of strings required to drive a
Garmin WAAS GPS (where the \fBA\fR channel uses a variant of the AVSim400
protocol and the \fBB\fR channel communicates with the GPS unit);
.IP \(bu 3
\fBgarmin\fR: the Garmin GPS protocol;
.IP \(bu 3
\fBhla\fR, \fBhla\-local\fR: the HLA protocol, either remote or local;
.IP \(bu 3
\fBigc\fR: the International Glider Commission protocol;
.IP \(bu 3
\fBjoyclient\fR: the protocol used by Agwagon joysticks;
.IP \(bu 3
\fBnative\-ctrls\fR: the FlightGear Native Controls protocol;
.IP \(bu 3
\fBnative\-gui\fR: the FlightGear Native GUI protocol;
.IP \(bu 3
\fBnative\-fdm\fR: the FlightGear Native FDM protocol;
.IP \(bu 3
\fBnative\fR: the FlightGear Native protocol;
.IP \(bu 3
\fBnmea\fR: the NMEA protocol (used to drive most GPS units);
.IP \(bu 3
\fBopengc\fR: the protocol used by OpenGC, a software used to render
high\-quality glass cockpit displays for simulated flightdecks;
.IP \(bu 3
\fBprops\fR: the interactive property manager protocol;
.IP \(bu 3
\fBpve\fR: the PVE protocol;
.IP \(bu 3
\fBray\fR: the Ray Woodworth motion chair protocol;
.IP \(bu 3
\fBrul\fR: the RUL protocol.
.RE
.RS 7
The parameters (\fIparams\fR) must be in the form
\fImedium\fB,\fIdirection\fB,\fIhz\fB,\fImedium_options\fR where \fImedium\fR
is the medium used by the protocol (\fBserial\fR, \fBsocket\fR, \fBfile\fR...),
\fIdirection\fR is the communication direction (\fBin\fR, \fBout\fR or
\fBbi\fR), \fIhz\fR is the frequency the channel should be processed at
(floating point values are accepted) and \fImedium_options\fR are:
.RE
.RS 7
.IP \(bu 3
for serial protocols, \fIdevice\fB,\fIbaud\fR, where \fIdevice\fR is the device
name to be opened and \fIbaud\fR is the communication baud rate;
.IP \(bu 3
for socket protocols, \fImachine\fB,\fIport\fB,\fIstyle\fR, where \fImachine\fR
is the machine name or the IP address of the server (if the simulator should
act as a client) or is left empty (if the simulator should act as a server),
\fIport\fR is the port to use (or is left empty to ask the operating system to
choose an available port) and \fIstyle\fR is \fBtcp\fR or \fBudp\fR;
.IP \(bu 3
for file protocols, \fIfilename\fR, where \fIfilename\fR is the name of the
file data should be written to.
.RE
.SS "Debugging options"
.TP
\fB\-\-enable\-fpe\fR
Abort when a floating\-point exception is encountered.
.TP
\fB\-\-fgviewer\fR
View the scenery and the aircraft in a simple model viewer, without loading the
entire simulator.
.TP
\fB\-\-log\-level=bulk\fR|\fBdebug\fR|\fBinfo\fR|\fBwarn\fR|\fBalert\fR
Set the minimum logging level. Log messages having a severity greater than or
equal to the specified value are recorded; the others are discarded.
.TP
\fB\-\-log\-class=all\fR|\fBnone\fR|\fBai\fR|\fBenvironment\fR|\fBflight\fR|\fBgeneral\fR|\fBio\fR|\fBnetwork\fR|\fBsound\fR|\fBterrain\fR|...
Log only events belonging to the specified log classes (\fBall\fR logs all
events, \fBnone\fR logs none). Multiple classes can be specified by separating
them with commas or pipes, for example: \fB\-\-log\-class=ai,flight\fR.
.TP
\fB\-\-log\-dir=\fIdir\fR
Save the logs in the directory \fIdir\fR. If \fIdir\fR is \fBdesktop\fR, the
logs are saved on the Desktop. This option may be given several times, using a
different directory each time. Inside the specified directory, the log file
will be named \fIFlightGear_\fRYYYY\fI-\fRMM\fI-\fRDD\fI_\fRnum\fI.log\fR,
where \fIYYYY-MM-DD\fR is the current date and \fInum\fR is a progressive
number starting at \fB0\fR.
.TP
\fB\-\-trace\-read=\fIproperty\fR, \fB\-\-trace\-write=\fIproperty\fR
Trace the reads/writes for a property (print a log message whenever
\fIproperty\fR is read from/written to).
.TP
\fB\-\-developer\fR
Enable developer mode.
.SH "EXIT STATUS"
.B fgfs
exits with
.B 0
if the execution completes successfully, or with another status (usually
.B 1
or \fB-1\fR) if an error occurred.
.SH ENVIRONMENT
.IP "\fBCOMPUTERNAME\fR" 4
Specifies the hostname of the system in use. This environment variable is only
taken into account on Microsoft Windows operating systems.
.IP "\fBFG_AIRCRAFT\fR" 4
Specifies the path in which aircraft should be searched for.
.IP "\fBFG_LAUNCHER\fR" 4
If this environment variable is set and is not \fB0\fR, the Qt launcher will be
shown. The variable is mainly used on Mac OS X operating systems to avoid the
use of wrapper scripts.
.IP "\fBFG_ROOT\fR" 4
Specifies the root data directory to use.
.IP "\fBFG_SCENERY\fR" 4
Specifies the scenery directory to use.
.IP "\fBHTTP_PROXY\fR" 4
Specifies the HTTP proxy to use. Must be in the form \fBhttp://host:port/\fR.
.IP "\fBLANG\fR" 4
Specifies the language to use.
.SH FILES
.IP "\fI~/.fgfs\fR" 4
The main directory where FlightGear configuration files and data (downloaded
aircraft/scenery) are stored.
.IP "\fI~/.fgfsrc.hostname\fR, \fI~/.fgfsrc\fR" 4
Configuration files containing command-line options for
.BR fgfs (1).
man/man1/fgjs.1
+67
View File
@@ -0,0 +1,67 @@
.\" Copyright (C) 2002 Cameron Moore
.\" Copyright (C) 2017 Alessandro Menti
.\"
.\" This program is free software; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License
.\" as published by the Free Software Foundation; either version 2
.\" of the License, or (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
.\" Or try here: http://www.fsf.org/copyleft/gpl.html
.\"
.TH FGJS 1 2017-06-04 FlightGear "FlightGear man pages"
.SH NAME
fgjs \- FlightGear joystick utility
.SH SYNOPSIS
\fBfgjs\fR [\fB\-\-help\fR] [\fB\-\-fg\-root=\fIrootdir\fR]
.SH DESCRIPTION
.B fgjs
is a joystick utility for the FlightGear flight simulator which allows you to
generate a configuration file for your joystick interactively.
To use it, launch the program with your joystick(s) connected. The utility will
first prompt you to move each joystick around in the \fIdead band\fR, that is,
the area where it is centered and should not generate any input. Afterwards,
you will be asked to move the control/push the button you would like to use for
each function.
The configuration will be saved in the current working directory in several
files named \fIjsI.xml\fR, where \fII\fR is the progressive number assigned to
each detected joystick. You will need to move them to
.I ~/.fgfs/Input/Joysticks
for them to be used by FlightGear.
.SH OPTIONS
.TP
\fB\-\-help\fR
Display usage information and exit.
.TP
\fB\-\-fg\-root=\fIrootdir\fR
Set the FlightGear data root directory (\fB$FG_ROOT\fR) to \fIrootdir\fR.
.SH ENVIRONMENT
.IP "\fBFG_ROOT\fR" 4
If
.B FG_ROOT
is set and
.B \-\-fg\-root
is not set, it specifies the root data directory to use.
.SH FILES
.IP "\fI~/.fgfsrc.hostname\fR, \fI~/.fgfsrc\fR" 4
Configuration files containing command-line options for
.BR fgfs (1).
The
.B \-\-fg\-root
command-line option is searched there if it is not passed as a command-line
argument to \fBfgjs\fR.
.SH "SEE ALSO"
.BR fgfs (1),
.BR js_demo (1),
.UR http://\:wiki.flightgear.org/\:Joystick
the FlightGear wiki "Joystick" page
.UE
man/man1/fgpanel.1
+44
View File
@@ -0,0 +1,44 @@
.\" Copyright (C) 2011 Thorsten Brehm
.\" Copyright (C) 2017 Alessandro Menti
.\"
.\" This program is free software; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License
.\" as published by the Free Software Foundation; either version 2
.\" of the License, or (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
.\" Or try here: http://www.fsf.org/copyleft/gpl.html
.\"
.TH FGPANEL 1 2017-02-26 FlightGear "FlightGear man pages"
.SH NAME
fgpanel \- FlightGear Flight Simulator Panel Rendering Engine
.SH SYNOPSIS
\fBfgpanel\fR \fB\-\-panel=\fIfile\fR [\fB\-\-fg-root=\fIpath\fR]
[\fB\-\-prop:\fIname\fB=\fIvalue\fR]
.SH DESCRIPTION
.B fgpanel
is a free, open-source, multi-platform, and lightweight panel rendering engine
to draw 2D panels on a low-cost computer/graphic card without 3D acceleration
at reasonable frame rates.
.SH OPTIONS
.TP
\fB\-\-panel=\fIfile\fR
Display the panel description file \fIfile\fR.
.TP
\fB\-\-fg\-root=\fIpath\fR
Set the FlightGear data root directory (\fB$FG_ROOT\fR) to \fIpath\fR.
.TP
\fB\-\-prop:\fIname\fB=\fIvalue\fR
Set the property named \fIname\fR to \fIvalue\fR.
.SH "SEE ALSO"
.BR fgfs (1),
.UR http://\:wiki.flightgear.org/\:FGPanel
the FlightGear wiki "FGPanel" page
.UE
man/man1/fgqcanvas.1
+37
View File
@@ -0,0 +1,37 @@
.\" Copyright (C) 2017 Alessandro Menti
.\"
.\" This program is free software; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License
.\" as published by the Free Software Foundation; either version 2
.\" of the License, or (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
.\" Or try here: http://www.fsf.org/copyleft/gpl.html
.\"
.TH FGQCANVAS 1 2017-02-28 FlightGear "FlightGear man pages"
.SH NAME
fgqcanvas \- A Qt-based remote canvas application for FlightGear
.SH SYNOPSIS
\fBfgqcanvas\fR
.SH DESCRIPTION
.B fgqcanvas
is a Qt-based application that can connect to any FlightGear instance having
the built-in HTTPD server enabled and display any canvas in real time.
.PP
To use \fBfgqcanvas\fR, start it and enter the URL to the HTTP websocket, such
as \fIws://localhost:8080/PropertyTreeMirror\fR, then enter the canvas path
you would like to display, such as \fI/canvas/by-index/texture[0]/\fR.
.SH "EXIT STATUS"
.B fgqcanvas
exits with
.B 0
on success, with an exit code other than zero if an error occurs.
.SH "SEE ALSO"
.BR fgfs (1)
man/man1/fgviewer.1
+91
View File
@@ -0,0 +1,91 @@
.\" Copyright (C) 2017 Alessandro Menti
.\"
.\" This program is free software; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License
.\" as published by the Free Software Foundation; either version 2
.\" of the License, or (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
.\" Or try here: http://www.fsf.org/copyleft/gpl.html
.\"
.TH FGVIEWER 1 2017-06-25 FlightGear "FlightGear man pages"
.SH NAME
fgviewer \- An alternative FlightGear viewer application
.SH SYNOPSIS
\fBfgviewer\fR [\fB\-\-fg\-root\fR \fIrootdir\fR]
[\fB\-\-fg\-scenery\fR \fIscenerydir\fR] [\fB\-\-config\fR \fIconfigfile\fR]
[\fB\-\-prop\fR \fIproperty\fR \fIvalue\fR] [\fB\-\-renderer\fR \fIrend\fR]
[\fB\-\-hla\fR] [\fB\-\-federation\fR \fIfed\fR]
.SH DESCRIPTION
.B fgviewer
is a viewer application that allows you to examine FlightGear scenery and
objects without starting
.BR fgfs (1).
.SH OPTIONS
.TP
\fB\-\-fg\-root\fR \fIrootdir\fR
Set the FlightGear data root directory (\fB$FG_ROOT\fR) to \fIrootdir\fR. If
this option is not set,
.B fgviewer
uses the path specified in the
.B FG_ROOT
environment variable or, absent that, the FlightGear data directory chosen at
the time the program was compiled.
.TP
\fB\-\-fg\-scenery\fR \fIscenerydir\fR
Set the FlightGear scenery directory (\fB$FG_SCENERY\fR) to \fIscenerydir\fR.
If this option is not set,
.B fgviewer
uses the path specified in the
.B FG_SCENERY
environment variable or, absent that, the
.B Scenery
subdirectory inside \fB$FG_ROOT\fR.
.TP
\fB\-\-config\fR \fIconfigfile\fR
Read configuration directives from \fIconfigfile\fR.
.TP
\fB\-\-prop\fR \fIproperty\fR \fIvalue\fR
Set the property named \fIproperty\fR to \fIvalue\fR.
.TP
\fB\-\-renderer\fR \fIrend\fR
Use the renderer named \fIrend\fR to render the scenery. This option is
currently not supported.
.TP
\fB\-\-hla\fR
Enable HLA federation.
.TP
\fB\-\-federation\fR \fIfed\fR
Enable a custom federation named \fIfed\fR.
.SH "EXIT STATUS"
.B fgviewer
exits with
.B EXIT_SUCCESS
on success, with
.B EXIT_FAILURE
if the syntax of the command-line arguments is wrong or an error occurs.
.SH ENVIRONMENT
.IP "\fBFG_ROOT\fR" 4
If
.B FG_ROOT
is set and
.B \-\-fg\-root
is not set, it specifies the root data directory to use.
.IP "\fBFG_SCENERY\fR" 4
If
.B FG_SCENERY
is set and
.B \-\-fg\-scenery
is not set, it specifies the scenery directory to use.
.SH FILES
.IP "\fI$FG_ROOT/defaults.xml\fR" 4
Default preferences file loaded on startup.
.SH "SEE ALSO"
.BR fgfs (1)
man/man1/js_demo.1
+34
View File
@@ -0,0 +1,34 @@
.\" Copyright (C) 2017 Alessandro Menti
.\"
.\" This program is free software; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License
.\" as published by the Free Software Foundation; either version 2
.\" of the License, or (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
.\" Or try here: http://www.fsf.org/copyleft/gpl.html
.\"
.TH JS_DEMO 1 2017-03-04 FlightGear "FlightGear man pages"
.SH NAME
js_demo \- Joystick demo application for FlightGear
.SH SYNOPSIS
\fBjs_demo\fR
.SH DESCRIPTION
.B js_demo
is a FlightGear utility that shows detected joysticks and provides a way to
monitor them as their axes are moved or their buttons are pressed.
.SH "EXIT STATUS"
.B js_demo
always exits with \fB0\fR.
.SH "SEE ALSO"
.BR fgfs (1),
.UR http://\:wiki.flightgear.org/\:Input_device
the FlightGear wiki "Input device" page
.UE
man/man1/metar.1
+79
View File
@@ -0,0 +1,79 @@
.\" Copyright (C) 2017 Alessandro Menti
.\"
.\" This program is free software; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License
.\" as published by the Free Software Foundation; either version 2
.\" of the License, or (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
.\" Or try here: http://www.fsf.org/copyleft/gpl.html
.\"
.TH METAR 1 2017-06-25 FlightGear "FlightGear man pages"
.SH NAME
metar \- demo METAR utility for FlightGear
.SH SYNOPSIS
\fBmetar\fR \fB\-h\fR | \fB\-\-help\fR | [\fB\-v\fR | \fB\-\-verbose\fR]
[\fB\-e\fR \fIelevation\fR | \fB\-\-elevation\fR \fIelevation\fR] [\fB\-r\fR |
\fB\-\-report\fR | \fB\-c\fR | \fB\-\-command\-line\fR] \fI<list of ICAO airport
IDs or METAR strings>\fR
.SH DESCRIPTION
.B metar
is a demo utility for FlightGear that retrieves a METAR (encoded weather
information) for one or more given airports from the Internet and displays it
in a user-readable form. Optionally, it can also print the command-line
arguments required to start
.BR fgfs (1)
at the current time and with the weather conditions in effect.
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
Display usage information and exit.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Display debugging information while performing the required operation.
.TP
\fB\-e\fR \fIelevation\fR, \fB\-\-elevation\fR \fIelevation\fR
Set the airport elevation to \fIelevation\fR meters.
.TP
\fB\-r\fR, \fB\-\-report\fR
Print the weather information on the screen in a user-readable form.
.TP
\fB\-c\fR, \fB\-\-command\-line\fR
Print the command-line arguments required to start FlightGear at the current
time and with the weather conditions in effect.
.SH "EXIT STATUS"
.B metar
exits with
.B 0
on success, with
.B 1
if the syntax of the command-line arguments is wrong or an error occurs.
.SH ENVIRONMENT
.IP "\fBHTTP_PROXY\fR" 4
Specifies the HTTP proxy to use. Must be in the form
\fBhttp://host:port/\fR.
.SH EXAMPLE
Print the current weather information for KSFO and KOAK:
$ \fBmetar KSFO KOAK\fR
Print the current weather information for KSFO, as well as the command line
arguments required to start FlightGear with the weather conditions in effect:
$ \fBmetar -c KSFO -r KSFO\fR
Print the given METAR string as a user-readable weather report:
$ \fBmetar "LOWL 161500Z 19004KT 160V240 9999 FEW035 SCT300 29/23 Q1006 NOSIG"\fR
.SH "SEE ALSO"
.BR fgfs (1),
.UR http://\:wiki.flightgear.org/\:Weather_reports
the FlightGear wiki "Weather reports" page
.UE