22 Run Manuskript from Source Code on Linux

Shivaekul edited this page 2021-10-16 15:37:52 -07:00

Table of Contents

• SUMMARY
• Open Terminal Session
• PREREQUISITE PACKAGE INSTALLATION
• Install Required Software Packages
• Install Optional Dependencies
• PyEnchant
• MarkDown
• OPTIONAL PACKAGE INSTALLATION
• Install Pandoc for more Compile/Export Formats
• MANUSKRIPT INSTALLATION
• A: Download zip or tar.gz and Extract Source Code
• B: Install Git and Clone Source Code
• Optional: Switch to the develop Branch (latest unreleased version)
• EXCECUTION
• Run manuskript from Source Code

SUMMARY

This guide describes the steps for installing and running Manuskript from source code on Linux.

The steps include installing all necessary software dependencies. These steps focus on Debian and Debian based GNU/Linux distributions , such as Ubuntu or Mint. These commands may also work for other distros, though there may be some differences in the package names.

• Fedora or CentOS - use yum or dnf package command instead of apt.
• openSUSE - use zypper package command instead of apt

Every command in this guide should be run in a terminal session.

Note that some commands require root privilege and hence are prefixed with the sudo command.
If sudo does not work then try using su -c instead.

Open Terminal Session

Following are some ways to invoke a terminal session with different window managers:

• GNOME: Left-click on Activities, then click on the Terminal icon on the left-hand side of the screen.
• KDE:     Use menu option K -> System -> Konsole
• LXDE:   Use menu option L -> Accessories -> LXTerminal
• Unity:   Left-click on the Search icon in the upper left-hand corner, type in terminal, then click on the terminal icon.
• XFCE4: Use menu option Applications Menu -> System -> XFCE Terminal

PREREQUISITE PACKAGE INSTALLATION

Install Required Software Packages

Manuskript is written in Python (v3) programming language and uses the cross-platform QT (v5) UI framework and also requires some additional software. Accept all other dependencies as proposed.

Debian / Ubuntu:

sudo apt install python3 python3-pyqt5 python3-pyqt5.qtwebkit libqt5svg5 python3-lxml zlib1g

Fedora / CentOS:

su -c "dnf install python3 python3-qt5 python3-qt5-webkit qt5-qtsvg python3-lxml zlib"

openSUSE:

sudo zypper install python3 python3-qt5 libQt5Svg5 python3-lxml

On openSUSE I was able to run manuskript but unable to find appropriate packages for python3-pyqt5.webkit and zlib1g.

Gentoo:

sudo emerge -va dev-python/lxml dev-python/PyQt5

FreeBSD:

sudo portmaster lang/python3 devel/py-qt5-core www/qt5-webkit www/py-qt5-webkit graphics/qt5-svg devel/py-lxml

I didn't test from fresh, so it is possible I'm missing something, but these worked to get Manuskript running on my machine. (zlib is built into FreeBSD.)

Install Optional Dependencies

PyEnchant

PyEnchant is used for spellchecking.

sudo apt install python3-enchant

Install the desired language dictionary.
Each language is identified by a suffix (en for English, fr for French, de for German, etc.)

For example to install the French fr dictionary use:

sudo apt install aspell-fr

MarkDown

MarkDown provides Manuskript export as HTML.

sudo apt install python3-markdown

OPTIONAL PACKAGE INSTALLATION

Install Pandoc for more Compile/Export Formats

To access additional compile/export formats, such as ePub, OpenDocument and DocX, install Pandoc.

sudo apt install pandoc

To access compile/export format PDF also install additional packages.

sudo apt install texlive-latex-recommended texlive-fonts-recommended texlive-luatex
sudo apt install texlive-xetex   # OPTIONAL - Provides improved unicode support with 'xelatex'

MANUSKRIPT INSTALLATION

The manuskript source code can be installed in one of two ways. Choose one of the following options (A or B).

A: Download zip or tar.gz and Extract Source Code

Download an official sources release zip or tar.gz file.
Note that these are NOT the files with -linux, -osx, -win32, or -windows in the filename.
http://www.theologeek.ch/manuskript/download/

Choose a directory to install the source code. For example, your home directory:

cd /home/your-user-name

Extract the source code.

Either:

unzip ~/Downloads/name-of-file.zip

Or:

tar -tvf ~/Downloads/name-of-file.tar.gz

The above commands should create a manuskript subdirectory. Change into this subdirectory.

cd manuskript

If you performed option A, then skip past option B to the section titled EXECUTION.

B: Install Git and Clone Source Code

The source code for Manuskript is managed with the git distributed version control system, and hence we need git to be able to clone a copy of the source code.

sudo apt install git-core

Note that the command sudo is used to acquire root privilege required to install software packages.

Choose a directory to install the source code. For example, your home directory:

cd /home/your-user-name

Use git to clone a copy of the source code your chosen directory.

git clone https://github.com/olivierkes/manuskript.git

The above command will create a manuskript subdirectory. Change into this subdirectory.

cd manuskript

At any time after you have cloned the source code, you can update your copy to the latest version with the git pull command.

Optional: Switch to the develop Branch (latest unreleased version)

git checkout develop

Note that you can return to the master branch with the git checkout master command.

EXCECUTION

Run manuskript from Source Code

bin/manuskript

The above command assumes you are in the directory in which you installed manuskript.