Tidy documentation for bash completion and cache maintenance
authorColin Clark <[email protected]>
Wed, 9 Jul 2025 15:34:55 +0000 (16:34 +0100)
committerColin Clark <[email protected]>
Wed, 9 Jul 2025 15:34:55 +0000 (16:34 +0100)
Remove no longer used text and options.

Bash completion cannot be used with cache maintenance because the cache
maintenance option has to be given to the GtkApplication via an
environment variable, and bash completion does not see the in-line
environment variables.

README.md
auto-complete/geeqie
auto-complete/geeqie-cache-maintenance [deleted file]
doc/docbook/GuideOtherSoftware.xml
doc/docbook/GuideReferenceManagement.xml
doc/docbook/GuideReferenceSimilarityAlgorithms.xml
meson.build
org.geeqie.cache-maintenance.desktop.in [deleted file]
src/main.cc

index dfd6102bc88274f644e3be6a6585e697c3ece875..a7914ff0d840238bcf4a52d17e74588c8d320cdd 100644 (file)
--- a/README.md
+++ b/README.md
@@ -96,7 +96,7 @@ Geeqie is a graphics file viewer. Basic features:
 
 * Maps from [OpenStreetMap](https://www.openstreetmap.org) may be displayed in a side panel. If an image has GPS coordinates embedded, its position will be displayed on the map - if Image Direction is encoded, that will be displayed also. If an image does not have embedded GPS coordinates, it may be dragged-and-dropped onto the map to encode its position.
 
-* Speed of operation can be increased by caching thumbnails and similarity data of images. When Geeqie is run as a stand-alone command line program (`geeqie --cache-maintenance <path>`) these data will be recursively created from the defined start point. This program can be called from `cron` or `anacron` so that cache updating is automatically done at specified intervals.
+* Speed of operation can be increased by caching thumbnails and similarity data of images. When Geeqie is run as a stand-alone command line program (`GQ_CACHE_MAINTENANCE=y geeqie --cache-maintenance=&lt;path&gt;`) these data will be recursively created from the defined start point. This program can be called from `cron` or `anacron` so that cache updating is automatically done at specified intervals.
 
 * Extensible via plugins
 
index 1cc2fbd561764e5b0e19b253d9bd4a57129a443a..9b9ba19b27d9258c2808eb8a21cc702a2cdc3b71 100644 (file)
@@ -17,11 +17,6 @@ _geeqie()
                        return
                        ;;
 
-               --cache-maintenance | --cache-render | --cache-render-recurse | --cache-render-shared-recurse | --get-filelist | --get-filelist-recurse | --slideshow-recurse)
-                       _filedir
-                       return
-                       ;;
-
                --cache-shared | --cache-thumbs)
                        COMPREPLY=($(compgen -W 'clean clear' -- "$cur"))
                        return
