summaryrefslogtreecommitdiff
path: root/README
blob: e5ebd5e443787d2cd1a6ea6f525addc981beea63 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
feh - Imlib2 based image viewer
-------------------------------

 * <http://feh.finalrewind.org/>
 * <http://linuxbrit.co.uk/feh/>
 * #feh on irc.oftc.net

Dependencies
------------

 * giblib
 * Imlib2
 * libcurl (disable with make curl=0)
 * libpng
 * libX11
 * libXinerama (disable with make xinerama=0)

Recommended
-----------

 * jpegtran  (supplied by the jpeg library, for lossless image rotation)

Installation
------------

$ make
$ sudo make install

ZSH Completion for feh is available at
<http://git.finalrewind.org/zsh/plain/etc/completions/_feh>

Make flags
----------

Use "make flag=bool", e.g. "make xinerama=0 debug=1" to disable Xinerama
support and get a debug build.

Available flags are:

 * curl     (default 1) - use libcurl to view http:// and similar images
 * debug    (default 0) - debug build, enables --debug
 * help     (default 0) - include help text (refers to the manpage otherwise)
 * xinerama (default 1) - Support Xinerama multiscreen setups

So, by default libcurl and Xinerama are enabled, while debug is disabled.

Note: config.mk is designed so that in most cases, you can set environment
variables instead of editing it. E.g.:
CFLAGS='-g -Os' make
export DESTDIR=/tmp/feh PREFIX=/usr; make && make install


Testing (non-X)
---------------

$ make test

Requires perl >= 5.10 with Test::Command. The tests are non-interactive and
work without X, so they can safely be run even on a headless buildserver.


Testing (X)
-----------

Requires
 * import (usually supplied by imagemagick)
 * perl >= 5.10 with GD, Test::More and X11::GUITest
 * twm
 * Xnest

$ make test-x11

Be aware that this is quite experimental, so far the X-tests have only been
run on one machine. So they may or may not work for you.