Update documentation for Fit image to window options
[geeqie.git] / doc / docbook / GuideOptionsImage.xml
1 <?xml version="1.0" encoding="utf-8"?>\r
2 <section id="GuideOptionsImage">\r
3   <title>Image Options</title>\r
4   <para>This section describes the options presented under the Image Tab of the preferences dialog.</para>\r
5   <section id="Zoom">\r
6     <title>Zoom</title>\r
7     <variablelist>\r
8       <varlistentry>\r
9         <term>\r
10           <guilabel>Quality</guilabel>\r
11         </term>\r
12         <listitem>\r
13           <para>\r
14             Selects the method used to scale the size of an image:\r
15             <variablelist>\r
16               <varlistentry>\r
17                 <term>\r
18                   <guilabel>Nearest</guilabel>\r
19                 </term>\r
20                 <listitem>\r
21                   <para>Fastest scaler, but results in poor image quality.</para>\r
22                 </listitem>\r
23               </varlistentry>\r
24               <varlistentry>\r
25                 <term>\r
26                   <guilabel>Tiles</guilabel>\r
27                 </term>\r
28                 <listitem>\r
29                   <para>Results are somewhat close to bilinear, with better speed.</para>\r
30                 </listitem>\r
31               </varlistentry>\r
32               <varlistentry>\r
33                 <term>\r
34                   <guilabel>Bilinear</guilabel>\r
35                 </term>\r
36                 <listitem>\r
37                   <para>High quality results, moderately fast.</para>\r
38                 </listitem>\r
39               </varlistentry>\r
40               <varlistentry>\r
41                 <term>\r
42                   <guilabel>Hyper</guilabel>\r
43                 </term>\r
44                 <listitem>\r
45                   <para>Slowest scaler, sometimes gives better results than bilinear.</para>\r
46                 </listitem>\r
47               </varlistentry>\r
48             </variablelist>\r
49           </para>\r
50         </listitem>\r
51       </varlistentry>\r
52       <varlistentry>\r
53         <term>\r
54           <guilabel>Use GPU acceleration via Clutter library</guilabel>\r
55         </term>\r
56         <listitem>\r
57           <para>Use alternate renderer. Geeqie must be compiled with the --enable-gpu-accel option.</para>\r
58         </listitem>\r
59       </varlistentry>\r
60       <varlistentry>\r
61         <term>\r
62           <guilabel>Two pass zooming</guilabel>\r
63         </term>\r
64         <listitem>\r
65           <para>\r
66             Enables Geeqie to first display a scaled image using the\r
67             <emphasis>Nearest</emphasis>\r
68             zoom quality. After image decoding is complete, the image is scaled again using the selected\r
69             <emphasis>Zoom Quality</emphasis>\r
70             method. This allows faster display of an image as it is decoded from the source file.\r
71           </para>\r
72         </listitem>\r
73       </varlistentry>\r
74       <varlistentry>\r
75         <term>\r
76           <guilabel>Zoom increment</guilabel>\r
77         </term>\r
78         <listitem>\r
79           <para>Adjusts the step size when zooming in or out on an image. This value corresponds to the percentage of the original image.</para>\r
80         </listitem>\r
81       </varlistentry>\r
82     </variablelist>\r
83   </section>\r
84   <section id="FitImageToWindow">\r
85     <title>Fit Image To Window</title>\r
86     <variablelist>\r
87       <varlistentry>\r
88         <term>\r
89           <guilabel>Allow enlargement of image (max. size in %)</guilabel>\r
90         </term>\r
91         <listitem>\r
92           <para>\r
93             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\r
94             <emphasis>Fit image to window</emphasis>\r
95             . This value sets the maximum expansion permitted in percent i.e. 100% is full-size.\r
96           </para>\r
97         </listitem>\r
98       </varlistentry>\r
99       <varlistentry>\r
100         <term>\r
101           <guilabel>Virtual window size (% of actual window)</guilabel>\r
102         </term>\r
103         <listitem>\r
104           <para>\r
105             This value will set the virtual size of the window when\r
106             <emphasis>Fit image to window</emphasis>\r
107             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.\r
108           </para>\r
109         </listitem>\r
110       </varlistentry>\r
111     </variablelist>\r
112   </section>\r
113   <section id="Appearance">\r
114     <title>Appearance</title>\r
115     <variablelist>\r
116       <varlistentry>\r
117         <term>\r
118           <guilabel>Custom border color</guilabel>\r
119         </term>\r
120         <listitem>\r
121           <para>Enable this to draw the image background (the area around the image) in the specified color.</para>\r
122         </listitem>\r
123       </varlistentry>\r
124     </variablelist>\r
125     <variablelist>\r
126       <varlistentry>\r
127         <term>\r
128           <guilabel>Border color</guilabel>\r
129         </term>\r
130         <listitem>\r
131           <para>Use this color chooser to define the color to use as image background.</para>\r
132           <note>\r
133             <para>\r
134               You may use the\r
135               <emphasis>Virtual window size</emphasis>\r
136               (see above) option to keep a border around the image in fullscreen mode.\r
137             </para>\r
138           </note>\r
139         </listitem>\r
140       </varlistentry>\r
141     </variablelist>\r
142     <variablelist>\r
143       <varlistentry>\r
144         <term>\r
145           <guilabel>Alpha channel color 1/2</guilabel>\r
146         </term>\r
147         <listitem>\r
148           <para>These two colors define the checkerboard background used when images with an alpha channel are displayed.</para>\r
149         </listitem>\r
150       </varlistentry>\r
151     </variablelist>\r
152   </section>\r
153   <section id="Convenience">\r
154     <title>Convenience</title>\r
155     <variablelist>\r
156       <varlistentry>\r
157         <term>\r
158           <guilabel>Auto rotate proofs using EXIF information</guilabel>\r
159         </term>\r
160         <listitem>\r
161           <para>Auto rotate images on print proof sheet.</para>\r
162         </listitem>\r
163       </varlistentry>\r
164     </variablelist>\r
165   </section>\r
166 </section>\r