3.4 KiB
Xournal++ Linux Build
Install dependencies
Please create pull requests (or file issues) if you have more precise dependencies.
Lua is needed for plugins, if it is missing, the plugins will be disabled.
CMake Generator
The installation instructions don't assume any specific build tool (other than CMake), but they do require make, ninja, or another supported CMake generator. It is required that such a tool is installed in order to build xournalpp.
Distribution specific commands
For Arch
sudo pacman -S cmake gtk3 base-devel libxml2 cppunit portaudio libsndfile \
poppler-glib texlive-bin texlive-pictures gettext libzip
For Fedora/CentOS/RHEL:
sudo dnf install gcc-c++ cmake gtk3-devel libxml2-devel cppunit-devel portaudio-devel libsndfile-devel \
poppler-glib-devel texlive-scheme-basic texlive-dvipng 'tex(standalone.cls)' gettext libzip-devel
For Ubuntu/Debian:
sudo apt-get install cmake libgtk-3-dev libpoppler-glib-dev portaudio19-dev libsndfile-dev \
libcppunit-dev dvipng texlive libxml2-dev liblua5.3-dev libzip-dev
For OpenSuse:
sudo zypper install cmake gtk3-devel cppunit-devel portaudio-devel libsndfile-devel \
texlive-dvipng texlive libxml2-devel libpoppler-glib-devel libzip-devel
For Solus:
sudo eopkg it -c system.devel
sudo eopkg it cmake libgtk-3-devel libxml2-devel poppler-devel libzip-devel \
portaudio-devel libsndfile-devel alsa-lib-devel cppunit-devel lua-devel
Compiling
The basic steps to compile Xournal++ are:
git clone http://github.com/xournalpp/xournalpp.git
cd xournalpp
mkdir build
cd build
cmake ..
cmake --build .
# For a faster build, set the flag -DCMAKE_BUILD_TYPE=RelWithDebInfo
Use cmake-gui .. to graphically configure compilation.
With Cairo 1.16 PDF Bookmarks will be possible, but this Version is not yet common available, therefore the Cairo PDF Export is without PDF Bookmarks.
The binary executable will be placed in the build/src/ subdirectory.
Packaging and Installation
Creating Packages for Package Managers
After compilation, select which packages you want to generate (see the relevant
sections below) and then run the package target. The generated packages will
be located in build/packages. For example:
cmake .. -DCPACK_GENERATOR="TGZ;DEB" # Generate .tar.gz and .deb packages
cmake --build . --target package
By default, a standalone .tar.gz package will be generated. For
distro-agnostic packaging platforms such as AppImages and Flatpaks, see the
relevant sections below.
.deb packages
cmake .. -DCPACK_GENERATOR="DEB" ..
cmake --build . --target package
.rpm packages
TODO
AppImage
TODO
Flatpak
TODO
Installation from source
We highly discourage installation from source, as it may lead to issues when upgrading to newer versions later on. Please think about creating a native package, an AppImage or Flatpak instead. Instructions are below.
If you don't want to make a package, you can install Xournal++ into your user
folder (or any other folder) by specifying CMAKE_INSTALL_PREFIX:
cmake .. -DCMAKE_INSTALL_PREFIX=$HOME/.local
cmake --build . --target install
./cmake/postinst configure
If you want to install Xournal++ systemwide directly from the build directory, run
cmake .. -DCMAKE_INSTALL_PREFIX=/usr
sudo cmake --build . --target install
./cmake/postinst configure