Document viewer
Go to file
Sebastian Ramacher 93edb66fef Some documentation
Signed-off-by: Sebastian Ramacher <sebastian+dev@ramacher.at>
2014-10-21 21:20:29 +02:00
data Add SynctaxView method 2014-10-21 20:57:12 +02:00
doc Update documentation 2014-09-30 19:48:51 +02:00
po Run update-po 2014-10-08 15:39:45 +02:00
synctex Update synctex_parser copy 2014-09-29 14:22:47 +02:00
tests Also use system synctex in tests if possible 2014-06-30 13:55:53 +02:00
.gitignore add zathura-*.tar.gz 2014-04-27 17:09:06 +02:00
adjustment.c Bound returned page by number of pages - 1 2014-06-23 21:14:14 +02:00
adjustment.h Remove unused zathura_adjustment_clone 2014-01-20 18:06:38 +01:00
AUTHORS Update AUTHORS 2014-08-20 23:55:28 +02:00
bookmarks.c Replace glib memory functions with try version 2014-01-19 16:47:08 +01:00
bookmarks.h Bookmark the exact position, not just the page number (along with a number of fixes). 2013-06-21 09:45:36 +02:00
callbacks.c Add option to ignore images while recoloring 2014-09-30 19:45:07 +02:00
callbacks.h Add option to ignore images while recoloring 2014-09-30 19:45:07 +02:00
colors.mk Add colored GCC output 2014-06-26 09:16:16 +02:00
commands.c Add vim style exec 2014-09-27 01:37:31 +02:00
commands.h Implement cmd_exec with 2012-08-14 11:45:11 +02:00
common.mk add verbose build output 2011-08-31 16:04:55 +02:00
completion.c Update style 2012-10-09 01:12:18 +02:00
completion.h Add completion for :write (Closes: #138) 2012-03-20 00:54:12 +01:00
config.c Add option to ignore images while recoloring 2014-09-30 19:45:07 +02:00
config.h Move config file loading to config.c 2014-01-06 16:02:58 +01:00
config.mk Version 0.3.0 2014-10-16 23:58:12 +02:00
content-type.c Use _DEFAULT_SOURCE instead of deprecated _BSD_SOURCE 2014-10-16 23:56:41 +02:00
content-type.h Documentation 2014-08-15 17:06:21 +02:00
css-definitions.h Style index mode with CSS 2014-04-26 23:32:38 +02:00
database-plain.c GObject references should be unref'd in dispose 2014-01-19 21:03:40 +01:00
database-plain.h Implement support to use both database backends. 2012-03-04 15:56:54 +01:00
database-sqlite.c Remove unnecessary check 2014-09-07 19:12:16 +02:00
database-sqlite.h Update typo in function description 2012-03-14 08:15:23 +01:00
database.c Make the jumplist persistent on a per-file basis 2013-06-29 11:35:29 +02:00
database.h Make the jumplist persistent on a per-file basis 2013-06-29 11:35:29 +02:00
dbus-interface-definitions.h Add a header for D-Bus interface definitions 2014-01-15 17:55:54 +01:00
dbus-interface.c Use SynctexView for --synctex-forward 2014-10-21 21:12:23 +02:00
dbus-interface.h Some documentation 2014-10-21 21:20:29 +02:00
document.c Prevent double-free in zathura_document_free 2014-09-09 17:28:10 +02:00
document.h Document return value if an error occurs 2013-11-04 15:38:13 +01:00
glib-compat.h Move the deprecated stuff to the end 2014-01-05 21:54:23 +01:00
internal.h Improve zathura_link_t 2012-05-28 12:43:22 +02:00
LICENSE Update copyright years 2014-01-01 16:49:34 +01:00
links.c Replace glib memory functions with try version 2014-01-19 16:47:08 +01:00
links.h Add new shortcut function to display links 2012-12-07 18:05:59 +01:00
macros.h Mark zathura->global.page_padding as deprecated. 2012-03-16 15:56:37 +01:00
main.c Adjust for different indices in SyncTex 2014-10-21 21:17:59 +02:00
Makefile Add AppData file 2014-09-29 14:44:12 +02:00
marks.c Fix a return 2014-01-20 00:55:39 +01:00
marks.h Implemented marks 2012-04-21 04:59:58 +02:00
page-widget.c Move synctex logic away from ZathuraPage 2014-08-22 20:42:33 +02:00
page-widget.h Move synctex logic away from ZathuraPage 2014-08-22 20:42:33 +02:00
page.c Replace glib memory functions with try version 2014-01-19 16:47:08 +01:00
page.h There is no need to include zathura.h anymore. 2012-04-03 18:39:00 +02:00
plugin-api.h Hide plugin structure and introduce new functions 2012-06-13 16:08:24 +02:00
plugin.c Check if plugin file ends with .so 2014-09-05 09:21:07 +02:00
plugin.h Hide plugin structure and introduce new functions 2012-06-13 16:08:24 +02:00
print.c CS 2014-01-31 10:33:25 +01:00
print.h Remove unnecessary include. 2012-06-08 18:10:54 +02:00
README Version 0.2.8 2014-06-24 22:31:37 +02:00
render.c Add option to ignore images while recoloring 2014-09-30 19:45:07 +02:00
render.h Add option to ignore images while recoloring 2014-09-30 19:45:07 +02:00
shortcuts.c Pass actual event instead of NULL pointer to sc_scroll 2014-10-21 18:03:24 +02:00
shortcuts.h Replace fullscreen mode with presentation mode 2013-11-25 23:10:35 +01:00
synctex.c Adjust for different indices in SyncTex 2014-10-21 21:17:59 +02:00
synctex.h Add synctex_get_input_line_column 2014-08-22 20:09:18 +02:00
types.c Replace glib memory functions with try version 2014-01-19 16:47:08 +01:00
types.h Finish renaming 2014-01-12 22:23:29 +01:00
utils.c Remove replace_substring 2014-04-11 14:48:04 +02:00
utils.h Remove replace_substring 2014-04-11 14:48:04 +02:00
version.h.in Fix version.h misspelling 2012-05-28 10:08:03 +02:00
zathura.c Use _DEFAULT_SOURCE instead of deprecated _BSD_SOURCE 2014-10-16 23:56:41 +02:00
zathura.desktop Add Lithuanian translation 2014-02-17 12:10:23 +01:00
zathura.h Replace deprecatec GtkAlignment 2014-09-27 02:07:53 +02:00
zathura.pc.in Don't need to depend on GTK+ anymore. 2012-04-06 13:46:35 +02:00

zathura - a document viewer
===========================
zathura is a highly customizable and functional document viewer based on the
girara user interface library and several document libraries.

Requirements
------------
gtk3
glib (>= 2.28)
girara (>= 0.2.0)
sqlite3 (optional, >= 3.5.9)
check (for tests)
intltool
libmagic from file(1) (optional, for mime-type detection)
Sphinx (optional, for manpages and HTML documentation)
doxygen (optional, for HTML documentation)
breathe (optional, for HTML documentation)
sphinx_rtd_theme (optional, for HTML documentation)

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.

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.

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

The use of magic to detect mime types is optional and can be disabled by setting
WITH_MAGIC=0.

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.

If you want to build zathuras documentation, please install all python
dependencies from the ./doc/requirements.txt file.

Installation
------------
To build and install zathura:

  make install

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

  make uninstall

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