README 1.47 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
meson (>= 0.45)
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)
Sebastian Ramacher's avatar
Sebastian Ramacher committed
19 20 21 22
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
23

Sebastian Ramacher's avatar
Sebastian Ramacher committed
24 25
Also note that Sphinx is needed to build the manpages.  If it is not
installed, the man pages won't be built. For the HTML documentation, doxygen,
Sebastian Ramacher's avatar
Sebastian Ramacher committed
26
breathe and sphinx_rtd_theme are needed in addition to Sphinx.
Sebastian Ramacher's avatar
Sebastian Ramacher committed
27 28

If you don't want to build with support for sqlite databases, you can set
29
enable-sqlite=off and sqlite support won't be available.
30

Moritz Lipp's avatar
Moritz Lipp committed
31
The use of magic to detect mime types is optional and can be disabled by setting
32
enable-magic=off.
Moritz Lipp's avatar
Moritz Lipp committed
33

Moritz Lipp's avatar
Moritz Lipp committed
34 35 36
Installation
------------

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

39 40 41 42
  meson build
  cd build
  ninja
  ninja install
43

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

47 48
Bugs
----
49

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