Add missing link.
[geeqie.git] / doc / options_advanced.html
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4
5 <html xmlns="http://www.w3.org/1999/xhtml">
6 <head>
7   <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" />
8
9   <title>Advanced Options - Geeqie User Manual</title>
10   <link rel="stylesheet" type="text/css" href="style.css" />
11 </head>
12
13 <body lang="en-US" dir="ltr" xml:lang="en-US">
14   <div class="navtop">
15     <table width="100%" border="0" cellpadding="4" cellspacing="0">
16       <col id="navtop_col1" width="33%"></col>
17       <col id="navtop_col2" width="33%"></col>
18       <col id="navtop_col3" width="33%"></col>
19
20         <tr>
21           <th>
22             <p class="previous"><a href="options_editor_commands.html">Previous</a>
23             </p>
24           </th>
25
26           <th>
27             <p class="navtop_title">Advanced &ndash; Options Explained</p>
28           </th>
29
30           <th>
31             <p class="next"><a href="options_hidden.html">Next</a>
32             </p>
33           </th>
34         </tr>
35     </table>
36   </div>
37
38   <hr />
39
40   <h1>Advanced Options</h1>
41
42   <p>This section describes the options presented under the Advanced Tab of the preferences dialog.</p>
43
44   <h2>Full Screen</h2>
45
46   <dl class="dialog_desc">
47   <dt>Location</dt>
48   <dd><p>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.</p></dd>
49
50   <dt>Stay above other windows</dt>
51   <dd><p>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.</p></dd>
52
53   <dt>Smooth image flip</dt>
54   <dd><p>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.</p></dd>
55
56   <dt>Disable screen saver</dt>
57   <dd><p>This option will execute <i>xscreensaver-command --deactivate</i> once per minute to avoid the screen saver from activating when Geeqie is displayed full screen.</p></dd>
58   
59   </dl>
60   
61   <h2>Overlay Screen Display</h2>
62
63   <dl class="dialog_desc">
64   <dt>Always show image overlay at startup</dt>
65   <dd><p>Enable this to have the image overlay info displayed by default</p></dd>
66
67   <dt>Image overlay template</dt>
68   <dd><p>Overlay info is customizable through this template</p>
69 <p>Overlay info format string syntax is: <code>%tag[:max_length][:extra]%</code></p>
70
71 <div class="overlay_tags">
72 <table width="60%" border="1" cellpadding="2" cellspacing="0">
73 <col id="overlay_tags_col1" width="30%"></col>
74 <col id="overlay_tags_col2" width="70%"></col>
75 <tr><th>Tag</th><th>Replaced by</th></tr>
76 <tr><td>%name%</td><td>Filename of the picture</td></tr>
77 <tr><td>%collection%</td><td>Name of the collection</td></tr>
78 <tr><td>%number%</td><td>Current number of image in the list</td></tr>
79 <tr><td>%total%</td><td>Total number of images</td></tr>
80 <tr><td>%date%</td><td>File date</td></tr>
81 <tr><td>%size%</td><td>File size</td></tr>
82 <tr><td>%width%</td><td>Image width</td></tr>
83 <tr><td>%height%</td><td>Image height</td></tr>
84 <tr><td>%res%</td><td>Image resolution</td></tr>
85 <tr><td>%keywords%</td><td>Image keywords from metadata</td></tr>
86 <tr><td>%comment%</td><td>Image comment from metadata</td></tr>
87 </table>
88 </div>
89
90 <p>To access exif data use the exif name, for example: <code>%Exif.Photo.DateTimeOriginal%</code> to get the date of the original shot</p>
91
92 <p>Pre-formatted exif data is also available:</p>
93 <div class="overlay_exif">
94 <table width="60%" border="1" cellpadding="2" cellspacing="0">
95 <col id="overlay_exif_col1" width="30%"></col>
96 <col id="overlay_exif_col2" width="70%"></col>
97 <tr><th>Tag</th><th>Replaced by exif data</th></tr>
98
99 <tr><td>formatted.Camera</td><td>Camera and sofware name</td></tr>
100 <tr><td>formatted.DateTime</td><td>Image Date</td></tr>
101 <tr><td>formatted.ShutterSpeed</td><td>Shutter speed in seconds (ie. 1/60s)</td></tr>
102 <tr><td>formatted.Aperture</td><td>Aperture (ie. f5.6)</td></tr>
103 <tr><td>formatted.ExposureBias</td><td>Exposure bias (ie. +0.3)</td></tr>
104 <tr><td>formatted.ISOSpeedRating</td><td>ISO sensitivity (ie. 100)</td></tr>
105 <tr><td>formatted.FocalLength</td><td>Focal length</td></tr>
106 <tr><td>formatted.FocalLength35mmFilm</td><td>Focal length 35mm</td></tr>
107 <tr><td>formatted.SubjectDistance</td><td>Subject distance</td></tr>
108 <tr><td>formatted.Flash</td><td>Flash</td></tr>
109 <tr><td>formatted.Resolution</td><td>Resolution</td></tr>
110 <tr><td>formatted.ColorProfile</td><td>Color profile</td></tr>
111 </table>
112 </div>
113
114 <p>
115   You can limit the length of displayed data using :number notation:
116   <code>%formatted.Camera:20%</code> will truncate the displayed data to 20 characters
117   and will add 3 dots at the end to denote the truncation.</p>
118
119 <p>
120   If two or more variables are connected with the |-sign, it prints available
121   variables with a separator:<br />
122   <code>%formatted.ShutterSpeed%|%formatted.ISOSpeedRating%|%formatted.FocalLength%</code><br />
123   could show:<br />
124     "1/20s - 400 - 80 mm"<br />
125   or<br />
126     "1/200 - 80 mm" if there's no ISO information in the Exif data.<br />
127 </p>
128
129 <p>
130   If a line is empty, it is removed.
131   This allows to add lines that totally disappear when no data is available.
132 </p>
133
134 <p>
135   Extra string uses special character '*' to mark the position of the data.
136   If no '*' is present, then extra string is just appended to data.
137   Any "\n" is replaced by a newline on display.
138   Pango mark up is accepted in left and right parts.
139   If data is empty, nothing will be displayed.
140 </p>
141
142 <p>Examples:</p>
143   <dl class="examples">
144   <dt><code>%name:&lt;i&gt;*&lt;/i&gt;\n%</code></dt><dd>name is displayed in italics ended with a newline</dd>
145   <dt><code>%size:\n%</code></dt><dd>size is displayed with a newline at end</dd>
146   <dt><code>%formatted.ISOSpeedRating:ISO *%</code></dt><dd>ie. "ISO 100"</dd>
147   <dt><code>Collection &lt;b&gt;*&lt;/b&gt;\n</code></dt><dd>display collection name in bold prefixed by "Collection " and a newline is appended</dd>
148   </dl>
149   
150   </dd>
151   
152   <dt>Help button</dt>
153   <dd><p>Show syntax help</p></dd>
154
155   <dt>Defaults button</dt>
156   <dd><p>Restore default image overlay template</p></dd> 
157   
158   </dl>
159
160   
161
162   <h2>Delete</h2>
163
164   <dl class="dialog_desc">
165   <dt>Confirm file delete</dt>
166   <dd><p>Prompts for confirmation before deleting files.</p></dd>
167
168   <dt>Enable Delete key</dt>
169   <dd><p>Disable this to disassociate the delete file function from the Delete key. This option does not effect the [Control] + D key sequence. May be useful in combination with &ldquo;confirm file delete&rdquo;, above, disabled so that accidentally hitting a single key will not result in deleted files.</p></dd>
170
171   <dt>Safe Delete</dt>
172   <dd><p>Moves deleted files to a temporary folder, for easy retrieval of deleted files. Files in the temporary folder are retained until the maximum size is reached, at which point deleting additional files will result in the removal of the oldest files to reclaim the space needed for the new files.</p>
173   <p class="note"><span class="note_label">Note:</span> Files moved to the Safe Delete folder are prefixed with a six digit number in the format: <code>nnnnnn_FILENAME</code><br />
174   This is used by the delete feature to distinguish which files to remove first when clearing space for new files.<br />
175   The digit counter increments with each deleted file.</p></dd>
176
177   <dt>Folder</dt>
178   <dd><p>The location of the folder used by the Safe Delete feature.</p></dd>
179
180   <dt>Maximum size</dt>
181   <dd><p>The size to use for the Safe Delete folder, in megabytes.</p></dd>
182
183   <dt>Clear button</dt>
184   <dd><p>Removes all files contained in the Safe Delete folder.</p></dd>
185
186   <dt>View button</dt>
187   <dd><p>Changes the Geeqie main window to display the contents of the Safe Delete folder.</p></dd>
188   
189   </dl>
190   
191   <h2>Behavior</h2>
192
193   <dl class="dialog_desc">
194   <dt>Rectangular selection in icon view</dt>
195   <dd><p> Enable this to change the selection method used when selecting multiple items in an icon view.</p></dd>
196
197   <dt>Descend folders in tree view</dt>
198   <dd>
199   <p>This will allow Geeqie to read sub folder content to determine if it should display expander indicators in the folder tree view.</p>
200   <p class="note"><span class="note_label">Note:</span> Disable this if Geeqie wakes up auto mounted network shares, or takes too long to initially display the folder view.</p>
201   </dd>
202   <dt>In place renaming</dt>
203   <dd><p>When renaming a single file, this will allow the rename entry to appear directly over the original filename.</p></dd>
204
205   </dl>
206
207   <h2>Navigation</h2>
208
209   <dl class="dialog_desc">
210   <dt>Progressive keyboard scrolling</dt>
211   <dd><p>This will cause image panning speed to gradually accelerate when holding down the keyboard arrows.</p></dd>
212
213   <dt>Mouse wheel scrolls image</dt>
214   <dd><p>The default is for the mouse wheel to change the image, and to scroll the image when shift is used in combination with the wheel. Enabling this swaps the behavior so that operating the wheel will scroll the image, and holding down shift will change the image.</p></dd>
215   </dl>
216
217   <h2>Miscellaneous</h2>
218
219   <dl class="dialog_desc">
220
221   <dt>Store keywords and comments local to source images</dt>
222   <dd><p> When enabled, Geeqie attempts to store metadata such as keywords closer to the source image. The resulting location is the source image's folder, in a sub folder with the name "<em>.metadata"</em>. When the image source folder cannot be written, Geeqie falls back to saving the medata in "$HOME/.geeqie/metadata".</p></dd>
223
224   <dt>Custom similarity threshold</dt>
225   <dd><p>This setting is used by the compare method &ldquo;similarity (custom)&rdquo;, located in the Find Duplicates window.</p></dd>
226
227   <dt>Offscreen cache size</dt>
228   <dd><p>Geeqie only renders the visible portion of an image. To reduce rendering the same area frequently when panning an image, some memory is used to retain the recently rendered image data. This value controls the maximum amount of memory to use.</p>
229   <p class="note"><span class="note_label">Note:</span> This setting controls the amount of memory for <em>each</em> image window.</p>
230   </dd>
231
232   </dl>
233   <hr id="bottomseparator" />
234
235   <div class="navbottom">
236     <table width="100%" border="0" cellpadding="4" cellspacing="0">
237       <col id="navbottom_col1" width="33%"></col>
238       <col id="navbottom_col2" width="33%"></col>
239       <col id="navbottom_col3" width="33%"></col>
240
241         <tr>
242           <th>
243             <p class="previous"><a href="options_editor_commands.html">Previous</a>
244             </p>
245           </th>
246
247           <th>
248             <p class="navbottom_title"><a href="index.html">Contents</a>
249             </p>
250           </th>
251
252           <th>
253             <p class="next"><a href="options_hidden.html">Next</a>
254             </p>
255           </th>
256         </tr>
257
258     </table>
259   </div>
260
261   <div class="footer">Geeqie User Manual</div>
262   <div class="bottomspacer">&nbsp;</div>
263 </body>
264 </html>