Update web help file and other docs
[geeqie.git] / web / installing.html
index fc3cae3..25b8c97 100644 (file)
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-"http://www.w3.org/TR/html4/loose.dtd">
-<html>
-<head>
-    <meta name="generator" content="HTML Tidy for HTML5 for Linux version 5.2.0">
-    <title>Installing Geeqie</title>
-</head>
-<body>
-    <div id="downloading">
-        <h5>Downloading</h5>
-        <p>To download the sources from the repository, you must first have installed git.</p>
-        <p>Then either: <code>git clone git://www.geeqie.org/geeqie.git</code></p>
-        <p>Or: <code>git clone http://www.geeqie.org/git/geeqie.git</code></p>
-        <h5>Installing</h5>
-        <p>Update secondary help documents (optional - requires use of git): <code>./gen_changelog.sh ; markdown
-        README.md &gt; README.html</code></p>
-        <p>Show compile options: <code>./autogen.sh --help</code></p>
-        <p>Common options: <code>./autogen.sh --disable-gtk3</code>, <code>./autogen.sh --enable-map</code></p>
-        <p>Compilation: <code>./autogen.sh [options]; make</code></p>
-        <p>Install: <code>[sudo] make install</code></p>
-        <p>Removal: <code>[sudo] make uninstall</code></p>
-        <h5>Dependencies</h5>
-        <pre><code>GTK+ 3.00
-    www.gtk.org
-    enabled by default
-    disable with configure option: --disable-gtk3
-or
-GTK+ 2.20
-    disabled by default when GTK+3 libraries are found.
-    enable with configure option: --disable-gtk3
-    optional items map display and GPU acceleration are not available
-    with GTK2
-
-</code></pre>
-        <h5>Optional libraries:</h5>
-        <pre><code>lcms2 2.0
-or
-lcms 1.14
-    www.littlecms.com
-    for color management support
-    enabled by default
-    disable with configure option: --disable-lcms
-
-exiv2 0.11
-    www.exiv2.org
-    for enhanced exif support
-    enabled by default
-    disable with configure option: --disable-exiv2
-
-lirc
-    www.lirc.org
-    for remote control support
-    enabled by default
-    disable with configure option: --disable-lirc
-
-libchamplain-gtk 0.12
-libchamplain 0.12
-libclutter 1.0
-    wiki.gnome.org/Projects/libchamplain
-    for map display
-    disabled by default
-    enable with configure option: --enable-map
-    enabling will also enable GPU acceleration
-
-libclutter 1.0
-    www.clutter-project.org
-    for GPU acceleration (a check-box on Preferences/Image must also be ticked)
-    disabled by default
-    enable with configure option: --enable-gpu-accel
-    explicitly disabling will also disable the map feature
-
-lua 5.1
-    www.lua.org
-    support for lua scripting
-    enabled by default
-    disable with configure option: --disable-lua
-
-awk
-    when running Geeqie, to use the geo-decode function
-
-markdown
-    when compiling Geeqie, to create the README file in html format
-</code></pre>
-    </div>
-</body>
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd" >\r
+<html>\r
+  <head>\r
+    <meta name="generator" content="HTML Tidy for HTML5 for Linux version 5.2.0" />\r
+    <title>Installing Geeqie</title>\r
+  </head>\r
+  <body>\r
+    <div id="downloading">\r
+      <h2>Downloading</h2>\r
+      <p>Geeqie is available as a package with some distributions.</p>\r
+      <p>\r
+        The source tar of the latest formal release may be downloaded:\r
+        <a href="http://geeqie.org/geeqie-1.3.tar.xz">http://geeqie.org/geeqie-1.3.tar.xz</a>\r
+      </p>\r
+      <p>However Geeqie is stable, and you may download the latest version (if you have installed git) from here:</p>\r
+      <p>\r
+        Either:\r
+        <code>git clone git://www.geeqie.org/geeqie.git</code>\r
+      </p>\r
+      <p>\r
+        Or:\r
+        <code>git clone http://www.geeqie.org/git/geeqie.git</code>\r
+      </p>\r
+      <h2>Installation</h2>\r
+      <p>\r
+        List compile options:\r
+        <code>./autogen.sh --help</code>\r
+      </p>\r
+      <p>\r
+        Common options:\r
+        <code>./autogen.sh --disable-gtk3</code>\r
+        ,\r
+      </p>\r
+      <p>\r
+        Compilation:\r
+        <code>./autogen.sh [options]; make -j&lt;no. of cpu cores&gt;</code>\r
+      </p>\r
+      <p>\r
+        Install:\r
+        <code>[sudo] make install</code>\r
+      </p>\r
+      <p>\r
+        Removal:\r
+        <code>[sudo] make uninstall</code>\r
+      </p>\r
+      <h4>Note:</h4>\r
+      <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
+      <p>\r
+        It is recommended to always use\r
+        <code>git clone  git://www.geeqie.org/geeqie.git</code>\r
+        to download Geeqie. After installing Geeqie you may delete the folder you have cloned Geeqie into.\r
+      </p>\r
+      <p>However if you leave the folder intact, whenever new features or patches are available, execute:</p>\r
+      <p>\r
+        <code>git pull; sudo make uninstall; sudo make distclean; ./autogen.sh; make -j&lt;no. of cpu cores&gt;; sudo make install</code>\r
+      </p>\r
+      <p>Only the changed sources are downloaded, which makes this a quick operation.</p>\r
+      <p>Your configuration file, history file and desktop files are not affected by this process.</p>\r
+      <h2>Notes and changes for the latest release</h2>\r
+      <p>\r
+        See the NEWS file in the installation folder, or\r
+        <a href="https://github.com/BestImageViewer/geeqie/blob/master/NEWS">Geeqie News at GitHub</a>\r
+      </p>\r
+      <p>\r
+        And either the ChangeLog file or\r
+        <a href="http://geeqie.org/cgi-bin/gitweb.cgi?p=geeqie.git;a=shortlog">Geeqie ChangeLog</a>\r
+      </p>\r
+      <h2>Requirements</h2>\r
+      <h3>Required libraries:</h3>\r
+      <pre>\r
+        <code>\r
+          GTK+ 3.00\r
+          www.gtk.org\r
+          enabled by default\r
+          disable with configure option: --disable-gtk3\r
+          or\r
+          GTK+ 2.20\r
+          disabled by default when GTK+3 libraries are found.\r
+          enable with configure option: --disable-gtk3\r
+          optional items map display and GPU acceleration are not available\r
+          with GTK2\r
+          \r
+          Note: GTK+3 is still somehow experimental. It is needed for some\r
+          features but we have several complains about the GTK+3 usability.\r
+          \r
+          So if you need a stable version, you are advised to compile it\r
+          with GTK+2. If you want to play with the cool new features, use\r
+          GTK+3.\r
+        </code>\r
+      </pre>\r
+      <h3>Optional libraries:</h3>\r
+      <pre>\r
+        <code>\r
+          lcms2 2.0\r
+          or\r
+          lcms 1.14\r
+          www.littlecms.com\r
+          for color management support\r
+          enabled by default\r
+          disable with configure option: --disable-lcms\r
+          \r
+          exiv2 0.11\r
+          www.exiv2.org\r
+          for enhanced exif support\r
+          enabled by default\r
+          disable with configure option: --disable-exiv2\r
+          \r
+          lirc\r
+          www.lirc.org\r
+          for remote control support\r
+          enabled by default\r
+          disable with configure option: --disable-lirc\r
+          \r
+          libchamplain-gtk 0.12\r
+          libchamplain 0.12\r
+          libclutter 1.0\r
+          wiki.gnome.org/Projects/libchamplain\r
+          for map display\r
+          enabled by default\r
+          disable with configure option: --disable-map\r
+          \r
+          libclutter 1.0\r
+          www.clutter-project.org\r
+          for GPU acceleration (a check-box on Preferences/Image must also be ticked)\r
+          enabled by default\r
+          disable with configure option: --disable-gpu-accel\r
+          explicitly disabling will also disable the map feature\r
+          \r
+          lua 5.1\r
+          www.lua.org\r
+          support for lua scripting\r
+          enabled by default\r
+          disable with configure option: --disable-lua\r
+          \r
+          awk\r
+          when running Geeqie, to use the geo-decode function\r
+          \r
+          markdown\r
+          when compiling Geeqie, to create this file in html format\r
+        </code>\r
+      </pre>\r
+    </div>\r
+  </body>\r
 </html>