kmarius / zathura

a document viewer

zathura - a document viewer

zathura is a highly customizable and functional document viewer based on the girara user interface library and several document libraries.

Requirements

The following dependencies are required:

• gtk3 (>= 3.22)
• glib (>= 2.50)
• girara (>= 0.4.1)
• libmagic from file(1): for mime-type detection
• json-glib

The following dependencies are optional:

• sqlite3 (>= 3.6.23): sqlite3 database backend
• libsynctex from TeXLive (>= 1.19): SyncTeX support
• libseccomp: sandbox support

For building zathura, the following dependencies are also required:

• meson (>= 0.61)
• gettext
• pkgconf

The following dependencies are optional build-time only dependencies:

• check (>= 0.11): for tests
• librvsg-bin: PNG icons
• Sphinx: manpages and HTML documentation
• doxygen: HTML documentation
• breathe: for HTML documentation
• sphinx_rtd_theme: for HTML documentation

Note that Sphinx is needed to build the manpages. If it is not installed, the man pages won't be built. For building the HTML documentation, doxygen, breathe and sphinx_rtd_theme are needed in addition to Sphinx.

If you don't want to build with support for sqlite databases, you can configure the build system with -Dsqlite=disabled and sqlite support won't be available.

The use of magic to detect mime types is optional and can be disabled by configuring the build system with -Dmagic=disabled.

The use of libseccomp to create a sandboxed environment is optional and can be disabled by configure the build system with -Dseccomp=disabled. The sandbox will by default be set to "normal" mode, which should not interfere with the normal operation of zathura. For strict sandbox mode set sandbox strict in zathurarc. Strict sandbox mode will reduce the available functionality of zathura and provide a read only document viewer.

Installation

To build and install zathura using meson's ninja backend:

meson build
cd build
ninja
ninja install

Note that the default backend for meson might vary based on the platform. Please refer to the meson documentation for platform specific dependencies.

Bugs

Please report bugs at http://git.pwmt.org/pwmt/zathura.