Show shortcut keys in pop-up menus
[geeqie.git] / web / installing.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd" >
2 <html>
3   <head>
4     <meta name="generator" content="HTML Tidy for HTML5 for Linux version 5.2.0" />
5     <title>Installing Geeqie</title>
6   </head>
7   <body>
8     <div id="downloading">
9       <h2>Downloading</h2>
10       <p>Geeqie is available as a package with some distributions.</p>
11       <p>
12         The source tar of the latest formal release may be downloaded:
13         <a href="http://geeqie.org/geeqie-1.3.tar.xz">http://geeqie.org/geeqie-1.3.tar.xz</a>
14       </p>
15       <p>However Geeqie is stable, and you may download the latest version (if you have installed git) from here:</p>
16       <p>
17         Either:
18         <code>git clone git://www.geeqie.org/geeqie.git</code>
19       </p>
20       <p>
21         Or:
22         <code>git clone http://www.geeqie.org/git/geeqie.git</code>
23       </p>
24       <h2>Installation</h2>
25       <p>
26         List compile options:
27         <code>./autogen.sh --help</code>
28       </p>
29       <p>
30         Common options:
31         <code>./autogen.sh --disable-gtk3</code>
32         ,
33       </p>
34       <p>
35         Compilation:
36         <code>./autogen.sh [options]; make -j&lt;no. of cpu cores&gt;</code>
37       </p>
38       <p>
39         Install:
40         <code>[sudo] make install</code>
41       </p>
42       <p>
43         Removal:
44         <code>[sudo] make uninstall</code>
45       </p>
46       <h4>Note:</h4>
47       <p>The zip and gzip files at geeqie.org and GitHub contain only the sources - they cannot, by themselves, be used to install Geeqie.</p>
48       <p>
49         It is recommended to always use
50         <code>git clone  git://www.geeqie.org/geeqie.git</code>
51         to download Geeqie. After installing Geeqie you may delete the folder you have cloned Geeqie into.
52       </p>
53       <p>However if you leave the folder intact, whenever new features or patches are available, execute:</p>
54       <p>
55         <code>git pull; sudo make uninstall; sudo make maintainer-clean; ./autogen.sh; make -j&lt;no. of cpu cores&gt;; sudo make install</code>
56       </p>
57       <p>Only the changed sources are downloaded, which makes this a quick operation.</p>
58       <p>Your configuration file, history file and desktop files are not affected by this process.</p>
59       <h2>Notes and changes for the latest release</h2>
60       <p>
61         See the NEWS file in the installation folder, or
62         <a href="https://github.com/BestImageViewer/geeqie/blob/master/NEWS">Geeqie News at GitHub</a>
63       </p>
64       <p>
65         And either the ChangeLog file or
66         <a href="http://geeqie.org/cgi-bin/gitweb.cgi?p=geeqie.git;a=shortlog">Geeqie ChangeLog</a>
67       </p>
68       <h2>Requirements</h2>
69       <h3>Required libraries:</h3>
70       <pre>
71         <code>
72           GTK+ 3.00
73           www.gtk.org
74           enabled by default
75           disable with configure option: --disable-gtk3
76           or
77           GTK+ 2.20
78           disabled by default when GTK+3 libraries are found.
79           enable with configure option: --disable-gtk3
80           optional items map display and GPU acceleration are not available
81           with GTK2
82           
83           Note: GTK+3 is still somehow experimental. It is needed for some
84           features but we have several complains about the GTK+3 usability.
85           
86           So if you need a stable version, you are advised to compile it
87           with GTK+2. If you want to play with the cool new features, use
88           GTK+3.
89         </code>
90       </pre>
91       <h3>Optional libraries:</h3>
92       <pre>
93         <code>
94           lcms2 2.0
95           or
96           lcms 1.14
97           www.littlecms.com
98           for color management support
99           enabled by default
100           disable with configure option: --disable-lcms
101           
102           exiv2 0.11
103           www.exiv2.org
104           for enhanced exif support
105           enabled by default
106           disable with configure option: --disable-exiv2
107           
108           lirc
109           www.lirc.org
110           for remote control support
111           enabled by default
112           disable with configure option: --disable-lirc
113           
114           libchamplain-gtk 0.12
115           libchamplain 0.12
116           libclutter 1.0
117           wiki.gnome.org/Projects/libchamplain
118           for map display
119           enabled by default
120           disable with configure option: --disable-map
121           
122           libclutter 1.0
123           www.clutter-project.org
124           for GPU acceleration (a check-box on Preferences/Image must also be ticked)
125           enabled by default
126           disable with configure option: --disable-gpu-accel
127           explicitly disabling will also disable the map feature
128           
129           lua 5.1
130           www.lua.org
131           support for lua scripting
132           enabled by default
133           disable with configure option: --disable-lua
134
135           librsvg2-common
136           for displaying .svg images
137
138           libwmf0.2-7-gtk
139           for displaying .wmf images
140
141           (see also "Additional pixbuf loaders" in the References section of the Help file)
142
143           awk
144           when running Geeqie, to use the geo-decode function
145           
146           markdown
147           when compiling Geeqie, to create this file in html format
148
149          libffmpegthumbnailer 2.1.0
150          for thumbnailing camera video clips
151          enabled by default
152          disable with configure option: --disable-libffmpegthumbnailer
153         </code>
154       </pre>
155     </div>
156   </body>
157 </html>