Configuration options and documentation
authorColin Clark <cclark@mcb.net>
Tue, 24 May 2016 13:22:28 +0000 (14:22 +0100)
committerColin Clark <cclark@mcb.net>
Tue, 24 May 2016 13:22:28 +0000 (14:22 +0100)
Configuration option changes:
--enable-gps is now --enable-map
--enable-clutter is now --enable-gpu-accel

If --disable-gtk3 is issued, both map and gpu-accel options are also
disabled.

--enable-map is the only option required to compile in the map.

README updated accordingly.

README
configure.in
doc/docbook/GuideOptionsImage.xml

diff --git a/README b/README
index 9395d66..7c89f15 100644 (file)
--- a/README
+++ b/README
@@ -49,21 +49,59 @@ geeqie-devel@lists.sourceforge.net
 ======== Requirements
 
   Required libraries:
-    GTK+ 2.20: ftp://ftp.gtk.org/pub/gtk
+    GTK+ 3.00
+               www.gtk.org
+               enabled by default
+               disable with configure option: --disable-gtk3
+    or
+    GTK+ 2.20
+               disabled by default
+               enable with configure option: --disable-gtk3
+               optional items map display and GPU acceleration
+               are not available with GTK2
 
   Optional libraries:
-    lcms or lcms2, for color management support: http://www.littlecms.com
-        (disable with configure option: '--without-lcms')
-    exiv2, for enhanced exif support: http://www.exiv2.org/
-        (disable with configure option: '--without-exiv2')
-        - due to fast development, newer versions work significantly better
-        FIXME: minimal version ?
-    lirc, for remote control support: http://www.lirc.org/
-       (disable with configure option: '--disable-lirc')
-    libchamplain - experimental map support, dissabled by default
-        http://projects.gnome.org/libchamplain/
-        WARNING: this library has a lot of dependencise
-    lua - Support for lua scripting
+    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
 
 ======== Notes and changes for this release            [section:release_notes]
 
index b5c03ed..00842e2 100644 (file)
@@ -404,31 +404,38 @@ AC_SUBST(CPPFLAGS)
 AC_SUBST(LDFLAGS)
 
 
-#  clutter support - experimental
+#  clutter and champlain support
 # ----------------------------------------------------------------------
 
