changeset 2912:3fc1b4b21177

Update documentation, remove obsolete GQview import options Update plugin and remote commands documentation. The last update for GQview was 13 years ago; presumably the import options are no longer useful.
author Colin Clark <colin.clark@cclark.uk>
date Wed, 27 Mar 2019 11:56:16 +0000
parents 89bdd971db1a
children a1ed644315cb
files doc/docbook/GuideImageManagementPlugins.xml doc/docbook/GuideReference.xml doc/docbook/GuideReferenceCommandLine.xml doc/docbook/GuideReferencePCRE.xml doc/docbook/GuideReferenceStandardPlugins.xml geeqie.1 plugins/Makefile.am plugins/import/Makefile.am plugins/import/geeqie-import plugins/import/geeqie-import-geeqie.desktop.in plugins/import/geeqie-import-gqview.desktop.in src/remote.c
diffstat 12 files changed, 166 insertions(+), 80 deletions(-) [+]
line wrap: on
line diff
--- a/doc/docbook/GuideImageManagementPlugins.xml	Tue Feb 26 10:07:24 2019 +0000
+++ b/doc/docbook/GuideImageManagementPlugins.xml	Wed Mar 27 11:56:16 2019 +0000
@@ -34,4 +34,8 @@
     <code>Escape</code>
     , to close the Result dialogue. The Result dialogue can not be closed while a command is still running.
   </para>
+  <para>
+    The supplied standard plugins are described in the
+    <link linkend="GuideReferenceStandardPlugins">Reference section.</link>
+  </para>
 </chapter>
--- a/doc/docbook/GuideReference.xml	Tue Feb 26 10:07:24 2019 +0000
+++ b/doc/docbook/GuideReference.xml	Wed Mar 27 11:56:16 2019 +0000
@@ -11,6 +11,7 @@
   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideReferenceTags.xml" />
   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideReferenceSupportedFormats.xml" />
   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideReferencePixbufLoaders.xml" />
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideReferenceStandardPlugins.xml" />
   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideReferenceUTC.xml" />
   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideReferenceDecodeLatLong.xml" />
   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideReferenceStandards.xml" />
--- a/doc/docbook/GuideReferenceCommandLine.xml	Tue Feb 26 10:07:24 2019 +0000
+++ b/doc/docbook/GuideReferenceCommandLine.xml	Wed Mar 27 11:56:16 2019 +0000
@@ -213,13 +213,23 @@
           </row>
           <row>
             <entry />
+            <entry>--file:&lt;file&gt;</entry>
+            <entry>Open  &lt;file&gt; and bring Geeqie window to the top</entry>
+          </row>
+          <row>
+            <entry />
             <entry>File:&lt;file&gt;</entry>
             <entry>Open  &lt;file&gt; and do not bring Geeqie window to the top</entry>
           </row>
           <row>
             <entry />
+            <entry>--File:&lt;file&gt;</entry>
+            <entry>Open  &lt;file&gt; and do not bring Geeqie window to the top</entry>
+          </row>
+          <row>
+            <entry />
             <entry>--tell</entry>
-            <entry>Print filename of current image</entry>
+            <entry>Print filename [and Collection] of current image</entry>
           </row>
           <row>
             <entry />
@@ -233,6 +243,11 @@
           </row>
           <row>
             <entry />
+            <entry>--view:&lt;file&gt;</entry>
+            <entry>Open new window containing &lt;file&gt;</entry>
+          </row>
+          <row>
+            <entry />
             <entry>--list-clear</entry>
             <entry>Clear command line collection list</entry>
           </row>
@@ -248,6 +263,11 @@
           </row>
           <row>
             <entry />
+            <entry>--raise</entry>
+            <entry>Bring the geeqie window to the top</entry>
+          </row>
+          <row>
+            <entry />
             <entry>--id:&lt;ID&gt;</entry>
             <entry>
               Window ID for following commands
@@ -311,6 +331,11 @@
             <entry>--lua:&lt;file&gt;,&lt;lua script&gt;</entry>
             <entry>run lua script on file</entry>
           </row>
+          <row>
+            <entry />
+            <entry>--PWD:&lt;PWD&gt;</entry>
+            <entry>Use PWD as working directory for following commands</entry>
+          </row>
         </tbody>
       </tgroup>
     </table>
--- a/doc/docbook/GuideReferencePCRE.xml	Tue Feb 26 10:07:24 2019 +0000
+++ b/doc/docbook/GuideReferencePCRE.xml	Wed Mar 27 11:56:16 2019 +0000
@@ -9,6 +9,7 @@
       <listitem>Use "." and not "?" for a single character.</listitem>
       <listitem>Use "abc.*ghk" and not "abc*ghk" for multiple characters</listitem>
       <listitem>Use "\." to represent the dot in a file extension</listitem>
+      <listitem>Use "(?i)" to make the following characters case-insensitive</listitem>
     </itemizedlist>
   </para>
 </section>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/docbook/GuideReferenceStandardPlugins.xml	Wed Mar 27 11:56:16 2019 +0000