diff --git a/auto-complete/geeqie-cache-maintenance b/auto-complete/geeqie-cache-maintenance
deleted file mode 100755 (executable)
index 77b0c3d..0000000
+++ /dev/null
@@ -1,71 +0,0 @@
-# bash completion for geeqie-cache-maintenance                             -*- shell-script -*-
-
-file_types='@(3fr|ani|arw|avif|bmp|cr2|cr3|crw|cur|dds|djvu|dng|erf|exr|gif|gqv|heic|heif|ico|jp2|jpe|jpeg|jpg|jps|jxl|kdc|mef|mos|mpo|mrw|nef|orf|pbm|pdf|pef|pgm|png|pnm|ppm|psd|qif|qtif|raf|raw|rw2|scr|sr2|srf|svg|svgz|tga|tif|tiff|webp|xbm|xpm)'
-
-actions='About AddMark0 AddMark1 AddMark2 AddMark3 AddMark4 AddMark5 AddMark6 AddMark7 AddMark8 AddMark9 AlterNone Animate Back ClearMarks CloseWindow ColorProfile0 ColorProfile1 ColorProfile2 ColorProfile3 ColorProfile4 ColorProfile5 ConnectZoom100 ConnectZoom200 ConnectZoom25 ConnectZoom300 ConnectZoom33 ConnectZoom400 ConnectZoom50 ConnectZoomFillHor ConnectZoomFillVert ConnectZoomFit ConnectZoomIn ConnectZoomOut Copy CopyImage CopyPath CopyPathUnquoted CropFourThree CropNone CropOneOne CropRectangle CropSixteenNine CropThreeTwo CutPath Delete DeleteWindow DrawRectangle Escape ExifRotate ExifWin FilterMark0 FilterMark1 FilterMark2 FilterMark3 FilterMark4 FilterMark5 FilterMark6 FilterMark7 FilterMark8 FilterMark9 FindDupes FirstImage FirstPage Flip FloatTools FolderTree Forward FullScreen Grayscale HelpChangeLog HelpContents HelpKbd HelpNotes HelpSearch HelpShortcuts HideBars HideSelectableToolbars HideTools HistogramChanB HistogramChanCycle HistogramChanG HistogramChanR HistogramChanRGB HistogramChanV HistogramModeCycle HistogramModeLin HistogramModeLog Home IgnoreAlpha ImageBack ImageForward ImageHistogram ImageOverlay ImageOverlayCycle IntMark0 IntMark1 IntMark2 IntMark3 IntMark4 IntMark5 IntMark6 IntMark7 IntMark8 IntMark9 KeywordAutocomplete LastImage LastPage LayoutConfig LogWindow Maintenance Mark0 Mark1 Mark2 Mark3 Mark4 Mark5 Mark6 Mark7 Mark8 Mark9 Mirror Move NewCollection NewFolder NewWindow NewWindowDefault NewWindowFromCurrent NextImage NextPage OpenArchive OpenCollection OpenRecent OpenWith OverUnderExposed PanView PermanentDelete Plugins Preferences PrevImage PrevPage Print Quit Rating0 Rating1 Rating2 Rating3 Rating4 Rating5 RatingM1 RectangularSelection Refresh Rename RenameWindow ResetMark0 ResetMark1 ResetMark2 ResetMark3 ResetMark4 ResetMark5 ResetMark6 ResetMark7 ResetMark8 ResetMark9 Rotate180 RotateCCW RotateCW SBar SBarSort SaveMetadata Search SearchAndRunCommand SelectAll SelectInvert SelectMark0 SelectMark1 SelectMark2 SelectMark3 SelectMark4 SelectMark5 SelectMark6 SelectMark7 SelectMark8 SelectMark9 SelectNone SetMark0 SetMark1 SetMark2 SetMark3 SetMark4 SetMark5 SetMark6 SetMark7 SetMark8 SetMark9 ShowFileFilter ShowInfoPixel ShowMarks SlideShow SlideShowFaster SlideShowPause SlideShowSlower SplitDownPane SplitHorizontal SplitNextPane SplitPaneSync SplitPreviousPane SplitQuad SplitSingle SplitTriple SplitUpPane SplitVertical StereoAuto StereoCross StereoCycle StereoOff StereoSBS Thumbnails ToggleMark0 ToggleMark1 ToggleMark2 ToggleMark3 ToggleMark4 ToggleMark5 ToggleMark6 ToggleMark7 ToggleMark8 ToggleMark9 UnselMark0 UnselMark1 UnselMark2 UnselMark3 UnselMark4 UnselMark5 UnselMark6 UnselMark7 UnselMark8 UnselMark9 Up UseColorProfiles UseImageProfile ViewIcons ViewInNewWindow ViewList WriteRotation WriteRotationKeepDate Zoom100 Zoom200 Zoom25 Zoom300 Zoom33 Zoom400 Zoom50 ZoomFillHor ZoomFillVert ZoomFit ZoomIn ZoomOut ZoomToRectangle'
-
-options_basic='--blank --fullscreen --geometry= --help --help-all --help-gapplication --help-gtk --list --new-instance --log-file= --remote --slideshow --with-tools --without-tools --version --show-log-window --debug= --grep= --action= --action-list --back --close-window --config-load= --cache-metadata --cache-render= --cache-render-recurse= --cache-render-shared= --cache-render-shared-recurse= --cache-shared= --cache-thumbs= --delay= --first --fullscreen --file= --File= --fullscreen-start --fullscreen-stop --geometry= --get-collection= --get-collection-list --get-destination= --get-file-info --get-filelist= --get-filelist-recurse= --get-rectangle --get-render-intent --get-selection --get-sidecars= --get-window-list --id= --last --list-add= --list-clear --lua= --new-window --next --pixel-info --print0 --quit --raise --selection-add= --selection-clear --selection-remove= --slideshow --slideshow-recurse= --tell --tools --view='
-
-options_remote='--action= --action-list --back --cache-metadata --cache-render= --cache-render-recurse= --cache-render-shared= --cache-render-shared-recurse= --cache-shared= --cache-thumbs= --close-window --config-load= --debug= --delay= --file= --File= --first --fullscreen --geometry= --get-collection= --get-collection-list --get-destination= --get-file-info --get-filelist= --get-filelist-recurse= --get-rectangle --get-render-intent --get-selection --get-sidecars= --get-window-list --grep --id= --last --log-file= --lua= --new-window --next --pixel-info --print0 --quit --raise --selection-add= --selection-clear --selection-remove= --show-log-window --slideshow --slideshow-recurse= --tell --tools --view= --version'
-
-_geeqie-cache-maintenance()
-{
-       local cur prev
-       _init_completion -s || return
-
-       case "$prev" in
-               --action)
-                       COMPREPLY=($(compgen -W '$actions' -- "$cur"))
-                       return
-                       ;;
-
-               --cache-maintenance | --cache-render | --cache-render-recurse | --cache-render-shared-recurse | --get-filelist | --get-filelist-recurse | --slideshow-recurse)
-                       _filedir
-                       return
-                       ;;
-
-               --cache-shared | --cache-thumbs)
-                       COMPREPLY=($(compgen -W 'clean clear' -- "$cur"))
-                       return
-                       ;;
-
-               --config-load)
-                       _filedir xml
-                       return
-                       ;;
-
-               --file | --File | --get-destination | --get-sidecars | --list-add | --selection-add | --selection-remove | --view)
-                       _filedir $file_types
-                       return
-                       ;;
-
-               --get-collection)
-                       collection="$(find $HOME/.local/share/geeqie/collections/ -maxdepth 1  -name "*gqv" -exec basename {} \;)"
-                       COMPREPLY=($(compgen -W '$collection' -- "$cur"))
-                       return
-                       ;;
-
-               --lua)
-                       _filedir lua
-                       return
-                       ;;
-       esac
-
-       if [[ $cur == -* ]]
-       then
-               if [[ $COMP_LINE == *"MAINTAIN"* ]]
-               then
-                       COMPREPLY=($(compgen -W '$options_maintenance' -- "$cur"))
-               else
-                       COMPREPLY=($(compgen -W '$options_basic' -- "$cur"))
-               fi
-
-               [[ ${COMPREPLY-} == *[=] ]] && compopt -o nospace
-               return
-       fi
-
-_filedir $file_types
-
-} &&  complete -F _geeqie-cache-maintenance geeqie-cache-maintenance
-
-# ex: filetype=sh
index a611e95aff2ce65f8d3752c8be6dbed1443fb255..0d3c3439468ae74e12ee07d9d46e7ba01e4306b9 100644 (file)
       <ulink url="https://github.com/bcpierce00/unison/">https://github.com/bcpierce00/unison/</ulink>
     </para>
   </section>
