Send stacktrace data also to a /tmp file
[geeqie.git] / doc / docbook / GuideOptionsImage.xml
1 <?xml version="1.0" encoding="utf-8"?>
2 <section id="GuideOptionsImage">
3   <title>Image Options</title>
4   <para>This section describes the options presented under the Image Tab of the preferences dialog.</para>
5   <section id="Zoom">
6     <title>Zoom</title>
7     <variablelist>
8       <varlistentry>
9         <term>
10           <guilabel>Quality</guilabel>
11         </term>
12         <listitem>
13           <para>
14             Selects the method used to scale the size of an image:
15             <variablelist>
16               <varlistentry>
17                 <term>
18                   <guilabel>Nearest</guilabel>
19                 </term>
20                 <listitem>
21                   <para>Fastest scaler, but results in poor image quality.</para>
22                 </listitem>
23               </varlistentry>
24               <varlistentry>
25                 <term>
26                   <guilabel>Tiles</guilabel>
27                 </term>
28                 <listitem>
29                   <para>Results are somewhat close to bilinear, with better speed.</para>
30                 </listitem>
31               </varlistentry>
32               <varlistentry>
33                 <term>
34                   <guilabel>Bilinear</guilabel>
35                 </term>
36                 <listitem>
37                   <para>High quality results, moderately fast.</para>
38                 </listitem>
39               </varlistentry>
40             </variablelist>
41           </para>
42         </listitem>
43       </varlistentry>
44       <varlistentry>
45         <term>
46           <guilabel>Two pass zooming</guilabel>
47         </term>
48         <listitem>
49           <para>
50             Enables Geeqie to first display a scaled image using the
51             <emphasis>Nearest</emphasis>
52             zoom quality. After image decoding is complete, the image is scaled again using the selected
53             <emphasis>Zoom Quality</emphasis>
54             method. This allows faster display of an image as it is decoded from the source file.
55           </para>
56         </listitem>
57       </varlistentry>
58       <varlistentry>
59         <term>
60           <guilabel>Zoom increment</guilabel>
61         </term>
62         <listitem>
63           <para>Adjusts the step size when zooming in or out on an image.</para>
64         </listitem>
65       </varlistentry>
66       <varlistentry>
67         <term>
68           <guilabel>Zoom style</guilabel>
69         </term>
70         <listitem>
71           <para>Selects whether the zoom step size is applied as a geometric (n * step) or arithmetic (n + step) factor.</para>
72         </listitem>
73       </varlistentry>
74     </variablelist>
75   </section>
76   <section id="FitImageToWindow">
77     <title>Fit Image To Window</title>
78     <variablelist>
79       <varlistentry>
80         <term>
81           <guilabel>Allow enlargement of image (max. size in %)</guilabel>
82         </term>
83         <listitem>
84           <para>
85             Enable this to allow Geeqie to increase the image size for images that are smaller than the current view area when the zoom is set to
86             <emphasis>Fit image to window</emphasis>
87             . This value sets the maximum expansion permitted in percent i.e. 100% is full-size.
88           </para>
89         </listitem>
90       </varlistentry>
91       <varlistentry>
92         <term>
93           <guilabel>Virtual window size (% of actual window)</guilabel>
94         </term>
95         <listitem>
96           <para>
97             This value will set the virtual size of the window when
98             <emphasis>Fit image to window</emphasis>
99             is set. Instead of using the actual size of the window, the specified percentage of the window will be used. It allows one to keep a border around the image (values lower than 100%) or to auto zoom the image (values greater than 100%). It affects fullscreen mode too.
100           </para>
101         </listitem>
102       </varlistentry>
103     </variablelist>
104   </section>
105   <section id="TileSize">
106     <title>Tile Size</title>
107     <variablelist>
108       <varlistentry>
109         <term>
110           <guilabel>Tile size in pixels</guilabel>
111         </term>
112         <listitem>
113           <para>
114             This option is only available when GPU acceleration is not selected. It sets the size in pixels that large images are split into during rendering. Setting a larger value will reduce the tiling effect seen as the image is displayed, but will also slightly increase the delay until the first part of the image is seen.
115           </para>
116         </listitem>
117       </varlistentry>
118     </variablelist>
119   </section>
120   <section id="Appearance">
121     <title>Appearance</title>
122     <variablelist>
123       <varlistentry>
124         <term>
125           <guilabel>Custom border color</guilabel>
126         </term>
127         <listitem>
128           <para>Enable this to draw the image background (the area around the image) in the specified color.</para>
129         </listitem>
130       </varlistentry>
131     </variablelist>
132     <variablelist>
133       <varlistentry>
134         <term>
135           <guilabel>Border color</guilabel>
136         </term>
137         <listitem>
138           <para>Use this color chooser to define the color to use as image background.</para>
139           <note>
140             <para>
141               You may use the
142               <emphasis>Virtual window size</emphasis>
143               (see above) option to keep a border around the image in fullscreen mode.
144             </para>
145           </note>
146         </listitem>
147       </varlistentry>
148     </variablelist>
149     <variablelist>
150       <varlistentry>
151         <term>
152           <guilabel>Alpha channel color 1/2</guilabel>
153         </term>
154         <listitem>
155           <para>These two colors define the checkerboard background used when images with an alpha channel are displayed.</para>
156         </listitem>
157       </varlistentry>
158     </variablelist>
159   </section>
160 </section>