Xfce Wiki

Sub domains
 

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
xfce:tumbler:start [2020/08/30 09:31] – added link to new available plugins page kevinbowenxfce:tumbler:start [2025/03/31 10:37] (current) – [Debugging Support] drop pkg-config, file is not always present gael
Line 1: Line 1:
 ~~NOTOC~~ ~~NOTOC~~
-====== Tumbler Thumbnail Service ======+{{ :xfce:tumbler.png?48nolink|}} 
 +====== Tumbler - Thumbnail Service ======
  
   * **[[#Introduction|Introduction]]**   * **[[#Introduction|Introduction]]**
 +  * **[[#Configuration|Configuration]]**
   * **[[#Available Plugins|Available Plugins]]**   * **[[#Available Plugins|Available Plugins]]**
 +  * **[[#Standards compliance|Standards compliance]]**
 +  * **[[#Debugging Support|Debugging Support]]**
 +  * **[[#Required packages|Required packages]]**
   * **[[#Latest Release|Latest Release]]**   * **[[#Latest Release|Latest Release]]**
   * **[[#Source Code Repository|Source Code Repository]]**   * **[[#Source Code Repository|Source Code Repository]]**
 +  * **[[https://developer.xfce.org/tumbler/index.html|tumbler API documentation (for developers)]]**
   * **[[#Reporting Bugs|Reporting Bugs]]**   * **[[#Reporting Bugs|Reporting Bugs]]**
  
Line 16: Line 22:
 thumbnail management D-Bus specification described on  thumbnail management D-Bus specification described on 
  
-[[https://wiki.gnome.org/DraftSpecs/ThumbnailerSpec]]+[[https://wiki.gnome.org/Attic/DraftThumbnailerSpec]]
  
 written in an object-oriented fashion using GLib and GObject. Its written in an object-oriented fashion using GLib and GObject. Its
 modular architecture makes it very flexible and useful in many modular architecture makes it very flexible and useful in many
 situations. It provides plugin interfaces for extending the URI schemes situations. It provides plugin interfaces for extending the URI schemes
-and MIME types for which thumbnails can be generated as well as +and MIME types for which thumbnails can be generated as well as for replacing the storage backend that is used to store the thumbnails
- +
-for replacing the storage backend that is used to store the thumbnails+
 on disk. Tumbler's functionality can also be extended via specialized on disk. Tumbler's functionality can also be extended via specialized
 thumbnailer services implemented in accordance to the thumbnail thumbnailer services implemented in accordance to the thumbnail
 management D-Bus specification. management D-Bus specification.
  
-Tumbler is used by Thunar, Xfce and MeeGo.+Tumbler is used by [[:xfce:thunar:start:|Thunar]], [[:apps:ristretto:start|Ristretto]], and Xfce.
  
 ---- ----
  
 +===== Configuration =====
 +
 +You can override the default cache directory ''$HOME/.cache'' in which, besides other non-essential files, thumbnails are stored:
 +
 +
 +  * **D-Bus/ systemd**
 +     * Create a file below ''~/.config/environment.d/'' and inside set XDG_CACHE_HOME. E.g:
 +     * ''XDG_CACHE_HOME=$HOME/.my_new_cache''
 +
 +  * **Other**
 +     * Extend $HOME/.profile, $HOME/.bash_rc or similar
 +     * ''export XDG_CACHE_HOME=$HOME/.my_new_cache''
 +
 +After that, re-login, make sure the variable is set, and check if it works fine.
 +
 +Tumbler has a configuration file ''tumbler.rc'' described in a [[available_plugins#configuration|dedicated page]].
 +
 +----
 ===== Available Plugins ===== ===== Available Plugins =====
  
-[[:xfce:tumbler:available_plugins:|Available Tumbler Plugins]]+Tumbler allows to load a number [[:xfce:tumbler:available_plugins:|additional tumbler plugins]] to support different file formats. Most plugins are loaded by default, if the required libraries are provided. 
  
-The Tumbler package contains a D-Bus thumbnailing service based on the thumbnail management D-Bus specification. This is useful for generating thumbnail images of files. +---- 
 + 
 +===== Standards compliance ===== 
 + 
 + 
 +Tumbler supports and implements the following standards/specifications: 
 +  * [[https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html|XDG Base Directory Specification]] 
 +  * [[https://specifications.freedesktop.org/thumbnail-spec/thumbnail-spec-latest.html|Thumbnail Managing Standard]] 
 +  * [[https://wiki.gnome.org/Attic/DraftThumbnailerSpec|Thumbnail Management D-Bus Specification]] 
 +  * [[https://www.freedesktop.org/wiki/Specifications/file-uri-spec/|File URI Specification]] 
 + 
 +[[|Back To Top]] 
 +---- 
 + 
 +===== Debugging Support ===== 
 + 
 +As with all Xfce components, you can [[:xfce:building#building_the_packages|set debug support at compile time]], but this is more likely to be of interest to developers or package maintainers. 
 + 
 +To get debug logs at runtime, starting with Tumbler 4.17.0 (first stable release 4.18.0), you can do the following: 
 + 
 +  pkill tumblerd 
 +  G_MESSAGES_PREFIXED= G_MESSAGES_DEBUG=all /usr/lib/tumbler-1/tumblerd 
 + 
 +Note: depending on your distribution, you may need to adapt the prefix to ''/tumbler-1/tumblerd'' (e.g. probably ''/usr/lib/x86_64-linux-gnu'' on debian-based distros). 
 + 
 +[[|Back To Top]] 
 +---- 
 + 
 +===== Required packages ===== 
 + 
 +Tumbler depends on the following packages: 
 + 
 +  * GLib >= 2.66.0 
 + 
 +Tumbler can optionally use the following packages: 
 + 
 +  * gdk-pixbuf >= 2.40.0 (various image formats, some of them requiring the installation of optional libraries specific to gdk-pixbuf; also required for all other plugins below)  
 +  * FreeType >= 2.0.0 (font) 
 +  * A libjpeg implementation (e.g. libjpeg-turbo) 
 +  * FFmpegthumbnailer >= 2.0.0 (video) 
 +  * GStreamer >= 1.0.0 (video) 
 +  * Poppler >= 0.12 (PDF/PS) 
 +  * libgsf >= 1.14.9 (ODF) 
 +  * libopenraw >= 0.0.4 (RAW images) 
 +  * libpng >= 1.2.0 (for the Thumbnail Managing Standard storage backend) 
 +  * libgepub >= 0.6.0 (EPUB) 
 + 
 +[[|Back To Top]]
 ---- ----
  
 ===== Latest Release ===== ===== Latest Release =====
 +{{rss>https://archive.xfce.org/feeds/project/tumbler 1 date 2h}}
  
-==== 0.3.0 (20200813)====+[[https://gitlab.xfce.org/xfce/tumbler/-/blob/master/NEWS|Read the CHANGELOG]]
  
-**[[https://archive.xfce.org/src/xfce/tumbler/0.3/tumbler-0.3.0.tar.bz2|tumbler-0.3.0.tar.bz2]]**+  * **[[https://archive.xfce.org/src/xfce/tumbler/|Download current release]]** (link also contains older versions)
  
 +[[|Back to Top]]
  
 ---- ----
Line 59: Line 130:
 [[|Back To Top]] [[|Back To Top]]
 ---- ----
-[[ :start:|Return to Main Xfce documentation page]]+[[ :start:|Return to Xfce Main Documentation Page]]