Plugins Configuration

Plugins Configuration Dialog

This dialog allows user to add new plugins or modify the system ones. It is available in the menu Edit ▸ Configure Plugins .

The Plugins dialog shows list of all relevant plugins i.e. all installed desktop files that are designated either:

  • Categories=Graphics
  • Categories=X-Geeqie

The list has the following columns:

Disabled

If the checkbox is ticked, the plugin will not be displayed in Geeqie menus.

Name

Plugin name as specified in desktop file, and is the name displayed in menus.

Hidden
A plugin can be Hidden for one of these reasons:
  • the desktop file contains Hidden=TRUE or NoDisplay=TRUE
  • TryExec binary was not found
  • MimeType list does not contain images
  • MimeType list is empty and Categories does not contain X-Geeqie
Desktop file
Name of the desktop file, used as an identifier in Keyboard Options .
Path
Full path to the desktop file. Desktop files in user directories override the system ones with the same name.

Adding new plugin

New opens a text editor with a desktop file template. You must amend the line

Exec=command %f
to contain the command you wish to execute. If it is more than a single command, you must create a script file and call that. If the location of the script file is not in your $PATH environment variable, you must include the full pathname.

Modifying an existing plugin

Edit opens a text editor with existing desktop file. For desktop files that are not writable by user, it allows saving to a Geeqie specific directory, where it overrides the system file (but only for Geeqie).

Deleting a plugin

Delete can delete user writable desktop files. System desktop files can't be deleted directly, but it is possible to edit them and set Hidden=TRUE , see above.

Convert image

Choose Convert image… from the Plugins menu to create JPEG or PNG copies of the selected images. This plugin requires Zenity and ImageMagick (the magick or convert program).

Choose JPEG or PNG and a destination folder. For JPEG, also choose quality (1–100; default 90). PNG uses lossless compression and preserves transparency; JPEG renders transparent areas white. Originals are preserved. Existing destination names are skipped and reported in the plugin output window, along with conversion failures. Files with the same base name share a destination name, so only the first successful conversion is saved.

Images are automatically oriented, and metadata, including embedded color profiles, is retained where supported by ImageMagick and the output format. Only the first frame or page is converted. Supported input formats, including RAW formats, depend on the installed ImageMagick delegates and security policy. This operation converts the original file; it does not export Geeqie's displayed adjustments.

The separate Export jpeg plugin extracts an existing embedded preview from a RAW file.

Symlink grouped files

Drop files onto a writable folder in the folder pane, including the parent folder entry, and choose Symlink grouped files. The plugin creates symbolic links for the selected files and their grouped sidecars.

The plugin reports an error if grouped-file or destination lookup fails, a destination already exists, or a link cannot be created. It stops at the first failure. Existing files, directories and symbolic links are not replaced; links already created before a failure remain in place. Enable X-Geeqie-Verbose=true in the plugin's desktop file to display its diagnostic output.

Special plugins

A desktop file with one of the following names has a special function. It will replace the corresponding internal command.

        geeqie-copy-command.desktop
        geeqie-move-command.desktop
        geeqie-rename-command.desktop
        geeqie-delete-command.desktop
        geeqie-folder-command.desktop
      

This can be used for example for a custom trash command or for manipulation of files under version control.

Geeqie desktop file keys

A desktop file for use only by Geeqie should have the following entries:

        Categories=X-Geeqie;
        OnlyShowIn=X-Geeqie;
      

Plugins appear in the Plugins menu and in plugin context menus. The legacy X-Geeqie-Menu-Path key does not control menu placement in GTK4; omit it from new desktop files.

To let the user choose a destination folder for a plugin, add this entry to its desktop file:

X-Geeqie-Filter=true

The plugin will appear in the Folder action list of the Sort Manager Sidebar . Clicking a bookmark uses that folder as the destination. When you run the plugin from the Plugins menu, Geeqie asks you to choose a destination folder.

In the plugin script, use geeqie --get-destination="$file" to get the destination folder with the file's name appended. For example, if the file is /photos/image.jpg and you choose /backup, the command returns /backup/image.jpg. It only returns the path; the script must perform the operation.

      for file in "$@"; do
        destination=$(geeqie --get-destination="$file")
        printf '%s\n' "$destination"
      done
      
The same path is available as $GEEQIE_DESTINATION for the file currently being processed:
      printf '%s\n' "$GEEQIE_DESTINATION"
      
A restart of Geeqie is required for this plugin to be registered

If you want to run a plugin in full-screen mode and wish full-screen to be maintained, include the following entry in the desktop file:

X-Geeqie-Keep-Fullscreen=true

Any terminal output from the plugin command can be displayed with the following command:

X-Geeqie-Verbose=true

Any terminal output from the plugin command can be displayed, only when multiple files are selected, with the following command:

X-Geeqie-Verbose-Multi=true

The plugin can be restricted to run on only certain file types, for example:

X-Geeqie-File-Extensions=.jpg; .cr2
The entries are case insensitive.

The key or key combination to execute this function can be set with:

X-Geeqie-Hotkey=
Key combinations are of the form:
X-Geeqie-Hotkey=<control>y
This value may conflict with a setting in Keyboard Options