Difference between revisions of "Building"

From GnuCash
Jump to: navigation, search
(Remove sections of the page now transferred to Building on Linux and its Break out pages)
m (>= -> ≥)
 
(24 intermediate revisions by 6 users not shown)
Line 1: Line 1:
 +
{| class="wikitable" style="margin: auto;"
 +
! scope="row"|Languages
 +
| [[de/{{PAGENAME:Gnucash}}|Deutsch]]
 +
| [[He/{{PAGENAME:בניה}}|עִברִית]]
 +
|}
 +
This page deals with building GnuCash '''from the source code'''. It includes building the current ''stable release'' from source code (downloaded as tarballs) as well as the ''developers version'' of GnuCash from the ''[[Git]] repository''. If you are searching for instructions for the version available '''from your distribution''''s software repositories, you should read [[Installation]].
 +
 +
This page doesn't provide specific instructions for optional third-party modules—like ''AqBanking'' or Perl ''Finance::Quote''—but does list the dependencies required and links to the configuration switches used with CMake to include them during compilation.
  
−
=Building GnuCash from Source code=
 
 
== Introduction ==
 
== Introduction ==
 +
GnuCash can be built from sources on Linux distributions, Microsoft Windows and macOS. There are three major steps in building the GnuCash program. These are listed along with the tools which may used for each step:
 +
 +
# Configuration (cmake - autotools in earlier GnuCash versions)
 +
# Compilation ( make or ninja)
 +
# Installation (make or ninja)
 +
 +
Building GnuCash utilizes a set of tools which is available for all three of the major operating systems.
 +
These steps are described in detail for each operating system in the linked pages below, along with the installation of the build tools.
  
−
Gnucash can be built from sources on Linux distributions, Microsoft Windows and Mac OS/X. There are three major steps in building the GnuCash program. These are listed along with the tools which may used for each step:
+
== Build Tools ==
 +
A general description of the tools used to configure and build GnuCash is given in [[Build_Tools |Build tools]].
  
−
# Configuration (cmake - autotools in earlier GnuCash versions);
+
A listing of dependencies is available at [[Dependencies]].
−
# Compilation ( make or ninja); 
 