-  <section id="GeeqieCacheMaintenance">
-    <title>Geeqie Cache Maintenance</title>
-    <para>
-      Command line program to automatically create or update thumbnails and similarity data: <emphasis role="underline"><link linkend="CacheMaintenance"><code>geeqie-cache-maintenance</code></link></emphasis>
-    </para>
-  </section>
   <section id="KeywordMerge">
     <title>Keyword Merge</title>
     <para>
index 64f324e4744bbad2056b40c8c6b1e01706336242..d75fe1cc0af075ffa2571e1641769010e17df61f 100644 (file)
   <section id="CacheMaintenance">
     <title>Command line program</title>
     <para>
-      Geeqie can be run as a command line program: <code>GQ_CACHE_MAINTENANCE=y[es] geeqie --cache-maintenance &lt;path to images&gt;</code>. It will recursively remove orphaned thumbnails and .sim files, and create thumbnails and similarity data for all images found.
+      Geeqie can be run as a command line program: <code>GQ_CACHE_MAINTENANCE=y[es] geeqie --cache-maintenance=&lt;path to images&gt;</code>. It will recursively remove orphaned thumbnails and .sim files, and create thumbnails and similarity data for all images found.
     <para/>
       It may also be called from <code>cron</code> or <code>anacron</code> thus enabling automatic updating of the cached data for all your images.
     </para>
