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