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