doc/docbook/GuideOptionsWindow.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <section id="GuideOptionsWindow">
   3     <title>
   4       Window Options
   5     </title>
   6     <para>
   7       This section describes the options presented under the Windows Tab of the preferences dialog.
   8     </para>
   9     <para/><section id="State"><title>
  10       State
  11     </title>
  12     <variablelist><varlistentry><term>
  13         Remember window positions
  14       </term><listitem><para/></listitem></varlistentry></variablelist>
  15     <para>
  16       This will maintain windows size and position between Geeqie sessions.
  17     </para>
  18     <variablelist><varlistentry><term>
  19         Remember tool state
  20       </term><listitem><para/></listitem></varlistentry></variablelist>
  21     <para>
  22       This will maintain the tool window state between Geeqie sessions.
  23     </para>
  24     <para/></section><section id="Size"><title>
  25       Size
  26     </title>
  27     <variablelist><varlistentry><term>
  28         Fit window to image when tools are hidden/floating
  29       </term><listitem><para/></listitem></varlistentry></variablelist>
  30     <para>
  31       The main window will be resized to accommodate each image's size and proportions when the image pane is the only one visible within the window.
  32     </para>
  33     <variablelist><varlistentry><term>
  34         Limit size when auto-sizing window
  35       </term><listitem><para/></listitem></varlistentry></variablelist>
  36     <para>
  37       This will restrict the maximum size a window can grow to automatically fit an image. The value represents the percentage of the desktop size in width and height.
  38     </para>
  39     <para/></section><section id="FullScreen"><title>
  40       Full Screen
  41     </title>
  42     <variablelist><varlistentry><term>
  43         Location
  44       </term><listitem><para/></listitem></varlistentry></variablelist>
  45     <para>
  46       Selects the location and position of the full screen window. 'Determined by window manager' will leave the window placement up to the window manager. 'Active screen' places the window on the same screen as the Geeqie main window. 'Active monitor' does the same, but limits the full screen window size to the monitor containing the main window. The remaining choices are dependent on the multiple monitor configuration.
  47     </para>
  48     <variablelist><varlistentry><term>
  49         Stay above other windows
  50       </term><listitem><para/></listitem></varlistentry></variablelist>
  51     <para>
  52       Enable this to have Geeqie ask the window manager to keep the full screen window above other windows. Note that the window manager may ignore the request. This option is not relevant when the full screen location is determined by the window manager.
  53     </para>
  54     <variablelist><varlistentry><term>
  55         Smooth image flip
  56       </term><listitem><para/></listitem></varlistentry></variablelist>
  57     <para>
  58       This option delays the image change in full screen until the next image is entirely decoded into memory, the result is a smoother transition between images.
  59     </para>
  60     <variablelist><varlistentry><term>
  61         Disable screen saver
  62       </term><listitem><para/></listitem></varlistentry></variablelist>
  63     <para>
  64       This option will execute <emphasis role="i">xscreensaver-command --deactivate</emphasis> once per minute to avoid the screen saver from activating when Geeqie is displayed full screen.
  65     </para>
  66     <para/></section><section id="OverlayScreenDisplay"><title>
  67       Overlay Screen Display
  68     </title>
  69     <variablelist><varlistentry><term>
  70         Always show image overlay at startup
  71       </term><listitem><para/></listitem></varlistentry></variablelist>
  72     <para>
  73       Enable this to have the image overlay info displayed by default
  74     </para>
  75     <variablelist><varlistentry><term>
  76         Image overlay template
  77       </term><listitem><para/></listitem></varlistentry></variablelist>
  78     <para>
  79       Overlay info is customizable through this template
  80     </para>
  81     <para>
  82       Overlay info format string syntax is: <literal>%tag[:max_length][:extra]%</literal>
  83     </para>
  84     <informaltable><tgroup cols="2"><tbody><row><entry>
  85           Tag
  86         </entry><entry>
  87           Replaced by
  88         </entry></row>
  89 <row><entry>
  90           name
  91         </entry><entry>
  92           Filename of the picture
  93         </entry></row>
  94 <row><entry>
  95           collection
  96         </entry><entry>
  97           Name of the collection
  98         </entry></row>
  99 <row><entry>
 100           number
 101         </entry><entry>
 102           Current number of image in the list
 103         </entry></row>
 104 <row><entry>
 105           total
 106         </entry><entry>
 107           Total number of images
 108         </entry></row>
 109 <row><entry>
 110           date
 111         </entry><entry>
 112           File date
 113         </entry></row>
 114 <row><entry>
 115           size
 116         </entry><entry>
 117           File size
 118         </entry></row>
 119 <row><entry>
 120           width
 121         </entry><entry>
 122           Image width
 123         </entry></row>
 124 <row><entry>
 125           height
 126         </entry><entry>
 127           Image height
 128         </entry></row>
 129 <row><entry>
 130           res
 131         </entry><entry>
 132           Image resolution
 133         </entry></row>
 134 <row><entry>
 135           keywords
 136         </entry><entry>
 137           Image keywords from metadata
 138         </entry></row>
 139 <row><entry>
 140           comment
 141         </entry><entry>
 142           Image comment from metadata
 143         </entry></row>
 144 </tbody></tgroup></informaltable>
 145     <para>
 146       To access exif data use the exif name, for example: <literal>%Exif.Photo.DateTimeOriginal%</literal> to get the date of the original shot
 147     </para>
 148     <para>
 149       Pre-formatted exif data is also available:
 150     </para>
 151     <informaltable><tgroup cols="2"><tbody><row><entry>
 152           Tag
 153         </entry><entry>
 154           Replaced by exif data
 155         </entry></row>
 156 <row><entry>
 157           formatted.Camera
 158         </entry><entry>
 159           Camera and sofware name
 160         </entry></row>
 161 <row><entry>
 162           formatted.<ulink url="/wiki/DateTime">DateTime?</ulink>
 163         </entry><entry>
 164           Image Date
 165         </entry></row>
 166 <row><entry>
 167           formatted.<ulink url="/wiki/ShutterSpeed">ShutterSpeed?</ulink>
 168         </entry><entry>
 169           Shutter speed in seconds (ie. 1/60s)
 170         </entry></row>
 171 <row><entry>
 172           formatted.Aperture
 173         </entry><entry>
 174           Aperture (ie. f5.6)
 175         </entry></row>
 176 <row><entry>
 177           formatted.<ulink url="/wiki/ExposureBias">ExposureBias?</ulink>
 178         </entry><entry>
 179           Exposure bias (ie. +0.3)
 180         </entry></row>
 181 <row><entry>
 182           formatted.ISOSpeedRating
 183         </entry><entry>
 184           ISO sensitivity (ie. 100)
 185         </entry></row>
 186 <row><entry>
 187           formatted.<ulink url="/wiki/FocalLength">FocalLength?</ulink>
 188         </entry><entry>
 189           Focal length
 190         </entry></row>
 191 <row><entry>
 192           formatted.<ulink url="/wiki/FocalLength">FocalLength?</ulink>35mmFilm
 193         </entry><entry>
 194           Focal length 35mm
 195         </entry></row>
 196 <row><entry>
 197           formatted.<ulink url="/wiki/SubjectDistance">SubjectDistance?</ulink>
 198         </entry><entry>
 199           Subject distance
 200         </entry></row>
 201 <row><entry>
 202           formatted.Flash
 203         </entry><entry>
 204           Flash
 205         </entry></row>
 206 <row><entry>
 207           formatted.Resolution
 208         </entry><entry>
 209           Resolution
 210         </entry></row>
 211 <row><entry>
 212           formatted.<ulink url="/wiki/ColorProfile">ColorProfile?</ulink>
 213         </entry><entry>
 214           Color profile
 215         </entry></row>
 216 </tbody></tgroup></informaltable>
 217     <para>
 218       You can limit the length of displayed data using :number notation: <literal>%formatted.Camera:20%</literal> will truncate the displayed data to 20 characters and will add 3 dots at the end to denote the truncation.
 219     </para>
 220     <para>
 221       If two or more variables are connected with the -sign, it prints available variables with a separator:<?db2html element="br"?>
 222       <literal>%formatted.ShutterSpeed% %formatted.ISOSpeedRating% %formatted.FocalLength%</literal><?db2html element="br"?>
 223       could show:<?db2html element="br"?>
 224       "1/20s - 400 - 80 mm"<?db2html element="br"?>
 225       or<?db2html element="br"?>
 226       "1/200 - 80 mm" if there's no ISO information in the Exif data.<?db2html element="br"?>
 227     </para>
 228     <para>
 229       If a line is empty, it is removed. This allows one to add lines that totally disappear when no data is available.
 230     </para>
 231     <para>
 232       Extra string uses special character '*' to mark the position of the data. If no '*' is present, then extra string is just appended to data. Any "\n" is replaced by a newline on display. Pango mark up is accepted in left and right parts. If data is empty, nothing will be displayed.
 233     </para>
 234     <para>
 235       Examples:
 236     </para>
 237     <variablelist><varlistentry><term>
 238         <literal>%name:&amp;lt;i&amp;gt;*&amp;lt;/i&amp;gt;\n%</literal>
 239       </term><listitem><para>
 240         name is displayed in italics ended with a newline
 241       </para></listitem></varlistentry><varlistentry><term>
 242         <literal>%size:\n%</literal>
 243       </term><listitem><para>
 244         size is displayed with a newline at end
 245       </para></listitem></varlistentry><varlistentry><term>
 246         <literal>%formatted.ISOSpeedRating:ISO *%</literal>
 247       </term><listitem><para>
 248         ie. "ISO 100"
 249       </para></listitem></varlistentry><varlistentry><term>
 250         <literal>Collection &amp;lt;b&amp;gt;*&amp;lt;/b&amp;gt;\n</literal>
 251       </term><listitem><para>
 252         display collection name in bold prefixed by "Collection " and a newline is appended
 253       </para></listitem></varlistentry></variablelist>
 254     <variablelist><varlistentry><term>
 255         Help button
 256       </term><listitem><para/></listitem></varlistentry></variablelist>
 257     <para>
 258       Show syntax help
 259     </para>
 260     <variablelist><varlistentry><term>
 261         Defaults button
 262       </term><listitem><para/></listitem></varlistentry></variablelist>
 263     <para>
 264       Restore default image overlay template
 265     </para>
 266   <para/></section></section>