Building SVN versions with CMake: Difference between revisions

From Scribus Wiki
Jump to navigation Jump to search
m (→‎Specific Dependencies: re-arranging)
(→‎Ubuntu: 14.04 libs)
(28 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Cleanup}}
{{Cleanup}}
[[Category:Installation]] [[Category:Development]]
[[Category:Installation]] [[Category:Development]]
This page tries to describe how to build Scribus from source.
The instructions mainly refer to building Scribus on Linux. Building on Mac OS and on Windows is not easy; you can find some explanations for Mac OS [[Installing from SVN on Mac OS X|here]], and for Windows [[Building SVN versions on Windows|here]].
=TL;DR (Too Long; Didn't Read)=
=TL;DR (Too Long; Didn't Read)=
<big>You know what you are doing already and just want to compile Scribus via SVN, skip the introduction and go to [[{{PAGENAME}}#Version 1.5.x|Installing 1.5svn]]</big>
<big>You know what you are doing already and just want to compile Scribus via SVN, skip the introduction and go to [[{{PAGENAME}}#Version 1.5.x|Installing 1.5svn]]</big>
Line 31: Line 35:
[[Image:Fear-is-the-mind-killer-Dune.png|500px|thumb|right|"Do not fear building Scribus from source" ~Paul Muad'dib Atreides]]
[[Image:Fear-is-the-mind-killer-Dune.png|500px|thumb|right|"Do not fear building Scribus from source" ~Paul Muad'dib Atreides]]
'''There is nothing to fear here, building Scribus yourself is not as hard as it sounds'''. This page can teach a beginner many things at once: starting with beginning to comprehend the internals of Scribus to appreciating the Command Line shell and how to invoke commands through it. Learn how to install software libraries (components that Scribus utilizes) and go so far as to modify source code through applying patches. This exposure will help increase your skill set to work on most all platforms and widen your knowledge of software creation and maintenance.
'''There is nothing to fear here, building Scribus yourself is not as hard as it sounds'''. This page can teach a beginner many things at once: starting with beginning to comprehend the internals of Scribus to appreciating the Command Line shell and how to invoke commands through it. Learn how to install software libraries (components that Scribus utilizes) and go so far as to modify source code through applying patches. This exposure will help increase your skill set to work on most all platforms and widen your knowledge of software creation and maintenance.
Take as an example this following set of commands which are geared towards the Linux environment. Here we see a case in which there is a downloading of the Scribus development version (1.5, not yet stable),  building it and then installing it. Note that this assumes that the environment has been prepared previously with all the dependencies installed.
<big><span style="background-color: #FFFF00">Don't think the placement of the following content in this subsection from here to the end of subsection is really relevant anymore. Thinking about moving it to another section. [[User:Kunda|Kunda]] ([[User talk:Kunda|talk]]) 14:37, 6 June 2014 (CEST)</span></big>
{{Warning|You must have CMake version &ge; 2.8.9 for best results. Older versions will fail. See: [[Official:Compile with CMake]]}}
<pre>
mkdir ~/src/
mkdir ~/src/scribus_svn
sudo mkdir /usr/local/scribus_svn
cd ~/src/scribus_svn
svn co svn://scribus.net/trunk/Scribus
cd ./Scribus
mkdir build
cd build
cmake -DCMAKE_INSTALL_PREFIX:PATH=/usr/local/scribus_svn ..
make
sudo make install
</pre>
'''Note:'''
* you may change ~/src/ to wherever you want to put your source into.
* you may change /usr/local/scribus_svn/ to wherever you want to put the Scribus binaries.
* in case you want to install the 1.4 stable version, replace the "svn" instruction with following : svn co svn://scribus.net/branches/Version14x/Scribus
<big><span style="background-color: #FFFF00">End of subsection</span></big>


=1st: Download latest snapshot with Subversion=
=1st: Download latest snapshot with Subversion=
Line 67: Line 47:
! Status !! Version !! !! SVN Path !! Command to download from SVN
! Status !! Version !! !! SVN Path !! Command to download from SVN
|-
|-
|Developmental || Version150 ||        || /trunk/Scribus || <tt><b>svn co svn://scribus.net/trunk/Scribus scribus150</b></tt>
|'''Developmental''' || '''v1.5.0''' ||        || /trunk/Scribus || <tt><b>svn co svn://scribus.net/trunk/Scribus scribus150</b></tt>
|-
|-
|Stable || Version14x ||        ||/branches/Version14x/Scribus || <tt><b>svn co svn://scribus.net/branches/Version14x/Scribus scribus14x</b></tt>
|'''Stable''' || '''v1.4.x''' ||        ||/branches/Version14x/Scribus || <tt><b>svn co svn://scribus.net/branches/Version14x/Scribus scribus14x</b></tt>
|-
|-
|Outdated  || <strike>Version133x</strike> ||        ||<strike>/branches/Version133x/Scribus</strike> || <strike><tt><b>svn co svn://scribus.net/branches/Version13x/Scribus scribus13x</b></tt></strike>
|Outdated  || <strike>v.1.3.3x</strike> ||        ||<strike>/branches/Version133x/Scribus</strike> || <strike><tt><b>svn co svn://scribus.net/branches/Version13x/Scribus scribus13x</b></tt></strike>
|}
|}
<small>'''Important Notes:'''  
<small>'''Important Notes:'''  
Line 80: Line 60:
</small>
</small>


------
<span style="background-color: #FFFF00"><big>Where does this need to go? [[User:Kunda|Kunda]] ([[User talk:Kunda|talk]]) 14:33, 6 June 2014 (CEST)</big><br />
If you are compiling for the first time, don't be scared of the command line. Just copy the lines relevant to the version of Scribus you want to use, one by one on the command line. </span>


<span style="background-color: #FFFF00">'''Watch out:'''
<span style="background-color: #FFFF00">* Newbies should take care, that only 'make install' part has to be done as a root. Rest of the part, like downloading and compiling can be done easily as a normal users.<br>You ''can'' install as a user, however, if you are installing into a directory you have write permission for. See the <tt>-DCMAKE_INSTALL_PREFIX</tt> command below.
<span style="background-color: #FFFF00">* And if you already have a version of Scribus on your system, don't forget to use the option WANT_VERSIONING=1. You can specify this option as -DWANT_VERSIONING=1.
</span>
------
------


'''Thanks to [http://anduin.net Anduin.net], anonymous SVN access is updated daily.'''
'''Thanks to [http://anduin.net Anduin.net], anonymous SVN access is updated daily.'''


=2nd: Download Dependencies=
=2nd: Install methods: Package Manager, Source, Out-of-Source Build=
<!-- This is probably something of a worst-case scenario, but likely representative for a situation for a newbie having no built-in capability to compile software. -->
 
Dependencies are considered to be 3rd party software libraries or other altogether unique software projects that are have components that are needed to build a specific project from. When we want to build Scribus we need to make sure that we have all the dependencies fulfilled or else it will complain to us about missing components or obsolete ones.
==Essential tools==
Before going further, we must understand that in order for anything to get built, tools need to exist. In modern OS's especially Linux many of these are build tools arrive already bundled. If they aren't for some reason you will need to '''install them manually''' (see [[{{PAGENAME}}#Package Manager|package manager]])
* gcc
* gcc-c++
* cmake (version &ge; 2.8.9)
 
* subversion &ndash; if you're going to compile, you might as well get the latest Scribus updates
 
<big>There are several option for installation.
* [[{{PAGENAME}}#Package Managers| Package Manager]]: (difficulty: easy) Does a lot of the heavy lifiting by installing all the components you specify
* [[{{PAGENAME}}#Build from Source| Build from Source]]: (difficulty: intermediate to advanced) Build it the old fashion way
* [[{{PAGENAME}}#Out-of-Source-Builds| Out-of-Source-Builds]]: (difficulty: intermediate) Needs explanation
</big>


==Package Managers==
==Package Managers==
Note: many Linux distros have their own Package Managers i.e. Debian has apt,  Fedora and Centos have yum, Redhat uses rpm etc... On Mac OS X there are several choices, most popular are Macports and Homebrew. In general, by utilizing the installed package manager we can streamline the installations through easy one liners which will automate the install. We do this by invoking the following pattern:   
Note: many Linux distros have their own Package Managers i.e. Debian has '''apt''',  Fedora and Centos have '''yum''', Redhat uses '''rpm''' etc... On Mac OS X there are several choices, most popular are '''Macports''' and '''Homebrew'''. In general, by utilizing the installed package manager we can streamline the installations through easy one liners which will automate the install. We do this by invoking the following pattern:   


<tt> <b>(package-manager)  install (software-or-library-package-name)</b></tt>  
<tt> <b>(package-manager)  install (software-or-library-package-name)</b></tt>  


'''Debian'''; &nbsp;&nbsp;&nbsp;<code>apt-get install cmake</code> <br />
'''Debian'''; &nbsp;&nbsp;&nbsp;'''<code>apt-get install cmake</code>''' <br />
'''Fedora''': &nbsp;&nbsp;&nbsp;<code>yum install cmake</code>        <br />
'''Fedora''': &nbsp;&nbsp;&nbsp;'''<code>yum install cmake</code>'''       <br />
'''MacOSX''':&nbsp;<code>brew install cmake</code>
'''MacOSX''':&nbsp;'''<code>brew install cmake</code>'''
 
==Essential tools==
In order for anything to get built, tools need to exist. In modern OS's especially Linux many of these are build tools arrive already bundled. If they aren't for some reason you will need to '''install them manually''' using the package manager.
* gcc
* gcc-c++
* cmake
* subversion &ndash; if you're going to compile, you might as well get the latest Scribus updates


==Specific Dependencies==  
==Specific Dependencies==  
The following section assumes you need to manually install dependencies. Here are the list of package names that will be needed to be installed before attempting to build Scribus. Each major version of Scribus will require different dependencies.
<!-- This is probably something of a worst-case scenario, but likely representative for a situation for a newbie having no built-in capability to compile software. -->
Dependencies are considered to be 3rd party software libraries or other altogether unique software projects that are have components that are needed to build a specific project from. When we want to build Scribus we need to make sure that we have all the dependencies fulfilled or else it will complain to us about missing components or obsolete ones. The following section assumes you need to manually install dependencies. Here are the list of package names that will be needed to be installed before attempting to build Scribus. Each major version of Scribus will require different dependencies.


===Version 1.5.x===
===Version 1.5.x===
Starting with rev. 18438 (2 September 2013), building version 1.5.0svn requires Qt5 (for previous revision, it was optional).  
Starting with rev. 18438 (2 September 2013), building version 1.5.0svn requires Qt5 (for previous revisions, it was optional). If Qt5 is not present on your system, you will have to install or build it.


====Build Qt5====
====Getting Qt5====
{{Warning|Is this still correct?}}
You can download Qt5 from http://qt-project.org/downloads. Installers are available for Windows, MacOS X and Linux. For Linux, if your distribution provides Qt5, you can install it from its repositories (details for some distributions are listed below).


If you have Qt4 and Qt5 installed, you need to specify Qt5 with [http://wiki.scribus.net/canvas/CMake_Build_Options#Qt5-Specific additional CMake options].
Also available is the source code, in case you want to build Qt5 yourself, or if an installer is not available for your operating system.


As of 21 of September 2013, the best way to get QT5 seems to be to use the installer found on http://qt-project.org/downloads. It suggests as installation directory /home/user/Qt and I suggest you keep to that. The cmake option is -DQT_PREFIX="/home/user/Qt/5.1.1/gcc/". It built OK on SUSE-12.3, Ubuntu-12.04 (Pepperment) and Ubuntu-13.04.
The installer suggests as installation directory /home/username/Qt and we suggest you keep to that.
 
If you have Qt4 and Qt5 installed, and/or cmake does not find Qt5, you need to specify its location with the [[CMake_Build_Options#Qt5-Specific|build option]] -DQT_PREFIX="path-to-Qt5" (for example: -DQT_PREFIX="/home/user/Qt/5.1.1/gcc/")


In case you need a list, required qt5 libs are :   
In case you need a list, required qt5 libs are :   
Line 142: Line 123:
   qt5-qtdeclarative-devel.x86_64 0:5.1.1-1.fc19
   qt5-qtdeclarative-devel.x86_64 0:5.1.1-1.fc19
   qt5-qtjsbackend.x86_64 0:5.1.1-1.fc19
   qt5-qtjsbackend.x86_64 0:5.1.1-1.fc19
The above list is for Fedora 19, but it should help you to identify the required Qt5 components.


In case you got problems, Pygmee suggests too : "it build here after i've build sigil where it make a bit changes in QT5 config".
In case you got problems, Pygmee suggests too : "it build here after i've build sigil where it make a bit changes in QT5 config".


=====Debian=====
=====Debian=====
<div class="toccolours mw-collapsible mw-collapsed" style="width:800px;">
On Debian Testing, on top of the packages pulled in by apt-get build-dep you need. ---->
<div class="mw-collapsible-content">
'''sudo apt-get install libqt5webkit5-dev qtquick1-5-dev qtdeclarative5-dev \'''
                      '''qttools5-dev-tools qttools5-dev liblcms2-dev'''


On Debian Testing, on top of the packages pulled in by apt-get build-dep you need.
Note 1: They are all available in the official Debian repositories.
Note 2: This list should also apply for the latest Ubuntu release.
</div></div>


* libqt5webkit5-dev
=====Fedora 19 and 20=====
* qtquick1-5-dev
<div class="toccolours mw-collapsible mw-collapsed" style="width:800px;">
* qtdeclarative5-dev
Fedora 19 and 20 have Qt5 packages available from their repositories. The requirements seem to be  ---->
* qttools5-dev-tools
<div class="mw-collapsible-content">
* qttools5-dev
'''yum install qt5-qtbase qt5-qtbase-devel qt5-qtdeclarative qt5-qtdeclarative-devel qt5-qttools \'''
* liblcms2-dev
            '''qt5-qttools-devel qt5-qtwebkit qt5-qtwebkit-devel'''


They are all available in the official Debian repositories.
The above list will bring in '''qt5-qtbase-gui''' and possibly some other packages as dependencies. You might need also to install '''glibc-headers'''.
</div></div>


This list should also apply for the latest Ubuntu release.
=====Ubuntu=====
<div class="toccolours mw-collapsible mw-collapsed" style="width:800px;">
Ubuntu v13.04 ---->
<div class="mw-collapsible-content">
* Initially install:
'''sudo apt-get install qt5-default qttools5-dev-tools libqt5location5 libqt5webkit5-dev libqt5webkit5 \'''
                      '''qt5-qmake libqt5xml5 libqt5gui5 libqt5core5 qttools5-dev qttools5'''
* Then, specifically relating to qt5, install:
'''sudo apt-get install libqt5declarative5-dev qtlocation5-dev qtsensors5-dev'''
* Install the usual libs '''not''' related to qt5 :
'''sudo apt-get install zlib1g-dev libpng12-dev libjpeg-dev libtiff5-dev libpython-all-dev \'''
                      '''libfreetype6-dev libcairo2-dev libcups2-dev libxml++2.6-dev liblcms2-dev'''
</div></div>


=====Fedora 20=====
<div class="toccolours mw-collapsible mw-collapsed" style="width:800px;">
Fedora 20 has Qt5 packages available from its repositories. The requirements seem to be:
Ubuntu v13.10 ---->
<pre>
<div class="mw-collapsible-content">
qt5-qtbase
Almost the same as 13.04 except '''no qttools5''' and '''no libqt5declarative5-dev''' instead '''use qtdeclarative5-dev'''  
qt5-qtbase-devel
qt5-qtdeclarative
qt5-qtdeclarative-devel
qt5-qttools
qt5-qttools-devel
qt5-qtwebkit
qt5-qtwebkit-devel
</pre>
There is also a Qt5-compiled version of Sigil in Fedora's repositories. Installing Sigil also installs '''qt5-qtbase-gui''', '''qt5-qtsvg''' and '''qt5-qtxmlpatterns''', but I don't think these or their development packages are used to build Scribus 1.5.0. I do note that in the absence of Sigil, the above list will bring in '''qt5-qtbase-gui''' as a dependency.


You might need also to install '''glibc-headers''' and '''qt5-qttools-devel''' packages from the main repo.
'''sudo apt-get install qt5-default qttools5-dev-tools libqt5location5 libqt5webkit5-dev libqt5webkit5 \'''
                      '''qt5-qmake libqt5xml5 libqt5gui5 libqt5core5 qttools5-dev'''
'''sudo apt-get install qtdeclarative5-dev qtlocation5-dev qtsensors5-dev'''
'''sudo apt-get install zlib1g-dev libpng12-dev libjpeg-dev libtiff5-dev libpython-all-dev \'''
                      '''libfreetype6-dev libcairo2-dev libcups2-dev libxml++2.6-dev liblcms2-dev'''


=====Ubuntu 13.04=====
# Note 1: There are bugs with qt5 version 5.0.2. Install qt5 version 5.2 with the installer found on https://qt-project.org/downloads.
# Note 2: (JLuc, 25 May 2014): I followed this procedure step by step and everything when right out of the box.
# Note 3 (unknown author) : In addition, I had to install: libgl1-mesa-dev and dependencies.
</div></div>


On Ubuntu 13.04  
<div class="toccolours mw-collapsible mw-collapsed" style="width:800px;">
Ubuntu v14.04 ---->
<div class="mw-collapsible-content">
This is how i compiles scribus 1.5 on a quite freshly installed Ubuntu 14.04  :
# Install scribus 1.5 out of the scribus friend's PPA (https://launchpad.net/~scribus/+archive/ubuntu/ppa). There are too many keyboard management bugs with this version, but it maybe installs some usefull libraries. Then uninstall it.
# Install cmake, g++ and subversion in case there are not there allready ("sudo apt-get install cmake" and "sudo apt-get install subversion")
# Install (using synaptics or sudo apt-get) the following libraries and their dependancies : libdrm-dev, libgl1-mesa-dev, libxml2-dev, libzip-dev, libfreetype6-dev, liblcms2-dev, libpodofo-dev, libcairo2-dev, libmagick++dev (maybe useless), libgraphicsmagick++1-dev, libcups2-dev, libpython2.7-dev, libpoppler-qt5-dev (maybe useless), libpoppler-cpp-dev, libhunspell-dev
# Compile using maksvn script (https://github.com/JLuc/makscribus/blob/master/maksvn).
That's it !
</div></div>


*use the command line :
=====OpenSuse=====
<pre>sudo apt-get install qt5-default qttools5-dev-tools libqt5location5 libqt5webkit5-dev libqt5webkit5 qt5-qmake libqt5xml5 libqt5gui5 libqt5core5 qttools5-dev qttools5</pre>
<div class="toccolours mw-collapsible mw-collapsed" style="width:800px;">
* then, specifically relating to qt5, install : libqt5declarative5-dev qtlocation5-dev qtsensors5-dev
13.1 RC1 or newer ---->
* install too the usual libs not related to qt5 : zlib1g-dev libpng12-dev libjpeg-dev libtiff5-dev libpython-all-dev libfreetype6-dev libcairo2-dev libcups2-dev libxml++2.6-dev liblcms2-dev
<div class="mw-collapsible-content">
* Install the OS
* Install these packages via Yast2:
: '''libQt5WebkitWidgets-devel libqt5-qttools-devel python-devel cairo-devel hunspell-devel cmake subversion'''
: '''liblcms2-devel''' (from repo http://download.opensuse.org/repositories/multimedia:/libs/openSUSE_13.1/)
* Proceed with Scribus compilation process.
</div></div>


=====Ubuntu 13.10=====
=====Windows=====
Please refer to [[Building_SVN_versions_on_Windows]]


Allmost the same : just no qttools5 and no libqt5declarative5-dev but qtdeclarative5-dev instead
=====Mac OSX=====
<div class="toccolours mw-collapsible mw-collapsed" style="width:800px;">
Homebrew Package Manager  ---->
<div class="mw-collapsible-content">
Read [[Scribus_and_Homebrew]] for more details
'''brew install -v --HEAD https://gist.githubusercontent.com/luzpaz/9042115/raw/scribus-dev.rb'''
</div></div>


<pre>
<div class="toccolours mw-collapsible mw-collapsed" style="width:800px;">
sudo apt-get install qt5-default qttools5-dev-tools libqt5location5 libqt5webkit5-dev libqt5webkit5 qt5-qmake libqt5xml5 libqt5gui5 libqt5core5 qttools5-dev
MacPorts  ---->
sudo apt-get install qtdeclarative5-dev qtlocation5-dev qtsensors5-dev
<div class="mw-collapsible-content">
sudo apt-get install zlib1g-dev libpng12-dev libjpeg-dev libtiff5-dev libpython-all-dev libfreetype6-dev libcairo2-dev libcups2-dev libxml++2.6-dev liblcms2-dev
Needs details
</pre>
</div></div>
 
Note 1 : There are bugs with qt5 version 5.0.2. Install qt5 version 5.2 with the installer found on https://qt-project.org/downloads.
 
Note 2 (JLuc, 25 May 2014) : I followed this procedure step by step and everything when right out of the box.
 
Note 3 (unknown author) : I had to install TOO : libgl1-mesa-dev and dependencies.
 
=====OpenSuse 13.1 RC1 or newer=====
Install the OS
Install these packages via Yast2:
* libQt5WebkitWidgets-devel
* libqt5-qttools-devel
* python-devel
* cairo-devel
* hunspell-devel
* liblcms2-devel (from repo http://download.opensuse.org/repositories/multimedia:/libs/openSUSE_13.1/)
* cmake
* subversion
... and that's it.
 
Proceed with Scribus compilation process.


====Additional dependencies for some graphics formats====
===Additional dependencies for some graphics formats===
In 1.5.0+, there are a number of vector and bitmap graphics formats which can now be imported into Scribus. Some of these have particular additional dependencies.
In 1.5.0+, there are a number of vector and bitmap graphics formats which can now be imported into Scribus. Some of these have particular additional dependencies.


Line 223: Line 225:


====OpenSceneGraph (Optional)====
====OpenSceneGraph (Optional)====
This may be available with your Linux distribution (definitely for Fedora 17). You can also [http://www.openscenegraph.org/projects/osg/wiki/Downloads download and compile] yourself.
This may be available with your Linux distribution (definitely for Fedora 17 and later). You can also [http://www.openscenegraph.org/projects/osg/wiki/Downloads download and compile] yourself.


For Fedora, typing
<div class="toccolours mw-collapsible mw-collapsed" style="width:800px;">
 
'''Fedora'''
<code>sudo yum install OpenSceneGraph OpenSceneGraph-devel</code>
<div class="mw-collapsible-content">
'''sudo yum install OpenSceneGraph OpenSceneGraph-devel'''


should be enough, and will get you the additional requirements of Inventor, OpenThreads, and OpenThreads-devel.
should be enough, and will get you the additional requirements of Inventor, OpenThreads, and OpenThreads-devel.
 
</div></div>
For OpenSUSE, go to http://software.opensuse.org/package/OpenSceneGraph and use the 1-click install procedure.
<div class="toccolours mw-collapsible mw-collapsed" style="width:800px;">
 
'''OpenSUSE'''
<div class="mw-collapsible-content">
go to http://software.opensuse.org/package/OpenSceneGraph and use the 1-click install procedure.
</div></div>
====MS Publisher and WPG Importers====
====MS Publisher and WPG Importers====


To build Scribus with support for MS Publisher and WPG files, you need [http://cgit.freedesktop.org/libreoffice/libmspub/ libmspub], as well as [http://libwpg.sourceforge.net/ libwpg] and [http://libwpd.sourceforge.net/ libwpd]. Note that the minimum version for PUB import is libmspub 0.0.6, and also that you want the development packages (libwpd-devel, libwpg-devel, libmspub-devel, for example in Fedora).
To build Scribus with support for MS Publisher and WPG files, you need [http://cgit.freedesktop.org/libreoffice/libmspub/ libmspub], as well as [http://libwpg.sourceforge.net/ libwpg] and [http://libwpd.sourceforge.net/ libwpd]. Note that the minimum version for PUB import is libmspub 0.0.6, and also that you want the development packages (libwpd-devel, libwpg-devel, libmspub-devel, for example in Fedora).
Update (June 2014): Scribus is now able to import MS Publisher, MS Visio and CorelDraw documents via librevenge. See [[Librevenge|this page]] for details.


===v1.4.4===
===v1.4.4===
<div class="toccolours mw-collapsible mw-collapsed" style="width:800px;">
{{Warning|Please update this section}}
{{Warning|Please update this section}}
<div class="mw-collapsible-content">
  qt4  
  qt4  
  qt4-devel
  qt4-devel
Line 257: Line 267:
  freetype
  freetype
  freetype-devel
  freetype-devel
  python-imaging-devel
  python-pillow-devel  (formerly python-imaging-devel)
  tk  
  tk  
  tkinter
  tkinter
Line 269: Line 279:
<big>For convenience, here is the above list listed all on the same line ----> </big>
<big>For convenience, here is the above list listed all on the same line ----> </big>
<div class="mw-collapsible-content">
<div class="mw-collapsible-content">
apt-get install qt4 qt4-devel qtwebkit-devel poppler-devel podofo-devel ghostscript pkgconfig lcms2-devel libjpeg-devel libtiff-devel cups-devel libxml2 libxml2-devel python python-devel fontconfig-devel openssl-devel freetype freetype-devel python-imaging-devel tk tkinter hunspell hunspell-devel cairo cairo-devel boost-devel
apt-get install qt4 qt4-devel qtwebkit-devel poppler-devel podofo-devel ghostscript pkgconfig lcms2-devel libjpeg-devel libtiff-devel cups-devel libxml2 libxml2-devel python python-devel fontconfig-devel openssl-devel freetype freetype-devel python-pillow-devel tk tkinter hunspell hunspell-devel cairo cairo-devel boost-devel
</div></div>
</div></div>


Line 314: Line 324:
</strike>
</strike>
For more information on using Scribus with debian, please have a look at the [http://www.scribus.net/?q=debian Debian page our offical site]
For more information on using Scribus with debian, please have a look at the [http://www.scribus.net/?q=debian Debian page our offical site]
</div></div>
== Build from Source ==
<span style="background-color: #FFFF00"><big>Moved from top of the page..being integrated [[User:Kunda|Kunda]] ([[User talk:Kunda|talk]]) 15:07, 29 June 2014 (CEST)</big><br />
If you are compiling for the first time, don't be scared of the command line. Just copy the lines relevant to the version of Scribus you want to use, one by one on the command line. </span>
<span style="background-color: #FFFF00">'''Watch out:'''
<span style="background-color: #FFFF00">* Newbies should take care, that only 'make install' part has to be done as a root. Rest of the part, like downloading and compiling can be done easily as a normal users.<br>You ''can'' install as a user, however, if you are installing into a directory you have write permission for. See the <tt>-DCMAKE_INSTALL_PREFIX</tt> command below.
<span style="background-color: #FFFF00">* And if you already have a version of Scribus on your system, don't forget to use the option WANT_VERSIONING=1. You can specify this option as -DWANT_VERSIONING=1.
</span>
------
Take as an example this following set of commands which are geared towards the Linux environment. Here we see a case in which there is a downloading of the Scribus development version (1.5, not yet stable),  building it and then installing it. Note that this assumes that the environment has been prepared previously with all the dependencies installed.
<big><span style="background-color: #FFFF00">Recently moved from top of page. Still fine tuning how to represent this.</span></big>
{{Warning|You must have CMake version &ge; 2.8.9 (Older versions will fail). See: [[Official:Compile with CMake]]}}
<pre>
mkdir ~/src/
mkdir ~/src/scribus_svn
sudo mkdir /usr/local/scribus_svn
cd ~/src/scribus_svn
svn co svn://scribus.net/trunk/Scribus
cd ./Scribus
mkdir build
cd build
cmake -DCMAKE_INSTALL_PREFIX:PATH=/usr/local/scribus_svn ..
make
sudo make install
</pre>
'''Note:'''
* you may change ~/src/ to wherever you want to put your source into.
* you may change /usr/local/scribus_svn/ to wherever you want to put the Scribus binaries.
* in case you want to install the 1.4 stable version, replace the "svn" instruction with following : svn co svn://scribus.net/branches/Version14x/Scribus
<big><span style="background-color: #FFFF00">End of subsection</span></big>


==Start the Build Process ==
==Start the Build Process ==
Line 328: Line 372:
*-DWANT_VERSIONING=1: Sets the build to use the VERSION setting as a suffix for the install directories and the binary. Eg, the binary could be <code>scribus-1.3.5svn</code>. This should mean that you can install multiple versions with the same prefix with no clashes.
*-DWANT_VERSIONING=1: Sets the build to use the VERSION setting as a suffix for the install directories and the binary. Eg, the binary could be <code>scribus-1.3.5svn</code>. This should mean that you can install multiple versions with the same prefix with no clashes.
*-DWANT_DEBUG=1: Sets the build to be a debug release and use -O0 -g3, instead of -O2 (This is the default for now, and cannot be turned off unless you edit the CMakeFiles.txt file).
*-DWANT_DEBUG=1: Sets the build to be a debug release and use -O0 -g3, instead of -O2 (This is the default for now, and cannot be turned off unless you edit the CMakeFiles.txt file).
*-DWANT_CAIRO=1: Makes CMake search for cairo and build with cairo instead of LibArt_LGPL. cairo is the primary supported option for 1.3.5+.
*<strike>-DWANT_CAIRO=1: Makes CMake search for cairo and build with cairo instead of LibArt_LGPL. cairo is the primary supported option for 1.3.5+</strike>. ('''DEPRECATED''')
*-DWANT_LIBART=1 (not available in 1.3.5, default in 1.3.3.x): Makes CMake search for and build with LibArt_LGPL instead of cairo.
*-DWANT_LIBART=1 (not available in 1.3.5, default in 1.3.3.x): Makes CMake search for and build with LibArt_LGPL instead of cairo.
*-DWANT_QTARTHUR=1: In 1.3.5, uses the QT4 ARTHUR rendering library. This is an alternative to CAIRO.
*-DWANT_QTARTHUR=1: In 1.3.5, uses the QT4 ARTHUR rendering library. This is an alternative to CAIRO.
Line 335: Line 379:
If you have several version of QT installed or QT is installed in a non standard location you'll have to tell cmake where to find it by setting <code>-DQT_QMAKE_EXECUTABLE</code>
If you have several version of QT installed or QT is installed in a non standard location you'll have to tell cmake where to find it by setting <code>-DQT_QMAKE_EXECUTABLE</code>


For example: to make a cairo debug build, then something like this:
<strike>For example: to make a cairo debug build, then something like this:</strike>


<code>/usr/local/bin/cmake . -DCMAKE_INSTALL_PREFIX:PATH=/opt/scribus134cvs -DWANT_CAIRO=1 -DWANT_DEBUG=1 -DWANT_VERSIONING=1</code>
<strike><code>/usr/local/bin/cmake . -DCMAKE_INSTALL_PREFIX:PATH=/opt/scribus134cvs -DWANT_CAIRO=1 -DWANT_DEBUG=1 -DWANT_VERSIONING=1</code></strike>


To use qt_arthur instead:
To use qt_arthur instead:
Line 343: Line 387:
<code>/usr/local/bin/cmake . -DCMAKE_INSTALL_PREFIX:PATH=/opt/scribus134cvs -DWANT_QTARTHUR=1 -DWANT_DEBUG=1 -DWANT_VERSIONING=1</code>
<code>/usr/local/bin/cmake . -DCMAKE_INSTALL_PREFIX:PATH=/opt/scribus134cvs -DWANT_QTARTHUR=1 -DWANT_DEBUG=1 -DWANT_VERSIONING=1</code>


==Out-of-source builds==
==Out-of-Source-Builds==
One of the advantages of CMake is that you can do an out-of-source build. What is this? It enables you to build the application without writing anything at all to the directory where the Scribus source is. This means your source tree is clean, always. Its easier and faster to update, and you can build multiple targets out-of-source from the same source tree. Cool!
One of the advantages of CMake is that you can do an out-of-source build. What is this? It enables you to build the application without writing anything at all to the directory where the Scribus source is. This means your source tree is clean, always. Its easier and faster to update, and you can build multiple targets out-of-source from the same source tree. Cool!


Line 414: Line 458:
*Enable more pkg-config usage
*Enable more pkg-config usage
*Prefixes for more packages
*Prefixes for more packages
*Create a [[Scribus_and_Homebrew|new Homebrew formula]] for MacOSX and eventually add to this page

Revision as of 20:57, 4 September 2014

Broom.png
This article needs to be cleaned up. Please update the information, remove factual errors, refresh category data, or correct the hyperlinks.

This page tries to describe how to build Scribus from source. The instructions mainly refer to building Scribus on Linux. Building on Mac OS and on Windows is not easy; you can find some explanations for Mac OS here, and for Windows here.

TL;DR (Too Long; Didn't Read)

You know what you are doing already and just want to compile Scribus via SVN, skip the introduction and go to Installing 1.5svn

Why would I Need or Want to 'Build' Scribus?

  1. For Necessity: You are using the current stable version, but certain bugs are a problem, and you know they have been fixed since the last release.
  2. For Science: You have heard about some new features in the development version, and you'd like to try them out.
  3. For the World: You're considering helping out the Scribus project and want to see how it's put together to get some idea about how you can help.

'Or, for that matter, what is this 'Building' you speak of?

Expand this content if you need a little bit more background on what Building source code means. --->

When you are going to build or compile Scribus, what you have downloaded (if you have downloaded the source code) is a large collection of plain-text files (ending in '.c' or '.cpp' to denote either the C or C++ programming language respectively). The reason there are so many is that this actually makes the process of developing software easier, and allows for use of small parts repeatedly by different functions of the overall program. These plain-text files need to be converted to binary files (ending in ',o' for object files) so that your computer can use them, and the program works efficiently.

The first step is to configure your downloaded directory of files. This requires a check of your computer to make sure the compiling programs and all the other required outside resources are present and sufficiently up-to-date. Just as Scribus itself consists of these small program files, it also will use those of outside programs, like CUPS, lcms, and so on, so it needs to have on hand those plain text files to connect to these outside resources. After checking for the necessary resources, a script is being written to tell the compiler how to go about building Scribus. The process will fail if you are missing something, and cmake will give you error messages.

The Scribus Team requires the use of CMake for this configuring process. It is quick, easy to use, and easy for the developers to write for – even CMake needs instructions. You can also pass to CMake several special parameters for your particular Computer setup, for example, where you want Scribus to be installed.

Next, the actual 'build' process is done with a program called make. To start the process you simply enter make in a command line. That's it. You do not need to have root privileges to compile, and it is generally recommended that do not compile as root (one reason for this is that, by creating a number of files under root's name, you then interfere with subsequent updating from SVN). Compiling takes up a good part of your computer's resources, especially your processor(s), so you will find its performance rather sluggish while compiling is going on. Consequently, many find that compiling is best done by starting make and then walking away from the PC to let it do its work.

Finally, you need to install, done with the command make install. If you are going to install in the default location, you will need to have root privileges. On most Linux distros this can easily be done with the su command (after which you need root's password), or with sudo, entered as sudo make install. You can run cmake with a command that can install Scribus in a directory for which you have write privileges, and therefore do not need to be root.

For this help, and other advice, continue reading the following sections.

Fear is the mind Killer...

"Do not fear building Scribus from source" ~Paul Muad'dib Atreides

There is nothing to fear here, building Scribus yourself is not as hard as it sounds. This page can teach a beginner many things at once: starting with beginning to comprehend the internals of Scribus to appreciating the Command Line shell and how to invoke commands through it. Learn how to install software libraries (components that Scribus utilizes) and go so far as to modify source code through applying patches. This exposure will help increase your skill set to work on most all platforms and widen your knowledge of software creation and maintenance.

1st: Download latest snapshot with Subversion

Subversion is the versioning control system used for Scribus. This allows multiple developers to hack on Scribus source code simultaneously. Check the Subversion page for further details on how to use this tool. Make sure you have svn installed.

# Add instruction here for directory creation where SVN will download to
# Direct the user to choose which SVN branch they are downloading by having them view the table below
# Execute said chosen SVN command to download the branch

Status Version SVN Path Command to download from SVN
Developmental v1.5.0 /trunk/Scribus svn co svn://scribus.net/trunk/Scribus scribus150
Stable v1.4.x /branches/Version14x/Scribus svn co svn://scribus.net/branches/Version14x/Scribus scribus14x
Outdated v.1.3.3x /branches/Version133x/Scribus svn co svn://scribus.net/branches/Version13x/Scribus scribus13x

Important Notes:

  • All subversion URLs for Scribus anonsvn are based at: svn://scribus.net/
  • Updating your working copy is much the same as cvs - just cd into your working copy and run "svn up".
  • There's also http://scribus.net/svn/Scribus/ , which gets you to the same content, but svn://scribus.net/ is usually faster. HTTP access might be useful to those behind paranoid firewalls or proxies.
  • If you used to check out -r <Version>, check out <SVN Path> instead



Thanks to Anduin.net, anonymous SVN access is updated daily.

2nd: Install methods: Package Manager, Source, Out-of-Source Build

Essential tools

Before going further, we must understand that in order for anything to get built, tools need to exist. In modern OS's especially Linux many of these are build tools arrive already bundled. If they aren't for some reason you will need to install them manually (see package manager)

  • gcc
  • gcc-c++
  • cmake (version ≥ 2.8.9)
  • subversion – if you're going to compile, you might as well get the latest Scribus updates

There are several option for installation.

Package Managers

Note: many Linux distros have their own Package Managers i.e. Debian has apt, Fedora and Centos have yum, Redhat uses rpm etc... On Mac OS X there are several choices, most popular are Macports and Homebrew. In general, by utilizing the installed package manager we can streamline the installations through easy one liners which will automate the install. We do this by invoking the following pattern:

(package-manager) install (software-or-library-package-name)

Debian;    apt-get install cmake
Fedora:    yum install cmake
MacOSXbrew install cmake

Specific Dependencies

Dependencies are considered to be 3rd party software libraries or other altogether unique software projects that are have components that are needed to build a specific project from. When we want to build Scribus we need to make sure that we have all the dependencies fulfilled or else it will complain to us about missing components or obsolete ones. The following section assumes you need to manually install dependencies. Here are the list of package names that will be needed to be installed before attempting to build Scribus. Each major version of Scribus will require different dependencies.

Version 1.5.x

Starting with rev. 18438 (2 September 2013), building version 1.5.0svn requires Qt5 (for previous revisions, it was optional). If Qt5 is not present on your system, you will have to install or build it.

Getting Qt5

You can download Qt5 from http://qt-project.org/downloads. Installers are available for Windows, MacOS X and Linux. For Linux, if your distribution provides Qt5, you can install it from its repositories (details for some distributions are listed below).

Also available is the source code, in case you want to build Qt5 yourself, or if an installer is not available for your operating system.

The installer suggests as installation directory /home/username/Qt and we suggest you keep to that.

If you have Qt4 and Qt5 installed, and/or cmake does not find Qt5, you need to specify its location with the build option -DQT_PREFIX="path-to-Qt5" (for example: -DQT_PREFIX="/home/user/Qt/5.1.1/gcc/")

In case you need a list, required qt5 libs are :

 qt5-qtbase.x86_64 0:5.1.1-1.fc19
 qt5-qtbase-devel.x86_64 0:5.1.1-1.fc19
 qt5-qtbase-ibase.x86_64 0:5.1.1-1.fc19
 qt5-qtbase-mysql.x86_64 0:5.1.1-1.fc19
 qt5-qtbase-odbc.x86_64 0:5.1.1-1.fc19
 qt5-qtbase-postgresql.x86_64 0:5.1.1-1.fc19
 qt5-qtbase-static.x86_64 0:5.1.1-1.fc19
 qt5-qtbase-tds.x86_64 0:5.1.1-1.fc19
 qt5-qtbase-x11.x86_64 0:5.1.1-1.fc19
 qt5-qttools.x86_64 0:5.1.1-3.fc19
 qt5-qttools-devel.x86_64 0:5.1.1-3.fc19
 qt5-qtwebkit.x86_64 0:5.1.1-1.fc19
 qt5-qtwebkit-devel.x86_64 0:5.1.1-1.fc19
 qt5-qtdeclarative.x86_64 0:5.1.1-1.fc19
 qt5-qtdeclarative-devel.x86_64 0:5.1.1-1.fc19
 qt5-qtjsbackend.x86_64 0:5.1.1-1.fc19

The above list is for Fedora 19, but it should help you to identify the required Qt5 components.

In case you got problems, Pygmee suggests too : "it build here after i've build sigil where it make a bit changes in QT5 config".

Debian

On Debian Testing, on top of the packages pulled in by apt-get build-dep you need. ---->

sudo apt-get install libqt5webkit5-dev qtquick1-5-dev qtdeclarative5-dev \
                     qttools5-dev-tools qttools5-dev liblcms2-dev
Note 1: They are all available in the official Debian repositories.
Note 2: This list should also apply for the latest Ubuntu release.
Fedora 19 and 20

Fedora 19 and 20 have Qt5 packages available from their repositories. The requirements seem to be ---->

yum install qt5-qtbase qt5-qtbase-devel qt5-qtdeclarative qt5-qtdeclarative-devel qt5-qttools \
            qt5-qttools-devel qt5-qtwebkit qt5-qtwebkit-devel

The above list will bring in qt5-qtbase-gui and possibly some other packages as dependencies. You might need also to install glibc-headers.

Ubuntu

Ubuntu v13.04 ---->

  • Initially install:
sudo apt-get install qt5-default qttools5-dev-tools libqt5location5 libqt5webkit5-dev libqt5webkit5 \
                     qt5-qmake libqt5xml5 libqt5gui5 libqt5core5 qttools5-dev qttools5
  • Then, specifically relating to qt5, install:
sudo apt-get install libqt5declarative5-dev qtlocation5-dev qtsensors5-dev 
  • Install the usual libs not related to qt5 :
sudo apt-get install zlib1g-dev libpng12-dev libjpeg-dev libtiff5-dev libpython-all-dev \
                     libfreetype6-dev libcairo2-dev libcups2-dev libxml++2.6-dev liblcms2-dev

Ubuntu v13.10 ---->

Almost the same as 13.04 except no qttools5 and no libqt5declarative5-dev instead use qtdeclarative5-dev

sudo apt-get install qt5-default qttools5-dev-tools libqt5location5 libqt5webkit5-dev libqt5webkit5 \
                     qt5-qmake libqt5xml5 libqt5gui5 libqt5core5 qttools5-dev
sudo apt-get install qtdeclarative5-dev qtlocation5-dev qtsensors5-dev
sudo apt-get install zlib1g-dev libpng12-dev libjpeg-dev libtiff5-dev libpython-all-dev \
                     libfreetype6-dev libcairo2-dev libcups2-dev libxml++2.6-dev liblcms2-dev
  1. Note 1: There are bugs with qt5 version 5.0.2. Install qt5 version 5.2 with the installer found on https://qt-project.org/downloads.
  2. Note 2: (JLuc, 25 May 2014): I followed this procedure step by step and everything when right out of the box.
  3. Note 3 (unknown author) : In addition, I had to install: libgl1-mesa-dev and dependencies.

Ubuntu v14.04 ---->

This is how i compiles scribus 1.5 on a quite freshly installed Ubuntu 14.04  :

  1. Install scribus 1.5 out of the scribus friend's PPA (https://launchpad.net/~scribus/+archive/ubuntu/ppa). There are too many keyboard management bugs with this version, but it maybe installs some usefull libraries. Then uninstall it.
  2. Install cmake, g++ and subversion in case there are not there allready ("sudo apt-get install cmake" and "sudo apt-get install subversion")
  3. Install (using synaptics or sudo apt-get) the following libraries and their dependancies : libdrm-dev, libgl1-mesa-dev, libxml2-dev, libzip-dev, libfreetype6-dev, liblcms2-dev, libpodofo-dev, libcairo2-dev, libmagick++dev (maybe useless), libgraphicsmagick++1-dev, libcups2-dev, libpython2.7-dev, libpoppler-qt5-dev (maybe useless), libpoppler-cpp-dev, libhunspell-dev
  4. Compile using maksvn script (https://github.com/JLuc/makscribus/blob/master/maksvn).

That's it !

OpenSuse

13.1 RC1 or newer ---->

  • Install the OS
  • Install these packages via Yast2:
libQt5WebkitWidgets-devel libqt5-qttools-devel python-devel cairo-devel hunspell-devel cmake subversion
liblcms2-devel (from repo http://download.opensuse.org/repositories/multimedia:/libs/openSUSE_13.1/)
  • Proceed with Scribus compilation process.
Windows

Please refer to Building_SVN_versions_on_Windows

Mac OSX

Homebrew Package Manager ---->

MacPorts ---->

Needs details

Additional dependencies for some graphics formats

In 1.5.0+, there are a number of vector and bitmap graphics formats which can now be imported into Scribus. Some of these have particular additional dependencies.

GraphicsMagick (Optional)

You do not need GraphicsMagick to run cmake or compile 1.5.0svn, but some added import filters will be available if you have it (and cmake will detect it automatically). What Scribus needs are the following packages: graphicsmagick, graphicsmagick-devel, graphicsmagick-c++, and graphicsmagick-c++-devel.

OpenSceneGraph (Optional)

This may be available with your Linux distribution (definitely for Fedora 17 and later). You can also download and compile yourself.

Fedora

sudo yum install OpenSceneGraph OpenSceneGraph-devel

should be enough, and will get you the additional requirements of Inventor, OpenThreads, and OpenThreads-devel.

OpenSUSE

go to http://software.opensuse.org/package/OpenSceneGraph and use the 1-click install procedure.

MS Publisher and WPG Importers

To build Scribus with support for MS Publisher and WPG files, you need libmspub, as well as libwpg and libwpd. Note that the minimum version for PUB import is libmspub 0.0.6, and also that you want the development packages (libwpd-devel, libwpg-devel, libmspub-devel, for example in Fedora).

Update (June 2014): Scribus is now able to import MS Publisher, MS Visio and CorelDraw documents via librevenge. See this page for details.

v1.4.4

Warning Warning: Please update this section
qt4 
qt4-devel
qtwebkit-devel
poppler-devel              (on debian you might need poppler-private-dev too : see http://bugs.scribus.net/view.php?id=11162)
podofo-devel
ghostscript                   (this should already be bundled)
pkgconfig
lcms2-devel
libjpeg-devel
libtiff-devel
cups-devel
libxml2 and libxml2-devel (libxml2 should already be bundled)
python
python-devel
fontconfig-devel
openssl-devel               (?)
freetype
freetype-devel
python-pillow-devel  (formerly python-imaging-devel)
tk 
tkinter
hunspell 
hunspell-devel              (as of 1.4.2)
cairo                             (cairo should already be bundled)
cairo-devel 
boost-devel

For convenience, here is the above list listed all on the same line ---->

apt-get install qt4 qt4-devel qtwebkit-devel poppler-devel podofo-devel ghostscript pkgconfig lcms2-devel libjpeg-devel libtiff-devel cups-devel libxml2 libxml2-devel python python-devel fontconfig-devel openssl-devel freetype freetype-devel python-pillow-devel tk tkinter hunspell hunspell-devel cairo cairo-devel boost-devel

In addition to the above each Linux distrubution has it's own quirks to be aware of. The subsections below work to address them:

Fedora

Warning Warning: Please update this section

For Fedora at least, the names are as used with yum, for example:

yum install qt-devel lcms-devel libjpeg-devel libtiff-devel

and so on. On other distros the exact names may vary. Here is a link describing the particulars for Ubuntu 7.10 (Gutsy Gibbon):

On Fedora, if you install various development packages, you have most of what you need. Exceptions seem to be cups-devel, lcms-devel, tk and tkinter, and python-imaging-devel (maybe cairo-devel). Incidentally, in Fedora 9 and later, Qt4 is loaded by default, and is labeled only qt and qt-devel.


Packages for Ubuntu

Warning Warning: Please update this section

To install all the required libraries and packages for Debian or Ubuntu type the following in a terminal:

sudo apt-get build-dep scribus-ng

In March 2011 the build dependencies for Scribus 1.4.0 on Debian/Ubuntu were:

debhelper (>= 7), cmake (>= 2.4.3), gcc (>=3.3.5), libqt4-dev (>= 4.6), libcairo2-dev, zlib1g-dev,
liblcms1-dev (>= 1.13), libtiff4-dev, libcups2-dev,libxml2-dev (>= 2.6.16), gettext, python-all-dev,
libboost-python-dev, libaspell-dev, libpodofo-dev (>= 0.8.4), quilt

The easy way for Debian users

Warning Warning: Please update this section

On Debian, if you install the develeopment packages as described above(apt-get build-dep scribus-ng) you will need the following packages to build the trunk (status September 2011):

  • libqtwebkit-dev
  • poppler-private-dev may be needed, see 11162

If you're using Debian (or Ubuntu) you need to manually compile the SVN version, only if you want to be really really up to date.

Otherwise, you can rely on the .deb for scribus-ng in our own repositories or, if you don't find the packages for your platform (ppc for instance) you can let apt-get compile from source using the latest sources in the repositories (most of the time those will be older than the SVN ones, but you probably don't really care).

You first have to add the source line for deb-src in synaptic, then you should become root (sudo -i) and:

apt-get source scribus-ng;
cd scribus-ng-1.3.5.dfsg~svn20090208;
apt-get build-dep scribus-ng;
debuild -us -uc; dpkg -i 
../scribus-ng_1.3.5.dfsg~svn20090208-3_i386.deb

For more information on using Scribus with debian, please have a look at the Debian page our offical site

Build from Source

Moved from top of the page..being integrated Kunda (talk) 15:07, 29 June 2014 (CEST)
If you are compiling for the first time, don't be scared of the command line. Just copy the lines relevant to the version of Scribus you want to use, one by one on the command line.

Watch out: * Newbies should take care, that only 'make install' part has to be done as a root. Rest of the part, like downloading and compiling can be done easily as a normal users.
You can install as a user, however, if you are installing into a directory you have write permission for. See the -DCMAKE_INSTALL_PREFIX command below. * And if you already have a version of Scribus on your system, don't forget to use the option WANT_VERSIONING=1. You can specify this option as -DWANT_VERSIONING=1.


Take as an example this following set of commands which are geared towards the Linux environment. Here we see a case in which there is a downloading of the Scribus development version (1.5, not yet stable), building it and then installing it. Note that this assumes that the environment has been prepared previously with all the dependencies installed.

Recently moved from top of page. Still fine tuning how to represent this.

Warning Warning: You must have CMake version ≥ 2.8.9 (Older versions will fail). See: Official:Compile with CMake
mkdir ~/src/
mkdir ~/src/scribus_svn
sudo mkdir /usr/local/scribus_svn
cd ~/src/scribus_svn
svn co svn://scribus.net/trunk/Scribus
cd ./Scribus
mkdir build
cd build
cmake -DCMAKE_INSTALL_PREFIX:PATH=/usr/local/scribus_svn ..
make
sudo make install

Note:

  • you may change ~/src/ to wherever you want to put your source into.
  • you may change /usr/local/scribus_svn/ to wherever you want to put the Scribus binaries.
  • in case you want to install the 1.4 stable version, replace the "svn" instruction with following : svn co svn://scribus.net/branches/Version14x/Scribus

End of subsection

Start the Build Process

Before continuing, please note that an out-of-source build is recommended, however.. From the Scribus directory:

/path/to/cmake . -DCMAKE_INSTALL_PREFIX:PATH=/path/to/install/to/scribuscmake/

For example:

/usr/local/bin/cmake . -DCMAKE_INSTALL_PREFIX:PATH=/opt/scribus15svn

Some options that the Scribus CMake files know about (more can be found here : http://wiki.scribus.net/canvas/CMake_Build_Options):

  • -DWANT_VERSIONING=1: Sets the build to use the VERSION setting as a suffix for the install directories and the binary. Eg, the binary could be scribus-1.3.5svn. This should mean that you can install multiple versions with the same prefix with no clashes.
  • -DWANT_DEBUG=1: Sets the build to be a debug release and use -O0 -g3, instead of -O2 (This is the default for now, and cannot be turned off unless you edit the CMakeFiles.txt file).
  • -DWANT_CAIRO=1: Makes CMake search for cairo and build with cairo instead of LibArt_LGPL. cairo is the primary supported option for 1.3.5+. (DEPRECATED)
  • -DWANT_LIBART=1 (not available in 1.3.5, default in 1.3.3.x): Makes CMake search for and build with LibArt_LGPL instead of cairo.
  • -DWANT_QTARTHUR=1: In 1.3.5, uses the QT4 ARTHUR rendering library. This is an alternative to CAIRO.
  • -DWANT_HUNSPELL=1: This will enable the new (as of 1.4.2) hunspell-based spell checking capabilities across *all* platforms.

If you have several version of QT installed or QT is installed in a non standard location you'll have to tell cmake where to find it by setting -DQT_QMAKE_EXECUTABLE

For example: to make a cairo debug build, then something like this:

/usr/local/bin/cmake . -DCMAKE_INSTALL_PREFIX:PATH=/opt/scribus134cvs -DWANT_CAIRO=1 -DWANT_DEBUG=1 -DWANT_VERSIONING=1

To use qt_arthur instead:

/usr/local/bin/cmake . -DCMAKE_INSTALL_PREFIX:PATH=/opt/scribus134cvs -DWANT_QTARTHUR=1 -DWANT_DEBUG=1 -DWANT_VERSIONING=1

Out-of-Source-Builds

One of the advantages of CMake is that you can do an out-of-source build. What is this? It enables you to build the application without writing anything at all to the directory where the Scribus source is. This means your source tree is clean, always. Its easier and faster to update, and you can build multiple targets out-of-source from the same source tree. Cool!

To do an out-of-source build, you need a new directory to build in. Say you have the source files in:

/home/username/scribuscmake/Scribus

Make the following directory:

/home/username/scribuscmake/builddir

So then, instead of doing:

eg /usr/local/bin/cmake . -DCMAKE_INSTALL_PREFIX:PATH=/opt/scribus15svn

you would then change to the builddir directory and run:

eg /usr/local/bin/cmake ../Scribus -DCMAKE_INSTALL_PREFIX:PATH=/opt/scribus15svn

Simple!

More CMake Options

CMake_Build_Options

Continuing on to the build stage

Once this has successfully completed, simply run make && make install.

The CMake based build system is very new to Scribus and it will change and it will need improving. Please report issues on our mailing list or bugtracker.

There is a long todo list for this build system including, but not limited to:

  • Checking it works across distributions
  • Checking it works across various flavours of UNIX
  • Checking it works on 64 bit distros
  • Add Win32 and Mac OSX support

Making a tarball for distribution

To make a tarball for distribution, the old way would be to make dist. The new way is to run make package_source or /path/to/cpack -G TBZ2 --config CPackSourceConfig.cmake to give you a bundle of the source. With cmake 2.4.1 there is only support for a gzip tar.gz however a bzip2 tar.bz2 is possible with later versions of cmake.

Notes For Packagers

If you package Scribus for a distribution keep in mind the issue of the install prefix versus temporary install directory prefix. The following seems to work well for Debian packaging:

>_______mkdir -p $(BUILD_DIR)

>_______cd $(BUILD_DIR) && $(CMAKE) \
>_______    -DWANT_DEBUG:STRING=$(DEBUG_FLAG) \
>_______    -DCMAKE_INSTALL_PREFIX:PATH=/usr \
>_______    -DCMAKE_SKIP_RPATH:BOOL=1 \
>_______    -DRPATH_STYLE:STRING=none \
>_______    -DWANT_VERSIONING:BOOL=1 \
>_______    -DCUSTOM_VERSIONTAG:STRING=-ng \
>_______    -DCMAKE_CXX_FLAGS:STRING='-o2 -g -Wall' \
>_______    -DCMAKE_C_FLAGS:STRING='-o2 -g -Wall' ../../

then

>_______$(MAKE) -C $(BUILD_DIR) install DESTDIR=$(INSTALL_DIR)

where $(BUILD_DIR) is ./build and $(INSTALL_DIR) is ./install

Using $(PREFIX) is the key to avoiding hardcoded absolute path problem.

=

TODO

  • Enable more pkg-config usage
  • Prefixes for more packages