Document viewer
Go to file
Moritz Lipp 88cdc850af Add CI
2020-01-05 14:21:51 +01:00
data Fix option name typo in zsh completion 2019-12-22 22:53:20 +01:00
doc reformat the rest pages used to create man pages 2019-11-26 15:49:09 +05:30
po Update translations 2019-09-06 22:50:37 +02:00
subprojects Add CI 2020-01-05 14:21:51 +01:00
tests Use SPDX license identifiers 2018-11-27 23:10:18 +01:00
zathura Implement document hash support for plain backend (fixes pwmt/zathura#86) 2019-12-01 17:37:18 +01:00
.gitignore Add CI 2020-01-05 14:21:51 +01:00
.gitlab-ci.yml Add CI 2020-01-05 14:21:51 +01:00
AUTHORS Acknowledge Jeremie Knuesel 2018-03-18 22:09:20 +01:00
LICENSE Update copyright year 2019-01-20 17:36:10 +01:00
meson_options.txt Allow to disable icon conversion 2018-12-09 23:25:55 +01:00
meson.build Add CI 2020-01-05 14:21:51 +01:00
README Remove support for old libsynctex 2019-03-03 18:33:23 +01:00

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.3.2)

The following dependencies are optional:

* sqlite3 (>= 3.6.23): splite3 database backend
* libmagic from file(1): for mime-type detection
* libsynctex from TeXLive (>= 1.19): SyncTeX support
* libseccomp: sandbox support

For building zathura, the following dependencies are also required:

* meson (>= 0.47)
* gettext

The following dependencies are optional build-time only dependencies:

* check: 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 seccomp 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.