README 1.78 KB
Newer Older
1
zathura - a document viewer
Moritz Lipp's avatar
Moritz Lipp committed
2
===========================
3 4
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
5 6 7

Requirements
------------
Sebastian Ramacher's avatar
Sebastian Ramacher committed
8
gtk3
9
glib (>= 2.28)
Sebastian Ramacher's avatar
Sebastian Ramacher committed
10
girara (>= 0.1.8)
11
sqlite3 (optional, >= 3.5.9)
12
check (for tests)
Sebastian Ramacher's avatar
Sebastian Ramacher committed
13
intltool
14
libmagic from file(1) (optional, for mime-type detection)
Sebastian Ramacher's avatar
Sebastian Ramacher committed
15 16 17 18
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
19

Moritz Lipp's avatar
Moritz Lipp committed
20 21 22 23
Please note that you need to have a working pkg-config installation and that the
Makefile is only compatible with GNU make. If you don't have a working
pkg-config installation please set the GTK_INC, GTK_LIB, GIRARA_INC, GIRARA_LIB,
SQLITE_INC and SQLITE_LIB variables accordingly.
Sebastian Ramacher's avatar
Sebastian Ramacher committed
24

Sebastian Ramacher's avatar
Sebastian Ramacher committed
25 26 27
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,
breathe and sphinx_rtd_theme are needed in additioan 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 set
30
WITH_SQLITE=0 and sqlite support won't be available.
31

Moritz Lipp's avatar
Moritz Lipp committed
32
The use of magic to detect mime types is optional and can be disabled by setting
Sebastian Ramacher's avatar
Sebastian Ramacher committed
33 34
WITH_MAGIC=0.

Moritz Lipp's avatar
Moritz Lipp committed
35 36
If you pass these flags as a command line argument to make, you have to ensure
to pass the same flags when executing the install target.
37

Moritz Lipp's avatar
Moritz Lipp committed
38 39 40
If you want to build zathuras documentation, please install all python
dependencies from the ./doc/requirements.txt file.

Moritz Lipp's avatar
Moritz Lipp committed
41 42
Installation
------------
43
To build and install zathura:
Moritz Lipp's avatar
Moritz Lipp committed
44 45 46

  make install

47 48
Uninstall
---------
Moritz Lipp's avatar
Moritz Lipp committed
49 50 51
To delete zathura from your system, just type:

  make uninstall
52 53 54 55 56

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