README 1.99 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

10
meson (>= 0.47)
Jeremie Knuesel's avatar
Jeremie Knuesel committed
11
gtk3 (>= 3.22)
12
glib (>= 2.50)
13
girara (>= 0.2.8)
14
sqlite3 (optional, >= 3.5.9)
15
check (optional, for tests)
Sebastian Ramacher's avatar
Sebastian Ramacher committed
16
intltool
17
libmagic from file(1) (optional, for mime-type detection)
Sebastian Ramacher's avatar
Sebastian Ramacher committed
18
libsynctex from TeXLive (optional, for SyncTeX support)
valoq's avatar
valoq committed
19
libseccomp (optional, for sandbox support)
Sebastian Ramacher's avatar
Sebastian Ramacher committed
20 21 22 23
Sphinx (optional, for manpages and HTML documentation)
doxygen (optional, for HTML documentation)
breathe (optional, for HTML documentation)
sphinx_rtd_theme (optional, for HTML documentation)
Moritz Lipp's avatar
Moritz Lipp committed
24

25
Note that Sphinx is needed to build the manpages.  If it is not installed, the
26 27
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
28

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

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

35
The use of seccomp to create a sandboxed environment is optional and can be
36
disabled by configure the build system with -Dseccomp=disabled. The sandbox
37 38 39 40
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
41

Moritz Lipp's avatar
Moritz Lipp committed
42 43 44
Installation
------------

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

47 48 49 50
  meson build
  cd build
  ninja
  ninja install
51

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

55 56
Bugs
----
57

58 59
Please report bugs at http://bugs.pwmt.org or contact us on our mailing list at
zathura@lists.pwmt.org.