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
------------
Moritz Lipp's avatar
Moritz Lipp committed
8
gtk2 (>= 2.28)
9
girara
10
sqlite3 (optional, >= 3.5.9)
11
check (for tests)
Sebastian Ramacher's avatar
Sebastian Ramacher committed
12
intltool
13 14
python-docutils (optional, for man pages)
libmagic from file(1) (optional, for mime-type detection)
Moritz Lipp's avatar
Moritz Lipp committed
15

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

Sebastian Ramacher's avatar
Sebastian Ramacher committed
21 22 23 24
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
Sebastian Ramacher's avatar
Sebastian Ramacher committed
25
WITH_SQLITE=0 and sqlite support won't be available. Please note that sqlite3
Moritz Lipp's avatar
Moritz Lipp committed
26
with meta data support is required, i.e. sqlite3 has to be built with
Sebastian Ramacher's avatar
Sebastian Ramacher committed
27
SQLITE_ENABLE_COLUMN_METADATA defined.
28

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

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

Moritz Lipp's avatar
Moritz Lipp committed
35 36
Installation
------------
37
To build and install zathura:
Moritz Lipp's avatar
Moritz Lipp committed
38 39 40 41 42 43 44 45

  make install

Uninstall:
----------
To delete zathura from your system, just type:

  make uninstall