@@ -0,0 +1,128 @@
+<?xml version="1.0" encoding="utf-8"?>
+<section id="GuideReferenceStandardPlugins">
+  <title id="titleGuideReferenceStandardPlugins">Standard Plugins</title>
+  <para>The following plugins are supplied as standard with Geeqie.</para>
+  <section id="EditUFRawIDfile">
+    <title>Edit UFRaw ID file</title>
+    <para>Creates a UFRaw ID file for each of the selected files.</para>
+    <para>
+      This item is displayed in the
+      <emphasis role="strong">Edit</emphasis>
+      menu.
+    </para>
+  </section>
+  <section id="UFRawBatch">
+    <title>UFRaw Batch</title>
+    <para>
+      Searches for new RAW files or for modified UFRaw 
+      ID files and processes them with
+      <code>ufraw-batch</code>
+      .
+    </para>
+    <para>
+      This item is displayed in the
+      <emphasis role="strong">Edit</emphasis>
+      menu.
+    </para>
+  </section>
+  <section id="UFRawBatchrecursive">
+    <title>UFRaw Batch recursive</title>
+    <para>As above, with a recursive search.</para>
+    <para>
+      This item is displayed in the
+      <emphasis role="strong">Edit</emphasis>
+      menu.
+    </para>
+  </section>
+  <section id="Symlink">
+    <title>Symlink</title>
+    <para>Creates a symbolic link on the selected files. If a file has sidecars, they will also be symlinked.</para>
+    <para>
+      This item is displayed in the
+      <emphasis role="strong">File</emphasis>
+      menu.
+    </para>
+  </section>
+  <section id="Applytheorientationtoimagecontent">
+    <title>Apply the orientation to image content</title>
+    <para>This command affects only jpeg, tiff and png files. The image file on disk is rotated to the orientation as specified by its Exif Orientation tag.</para>
+    <warning>
+      <para>External commands exiftran, exiv2 and mogrify, are used to implement this command.</para>
+    </warning>
+    <para>
+      This item is displayed in the
+      <emphasis role="strong">Edit/Orientation</emphasis>
+      menu.
+    </para>
+  </section>
+  <section id="Cameraimport">
+    <title>Camera import</title>
+    <para>Imports images from an attached camera to the current folder. If a file with the same name already exists it will not be overwritten, and the new image will not be downloaded.</para>
+    <para>
+      This item is displayed in the
+      <emphasis role="strong">Plugins</emphasis>
+      menu.
+    </para>
+  </section>
+  <section id="Exportjpeg">
+    <title>Export jpeg</title>
+    <para>
+      Extracts an embedded jpeg from a raw image to a file in the
+      <code>/tmp</code>
+      folder. If you wish to to keep this image, it must be copied or moved.
+      <para />
+      If
+      <code>jpgicc</code>
+      is installed, the image will be colour-corrected for the currently selected rendering intent.
+    </para>
+    <para>
+      This item is displayed in the
+      <emphasis role="strong">Plugins</emphasis>
+      menu.
+    </para>
+  </section>
+  <section id="Imagecrop">
+    <title>Image crop</title>
+    <para>
+      If rectangle coordinates have been set by
+      <emphasis role="strong">Edit/Draw Rectangle</emphasis>
+      , a cropped image will be stored in the
+      <code>/tmp</code>
+      folder. If you wish to to keep this image, it must be copied or moved.
+    </para>
+    <para>
+      This item is displayed in the
+      <emphasis role="strong">Plugins</emphasis>
+      menu.
+    </para>
+  </section>
+  <section id="Randomimage">
+    <title>Random image</title>
+    <para>Selects and displays a random image from a list of all images in Collections and the currently displayed folder.</para>
+    <para>
+      This item is displayed in the
+      <emphasis role="strong">Plugins</emphasis>
+      menu.
+    </para>
+  </section>
+  <section id="Tetheredphotography">
+    <title>Tethered photography</title>
+    <para>
+      If a camera is connected to the computer via USB, photos taken are immediately downloaded to the current folder and displayed on the computer.
+      <para />
+      If a file already exists with the same name, it is not overwritten but the download will not take place.
+      <para />
+      Auto-rename can be achieved with the --filename option of gphoto2.
+      <para />
+      In file
+      <code>$HOME/.config/gphoto2/settings</code>
+      , set the option:
+      <code>gphoto2=filename=&lt;see the gphoto2 manual&gt;</code>
+    </para>
+    <para>
+      This item is displayed in the
+      <emphasis role="strong">Plugins</emphasis>
+      menu.
+    </para>
+  </section>
+</section>
--- a/geeqie.1	Tue Feb 26 10:07:24 2019 +0000
+++ b/geeqie.1	Wed Mar 27 11:56:16 2019 +0000
@@ -271,6 +271,10 @@
 .IP \-\-lua:<FILE>,<lua-script>
 Run lua script on FILE.
 .br
