Scripted Compilation on Linux Debian/Ubuntu: Difference between revisions

Reduce redundancy (only one copy of the list of available components in the main text—sample output of download_and_compile.sh --help has a second copy)
(→‎Launching FlightGear: Add precisions (start without any launcher))
(Reduce redundancy (only one copy of the list of available components in the main text—sample output of download_and_compile.sh --help has a second copy))
Line 337: Line 337:
  $ git log -p -- download_and_compile.sh
  $ git log -p -- download_and_compile.sh


== List of compiled programs ==
== <span id="list-of-available-components"></span> List of available components ==


The <tt>download_and_compile.sh</tt> script is able to download and compile:
The <tt>download_and_compile.sh</tt> script is able to download, compile (when applicable) and install the following components:
* [[SimGear]] (”base libraries” that are part of the FlightGear project, and required)
* FlightGear
* [[FGData]] (base data files that are part of the FlightGear project, and required)
* [https://cmake.org/ CMake] (in case CMake is too old in your distribution)
* [[PLIB]]
* [[OpenSceneGraph]]
* [[FGRun]]
* [[FGo!]]
* [[FGX]]
* [[TerraGear]]
* [[TerraGear_GUI]]
* [[OpenRadar]]
* [[ATC-pie]]
* [[FlightGear HLA support (High Level Architecture) | OpenRTI]]


(Note that OpenRTI is just an optional dependency for [[FlightGear high-level architecture support|HLA support]]. For the time being, you should be just fine building without it. Eventually, the idea is for HLA to replace the existing MP system and even increasingly distribute the FlightGear architecture such that more and more components can be more easily run in separate threads or even separate processes, possibly even on different machines. So this is going to be an important feature for professional users, using several computers and screens to create a comprehensive and immersive simulation environment.
* ATCPIE (for the [[ATC-pie]] air traffic control simulation program)
* CMAKE (for the [https://cmake.org/ CMake] build tool—this can be useful in case CMake is too old in your distribution)
* DATA (for [[FGData]], the main set of data files used by FlightGear)
* FGFS (for FlightGear itself)
* FGO (for the [[FGo!]] FlightGear launcher)
* FGRUN (for the [[Fgrun|FGRun]] FlightGear launcher)
* FGX (for the [[FGX|FGx]] FlightGear launcher<ref name="note-on-the-status-of-FGx-support-in-download-and-compile-sh">Support for FGx in <tt>download_and_compile.sh</tt> would probably benefit from a code review.</ref>)
* OPENRADAR (for the [[OpenRadar]] air traffic control simulation program)
* OPENRTI (for [[FlightGear HLA support (High Level Architecture)#OpenRTI | OpenRTI]]<ref name="note-on-the-status-of-OpenRTI-support-in-FG">Note that OpenRTI is just an optional dependency for [[FlightGear high-level architecture support | HLA support]]. For the time being, you should be just fine building without it. Eventually, the idea is for HLA to replace the existing MP system and even increasingly distribute the FlightGear architecture such that more and more components can be more easily run in separate threads or even separate processes, possibly even on different machines. So this is going to be an important feature for professional users, using several computers and screens to create a comprehensive and immersive simulation environment.
<p>
At the moment, it is probably safe to say that HLA is only of interest to developers and people willing to play with experimental features.</ref>)
* OSG (for the [[OpenSceneGraph]] library)
* PLIB (for the [[PLIB]] library)
* SIMGEAR (for the [[SimGear]] library—foundation for FlightGear and TerraGear)
* TERRAGEAR (for the [[TerraGear]] terrain building toolchain)
* TERRAGEARGUI (for [[TerraGear GUI]], a graphical interface for TerraGear)


At the moment, it's probably safe to say that HLA is only of interest to developers and people willing to play with experimental features.)
Each of the items listed above is a ''component'' in <tt>download_and_compile.sh</tt> terminology. Components are written in uppercase by convention.


Each of the items listed above corresponds to a ''component'' in <tt>download_and_compile.sh</tt> terminology. Components are written in uppercase. The list of supported ones is currently:
{{Note|The preceding list might not be up-to-date. The up-to-date list of components supported by <tt>download_and_compile.sh</tt> can always be obtained by running <code>download_and_compile.sh --help</code>.}}
* SIMGEAR
* FGFS (this corresponds to FlightGear)
* DATA (this corresponds to [[FGData]])
* CMAKE
* PLIB
* OSG (this corresponds to [[OpenSceneGraph]])
* FGRUN
* FGO
* FGX
* TERRAGEAR
* TERRAGEARGUI
* OPENRADAR
* ATCPIE
* OPENRTI
The up-to-date list of components can be obtained by running:
$ download_and_compile.sh --help


What is the point of knowing this? Because you may pass component names to <tt>download_and_compile.sh</tt> in order to tell it what you want to download, build and install. By default, only the three essential components SIMGEAR, FGFS and DATA are taken care of, which means that the command:
What is the point of knowing this? Because you may pass component names to <tt>download_and_compile.sh</tt> in order to tell it what you want to download, build and install. By default, only the three essential components SIMGEAR, FGFS and DATA are taken care of, which means that the command:
  download_and_compile.sh
  $ download_and_compile.sh
is equivalent to:
is equivalent to:
  $ download_and_compile.sh SIMGEAR FGFS DATA
  $ download_and_compile.sh SIMGEAR FGFS DATA
Line 467: Line 452:
  $ download_and_compile.sh SIMGEAR FGFS DATA OSG
  $ download_and_compile.sh SIMGEAR FGFS DATA OSG


The available components are (in April 2019):<br />
See [[#list-of-available-components|above]] for the list of available components.
CMAKE, PLIB, OPENRTI, OSG, SIMGEAR, FGFS, DATA, FGRUN, FGO, FGX, OPENRADAR, ATCPIE, TERRAGEAR, TERRAGEARGUI.
 
The full, up-to-date list of these components can always be obtained by running:
$ download_and_compile.sh --help


=== TerraGear ===
=== TerraGear ===
Line 545: Line 526:


== Options ==
== Options ==
=== Selecting the components to build ===


By default, <tt>download_and_compile.sh</tt> downloads or updates, then compiles, [[SimGear]] and FlightGear, and downloads or updates [[FGData]] (by nature, FGData can't be compiled). This is what happens when running:
By default, <tt>download_and_compile.sh</tt> downloads or updates, then compiles, [[SimGear]] and FlightGear, and downloads or updates [[FGData]] (by nature, FGData can't be compiled). This is what happens when running:
Line 552: Line 535:
SIMGEAR, FGFS, DATA and OSG are the component names respectively corresponding to [[SimGear]], FlightGear, [[FGData]] and [[OpenSceneGraph]] in <tt>download_and_compile.sh</tt>'s terminology.
SIMGEAR, FGFS, DATA and OSG are the component names respectively corresponding to [[SimGear]], FlightGear, [[FGData]] and [[OpenSceneGraph]] in <tt>download_and_compile.sh</tt>'s terminology.


See the output of <code>download_and_compile.sh --help</code> for more details.
A [[#list-of-available-components|list of available components]] is provided on this page, but the fully up-to-date list can always be obtained by running <code>download_and_compile.sh --help</code>.
 
=== Compiling selected components ===
 
{{Note|The following is not necessarily up-to-date. See the output of <code>download_and_compile.sh --help</code> for the up-to-date list of components.}}
 
If you wish to download, build and install some of the available programs, you can launch <tt>download_and_compile.sh</tt> with one or more of the following component names:
* CMAKE (for the [https://cmake.org/ CMake] build tool)
* PLIB (for the [[PLIB]] library)
* OSG (for the [[OpenSceneGraph]] library)
* SIMGEAR (for the [[SimGear]] library)
* FGFS (for FlightGear itself)
* DATA (for [[FGData]], the main set of data files used by FlightGear)
* FGRUN (for the [[Fgrun|FGRun]] launcher)
* TERRAGEAR (for the [[TerraGear]] terrain building toolchain)
* TERRAGEARGUI (for [[TerraGear GUI]], a graphical interface for TerraGear)
* OPENRADAR (for [[OpenRadar]])
* FGO (for the [[FGo!]] launcher)


=== Compiling the last known-stable versions ===
=== Compiling the last known-stable versions ===
377

edits