zathura/README

71 lines
2.1 KiB
Plaintext
Raw Normal View History

2011-04-26 17:09:39 +02:00
zathura - a document viewer
2012-09-10 00:18:57 +02:00
===========================
2011-04-26 17:09:39 +02:00
zathura is a highly customizable and functional document viewer based on the
girara user interface library and several document libraries.
2009-08-11 23:18:50 +02:00
Requirements
------------
2018-12-23 12:59:58 +01:00
The following dependencies are required:
* gtk3 (>= 3.22)
* glib (>= 2.50)
* girara (>= 0.3.2)
The following dependencies are optional:
2019-01-20 20:12:36 +01:00
* sqlite3 (>= 3.6.23): splite3 database backend
2018-12-23 12:59:58 +01:00
* libmagic from file(1): for mime-type detection
* libsynctex from TeXLive (>= 1.19): SyncTeX support
2018-12-23 12:59:58 +01:00
* libseccomp: sandbox support
For building zathura, the following dependencies are also required:
* meson (>= 0.47)
* gettext
The following dependencies are optional build-time only dependencies:
* check: for tests
* librvsg-bin: PNG icons
* Sphinx: manpages and HTML documentation
* doxygen: HTML documentation
* breathe: for HTML documentation
* sphinx_rtd_theme: for HTML documentation
2009-08-11 23:18:50 +02:00
2018-03-12 13:39:39 +01:00
Note that Sphinx is needed to build the manpages. If it is not installed, the
2018-11-27 20:55:16 +01:00
man pages won't be built. For building the HTML documentation, doxygen, breathe
and sphinx_rtd_theme are needed in addition to Sphinx.
2012-03-04 18:54:52 +01:00
2018-03-12 13:39:39 +01:00
If you don't want to build with support for sqlite databases, you can configure
2018-11-27 20:55:16 +01:00
the build system with -Dsqlite=disabled and sqlite support won't be available.
2018-03-12 13:39:39 +01:00
The use of magic to detect mime types is optional and can be disabled by
2018-11-27 20:55:16 +01:00
configuring the build system with -Dmagic=disabled.
2014-04-08 19:56:31 +02:00
The use of seccomp to create a sandboxed environment is optional and can be
2018-11-27 20:55:16 +01:00
disabled by configure the build system with -Dseccomp=disabled. The sandbox
2018-08-24 16:08:58 +02:00
will by default be set to "normal" mode, which should not interfere with the
normal operation of zathura. For strict sandbox mode set "sandbox strict" in
zathurarc. Strict sandbox mode will reduce the available functionality of
zathura and provide a read only document viewer.
2014-04-08 19:56:31 +02:00
2009-08-11 23:18:50 +02:00
Installation
------------
To build and install zathura using meson's ninja backend:
2009-08-11 23:18:50 +02:00
meson build
cd build
ninja
ninja install
Note that the default backend for meson might vary based on the platform. Please
refer to the meson documentation for platform specific dependencies.
Bugs
----
2018-11-27 20:55:16 +01:00
Please report bugs at http://git.pwmt.org/pwmt/zathura.