+.B
+.IP \-\-PWD:<PWD>
+Use PWD as working directory for following commands.
+.br
 
 .SH USAGE
 Key naming is similar to that of \fBemacs\fP(1): \fIC-key\fP indicates that control should be held, and key should be pressed; \fIS-key\fP  indicates that shift should be held and key should be pressed; these two can be combined, also, into \fIC-S-key\fP.
--- a/plugins/Makefile.am	Tue Feb 26 10:07:24 2019 +0000
+++ b/plugins/Makefile.am	Wed Mar 27 11:56:16 2019 +0000
@@ -1,5 +1,5 @@
 
-SUBDIRS = rotate symlink ufraw import geocode-parameters export-jpeg tethered-photography camera-import image-crop random-image
+SUBDIRS = rotate symlink ufraw geocode-parameters export-jpeg tethered-photography camera-import image-crop random-image
 qq_desktoptemplatedir = $(appdir)
 qq_desktoptemplate_in_files = template.desktop.in
 qq_desktoptemplate_DATA = $(qq_desktoptemplate_in_files:.desktop.in=.desktop)
--- a/plugins/import/Makefile.am	Tue Feb 26 10:07:24 2019 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,9 +0,0 @@
-dist_gq_bin_SCRIPTS = geeqie-import
-
-gq_desktopdir = $(appdir)/applications
-gq_desktop_in_files = geeqie-import-geeqie.desktop.in geeqie-import-gqview.desktop.in
-gq_desktop_DATA = $(gq_desktop_in_files:.desktop.in=.desktop)
-@INTLTOOL_DESKTOP_RULE@
-
-EXTRA_DIST = $(gq_desktop_in_files)
-CLEANFILES = $(gq_desktop_DATA)
--- a/plugins/import/geeqie-import	Tue Feb 26 10:07:24 2019 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,34 +0,0 @@
-#!/bin/sh
-
-case "$1" in
-	gqview) 
-	    srcdir=$HOME/.gqview/metadata
-	    ;;
-	geeqie-1-alpha) 
-	    srcdir=$HOME/.geeqie/metadata
-	    ;;
-	*)
-	    echo Unknown argument $1
-	    exit 1
-	    ;;
-esac
-
-destdir=$HOME/.local/share/geeqie/metadata
-
-if [ ! -d $HOME/.local/share/geeqie ] ; then
-    echo \"$HOME/.local/share/geeqie\" does not exist
-    exit 1
-fi
-
-for ext in .meta .gq.xmp ; do
-    find "$srcdir" -type f -name "*$ext" -print | while read src ; do
-        img="${src#$srcdir}"
-        img="${img%$ext}"
-        dest="$destdir$img$ext"
-        if [ -f "$img" -a ! -f "$dest" ] ; then
-            mkdir -p "${dest%/*}"
-            cp -pr "$src" "$dest"
-            echo Importing $ext metadata for \"$img\"
-        fi
-    done
-done
--- a/plugins/import/geeqie-import-geeqie.desktop.in	Tue Feb 26 10:07:24 2019 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,17 +0,0 @@
-[Desktop Entry]
-Version=1.0
-Type=Application
-_Name=Import Geeqie 1.0alphaX metadata
-
-# call the helper script
-Exec=geeqie-import geeqie-1-alpha
-
-# Desktop files that are usable only in Geeqie should be marked like this:
-Categories=X-Geeqie;
-OnlyShowIn=X-Geeqie;
-
-# Show in menu "File"
-#X-Geeqie-Menu-Path=EditMenu/PreferencesMenu
-
-# It can be made verbose
-X-Geeqie-Verbose=true
--- a/plugins/import/geeqie-import-gqview.desktop.in	Tue Feb 26 10:07:24 2019 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,17 +0,0 @@
-[Desktop Entry]
-Version=1.0
-Type=Application
-_Name=Import GQView metadata
-
-# call the helper script
-Exec=geeqie-import gqview
-
-# Desktop files that are usable only in Geeqie should be marked like this:
-Categories=X-Geeqie;
-OnlyShowIn=X-Geeqie;
-
-# Show in menu "File"
-#X-Geeqie-Menu-Path=EditMenu/PreferencesMenu
-
-# It can be made verbose
-X-Geeqie-Verbose=true
--- a/src/remote.c	Tue Feb 26 10:07:24 2019 +0000
+++ b/src/remote.c	Wed Mar 27 11:56:16 2019 +0000
@@ -1174,7 +1174,7 @@
 #ifdef HAVE_LUA
 	{ NULL, "--lua:",               gr_lua,                 TRUE, FALSE, N_("<FILE>,<lua script>"), N_("run lua script on FILE") },
 #endif
-	{ NULL, "--PWD:",               gr_pwd,                 TRUE, FALSE, N_("<PWD>"), N_("for internal use only") },
+	{ NULL, "--PWD:",               gr_pwd,                 TRUE, FALSE, N_("<PWD>"), N_("use PWD as working directory for following commands") },
 	{ NULL, NULL, NULL, FALSE, FALSE, NULL, NULL }
 };