-AC_ARG_ENABLE([clutter],
-  AC_HELP_STRING([--enable-clutter], [enable clutter support - experimental]),
+AC_ARG_ENABLE([map],
+  AC_HELP_STRING([--enable-map], [enable map support]),
+    [libgps=$enableval], [libgps=no])
+
+AC_ARG_ENABLE([gpu-accel],
+  AC_HELP_STRING([--enable-gpu-accel], [enable GPU acceleration support - experimental]),
     [libclutter=$enableval], [libclutter=auto])
 
 if test "x${libclutter}" = "xyes" -o "x${libgps}" = "xyes"; then
-  PKG_CHECK_MODULES(CLUTTER, [clutter-1.0 >= 1.0],
-    [
-      PKG_CHECK_MODULES(CLUTTER_GTK, [clutter-gtk-1.0 >= 1.0],
+    if test "x${libclutter}" != "xno" -a "x${gtk3}" != "xno"; then
+      PKG_CHECK_MODULES(CLUTTER, [clutter-1.0 >= 1.0],
         [
-          HAVE_CLUTTER=yes
-          AC_DEFINE(HAVE_CLUTTER, 1, [define to enable use of clutter library])
+          PKG_CHECK_MODULES(CLUTTER_GTK, [clutter-gtk-1.0 >= 1.0],
+            [
+              HAVE_CLUTTER=yes
+              AC_DEFINE(HAVE_CLUTTER, 1, [define to enable use of clutter library])
+            ],
+            [
+              HAVE_CLUTTER=no
+              AC_MSG_WARN([$CLUTTER_GTK_PKG_ERRORS])
+            ])
         ],
         [
           HAVE_CLUTTER=no
-          AC_MSG_WARN([$CLUTTER_GTK_PKG_ERRORS])
+          AC_MSG_WARN([$CLUTTER_PKG_ERRORS])
         ])
-        
-    ],
-    [
-      HAVE_CLUTTER=no
-      AC_MSG_WARN([$CLUTTER_PKG_ERRORS])
-    ])
+    else
+      HAVE_CLUTTER=disabled
+    fi
 else
   HAVE_CLUTTER=disabled
 fi
@@ -439,23 +446,23 @@ AC_SUBST(CLUTTER_GTK_CFLAGS)
 AC_SUBST(CLUTTER_GTK_LIBS)
 
 
-#  Libchamplain support - used for GPS map facility - experimental
+#  Libchamplain support - used for map facility
 # ----------------------------------------------------------------------
 
-AC_ARG_ENABLE([gps],
-  AC_HELP_STRING([--enable-gps], [enable GPS map support - experimental]),
-    [libgps=$enableval], [libgps=yes])
-
-if test "x${libgps}" = "xyes" -a "x${HAVE_CLUTTER}" = "xyes" ; then
-  PKG_CHECK_MODULES(LIBCHAMPLAIN, [champlain-0.12 >= 0.12],
-    [
-      HAVE_LIBCHAMPLAIN=yes
-      AC_DEFINE(HAVE_LIBCHAMPLAIN, 1, [define to enable use of GPS maps])
-    ],
-    [
-      HAVE_LIBCHAMPLAIN=no
-      AC_MSG_WARN([$LIBCHAMPLAIN_PKG_ERRORS])
-    ])
+if test "x${libgps}" = "xyes" -a "x${HAVE_CLUTTER}" = "xyes"; then
+    if test "x${gtk3}" != "xno"; then
+      PKG_CHECK_MODULES(LIBCHAMPLAIN, [champlain-0.12 >= 0.12],
+        [
+          HAVE_LIBCHAMPLAIN=yes
+          AC_DEFINE(HAVE_LIBCHAMPLAIN, 1, [define to enable use of maps])
+        ],
+        [
+          HAVE_LIBCHAMPLAIN=no
+          AC_MSG_WARN([$LIBCHAMPLAIN_PKG_ERRORS])
+        ])
+    else
+      HAVE_LIBCHAMPLAIN=disabled
+    fi
 else
   HAVE_LIBCHAMPLAIN=disabled
 fi
@@ -464,7 +471,7 @@ if test "x${libgps}" = "xyes" -a "x${HAVE_LIBCHAMPLAIN}" = "xyes" ; then
   PKG_CHECK_MODULES(LIBCHAMPLAIN_GTK, [champlain-gtk-0.12 >= 0.12],
     [
       HAVE_LIBCHAMPLAIN_GTK=yes
-      AC_DEFINE(HAVE_LIBCHAMPLAIN_GTK, 1, [define to enable use of GPS maps])
+      AC_DEFINE(HAVE_LIBCHAMPLAIN_GTK, 1, [define to enable use of maps])
     ],
     [
       HAVE_LIBCHAMPLAIN_GTK=no
index a26c206..781da13 100644 (file)
@@ -9,13 +9,12 @@
     <para/><section id="Zoom"><title>
       Zoom
     </title>
+
     <variablelist><varlistentry><term>
         Quality
-      </term><listitem><para/></listitem></varlistentry></variablelist>
-    <para>
-      Selects the method used to scale the size of an image.
-    </para>
-    <variablelist><varlistentry><term>
+      </term><listitem><para>
+       Selects the method used to scale the size of an image.
+      </para></listitem></varlistentry><varlistentry><term>
         Nearest
       </term><listitem><para>
         Fastest scaler, but results in poor image quality.
         Hyper
       </term><listitem><para>
         Slowest scaler, sometimes gives better results than bilinear.
-      </para></listitem></varlistentry></variablelist>
-    <variablelist><varlistentry><term>
-        Two pass zooming
-      </term><listitem><para/></listitem></varlistentry></variablelist>
-    <para>
-      Enables Geeqie to first display a scaled image using the nearest zoom quality. After image decoding is complete, the image is scaled again using the selected “Zoom (scaling)” method. This allows faster display of an image as it is decoded from the source file.
-    </para>
-    <variablelist><varlistentry><term>
+      </para></listitem></varlistentry><varlistentry><term>
+       Use GPU acceleration via Clutter library
+       </term><listitem><para>
+       Use alternate renderer. Geeqie must be compiled with the --enable-gpu-accel option.
+      </para></listitem></varlistentry><varlistentry><term>
+       Two pass zooming
+       </term><listitem><para>
+       Enables Geeqie to first display a scaled image using the nearest zoom quality. After image decoding is complete, the image is scaled again using the selected “Zoom (scaling)” method. This allows faster display of an image as it is decoded from the source file.
+      </para></listitem></varlistentry><varlistentry><term>
         Allow enlargement of image for zoom to fit
-      </term><listitem><para/></listitem></varlistentry></variablelist>
-    <para>
-      Enable this to allow Geeqie to increase the image size for images that are smaller than the current view area when the zoom is set to “Fit to Window”.
-    </para>
-    <variablelist><varlistentry><term>
+      </term><listitem><para>
+        Enable this to allow Geeqie to increase the image size for images that are smaller than the current view area when the zoom is set to “Fit to Window”.
+      </para></listitem></varlistentry><varlistentry><term>
         Limit image size when autofitting
-      </term><listitem><para/></listitem></varlistentry></variablelist>
-    <para>
+      </term><listitem><para>
       This percentage will affect the size of the image when Fit image to window is set, instead of using 100% of the window, it will use the specified percentage. It allows one to keep a border around the image (values lower than 100%) or to auto zoom the image (values greater than 100%). It affects fullscreen mode too.
-    </para>
-    <variablelist><varlistentry><term>
+      </para></listitem></varlistentry><varlistentry><term>
         Zoom increment
-      </term><listitem><para/></listitem></varlistentry></variablelist>
-    <para>
+      </term><listitem><para>
       Adjusts the step size when zooming in or out on an image. This value corresponds to the percentage of the original image.
-    </para>
+    </para></listitem></varlistentry></variablelist>
     <para/></section><section id="Zoomcontrol"><title>
       Zoom control
     </title>