README 1.44 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 15
python-docutils (optional, for man pages)
libmagic from file(1) (optional, for mime-type detection)
Moritz Lipp's avatar
Moritz Lipp committed
16

Moritz Lipp's avatar
Moritz Lipp committed
17 18 19 20
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
21

Sebastian Ramacher's avatar
Sebastian Ramacher committed
22 23 24 25
And also note that rst2man from python-docutils is needed to build the man pages.
If it is not installed, the man pages won't be built.

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

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

Moritz Lipp's avatar
Moritz Lipp committed
31 32
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.
33

Moritz Lipp's avatar
Moritz Lipp committed
34 35
Installation
------------
36
To build and install zathura:
Moritz Lipp's avatar
Moritz Lipp committed
37 38 39

  make install

40 41
Uninstall
---------
Moritz Lipp's avatar
Moritz Lipp committed
42 43 44
To delete zathura from your system, just type:

  make uninstall
45 46 47 48 49

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