README 1.84 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
------------
8
gtk3 (>= 3.6)
9
glib (>= 2.49.6)
10
girara (>= 0.2.7)
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
libsynctex from TeXLive (optional, for SyncTeX support)
Sebastian Ramacher's avatar
Sebastian Ramacher committed
16 17 18 19
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
20

Moritz Lipp's avatar
Moritz Lipp committed
21 22 23 24
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
25

Sebastian Ramacher's avatar
Sebastian Ramacher committed
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,
Sebastian Ramacher's avatar
Sebastian Ramacher committed
28
breathe and sphinx_rtd_theme are needed in addition to Sphinx.
Sebastian Ramacher's avatar
Sebastian Ramacher committed
29 30

If you don't want to build with support for sqlite databases, you can set
31
WITH_SQLITE=0 and sqlite support won't be available.
32

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

Moritz Lipp's avatar
Moritz Lipp committed
36 37
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.
38

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

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

  make install

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

  make uninstall
53 54 55 56 57

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