Code

gtk-tpdfv.h: Documented behavior of navigation functions.
[tpdfview.git] / README
1 tpdfview
2 ========
4   tpdfview (tiny PDF viewer, or tokkee's PDF viewer, choose whatever you like
5   best) displays PDF files. It was developed with presentations and
6   accompanying material in mind.
8   This is free and open source software, licensed under the 2-clause BSD
9   license. See COPYING for details.
11 Prerequisites
12 -------------
14   To compile the tpdfview package from source you need:
16   * A build environment: autotools, libtool, C compiler, ...
18   * A POSIX + Single UNIX Specification compatible C library.
20   * libcairo:
21     The 2D vector graphics library is used for the actual drawing of the PDF
22     on screen.
24   * libgtk-2.0:
25     The cross-plattform GIMP Toolkit (GTK+) is used to create the graphical
26     user interface.
28   * libpoppler-glib:
29     The (GLib-based) PDF rendering library is used for handling the PDF files.
31 Configuring / Compiling / Installing
32 ------------------------------------
34   To configure, build and install tpdfview with the default settings, run
35   `./configure && make && make install'. For detailed, generic instructions
36   see INSTALL. For a complete list of configure options and their description,
37   run `./configure --help'.
39   By default, tpdfview will be installed into `/opt/tpdfview'. You can adjust
40   this setting by specifying the `--prefix' configure option - see INSTALL for
41   details. If you pass DESTDIR=<path> to `make install', <path> will be
42   prefixed to all installation directories. This might be useful when creating
43   packages for tpdfview.
45 Author
46 ------
48   Sebastian "tokkee" Harl <sh@tokkee.org>