index efdcdb4795c3f3fc883f40cd274393f78b74bc8d..f44863f95f960373c06ebb5a42052c905a1cea05 100644 (file)
@@ -9,7 +9,7 @@
     For each array element, the average value of all the red and the green and the blue pixels is computed and stored in the array. Therefore the array represents the average color of each corresponding part of the image.
     <para />
     This data is stored in a file with the same name is the image and with the extension .sim. It is stored in the same location as thumbnails. If many images are to be compered, run-time is reduced by having these .sim files already created. This can be done via Edit/Cache Maintenance or by the command line instruction:
-    <code>geeqie --cache-maintenance &lt;path&gt;</code>
+    <code>GQ_CACHE_MAINTENANCE=y geeqie --cache-maintenance=&lt;path&gt;</code>
   </para>
   <section id="standard">
     <title>Standard Algorithm</title>
index c166fa1d1b5469a05c6083aad327e30f1c6d6499..7d99a93d7623e0064ce06f1eaf5ed928d6c9d5dd 100644 (file)
@@ -707,14 +707,6 @@ i18n.merge_file(
     install : true,
     install_dir : join_paths(datadir, 'applications'))
 
-i18n.merge_file(
-    input : 'org.geeqie.cache-maintenance.desktop.in',
-    output : 'org.geeqie.cache-maintenance.desktop',
-    type : 'desktop',
-    po_dir : podir,
-    install : true,
-    install_dir : join_paths(datadir, 'applications'))
-
 i18n.merge_file(
     input : 'org.geeqie.Geeqie.appdata.xml.in',
     output : 'org.geeqie.Geeqie.appdata.xml',
diff --git a/org.geeqie.cache-maintenance.desktop.in b/org.geeqie.cache-maintenance.desktop.in
deleted file mode 100644 (file)
index 1326011..0000000
+++ /dev/null
@@ -1,14 +0,0 @@
-[Desktop Entry]
-Name=Geeqie Cache Maintenance
-GenericName=Image Viewer
-Comment=View and manage images
-Exec=/bin/true
-Icon=geeqie
-Type=Application
-Terminal=false
-StartupNotify=true
-StartupWMClass=geeqie
-NotShowIn=X-Geeqie;
-Categories=Graphics;Viewer;
-MimeType=application/x-navi-animation;image/bmp;image/x-bmp;image/x-MS-bmp;image/gif;image/x-icon;image/jpeg;image/png;image/x-portable-anymap;image/x-portable-bitmap;image/x-portable-graymap;image/x-portable-pixmap;image/x-tga;image/tiff;image/x-xbitmap;image/x-xpixmap;image/svg;image/svg+xml;image/x-png;image/xpm;image/x-ico;
-Keywords=Picture;Slideshow;Graphics;
index 6345533f3f178ee6c5b3d0f1760a0032f405bb66..4f41a95614051c2ac34a82e8fe79379a04a433bd 100644 (file)
@@ -119,15 +119,17 @@ XDG_CONFIG_HOME=/tmp/a XDG_CACHE_HOME=/tmp/b GQ_NEW_INSTANCE=y geeqie\n\n \
 To disable Clutter use:\n \
 GQ_DISABLE_CLUTTER=y[es] geeqie\n\n \
 To run or stop Geeqie in cache maintenance (non-GUI) mode use:\n \
-GQ_CACHE_MAINTENANCE=y[es] geeqie --help\n\n \
+GQ_CACHE_MAINTENANCE=y[es] geeqie --help\n \
+Note that bash command line completion does not work in this mode.\n\n \
 User manual: https://www.geeqie.org/help/GuideIndex.html\n \
            : https://www.geeqie.org/help-pdf/help.pdf");
 
 const gchar *option_context_description_cache_maintenance = _(" \
 This is a command line program that will recursively remove orphaned thumbnails and\n \
-.sim files, and create thumbnails and similarity data for all images found under FOLDER.\n \
+.sim files, and create thumbnails and similarity data for all images found under FOLDER.\n\n \
 It may also be called from cron or anacron thus enabling automatic updating of the cached\n \
 data for all your images.\n\n \
+Note that bash command line completion does not work in this mode.\n\n \
 User manual: https://www.geeqie.org/help/GuideIndex.html\n \
            : https://www.geeqie.org/help-pdf/help.pdf");