doc/docbook/GuideOptionsGeneral.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <section id="GuideOptionsGeneral">
   3   <title>General Options</title>
   4   <para>This section describes the options presented under the General Tab of the preferences dialog.</para>
   5   <section id="PreferencesThumbnails">
   6     <title>Thumbnails</title>
   7     <variablelist>
   8       <varlistentry>
   9         <term>
  10           <guilabel>Size</guilabel>
  11         </term>
  12         <listitem>
  13           <para>Selects the size of the thumbnails displayed throughout Geeqie, dimensions are width by height in pixels.</para>
  14         </listitem>
  15       </varlistentry>
  16     </variablelist>
  17     <variablelist>
  18       <varlistentry>
  19         <term>
  20           <guilabel>Quality</guilabel>
  21         </term>
  22         <listitem>
  23           <para>
  24             Selects the method to use when scaling an image down for thumbnails:
  25             <variablelist>
  26               <varlistentry>
  27                 <term>
  28                   <guilabel>Nearest</guilabel>
  29                 </term>
  30                 <listitem>
  31                   <para>Fastest scaler, but results in poor thumbnail quality.</para>
  32                 </listitem>
  33               </varlistentry>
  34               <varlistentry>
  35                 <term>
  36                   <guilabel>Tiles</guilabel>
  37                 </term>
  38                 <listitem>
  39                   <para>Thumbnail results are very close to bilinear, with better speed.</para>
  40                 </listitem>
  41               </varlistentry>
  42               <varlistentry>
  43                 <term>
  44                   <guilabel>Bilinear</guilabel>
  45                 </term>
  46                 <listitem>
  47                   <para>High quality results, moderately fast.</para>
  48                 </listitem>
  49               </varlistentry>
  50             </variablelist>
  51           </para>
  52         </listitem>
  53       </varlistentry>
  54     </variablelist>
  55     <variablelist>
  56       <varlistentry>
  57         <term>
  58           <guilabel>Cache thumbnails and sim. files</guilabel>
  59         </term>
  60         <listitem>
  61           <para>
  62             Enable this to save thumbnails and
  63             <link linkend="CreateSimFiles">sim. files</link>
  64             to disk. Subsequent requests for a thumbnail will be faster, as will searches and find duplicates.
  65           </para>
  66           <variablelist>
  67             <varlistentry>
  68               <term>
  69                 <guilabel>Use Geeqie thumbnail style and cache</guilabel>
  70               </term>
  71               <listitem>
  72                 <para>Thumbnails are stored in a folder hierarchy that mirrors the location of the source images. Thumbnails have the same name as the original appended by the file extension .png.</para>
  73                 <para>
  74                   The root of the hierarchy is:
  75                   <para>
  76                     <programlisting>$XDG_CACHE_HOME/geeqie/thumbnails/</programlisting>
  77                     or, if $XDG_CACHE_HOME is not defined:
  78                     <programlisting>$HOME/.cache/geeqie/thumbnails/</programlisting>
  79                   </para>
  80                 </para>
  81               </listitem>
  82             </varlistentry>
  83           </variablelist>
  84           <variablelist>
  85             <varlistentry>
  86               <term>
  87                 <guilabel>Store thumbnails local to image folder (non-standard)</guilabel>
  88               </term>
  89               <listitem>
  90                 <para>
  91                   When enabled, Geeqie attempts to store cached thumbnails closer to the source image. This way multiple users can benefit from a single cache, thereby reducing wasted disk space.
  92                   <para />
  93                   Thumbnails have the same name as the original appended by the file extension .png.
  94                   <para />
  95                   The resulting location is the source image's folder, in a sub folder with the name
  96                   <programlisting>.thumbnails</programlisting>
  97                   <para />
  98                   When the image source folder cannot be written, Geeqie falls back to saving the thumbnail in the user's home folder.
  99                 </para>
 100               </listitem>
 101             </varlistentry>
 102           </variablelist>
 103           <variablelist>
 104             <varlistentry>
 105               <term>
 106                 <guilabel>Use standard thumbnail style and cache, shared with other applications</guilabel>
 107               </term>
 108               <listitem>
 109                 <para>
 110                   This will use a thumbnail caching method that is compatible with applications that use the standard thumbnail specification. When this option is enabled thumbnails will be stored in:
 111                   <para>
 112                     <programlisting>$XDG_CACHE_HOME/thumbnails/</programlisting>
 113                     or, if $XDG_CACHE_HOME is not defined:
 114                     <programlisting>$HOME/.cache/thumbnails/</programlisting>
 115                   </para>
 116                   <para>
 117                     All thumbnails are stored in the same folder, with computer-generated filenames. Refer to
 118                     <link linkend="GuideReferenceThumbnails">Thumbnails Reference</link>
 119                     for additional details.
 120                   </para>
 121                 </para>
 122               </listitem>
 123             </varlistentry>
 124           </variablelist>
 125         </listitem>
 126       </varlistentry>
 127     </variablelist>
 128     <variablelist>
 129       <varlistentry>
 130         <term>
 131           <guilabel>Use EXIF thumbnails when available</guilabel>
 132         </term>
 133         <listitem>
 134           <para>Geeqie will extract thumbnail from EXIF data if available, instead of generating one. This will speed up thumbnails generation, but the EXIF thumbnail may be not in sync with the image if it was modified by a tool which did not also update the thumbnail data.</para>
 135         </listitem>
 136       </varlistentry>
 137     </variablelist>
 138     <variablelist>
 139       <varlistentry>
 140         <term>
 141           <guilabel>Thumbnail color management</guilabel>
 142         </term>
 143         <listitem>
 144           <para>Where possible store thumbnails with an sRGB color profile.</para>
 145             <note>
 146               <para>Selecting this option will increase the time taken to generate thumbnails.</para>
 147               <para>You probably will want to deselect the "Use EXIF thumbnails" option.</para>
 148             </note>
 149         </listitem>
 150       </varlistentry>
 151     </variablelist>
 152     <variablelist>
 153       <varlistentry>
 154         <term>
 155           <guilabel>Collection preview</guilabel>
 156         </term>
 157         <listitem>
 158           <para>
 159             If thumbnail caching is enabled and you open the
 160             <link linkend="GuideReferenceConfig">Collections folder</link>
 161             ,
 162             Geeqie will display a preview of the collections as a thumbnail montage. This option limits the number of thumbnails displayed in each preview.
 163             <note>
 164               <para>ImageMagick is required for this feature.</para>
 165             </note>
 166           </para>
 167         </listitem>
 168       </varlistentry>
 169     </variablelist>
 170   </section>
 171   <section id="StarRatingCharacters">
 172     <title>Star Rating</title>
 173     <para>The characters used to display the Star Rating are defined here. They are defined as a hexadecimal Unicode character. The complete list of Unicode characters can be found in many places on the Internet.</para>
 174   </section>
 175   <section id="Slideshow">
 176     <title>Slide show</title>
 177     <variablelist>
 178       <varlistentry>
 179         <term>
 180           <guilabel>Delay between image change</guilabel>
 181         </term>
 182         <listitem>Specifies the delay between images for slide shows, in seconds.</listitem>
 183       </varlistentry>
 184     </variablelist>
 185     <variablelist>
 186       <varlistentry>
 187         <term>
 188           <guilabel>Random</guilabel>
 189         </term>
 190         <listitem>
 191           When enabled, slide show images will appear in random order.
 192           <note>
 193             <para>Random images are displayed such that each image appears once per cycle of all images. When the slide show repeat option is enabled, the image order is randomized after completing each cycle.</para>
 194           </note>
 195         </listitem>
 196       </varlistentry>
 197     </variablelist>
 198     <variablelist>
 199       <varlistentry>
 200         <term>
 201           <guilabel>Repeat</guilabel>
 202         </term>
 203         <listitem>This will cause the slide show to loop indefinitely, it will continue with the first image after displaying the last image in the slide show list.</listitem>
 204       </varlistentry>
 205     </variablelist>
 206   </section>
 207   <section id="ImageLoadingandCaching">
 208     <title>Image loading and caching</title>
 209     <variablelist>
 210       <varlistentry>
 211         <term>
 212           <guilabel>Decoded image cache size</guilabel>
 213         </term>
 214         <listitem>
 215           <para>Limit the amount of memory available for caching images.</para>
 216         </listitem>
 217       </varlistentry>
 218       <varlistentry>
 219         <term>
 220           <guilabel>Preload next image</guilabel>
 221         </term>
 222         <listitem>
 223           <para>Enabling this option will cause Geeqie to read the next logical image from disk when idle, it will also retain the previously viewed image in memory. By reading the nearest images into memory, time to display the next image is reduced.</para>
 224           <note>
 225             <para>This option will increase Geeqie memory requirements, and may cause performance issues with very large images. If the use of Geeqie results in the system noticeably swapping memory to disk, try disabling this feature.</para>
 226           </note>
 227         </listitem>
 228       </varlistentry>
 229       <varlistentry>
 230         <term>
 231           <guilabel>Refresh on file change</guilabel>
 232         </term>
 233         <listitem>
 234           <para>Geeqie will monitor currently active images and folders for changes in their modification time, and update the display if it changes.</para>
 235           <note>
 236             <para>Disable this if the system will not go into sleep mode due to occasional disk activity from the time check, or if Geeqie updates too often for folders with continuously changing content.</para>
 237           </note>
 238         </listitem>
 239       </varlistentry>
 240     </variablelist>
 241   </section>
 242   <section id="ExpandToolbar">
 243     <title>Expand toolbar</title>
 244     <para>Expand the toolbar to the full width of the window.</para>
 245     <note>
 246       <para>Geeqie must be restarted for changes to take effect.</para>
 247     </note>
 248   </section>
 249   <section id="HideSelectableBars">
 250     <title>Hide Selectable Bars</title>
 251     <para>The menu item Hide Selectable Bars will toggle display of the bars selected here. The default keystroke for this action is <code>control + backtick</code></para>
 252     <note>
 253       <para>Geeqie must be restarted for changes to take effect.</para>
 254     </note>
 255   </section>
 256   <section id="AppImageUpdatesNotifications">
 257     <title>AppImage updates notifications</title>
 258     <para>Show a notification on start-up if the server has a newer version than the current. Requires an Internet connection. Displayed only if an AppImage is being run.</para>
 259   </section>
 260   <section id="PredefinedKeywordTree">
 261     <title>Show predefined keyword tree</title>
 262     <para>Deselecting this option will hide the list of predefined keywords on the right-hand side of the keywords pane of the info sidebar.</para>
 263     <note>
 264       <para>Geeqie must be restarted for the change to take effect.</para>
 265     </note>
 266     <variablelist />
 267   </section>
 268   <section id="TimezoneDatabase">
 269     <title>Timezone Database</title>
 270     <para>
 271       The timezone database is used to correct exif time and date for UTC offset and Daylight Saving Time as described
 272       <link linkend="GuideReferenceUTC">here.</link>
 273       This option allows you to install or update the database. An Internet connection is required.
 274     </para>
 275     <variablelist />
 276   </section>
 277   <section id="OnLineHelpSearch">
 278     <title>On-line help search</title>
 279     <para>
 280       An internet search engine may be used to search the help files on Geeqie's website. The string used to conduct the search is defined here. In most cases it will be in one of two formats:
 281       <para />
 282       <code>https://www.search-engine.com/search?q=site:geeqie.org/help</code>
 283       <para />
 284       <code>https://www.search-engine.com/?q=site:geeqie.org/help'</code>
 285     </para>
 286     <variablelist />
 287   </section>
 288 </section>