−
# Installation (make or ninja).
 
  
−
Building GnuCash utilizes a set of build tools which is available for all three of the major operating systems.
+
The GnuCash build system has gone through some changes in the course of the 2.6 and 3 series. CMake has replaced the Autotools autogen and configure scripts for configuring the build. This has provided the ability to configure for alternative build systems and popular IDEs. Under the hood compilation and installation can now either be controlled using GNU [[Build_Tools#Make|Make]] or alternatively using the faster [[Build_Tools#Ninja|Ninja]]. Depending on the version of GnuCash you want to build you have the following options:
−
These steps are described in detail for each operating system in the linked pages below, along with the installation of the build tools.
 
−
=== Build Tools ===
 
−
A general description of the tools used to configure and build Gnucash is given in [[Build_Tools |Build tools]].
 
−
The GnuCash build system has gone through some changes in the course of the 2.6 and 3 series. The Autotools set originally used to build GnuCash has been replaced in part with more recent developments which provide the ability to configure for alternative build systems and popular IDEs. CMake has replaced the Autotools autogen and configure scripts for configuring the build. Compilation can either be performed and controlled using the Autotools make script or alternatively using a faster build system Ninja. Either Autotools make or Ninja can also control the installation of GnuCash. Depending on the version of GnuCash you want to build you have the following options:
 
 
;For the application generally:
 
;For the application generally:
−
:;GnuCash 3 and more recent: These versions can now only be configured using [[#CMake]]. Autotools support was removed. Either make or ninja may be used to build ;
+
:;GnuCash 3 and more recent: These versions are configured using [[Build_Tools#CMake|CMake]]. Autotools support has been removed. Either make or ninja may be used for the build.
−
:;GnuCash 2.6 and earlier:Can only be configured with Autotool and built with ther GNU make utility. (V 2.6.13 on allowed experimental use of cmake to configure and ninja to build);
+
:;GnuCash 2.6 and earlier: These versions are configured with [[Build_Tools#Autotools|Autotools]] and built with the GNU make utility. GnuCash from v2.6.13 allowed experimental use of cmake to configure and ninja to build.
−
:;API Source Documentation requires Doxygen and is built from the program sources using <code>make doc</code>.
 
−
 
 
−
;For program Documentation:
 
−
; The GnuCash Help and Tutorial and Concept Guide are configured with autotools and built with make.
 
  
−
==== Compiler ====
+
;For the Source API Documentation: This is built directly from the program sources. Depending on how the build system is configured you can use <code>make doc</code> or <code>ninja doc</code>. Note this requires [[Doxygen]] to be installed.
−
GnuCash 3.x requires a C++ compiler that supports ISO-standards C11 and C++11. Gcc version >=4.8 and Clang version >= 3.3 are known to work.
 
−
For GnuCash 4.x (i.e. current master branch) we expect to require C++14 and may require C++17 compatibility.
 
−
=== Disclaimer ===
 
−
This page deals with building the GnuCash from the source code. It includes building the current stable release from source code (downloaded tarballs as well as well as the '''developers version''' of GnuCash from the ''[[Git]] repository''. If you are searching for instructions for the ''stable version''available from your distributions software repositories, you should read [[GnuCash#Installation]].
 
  
−
This page doesn't provide specific instructions for optional third-party modules like ''AqBanking'' or Perl ''Finance::Quote'' but does list the dependencies required and links to the configuration switches used with CMake to include them during compilation.
+
;For the documentation:
 +
:;Since GnuCash 4.8: Only [[Build_Tools#CMake|CMake]] with either [[Build_Tools#Make|Make]] or [[Build_Tools#Ninja|Ninja]] is supported
 +
:;Upto GnuCash 4.7: The GnuCash Help and Tutorial and Concept Guide are configured with [[Build_Tools#Autotools|Autotools]] and built with [[Build_Tools#Make|Make]].
 +
::[[Build_Tools#CMake|CMake]] was introduced in 3.7.
  
−
== Building on Linux Distributions ==
+
== Compiler ==
−
Detailed instructions for building Gnucash on Linux distributions can be found on [[Building_On_Linux | Building On Linux]].
+
'''GnuCash &ge; 4.0''' requires ISO-standard '''C++17''' compatibility.
  
−
== Building on Mac OS X ==
+
'''GnuCash 3.x''' required a C++ compiler that supports ''C11'' and ''C++11''. '''Gcc version &ge; 4.8''' and '''Clang version &ge; 3.3''' are known to work.
  
−
Mac OS X instructions can be found on [[MacOSX/Quartz]] (This is the procedure used for building the binary packages)
+
== Source Platform ==
−
or [[MacOSXInstallation| gnucash installation from source on Mac OS X]].
+
=== Building on Linux Distributions ===
 +
Detailed instructions for building GnuCash on Linux distributions can be found on [[Building_On_Linux | Building On Linux]].
  
−
== Building on Microsoft Windows ==
+
=== Building on macOS ===
 +
macOS instructions can be found on [[MacOS/Quartz]] (This is the procedure used for building the binary packages)
 +
or [[MacOS Installation| GnuCash installation from source on macOS]].
  
−
Compiling GnuCash on Windows is possible, but much more difficult than on linux.  
+
=== Building on Microsoft Windows ===
−
For details, see [[Windows|GnuCash on Microsoft Windows]].
+
Compiling GnuCash on Windows is possible, but much more difficult than on Linux.  
 +
For details, see [[Building on Windows|building GnuCash on Microsoft Windows]].

Latest revision as of 15:37, 26 March 2024

Languages Deutsch עִברִית

This page deals with building GnuCash from the source code. It includes building the current stable release from source code (downloaded as tarballs) as well as the developers version of GnuCash from the Git repository. If you are searching for instructions for the version available from your distribution's software repositories, you should read Installation.

This page doesn't provide specific instructions for optional third-party modules—like AqBanking or Perl Finance::Quote—but does list the dependencies required and links to the configuration switches used with CMake to include them during compilation.

Introduction

GnuCash can be built from sources on Linux distributions, Microsoft Windows and macOS. There are three major steps in building the GnuCash program. These are listed along with the tools which may used for each step:

  1. Configuration (cmake - autotools in earlier GnuCash versions)
  2. Compilation ( make or ninja)
  3. Installation (make or ninja)

Building GnuCash utilizes a set of tools which is available for all three of the major operating systems. These steps are described in detail for each operating system in the linked pages below, along with the installation of the build tools.

Build Tools

A general description of the tools used to configure and build GnuCash is given in Build tools.

A listing of dependencies is available at Dependencies.

The GnuCash build system has gone through some changes in the course of the 2.6 and 3 series. CMake has replaced the Autotools autogen and configure scripts for configuring the build. This has provided the ability to configure for alternative build systems and popular IDEs. Under the hood compilation and installation can now either be controlled using GNU Make or alternatively using the faster Ninja. Depending on the version of GnuCash you want to build you have the following options:

For the application generally
GnuCash 3 and more recent
These versions are configured using CMake. Autotools support has been removed. Either make or ninja may be used for the build.
GnuCash 2.6 and earlier
These versions are configured with Autotools and built with the GNU make utility. GnuCash from v2.6.13 allowed experimental use of cmake to configure and ninja to build.
For the Source API Documentation
This is built directly from the program sources. Depending on how the build system is configured you can use make doc or ninja doc. Note this requires Doxygen to be installed.
For the documentation
Since GnuCash 4.8
Only CMake with either Make or Ninja is supported
Upto GnuCash 4.7
The GnuCash Help and Tutorial and Concept Guide are configured with Autotools and built with Make.
CMake was introduced in 3.7.

Compiler

GnuCash ≥ 4.0 requires ISO-standard C++17 compatibility.

GnuCash 3.x required a C++ compiler that supports C11 and C++11. Gcc version ≥ 4.8 and Clang version ≥ 3.3 are known to work.

Source Platform

Building on Linux Distributions

Detailed instructions for building GnuCash on Linux distributions can be found on Building On Linux.

Building on macOS

macOS instructions can be found on MacOS/Quartz (This is the procedure used for building the binary packages) or GnuCash installation from source on macOS.

Building on Microsoft Windows

Compiling GnuCash on Windows is possible, but much more difficult than on Linux. For details, see building GnuCash on Microsoft Windows.

Retrieved from "https://code.gnucash.org/wiki/index.php?title=Building&oldid=22075"