Jump to: navigation, search

Scripted Compilation on Linux Debian/Ubuntu

51,779 bytes added, 17:22, 4 October 2019
add prerequisites section since dnc doesn't automatically pull these needed tools if they are not already installed.
==Description==The following <tt></tt> is a Bash script that takes care of downloading and compiling Flightgear FlightGear and related software from the git their source code repositories with just one command execution <ref name="just-one-command">Due to technical problems on the [ SourceForge] side, this is currently only true once you have an [[FGData]] clone. See [[User:Rominet|here]] for details.</ref> for both 32-bit and 64-bit [ Debian ]-based systems (Debian, Ubuntu). Pre-existing installed version versions (if any) of Flightgear the software installed by <tt></tt> are not touched at all since the script downloads, builds and installs everything under the directory in which it is launched. You can choose the particular components to download, build and install.
Necessary Unless told not to do so, <tt></tt> installs packages are installed via the with <tt>apt-get system while libraries not included in the repositories are downloaded and compiled </tt>. For this reason, it is primarily useful on the fly (iDebian-based distributions.e. [[Plib]]However, [[Simgear]] and [[OSG]]if one disables package installation (using <code>-pn</code> or <code>--sudo=echo</code>)and installs the corresponding dependencies oneself, it might be useful on other distributions as well.
===List of compiled programs===The script is able to download For hints on using <tt>rpm</tt>-based distributions such as Redhat, Fedora and compile:* Flightgear (And all the data needed to use it)* CentOS, please see [[FgrunCentOS]]* . Please also see [[FGCOM]]* [[FGComGui]]* [[Atlas]]* [[TerrasyncSuperbuild]].
==DownloadIntroduction ==You can download the script here: [] [[|Wiki Backup]]
The script <tt></tt> is hosted on a home server[ Bash] script written for [ Debian]-derived distributions ([ Ubuntu], so if the electricity goes down or internet connection fails[ Devuan], you will be not able [ Linux Mint], etc.). Its purpose is to download it directlyautomatically install dependencies using the package manager, then build and install FlightGear-related programs.
By default, <tt></tt> installs most dependencies with <tt>apt-get</tt> run under <tt>sudo</tt>.<ref name="disabling-installation-of-dependencies-via-package-manager">If all else failsyou think you already have the dependencies, join this installation can be disabled either by using option <code>-pn</code> or by passing option <code>--sudo=echo</code> (the latter results in printing the <tt>apt-get</tt> command line without running it).</ref> Other dependencies, either because they aren't available in the standard APT repositories, or because of non-option arguments passed to <tt></tt>, are downloaded and compiled on the fly (this can be the case for [[FlightGear IRC channelPLIB]], [[Simgear]] and ask [[OpenSceneGraph]], for instance—it all depends on the script. Someone there will be likely arguments passed to provide it to youthe script).
==Instructions==To run <tt>, just save it </tt> works in a the directory called for exampleit is run from: ~apart from dependencies installed via the package manager, all programs built by <tt></fg_toolsthen execute it (no need tt> are installed under the <tt>install</tt> subdirectory of the directory from which the script was run. In other words, installation of programs by <tt></tt> is clean, very easy to execute it as root)undo and doesn't interfere with other programs on the system.
Here It is for example a sequence of commands possible to get the script and launch it in a new folder.manage several directory trees with <prett>mkdir ~/fgfscd ~/fgfswget 755 download_and_compile</tt>; as far as it is concerned, such directory trees are completely independent from each other.shsh For instance, if you run <tt></prett> in <tt>dir1</tt> and <tt>dir2</tt>Once all will be finished, you will sucessfully get all the programs installed in the ~under <tt>dir1</fgfs directorytt> won't “see” those installed under <tt>dir2</tt>, and vice versa.
===Launching FlightGear===To run your new git installation of Flightgear you have Apart from its main purpose, <tt></tt> can be used to launch the ''run_fgfsfind hopefully up-to-date build-dependency information for FlightGear and related software. You would do so by inspecting ['' command under the same folder, script] at the point where it installs packages.<ref name="note-inspecting-download-and-compile-sh-to-gather-build-dependency-information">Look for example:strings such as <prett>cd ~zlib1g-dev</fgfssh run_fgfstt>, <tt>libglew-dev</tt> or <tt>qt5-default</tt>.sh</preref>
==Prerequisites =Launching Fgrun===For many users it's more comfortable having Flightgear launched by the graphical utiliy Fgrun which is installed as well in the same folder. You have to launch the '''' command, for example:<pre>cd ~/fgfssh</pre>
===Launching FGCOM===FGCOM is Before embarking on building your own FlightGear binaries, you must have already installed the system used by flightgear necessary tools to simulate radio communications between users. Launch it using compile the '''' command:<pre>cd ~/fgfssh run_fgcomsource code -cs</pre>These preliminary tools are
* build-essential* git* subversion* cmake* automake They can be installed quite simply by running the following command line.  $ sudo apt-get install build-essential git subversion cmake automake Once these tools are installed, the script can be run. It will install possibly needed additional tools and libraries as it runs. ==<span id=Launching FGComGui"disk-space-requirements-and-build-time"></span> Disk space requirements and build time == As of April 2019, building FlightGear requires about 12 [ GiB] of disk space. Note that this includes downloaded source code for [[SimGear]] and FlightGear, generated build files and the large [[FGData]] repository (about 6 GiB for that one). With an Intel Core i7 860 CPU (2.80 GHz) purchased in 2009, compiling [[SimGear]] and FlightGear 2019.2 with option <code>-j8</code> takes about 14 minutes. If you don't have a fast machine and build using only one core, it may require several hours. == Download ==FgComGui You can get <tt></tt> {{fgmeta source| path =| text = from FGMeta }}. It is contained in the [[FGMeta]] repository, which is maintained by the FlightGear developers. The script can be downloaded from the link given above, however, for easier updates and in order to have the command <code> --version</code> work as intended, it is recommended to get it as explained [[#getting-download-and-compile-sh-using-an-fgmeta-clone|below]]. In case you build stable versions of FlightGear using the <code>-s</code> option of <tt></tt>, remember to update the script before trying to build a GUI wrapper new version of FlightGear (see [[#updating-download-and-compile-sh-using-an-fgmeta-clone|Updating <tt></tt>]] below). Of course, you can update it more often in order to launch fgcombenefit from new features or bug fixes; this is especially useful if you are building ''next'', that is, the development branch of FlightGear== <span id="getting-started-with-download-and-compile-sh"></span> Getting started with <tt></tt> == Because of technical problems at SourceForge (cloning [[FGData]] using the https protocol usually fails), the initial setup is unfortunately more complex than it used to be. You'll be guided step by step though, so don't be afraid. Besides, once you have a complete clone of the FGData repository, all future operations will be really easy. We'll first explain how to get <tt></tt> in a way that makes it convenient to update and causes the command <code> --version</code> to work as intended (the reported “version” is a Git blob id such as <tt>6a5e4f05e2ccf27115eec58313be027b11266097</tt><ref name="note-on-download-and-compile-sh-version-being-a-Git-blob-id">This looks like, but is ''not'' a Git commit identifier. This kind of “version number” is admittedly not very pretty, but it doesn't pollute Git commits (the diffs) and is automatically updated by Git every time you update <tt></tt> the way we present here; thus, the advantages compensate for the ugliness.</ref>). Then we'll show how to clone the large FGData repository, and finally give instructions to get FlightGear up and running. === <span id="getting-started-with-download-and-compile-sh-notations"></span> Notations === When a command should be run as an unpriviledged user, it will be preceded by a dollar sign: $ whoami totoIn contrast, a hash sign (#) means that the command must be run with superuser privileges to achieve the desired effect: # whoami root In order to make instructions easy to understand, two directories (= folders) will be consistently used for the same purpose below:* <tt>~/flightgear/fgmeta</tt> will contain a clone of the [[FGMeta]] repository; therefore, <tt></tt> will reside in that directory;* <tt>~/flightgear/dnc-managed</tt> will be the directory from which we run <tt></tt>. In other words, with this setup, a typical sequence of commands could be: $ cd ~/flightgear/dnc-managed $ ~/flightgear/fgmeta/ SIMGEAR FGFS DATAThese are of course just examples. The aforementioned paths are not hardwired anywhere in the script; you are free to choose the directories you want for these purposes. === <span id="getting-download-and-compile-sh-using-an-fgmeta-clone"></span> Getting <tt></tt> the “right way” === There are several ways to obtain []. The method described here makes it very easy to update the script and causes the command <code> --version</code> to work as intended. As explained in [[#getting-started-with-download-and-compile-sh-notations|Notations]], we want to clone the [[FGMeta]] repository in <tt>~/flightgear/fgmeta</tt>. Let's go: $ mkdir -p ~/flightgear $ cd ~/flightgear <nowiki>$ git clone</nowiki>You now have a fresh FGMeta clone in <tt>~/flightgear/fgmeta</tt> and your brand new <tt></tt> script is located in that directory. You can already try it to see the available options:<pre>$ ~/flightgear/fgmeta/ [OPTION...] [--] [COMPONENT...]Download and compile components belonging to the FlightGear ecosystem. Without any COMPONENT listed, or if ALL is specified, recompile allcomponents listed in the WHATTOBUILDALL variable. Each COMPONENT maybe one of the following words:  ALL, CMAKE, OSG, PLIB, OPENRTI, SIMGEAR, FGFS, DATA, FGRUN, FGO, FGX, OPENRADAR, ATCPIE, TERRAGEAR, TERRAGEARGUI Available options: -h, --help show this help message and exit --version print version and license information, then exit (...)</pre> === <span id="updating-download-and-compile-sh-using-an-fgmeta-clone"></span> Updating <tt></tt> === Now that you have <tt></tt> from the [[FGMeta]] repository, it is very easy to update (this assumes you didn't modify anything yourself inside <tt>~/flightgear/fgmeta</tt>!): $ cd ~/fgfs flightgear/fgmeta && git pull If you want to keep updates as easy as we just shown, it is best not to modify <tt></tt> yourself. <tt></tt> has plenty of options that usually make it unnecessary to modify the script. Just run <code> --help</code> and learn about the available options when you feel the need to change something. Unless you have special needs that can only be accomodated by modifying <tt></tt>, you are invited to skip to the next section. If you really, ''really'' want to modify <tt></tt> while keeping updates easy, a good technique is to add your changes to your FGMeta clone in the form of one or more Git ''commits'' (no need to push them anywhere, commits can remain in your clone). How to do that is beyond the scope of this document, though; read Git tutorials if you want to learn it (there are plenty on the Internet). Once you have committed your changes to your FGMeta clone, make sure the repository is clean (use <code>git status</code>), then update it with: $ cd ~/flightgear/fgmeta && git pull --rebaseThis will apply your commits on top of the latest commit of the branch that is currently checked out, which so far contained the official version of <tt> run_fgcomgui</tt>.In case your changes conflict with the update, Git will tell you and you'll have to resolve the conflict manually (look for “Git resolve conflict” on your favorite search engine)... or start again from a pristine [[FGMeta]] clone. === <span id="using-download-and-compile-sh-to-build-flightgear"></span> Building FlightGear === For the method described below, you'll need an account at [ SourceForge] (this is unfortunate, but methods that don't require such an account are either unreliable or insecure, as long as [[FGData]] can't be cloned using the <tt>https</tt> protocol). If you don't already have one, go to the [ registration page] and create an account. In all this section, we'll assume that your account name at SourceForge is ''SFusername''. In what follows, we won't give the full path to <tt></tt> when showing commands to be run, but you should prepend it to <tt></tt> whenever you see a <tt></tt> command. For instance, if you used the same path as in [[#getting-started-with-download-and-compile-sh-notations|Notations]] and see the command: $ --helpwhat you should actually run is: $ ~/flightgear/fgmeta/ --help Apart from this harmless command, ''do not'' run other <tt></tt> commands from an arbitrary directory, in particular ''don't'' run them from <tt>~/flightgear/fgmeta</tt>. This is because '''most other <tt></tt> commands write to the current directory''' (<code> --help</code> and <code> --version</code> are safe to run from any directory, though). Of course, it is always possible to make commands shorter by setting up aliases (see tips at the end of [ this message]), by adding the directory containing <tt></tt> to your <tt>PATH</tt> or by creating a symbolink link pointing to <tt></tt> in a directory that is part of your <tt>PATH</tt>. This is not necessary, though; do it only if you feel the need (when enabled, persistent shell history is often enough for such things). {{Note|The following commands should be run from an empty directory<ref name="dedicated-directory-won-t-stay-empty-forever">Well, empty before the first time; later, <tt></tt> is going to populate it with plenty of FlightGear files and subdirectories, of course.</ref> in a partition that has enough free space (see [[#disk-space-requirements-and-build-time | Disk space requirements and build time]]). As explained in [[#getting-started-with-download-and-compile-sh-notations|Notations]], we are going to choose the directory <tt>~/flightgear/dnc-managed</tt> for this purpose, in order to express that the whole directory tree is managed by <tt></tt>. This is just an example; feel free to choose another directory if you want. '''Don't run the commands from a non-dedicated directory,''' because it will be filled with files and directories created by <tt></tt> and the FlightGear, SimGear, etc. build systems. That would be a complete mess! In particular, ''don't'' run the commands from the directory containing your [[FGMeta]] clone.}} {{Note|As explained in [[#getting-started-with-download-and-compile-sh-notations|Notations]], we assume that your Unix user name (login) is <tt>toto</tt>. Don't confuse the <tt>sudo</tt> password prompt (where you need to enter <tt>toto</tt>'s password) with the password prompt for your SourceForge account! The former appears as [sudo] password for toto:whereas the latter is just: Password:}} {{Tip|In case you want to run some other program instead of <tt>sudo</tt>, this can be done with the <code>--sudo</code> option of <tt></tt>. For instance, in order to see the commands that would be run with sudo without actually running them, you can pass <code><nowiki>--sudo=echo</nowiki></code> to <tt></tt>. Like all other options, <code><nowiki>--sudo</nowiki></code> must be given ''before'' all arguments that are component names (such as <tt>SIMGEAR</tt>, <tt>FGFS</tt>, <tt>DATA</tt>, etc.).}} The package manager used by <tt></tt> by default is <tt>apt-get</tt>. You can use another one if you want, as long as it supports the following calls: ''pkg-mgr'' update ''pkg-mgr'' install ''pkg1 pkg2'' ...This is the case for <tt>aptitude</tt> as well as <tt>apt</tt>. If you want <tt></tt> to use <tt>aptitude</tt>, give it the option <code><nowiki>--package-manager=aptitude</nowiki></code> before any of the ''COMPONENT'' arguments. All options of <tt></tt> can be seen by running the following command: $ --helpNow the instructions we promised you. You have chosen a dedicated directory where all the stuff that is downloaded and built by <tt></tt> will be stored. This is <tt>~/flightgear/dnc-managed</tt> in our example, and should be empty before you run <tt></tt> for the first time. However, it is quite correct to start <tt></tt> from the same directory for subsequent runs, even when non-empty (otherwise, <tt></tt> would automatically reclone the repositories every time you run it; that would be a sheer waste of time and bandwidth). Ready? Let's go!<pre>$ mkdir -p ~/flightgear/dnc-managed$ cd ~/flightgear/dnc-managed$ --git-clone-site-params SourceForge=ssh:SFusername DATA*********************************************************************** ** Warning: a typical SimGear + FlightGear + FGData build requires ** about 12 GiB of disk space. The compilation part may last from a ** few minutes to hours, depending on your computer. ** ** Hint: use the -j option if your CPU has several cores, as in: ** ** -j$(nproc) ** ***********************************************************************Running 'apt-get update'...[sudo] password for toto: (...) Considering a package alternative: libcurl4-openssl-dev libcurl4-gnutls-devPackage alternative matched for libcurl4-openssl-devRunning 'apt-get install build-essential git libcurl4-openssl-dev cmake'...[sudo] password for toto: (...) ******************************************************** DATA **********************************************************Fetching DATA with 'git clone ssh://'Cloning into '.'...The authenticity of host ' (' can't be established.ECDSA key fingerprint is SHA256:FeVkoYYBjuQzb5QVAgm3BkmeN5TTgL2qfmqz9tCPRL4.Are you sure you want to continue connecting (yes/no)?Warning: Permanently added ',' (ECDSA) to the list of known hosts.Connection closed by port 22fatal: Could not read from remote repository.
===Launching Atlas===Please make sure you have the correct access rightsAtlas provides a map for Flightgear, use it launching: ''run_atlasand the repository''<pre>cd ~/fgfssh
===Launching Terrasync===The above messages are perfectly normal but deserve a little explanation. Here, <tt>ssh</tt> asked us to confirm that the fingerprint sent by the remote host is that of the real <tt></tt>, as opposed to that of some malicious server ''pretending'' to be <tt></tt>. This confirmation only has to be done once, after which it is remembered thanks to <tt>~/.ssh/known_hosts</tt>. You should visit the [ page that gives the host key fingerprint of every publically-accessible SSH server at SourceForge] and carefully check that the fingerprint appearing on your terminal is listed on that page for <tt></tt>, or some matching pattern such as <tt>*</tt>.Your Flightgear compilation comes with If the Terrasync program toofingerprint that is printed on your terminal is not listed on that page, so if answer <tt>no</tt> to the question ''Are you sure you want to use it:continue connecting (yes/no)?'' and copy/paste to flightgear-devel (see [[Mailing lists]]) the above message from <tt>ssh</tt> that contains the fingerprint sent to you by the remote host which pretends to be <tt></tt>. If this happened, you should stop here and wait for answers from readers of flightgear-devel. From now on, we'll assume that the fingerprint you received was correct, and therefore that you have answered <prett>yes</tt> to the ''Are you sure you want to continue connecting (yes/no)?'' In this example, it took us several minutes to verify the fingerprint of the <tt></tt> server and confirm it to <tt>ssh</tt>. Because of this delay, <tt></tt> hung up on us and closed the connection. This is absolutely ''not a problem:'' we can just rerun the <tt></tt> command with the same arguments as the first time. Since we answered <tt>yes</tt> to the ''Are you sure you want to continue connecting (yes/no)?'' prompt, the fingerprint of <tt></tt>'s key has been stored in <tt>~/fgfs.ssh/known_hosts</tt>, therefore we won't get this prompt anymore. But if some server claiming to be <tt></tt> presents a host key that has a different fingerprint in the future, <tt>ssh</tt> will print a big fat warning that the server may belong to an attacker trying to impersonate <tt></tt>. Therefore, this SSH host key verification is very useful to protect us from future attacks (which hopefully won't happen at all). As said, we just rerun the <tt> run_terrasync</tt> command with the same arguments:<pre>$ --git-clone-site-params SourceForge=ssh:SFusername DATA*********************************************************************** ** Warning: a typical SimGear + FlightGear + FGData build requires ** about 12 GiB of disk space. The compilation part may last from a ** few minutes to hours, depending on your computer. ** ** Hint: use the -j option if your CPU has several cores, as in: ** ** -j$(nproc) ** ***********************************************************************Running 'apt-get update'...[sudo] password for toto: (...) Considering a package alternative: libcurl4-openssl-dev libcurl4-gnutls-devPackage alternative matched for libcurl4-openssl-devRunning 'apt-get install build-essential git libcurl4-openssl-dev cmake'...[sudo] password for toto: (...) ******************************************************** DATA **********************************************************Fetching DATA with 'git clone ssh:// 5500 /flightgear/fgdata'Cloning into '.'...Password:</pre>As explained above, the preceding prompt is for your SourceForge password (which you could guess from the <code><nowiki>git clone ssh://</nowiki></code> command).<pre>remote: Enumerating objects: 67011, done.remote: Counting objects: 100% (67011/67011), done.remote: Compressing objects: 100% (31342/31342), done.remote: Total 67011 (delta 38776), reused 59640 (delta 33570)Receiving objects: 100% (67011/67011), 2.60 GiB | 313.00 KiB/s, done.Resolving deltas: 100% (38776/38776), done.Checking out files: 100% (12959/12959), done.Password:</pre>(It will take a fair amount of time to get there, because this is the complete download of [[FGData]].)<br />This is again a prompt for your SourceForge password, because <tt></tt> wants to run <code>git pull -d -rebase</foldercode> in the repository (admittedly, it's a bit dumb after a <tt>clone</tt> operation—please forgive us). In case you were not monitoring the <tt>clone</tt> operation, you probably saw the password prompt way after <tt></tt> got bored waiting for you and closed our second connection:<pre>Connection closed by port 22fatal: Could not read from remote repository. Please make sure you have the correct access rightsand the repository exists.</pre>(if not, there should be no error message and you should have a clean FGData clone)<br />No worries. Just as before, simply rerun the command withthe same arguments:<pre>$ --git-clone-site-params SourceForge=ssh:SFusername DATA*********************************************************************** ** Warning: a typical SimGear + FlightGear + FGData build requires ** about 12 GiB of disk space. The compilation part may last from a ** few minutes to hours, depending on your computer. ** ** Hint: use the -j option if your CPU has several cores, as in: ** ** -j$(nproc) ** ***********************************************************************Running 'apt-get update'...[sudo] password for toto: (...) Considering a package alternative: libcurl4-openssl-dev libcurl4-gnutls-devPackage alternative matched for libcurl4-openssl-devRunning 'apt-get install build-essential git libcurl4-openssl-dev cmake'...[sudo] password for toto: (...) ******************************************************** DATA **********************************************************DATA: the repository already existsPassword:Already up to date.Current branch next is up to date.Already on 'next'Your branch is up to date with 'origin/sceneriesnext'.All optional package alternatives have found a matching package. has finished to work.
WhereThere we are! You now have a clean, up-to-date [[FGData]] clone in <tt>~/flightgear/dnc-managed/install/flightgear/fgdata</tt> (remember: ''<tt>~/folderflightgear/withdnc-managed</sceneries'' tt> is the folder containing directory from which you ran <tt></tt>). Note this place: the sceneries datafull path of the <tt>~/flightgear/dnc-managed/install/flightgear/fgdata</tt> directory is your [[$FG_ROOT]].
Then launch fgfs with Now, change the '''protocol to use for future updates of your FGData clone:<ref name="changing-the-fgprotocol-sceneryfor-a-git-remote-manual-method">Another way would be to manually change the relevant line starting with <code><nowiki>url =ssh:/folder/withSFusername@</nowiki></code> for the <code>origin</code> remote in the <tt>.git/config</tt> file that lives inside your repository clone (i.e., <tt>~/flightgear/sceneries dnc-managed/install/flightgear/fgdata/.git/config</tt> in our example).</ref> (cd install/flightgear/fgdata && \ git remote set-atlas=socketurl origin <nowiki></nowiki>)(you can check at any time the protocol(s) in use with the command <code>git remote -v</code> run inside a Git repository—in this case,outinside the folder <tt>install/flightgear/fgdata</tt>). As a consequence of this change,5,localhostall future updates of your FGData clone will use the <tt>https</tt> protocol,5500,udp''therefore you won' optiont be prompted anymore for your SourceForge password.
==Troubleshooting==All that remains to do is to run, from the same directory as before (<tt>~/flightgear/dnc-managed</tt> in our example): $ download_and_compile.shor $ -j$(nproc)(<code>-j$(nproc)</code> is “only” useful to save time—see the tip below).
When you don't pass any non-option argument to <tt></tt> as done here, it takes care of the three base components needed to run FlightGear: <tt>SIMGEAR</tt>, <tt>FGFS</tt> and <tt>DATA</tt> (these are the component names used by <tt></tt>, i.e., the final arguments one can optionally give in a <tt></tt> command; in normal speech, they correspond to the {{simgear source| text = SimGear}}, {{flightgear source| text = FlightGear}} and {{fgdata source| text = FGData}} repositories). Therefore, the above command is presently exactly equivalent to: $ SIMGEAR FGFS DATA In case you wanted to build another component such as [[OpenSceneGraph|OSG]], you could add it to the command, like this: $ SIMGEAR FGFS DATA OSG (With current Debian stable, this is not necessary because it has OpenSceneGraph 3.4. But if your distribution only has an older version, you'll certainly need to select the <tt>OSG</tt> component like this.) When the command terminates, you should have a script called <tt></tt> in the directory <tt>~/flightgear/dnc-managed</tt> from which you ran <tt></tt>. This will be your script to run FlightGear. For instance, in order to start the built-in launcher, you can run the following commands:<ref name="no-need-to-change-to-dnc-managed-dir-before-starting-generated-scripts">We give these commands because they are easy to read, but the <code>cd</code> command is not needed if you use the correct path, as in <code>~/flightgear/dnc-managed/ --launcher</code>.</ref> $ cd ~/flightgear/dnc-managed $ ./ --launcher(You may omit the <code>--launcher</code> option; this would simply start FlightGear without any launcher, at the default airport and with the default aircraft.)<br />In case you find this tedious to type or have more arguments to pass on a regular basis, you can follow the advice given at the end of [ this message] or use another launcher such as [[FFGo]] (but the [[FlightGear Qt launcher|FlightGear built-in launcher]] started with <code> --launcher</code> is quite fine, be sure to try it first!). {{Tip|You can considerably speed up the build process—literally, save hours—by telling <tt></tt> to use several cores simultaneously when compiling. With option <code>-j$(nproc)</code>, compilations will use all cores available on your processor; thus, a typical <tt></tt> command is <code> -j$(nproc)</code>. If you want to use, say, 4 cores, replace <code>-j$(nproc)</code> with <code>-j4</code>.}} === <span id="using-download-and-compile-sh-to-update-flightgear"></span> Updating FlightGear === Just go to the directory from which you you previously ran <tt></tt> (<tt>~/flightgear/dnc-managed</tt> in our example). This is the folder which, if you did a complete run of <tt></tt> as shown in the previous section, contains the <tt></tt> script and a log file named <tt>compilation_log.txt</tt> that records what <tt></tt> did in its last run. If you wish to update, say, {{simgear source| text = SimGear}}, {{flightgear source| text = FlightGear}} and {{fgdata source| text = FGData}}, simply execute this: $ -pn SIMGEAR FGFS DATAWe'll explain the <code>-pn</code> in a minute. <tt>SIMGEAR</tt>, <tt>FGFS</tt> and <tt>DATA</tt> are called ''components'' in <tt></tt> terminology. A component generally corresponds to a software repository, or something close. In fact, since <tt>SIMGEAR</tt>, <tt>FGFS</tt> and <tt>DATA</tt> are often precisely the components people wish to update, they form the default components set, so that the previous command is equivalent to: $ -pnNow about this <code>-pn</code>. It is equivalent to <code>-p n</code> and means “don't install packages from my (Linux) distribution” (<code>y</code> means ''yes, please install'', <code>n</code> means ''no, don't install''). In case you forgot that, simply run: $ --helpWhat does it imply to pass <code>-pn</code>? This tells <tt></tt> to completely skip the step where it checks for needed packages from your distribution and installs them, by default using <tt>apt-get</tt>. It thus goes straight to the following steps:* update each repository corresponding to one of the selected components (<tt>SIMGEAR</tt>, <tt>FGFS</tt> and <tt>DATA</tt> in our example);* compile each selected component that requires compilation;* install each selected component in the appropriate place (under <tt>~/flightgear/dnc-managed</tt> according to our [[#getting-started-with-download-and-compile-sh-notations|Notations]]).In case you don't have all required dependencies for the selected components, one of them is likely to fail, of course, since by passing <code>-pn</code> to <tt></tt>, you forbid it to install these dependencies for you. So, you can also very well update without passing the <code>-pn</code> option, it will simply take a little longer (the time to check if all dependencies of the selected components are available with <tt>APT</tt>). In fact, this is '''what you should do if the previous <tt></tt> run failed:''' first update <tt></tt> (see [[#getting-download-and-compile-sh-using-an-fgmeta-clone|above]]) then run it ''without'' <code>-pn</code><ref name="passing-no-pn-option-equals-passing-py">Which is the same as passing <code>-py</code>.</ref> in case new dependencies have been recently added and you don't have them on your system yet—this would be a very likely cause for the failure. '''Summary''' Routine update: $ -pn ''COMPONENT...''In case this fails, first update <tt></tt> (see [[#getting-download-and-compile-sh-using-an-fgmeta-clone|above]]), then run $ ''COMPONENT...''where ''COMPONENT...'' stands for the space-separated list of selected components, and defaults to <tt>SIMGEAR FGFS DATA</tt> if you don't specify any. === <span id="examining-download-and-compile-sh-history"></span> Examining the history of <tt></tt> === Looking at the latest commits that affected <tt></tt> is quite easy with your FGMeta clone: $ cd ~/flightgear/fgmeta $ git log -- quit by typing <tt>q</tt>, assuming your <tt>$GIT_PAGER</tt> is <tt>less</tt>)<br /> In order to do the same, but also see the patch for each commit: $ cd ~/flightgear/fgmeta $ git log -p -- == <span id="list-of-available-components"></span> List of available components == The <tt></tt> script is able to download, compile (when applicable) and install the following components: * ATCPIE (for the [[ATC-pie]] air traffic control simulation program)* CMAKE (for the [ 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></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) Each of the items listed above is a ''component'' in <tt></tt> terminology. Components are written in uppercase by convention. {{Note|The preceding list might not be up-to-date. The up-to-date list of components supported by <tt></tt> can always be obtained by running <code> --help</code>.}} What is the point of knowing this? Because you may pass component names to <tt></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.shis equivalent to: $ SIMGEAR FGFS DATA In case you want to do the same build with just [[OpenSceneGraph]] added, you can use: $ SIMGEAR FGFS DATA OSG You get the idea. When several components are passed on the same command line, <tt></tt> chooses a reasonable order for processing, so don't worry about that. == When building 'next', you may see build errors == Keeping in mind that this script compiles sometimes bleeding edge software, it can happen that what was successfully compiling last week, does not compile anymore today. Building the stable version should always work, unless there is a problem with the script. That said, don't be too afraid of building the development version (called ''next''): this is the one developers use all the time, so kindly asking on the flightgear-devel [[Mailing_lists|mailing list]] in case a problem popped up<ref name="what-to-provide-when-asking-for-help">Don't forget in this case to precisely tell what you did and include the <tt>compilation_log.txt</tt> file written by <tt></tt>.</ref> should allow you to find good advice and get the problem quickly fixed, if it's a new one. Conversely, probably not many people (in 2019) build themselves the “stable” version of FlightGear. People who want the stable version can usually have it from their distribution, this is generally easier. On the other hand, those running <tt></tt> typically want to build the latest code that FlightGear developers are working on; this is useful when you want to contribute feedback, code, aircraft or scenery based on recent technology, or just want to enjoy the latest features and bugs. ;-) == Task-specific instructions == {{Note|In this section, we assume you've read and followed the advice given in [[#getting-started-with-download-and-compile-sh|Getting started with <tt></tt>]].}} === <span id="selecting-the-components-to-work-on"></span> Selecting the components to build === By default, <tt></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: $ download_and_compile.shThe preceding command is therefore equivalent to: $ SIMGEAR FGFS DATA To make <tt></tt> take care of other programs or libraries, use non-option arguments naming the ''components'' you want, for instance: $ SIMGEAR FGFS DATA OSGSIMGEAR, FGFS, DATA and OSG are the component names respectively corresponding to [[SimGear]], FlightGear, [[FGData]] and [[OpenSceneGraph]] in <tt></tt>'s terminology. 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> --help</code>. === Choosing between stable and development versions === By default, <tt></tt> fetches code and data from development branches of the source repositories (which sometimes causes compilation or runtime errors). However, it is possible to tell the script to download the latest ”stable” version of each component, for some suitable definition of “stable”. This is by means of the <code>-s</code> option: $ -s ''COMPONENT1 COMPONENT2...'' How does it work?* For [[SimGear]], FlightGear and [[FGData]], it uses the most recent stable release branch of the corresponding Git repository.* For some components, a known-stable version is hardcoded in <tt></tt> and used when the <code>-s</code> option is given<ref name="components-with-a-known-stable-version-hardcoded-in-download_and_compile_sh">As of May 2019, apart from SIMGEAR, FGFS and DATA, the only components for which <tt></tt> “knows” a stable version are TERRAGEAR and OPENRTI.</ref> (for instance, the hardcoded information can be the name of a Git branch).* For the other components, the <code>-s</code> option has no effect. {{Warning|In a given folder where <tt></tt> is run, you should either always use the <code>-s</code> option, or never. Building some components with <code>-s</code> and others without (all within the same base folder) is not supported.}} Applying what we just said to the FGFS component (FlightGear) leaves us with two main options:* build the latest stable release;* build the current development version (bleeding edge), which lives in the {{flightgear source| branch = next| text = next}} branch of the FlightGear repository. ==== Building the latest stable FlightGear release ==== When executing <tt></tt>, use the <code>-s</code> option to build the latest stable release: $ cd ~/flightgear/dnc-managed $ -s {{Note|If you decide to use the <code>-s</code> option in a given directory tree, you should use it for all components in that directory tree (SIMGEAR, FGFS, DATA, etc.). Running <tt></tt> in a given directory with the <code>-s</code> option for some components and not for others is not supported.}} ==== Building the current FlightGear development version ==== When executing <tt></tt> without any option, the development version of every selected component is built: $ cd ~/flightgear/dnc-managed $ this example, the implicitly-selected components are SIMGEAR, FGFS and DATA, as explained [[#selecting-the-components-to-work-on | above]].) {{Note|The development version of FlightGear changes on an almost daily basis. It provides the latest features, but is not guaranteed to always work reliably. If you don't want to take the risk of finding new bugs when updating, you may prefer to use the latest stable release.}} === Passing custom arguments to CMake === Sometimes, when building a program, you may want to enable a feature that is not enabled by default, or disable a feature that is enabled by default. With recent versions of <tt></tt> (April 2019 or later), the environment variables <tt>SG_CMAKEARGS</tt> and <tt>FG_CMAKEARGS</tt> allow one to do that for SimGear and FlightGear. For instance, in order to link SimGear with the system Expat library, you can do: $ SG_CMAKEARGS='-DSYSTEM_EXPAT=ON' SIMGEARSimilarly, disabling HID-based input when building FlightGear can be achieved this way: $ FG_CMAKEARGS='-DENABLE_HID_INPUT=OFF' FGFS {{Note|Such options are typically defined in <tt>CMakeLists.txt</tt> files, for example {{simgear source| path = CMakeLists.txt| text = here}} for SimGear and {{flightgear source| path = CMakeLists.txt| text = here}} for FlightGear.}} This can be useful for instance to work around bugs in a part of SimGear or FlightGear that you don't need, but causes a build or runtime failure (see {{forum link|t=35740|text=here}} for example). This is often convenient when using the development version of FlightGear, but doesn't mean such bugs shouldn't be reported! If you have several such options to pass, just use spaces to separate them inside the quotes: $ FG_CMAKEARGS='-DENABLE_SWIFT=ON -DENABLE_HID_INPUT=OFF' FGFSOf course, the same thing can also be achieved this way in Bourne-style shells: $ export FG_CMAKEARGS='-DENABLE_SWIFT=ON -DENABLE_HID_INPUT=OFF' $ FGFS It is also possible to set both <tt>SG_CMAKEARGS</tt> and <tt>FG_CMAKEARGS</tt> at the same time for a given <tt></tt> run: $ export SG_CMAKEARGS='-DSYSTEM_EXPAT=ON' $ export FG_CMAKEARGS='-DENABLE_SWIFT=ON -DENABLE_HID_INPUT=OFF' $ === Launching FlightGear === When using <tt></tt>, apart from those installed with the package manager, the FlightGear dependencies (which are typically libraries) are not installed system-wide but under the directory from which <tt></tt> was run. This makes it possible to easily use, for instance, different [[OpenSceneGraph]], [[SimGear]] and FlightGear versions on a single system—e.g., for testing purposes—but also to have separate build trees (optimized/debug). This is also why you either need to set LD_LIBRARY_PATH to run the built programs, or simply use the scripts created by <tt></tt> in the directory where it is run, such as <tt></tt> and <tt></tt>: these scripts automatically set up the required environment variables according to your build settings before firing the desired program (e.g., <tt>fgfs</tt>) with the arguments you provided.  Therefore, the simplest way to run a FlightGear program built by <tt></tt> is to launch the <tt></tt> script that <tt></tt> created in the directory from which it was run, for example: $ cd ~/flightgear/dnc-managed $ ./ --launcher {{Note|<code>./ --launcher</code> starts FlightGear with its built-in launcher. If you just do <code>./</code>, FlightGear will be started without any launcher, at the default airport and with the default aircraft.}} In order to start FlightGear without any launcher, at a given airport (say, [ Paro airport], whose ICAO code is VQPR) and with a chosen aircraft, you can do: $ cd ~/flightgear/dnc-managed $ ./ --airport=VQPR --aircraft=dhc6Actually, the directory change is not needed, we only gave it here for readability. Therefore, the following single command does the same: $ ~/flightgear/dnc-managed/ --airport=VQPR --aircraft=dhc6 === <span id="avoiding-multiple-downloads-of-fgdata"></span> Avoiding multiple downloads of FGData === Some people use <tt></tt> to maintain several directory trees such as the tree starting at <tt>~/flightgear/dnc-managed</tt> in [[#getting-started-with-download-and-compile-sh|Getting started with <tt></tt>]] (this can be useful if you want to have one tree with programs compiled in Release mode and another tree where they are built in Debug mode, for instance). This can easily be done by running <tt></tt> in each of the directories. But since [[FGData]] is so large, it may be tempting to share a single instance of this repository among several trees. This is not officially supported, but apparently can be made to work with symbolic links. Let's show how this can be done on an example. Suppose your master copy of FGData is in <tt>~/flightgear/dnc-managed/install/flightgear/fgdata</tt>. Then the following appears to work: $ mkdir -p ~/flightgear/other-dnc-managed-tree/install/flightgear $ cd ~/flightgear/other-dnc-managed-tree/install/flightgear $ ln -s ../../../dnc-managed/install/flightgear/fgdata $ cd ~/flightgear/other-dnc-managed-tree $ The last of these commands will use and update the FGData repository present in <tt>~/flightgear/dnc-managed/install/flightgear/fgdata</tt>. {{Warning|This can only work simply if all trees that share a given FGData repository are from the same release (e.g., current stable or development). Running a “stable“ FlightGear with FGData from the ''next'' branch or the other way round, a development version of FlightGear with FGData from a release branch, doesn't work—and FlightGear should tell you when you start it in such a situation. That said, people comfortable with Git can check out the correct FGData branch before building or starting FlightGear, for instance: $ cd /path/to/fgdata && git checkout release/2019.1or $ cd /path/to/fgdata && git checkout nextSo, this is possible but somewhat acrobatic. You've been warned.}} Note: there is a [[Avoiding multiple downloads of FGData on Linux|wiki article about this subject]], but it is severely outdated as of April 2019. == Additional programs == {{Note|In this section, we assume you've read and followed the advice given in [[#getting-started-with-download-and-compile-sh|Getting started with <tt></tt>]].}} If you wish to get other programs (precisely: download, build and install them), you need to launch <tt></tt> with the desired component names as arguments. For instance: $ cd ~/flightgear/dnc-managed $ SIMGEAR FGFS DATA OSG See [[#list-of-available-components|above]] for the list of available components. === TerraGear === Run <tt></tt> with the TERRAGEAR component in order to build and install the [[TerraGear]] terrain building toolchain: $ cd ~/flightgear/dnc-managed $ TERRAGEAR This creates the following scripts in <tt>~/flightgear/dnc-managed</tt>:* <tt></tt>* <tt></tt>* <tt></tt>These scripts themselves run the corresponding TerraGear tools, as expected. === TerraGear GUI === [[TerraGear GUI]] is a graphical interface for [[TerraGear]] written with the Qt toolkit (still Qt 4 in 2019, but it works). In order to install it, run <tt></tt> with the TERRAGEARGUI component: $ cd ~/flightgear/dnc-managed $ TERRAGEARGUIThis will create a <tt></tt> script in <tt>~/flightgear/dnc-managed</tt>, and also a default configuration file <tt>~/.config/TerraGear/TerraGearGUI.conf</tt>, unless you already have one. This default configuration file contains paths to the TerraGear and [[$FG_ROOT]] directories, assuming you have installed the TERRAGEAR and DATA components. To run TerraGear GUI: $ cd ~/flightgear/dnc-managed $ ./ === FGCom === {{Note|[[FGCom]] has been integrated into FlightGear long ago, therefore the following is not needed in general.}} [[FGCom]] is the system used by FlightGear to simulate radio communications between users. It is automatically built and installed when you tell <tt></tt> to take care of the FGFS component. You can launch the standalone FGCom program by using the <tt></tt> script: $ cd ~/flightgear/dnc-managed $ ./ === FGRun === {{Note|As of 2019, FGRun has been superseded by the [[FlightGear Qt launcher|FlightGear built-in launcher]]. The built-in launcher is the most actively maintained launcher for FlightGear. Other launchers are [[FFGo]] and [[FGX|FGx]].}} [[File:fgrun-page2.jpg|thumb|right]]Before FlightGear had its built-in launcher (the one you get with <code> --launcher</code>), many users found comfortable having FlightGear launched by the graphical utility [[Fgrun|FGRun]]. This program is built and installed when <tt></tt> is run with the FGRUN component. You then have to launch the <tt></tt> command, for example: $ cd ~/flightgear/dnc-managed $ ./ FGRun will save its settings in <tt>~/.fltk/</tt>. You may want to save copies of the preferences customized for stable and next. === FGo! === {{Note|As of 2019, FGo! is not maintained anymore. You may want to try the built-in launcher (started with <code> --launcher</code>) or [[FFGo]].}} [[File:Fgo01.jpg|thumb|left]]FGo! is a graphical utility written in [[python]]. It is downloaded and installed when <tt></tt> is run with the FGO component. You then have to launch the <tt></tt> command, for example: $ cd ~/flightgear/dnc-managed $ ./ Remember that the first time you run it, you have to go to open the ''Preferences'' dialog and set the paths to the <tt>fgfs</tt> executable and to FGData. == Troubleshooting == ===Compilation errors===Here we are, no fear, if you wish to use programs from the cvs/svn/git repositories, you might face compilation errors that will prevent you to have a working copy of one or more of the programs provided by this script. What can be the causes that prevent us from a successful successfully compiling? As far as I know those:
# Software developers introduce a new functionality with a new piece of code that prevents the compilation under your architecture, this can happen working with cvs/svn/git sources.
# The program refuses to compile because of a divergence in the libraries on which it depends. For example Flightgear FlightGear might not compile because OSG has been modified, while OSG itself compiles fine, FG won't.
# One or more repositories are down and you can't get the library you need. (Both from cvs/svn/git or apt-get)
There is a simple solution to the above errors: wait and relaunch the script after some time (hours or days), if (and generally happens) software developers repair or synchronize their code with the newly updated libraries(which generally happens eventually), your Flightgear FlightGear will compile fine as if the previous error never took place.
Sometimes it happens that the script fails to compile only fgrun[[Fgrun|FGRun]],fgcom [[FGCom]] or atlas, if you then see the file it means that Flightgear FlightGear installation was successful and you can safely run it.
==Options= OpenRTI undefined reference errors ===The script by default (without any option) will only compile Flightgear and FgrunSometimes due to the way d&c build cleans up projects, linking errors might occur, this is the case with this error "libRTI-NG. To make it compile allso: undefined reference to xxx", sadly at this point either you need to launch patch the d&c script to clean OpenRTI with the ''ALL'' parameter. i.e.:<precode>sh download_and_compilerm -f ALLtxt && rm -rf CMakeFiles/</precode>, or just start from a clean environment, assuming you are in the parent project directory, you will need to issue this command to clean everything (except FGData): $ rm -rf build/* install/simgear/ install/openrti/ install/flightgear/share/ install/flightgear/bin/
See {{forum link|t=26244|text==Compiling only one program===If you wish to recompile only one of the programs you can launch the script with one of the following parameters:* PLIB (to compile and install only plib)* OSG (to compile and install only OpenSceneGraph)* SIMGEAR (to compile and install only Simgear)* FGFS (to compile and install only FlightGear)* DATA (to download / update only data files this thread}} for FlightGear)* FGRUN (to compile and install only Fgrun)* FGCOM (to compile and install only Fgcom)* FGCOMGUI (to compile and install only FgComGui)* ATLAS (to compile and install only Atlas)more details.
==Options =Fast updating===There is a second parameter ''UPDATE'' that allows you to just update your installation. i.e.:This will only update FGFS<pre>sh FGFS UPDATE</pre>
===Compiling last stable versions (Sperimental)Multicore acceleration ===Event if the script fetches data and sources from bleeding edge developers repositories (which sometimes do not compile), you can still force the script to download latest know versions of the software that was compiling successfully adding the -s option.<pre>sh -s</pre>
How it works ? Inside the script there is a small list with lates known versions of successfully compiling revisions, it will download from svn/git that specific revisions, which have been found able to compile together.
===Advanced options===* Skip download of packages using '''-p n''' Passing option* Skip compilation of programs using '''<code>-c nj x</code> to <tt></tt> (where ''x' option* Skip retrieving software updates using '''-d n''' option* Skip reconfigure (make cleanis the number of your CPU cores you wish to assign to the job) using '''-r n''' optionwill considerably speed up the compilation steps.
=== Advanced options === * Build a release version: <code>-b Release</code>* Build a version that should run as fast as a release build, yet has debug information that can be used to post backtraces: <code>-b RelWithDebInfo</code> (this is the default)* Build a full debug version for very complete bug reporting: <code>-b Debug</code>* Skip download of distro packages (i.e., by default: <tt>apt-get install ...</tt>): <code>-p n</code>* Skip retrieving of software updates (i.e., by default: <tt>apt-get update</tt>): <code>-d n</code>* Skip the configure step (like running [ CMake] or [ autoconf]'s <tt>./configure</tt>): <code>-r n</code>* Skip compilation of programs: <code>-c n</code>. For example, if you are a developer and wish to fast quickly recompile and reinstall only modification your own modifications for FlightGear , you can do this:<pre>sh $ -p n -d n -r n FGFS Note that this is the same as: $ -pn -dn -rn FGFS This command will only rebuild modified files and reinstall FlightGear. Note that depending on the kind of changes you made, reconfiguring and thus dropping the <code>-d n</code> option may be necessary, though (this is the case in particular if you added or removed C++ files). == Optimus technology ==If your computer has a GPU with Optimus technology, you need a dedicated script in order to make FlightGear run with the powerful GPU. After having installed required tools (Bumblebee) you just need to run this command line in your FlightGear installation directory (where you executed <tt></tt>): $ sed 's|\./fgfs|optirun ./fgfs|' > && chmod +x run_fgfs_optirun.shNow you can run FlightGear with <code>./</code>. The same can be done for the [[FlightGear_Launch_Control|FGRun]] launcher: $ sed 's|\./fgrun|optirun ./fgrun|' > && chmod +x == See also == * {{fgmeta source| path = compile-scripts| text = Other FlightGear build scripts}} present in [[FGMeta]]* {{fgmeta source| path = fg-from-scratch| simplepath = true}}* [ Another script] for building FlightGear and all its dependencies in an automated fashion. The page seems a bit oldish, though (as of 2019). == References ==<references/pre>
this will only recompile modifications and reinstall them.[[Category:Building from source]]
==Disk usage==Having both compiled program, source codes and data from git requires some hard disk space[[fr: It will take you something like 7 GB of space.If you don't have a fast machine, it will require you also some hours of Script de compilation time.sous Linux Debian/Ubuntu]][[nl:Compileren met een Script op Linux Debian/Ubuntu]]

Navigation menu