README 2.14 KB
Newer Older
1
zathura - a document viewer
Moritz Lipp's avatar
Moritz Lipp committed
2
===========================
3

4 5
zathura is a highly customizable and functional document viewer based on the
girara user interface library and several document libraries.
Moritz Lipp's avatar
Moritz Lipp committed
6 7 8

Requirements
------------
9

Sebastian Ramacher's avatar
Sebastian Ramacher committed
10 11 12 13 14 15 16 17
The following dependencies are required:

* gtk3 (>= 3.22)
* glib (>= 2.50)
* girara (>= 0.3.2)

The following dependencies are optional:

18
* sqlite3 (>= 3.6.23): splite3 database backend
Sebastian Ramacher's avatar
Sebastian Ramacher committed
19
* libmagic from file(1): for mime-type detection
20
* libsynctex from TeXLive (>= 1.19): SyncTeX support
Sebastian Ramacher's avatar
Sebastian Ramacher committed
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
* 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
Moritz Lipp's avatar
Moritz Lipp committed
36

37
Note that Sphinx is needed to build the manpages.  If it is not installed, the
38 39
man pages won't be built. For building the HTML documentation, doxygen, breathe
and sphinx_rtd_theme are needed in addition to Sphinx.
Sebastian Ramacher's avatar
Sebastian Ramacher committed
40

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

44
The use of magic to detect mime types is optional and can be disabled by
45
configuring the build system with -Dmagic=disabled.
Moritz Lipp's avatar
Moritz Lipp committed
46

47
The use of seccomp to create a sandboxed environment is optional and can be
48
disabled by configure the build system with -Dseccomp=disabled. The sandbox
49 50 51 52
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.
Moritz Lipp's avatar
Moritz Lipp committed
53

Moritz Lipp's avatar
Moritz Lipp committed
54 55 56
Installation
------------

57
To build and install zathura using meson's ninja backend:
Moritz Lipp's avatar
Moritz Lipp committed
58

59 60 61 62
  meson build
  cd build
  ninja
  ninja install
63

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

67 68
Bugs
----
69

Sebastian Ramacher's avatar
Sebastian Ramacher committed
70
Please report bugs at http://git.pwmt.org/pwmt/zathura.