Configuration options and documentation
[geeqie.git] / doc / docbook / GuideOptionsImage.xml
1 <?xml version="1.0" encoding="utf-8"?>
2 <section id="GuideOptionsImage">
3     <title>
4       Image Options
5     </title>
6     <para>
7       This section describes the options presented under the Image Tab of the preferences dialog.
8     </para>
9     <para/><section id="Zoom"><title>
10       Zoom
11     </title>
12
13     <variablelist><varlistentry><term>
14         Quality
15       </term><listitem><para>
16        Selects the method used to scale the size of an image.
17       </para></listitem></varlistentry><varlistentry><term>
18         Nearest
19       </term><listitem><para>
20         Fastest scaler, but results in poor image quality.
21       </para></listitem></varlistentry><varlistentry><term>
22         Tiles
23       </term><listitem><para>
24         Results are somewhat close to bilinear, with better speed.
25       </para></listitem></varlistentry><varlistentry><term>
26         Bilinear
27       </term><listitem><para>
28         High quality results, moderately fast.
29       </para></listitem></varlistentry><varlistentry><term>
30         Hyper
31       </term><listitem><para>
32         Slowest scaler, sometimes gives better results than bilinear.
33       </para></listitem></varlistentry><varlistentry><term>
34        Use GPU acceleration via Clutter library
35        </term><listitem><para>
36        Use alternate renderer. Geeqie must be compiled with the --enable-gpu-accel option.
37       </para></listitem></varlistentry><varlistentry><term>
38        Two pass zooming
39        </term><listitem><para>
40        Enables Geeqie to first display a scaled image using the nearest zoom quality. After image decoding is complete, the image is scaled again using the selected “Zoom (scaling)” method. This allows faster display of an image as it is decoded from the source file.
41       </para></listitem></varlistentry><varlistentry><term>
42         Allow enlargement of image for zoom to fit
43       </term><listitem><para>
44         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 “Fit to Window”.
45       </para></listitem></varlistentry><varlistentry><term>
46         Limit image size when autofitting
47       </term><listitem><para>
48       This percentage will affect the size of the image when Fit image to window is set, instead of using 100% of the window, it will use the specified percentage. 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.
49       </para></listitem></varlistentry><varlistentry><term>
50         Zoom increment
51       </term><listitem><para>
52       Adjusts the step size when zooming in or out on an image. This value corresponds to the percentage of the original image.
53     </para></listitem></varlistentry></variablelist>
54     <para/></section><section id="Zoomcontrol"><title>
55       Zoom control
56     </title>
57     <variablelist><varlistentry><term>
58         When new image is selected
59       </term><listitem><para/></listitem></varlistentry></variablelist>
60     <para>
61       This controls the behavior of the zoom setting when changing the displayed image.
62     </para>
63     <variablelist><varlistentry><term>
64         Zoom to original size
65       </term><listitem><para>
66         The new image is set to it's original size.
67       </para></listitem></varlistentry><varlistentry><term>
68         Fit image to window
69       </term><listitem><para>
70         The new image's zoom is changed so that the image will fit within the current view area.
71       </para></listitem></varlistentry><varlistentry><term>
72         Leave zoom at previous setting
73       </term><listitem><para>
74         The zoom setting is unchanged, the new image will be scaled the same as the previous image.
75       </para></listitem></varlistentry></variablelist>
76     <para/></section><section id="Scrollcontrol"><title>
77       Scroll control
78     </title>
79     <variablelist><varlistentry><term>
80         Scroll reset method
81       </term><listitem><para/></listitem></varlistentry></variablelist>
82     <para>
83       This controls the scroll initial position when changing the displayed image.
84     </para>
85     <variablelist><varlistentry><term>
86         Top left
87       </term><listitem><para>
88         The new image is displayed from top left corner.
89       </para></listitem></varlistentry><varlistentry><term>
90         Center
91       </term><listitem><para>
92         The new image is centered
93       </para></listitem></varlistentry><varlistentry><term>
94         No change
95       </term><listitem><para>
96         The new image is positionned as the previous one, whenever possible.
97       </para></listitem></varlistentry></variablelist>
98     <para/></section><section id="Appearance"><title>
99       Appearance
100     </title>
101     <variablelist><varlistentry><term>
102         Custom border color
103       </term><listitem><para/></listitem></varlistentry></variablelist>
104     <para>
105       Enable this to draw the image background (the area around the image) in the specified color.
106     </para>
107     <variablelist><varlistentry><term>
108         Border color
109       </term><listitem><para/></listitem></varlistentry></variablelist>
110     <para>
111       Use this color chooser to define the color to use as image background.
112     </para>
113     <para>
114       Note: You may use Limit image size when autofitting option to keep a border around the image in fullscreen mode.
115     </para>
116     <para/></section><section id="Convenience"><title>
117       Convenience
118     </title>
119     <variablelist><varlistentry><term>
120         Refresh on file change
121       </term><listitem><para/></listitem></varlistentry></variablelist>
122     <para>
123       Geeqie will monitor currently active images and folders for changes in their modification time, and update the display if it changes.
124     </para>
125     <para>
126       Note: 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.
127     </para>
128     <variablelist><varlistentry><term>
129         Preload next image
130       </term><listitem><para/></listitem></varlistentry></variablelist>
131     <para>
132       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.
133     </para>
134     <para>
135       Note: 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.
136     </para>
137     <variablelist><varlistentry><term>
138         Auto rotate image using EXIF information
139       </term><listitem><para/></listitem></varlistentry></variablelist>
140     <para>
141       Auto rotates images based on data stored in images that include EXIF data.
142     </para>
143   <para/></section></section>