Eliminate some GitHub action warnings
[geeqie.git] / doc / docbook / GuideOptionsWindow.xml
1 <?xml version="1.0" encoding="utf-8"?>
2 <section id="GuideOptionsWindow">
3   <title>Window Options</title>
4   <para>This section describes the options presented under the Windows Tab of the preferences dialog.</para>
5   <section id="State">
6     <title>State</title>
7     <variablelist>
8       <varlistentry>
9         <term>
10           <guilabel>Remember session</guilabel>
11         </term>
12         <listitem>
13           <para>This will maintain windows size and position between Geeqie sessions.</para>
14         </listitem>
15       </varlistentry>
16     </variablelist>
17     <variablelist>
18       <varlistentry>
19         <term>
20           <guilabel>Use saved window positions also for new windows</guilabel>
21         </term>
22         <listitem>
23           <para>
24             A new window opened by menu
25             <menuchoice>
26               <shortcut>
27                 <keycombo>
28                   <keycap>Ctrl</keycap>
29                   <keycap>N</keycap>
30                 </keycombo>
31               </shortcut>
32               <guimenu>File</guimenu>
33               <guimenuitem>New Window</guimenuitem>
34             </menuchoice>
35             will use the saved window positions also.
36           </para>
37         </listitem>
38       </varlistentry>
39     </variablelist>
40     <variablelist>
41       <varlistentry>
42         <term>
43           <guilabel>Remember window workspace</guilabel>
44         </term>
45         <listitem>
46           <para>
47             Remember which workspace a window was displayed in.
48           </para>
49         </listitem>
50       </varlistentry>
51     </variablelist>
52     <variablelist>
53       <varlistentry>
54         <term>
55           <guilabel>Remember tool state</guilabel>
56         </term>
57         <listitem>
58           <para>
59             Maintains the selection set by
60             <menuchoice>
61               <shortcut>
62                 <keycombo>
63                   <keycap>L</keycap>
64                 </keycombo>
65               </shortcut>
66               <guimenu>View</guimenu>
67               <guimenuitem>File and Folders</guimenuitem>
68               <guimenuitem>Float File List</guimenuitem>
69             </menuchoice>
70           </para>
71         </listitem>
72       </varlistentry>
73     </variablelist>
74     <variablelist>
75       <varlistentry>
76         <term>
77           <guilabel>Remember dialog window positions</guilabel>
78         </term>
79         <listitem>
80           <para>This will maintain dialog windows size and position between Geeqie sessions.</para>
81         </listitem>
82       </varlistentry>
83     </variablelist>
84     <variablelist>
85       <varlistentry>
86         <term>
87           <guilabel>Hide window decorations</guilabel>
88         </term>
89         <listitem>
90           <para>
91             By default, windows are decorated with a title bar, resize controls, etc. If this option is selected, some window managers may be able to disable these decorations, creating a borderless window.
92           </para>
93         </listitem>
94       </varlistentry>
95     </variablelist>
96     <variablelist>
97       <varlistentry>
98         <term>
99           <guilabel>Show window IDs</guilabel>
100         </term>
101         <listitem>
102           <para>
103             Show the window ID in the titlebar of each window. When multiple Geeqie windows are opened, this option shows a unique identifier for each window. It may be used in conjunction with the command line option:
104             <link linkend="GuideReferenceCommandLine">
105               <programlisting>--remote --id:&lt;ID&gt;</programlisting>
106             </link>
107           </para>
108         </listitem>
109       </varlistentry>
110     </variablelist>
111     <variablelist>
112       <varlistentry>
113         <term>
114           <guilabel>Use current layout for default</guilabel>
115         </term>
116         <listitem>
117           <para>
118             Press the <code>Set</code> button to store the current window layout for use as the default for all new windows.
119           </para>
120         </listitem>
121       </varlistentry>
122     </variablelist>
123   </section>
124   <section id="Size">
125     <title>Size</title>
126     <variablelist>
127       <varlistentry>
128         <term>
129           <guilabel>Fit window to image when tools are hidden/floating</guilabel>
130         </term>
131         <listitem>
132           <para>The main window will be resized to accommodate each image's size and proportions when the image pane is the only one visible within the window.</para>
133         </listitem>
134       </varlistentry>
135     </variablelist>
136     <variablelist>
137       <varlistentry>
138         <term>
139           <guilabel>Limit size when auto-sizing window</guilabel>
140         </term>
141         <listitem>
142           <para>This will restrict the maximum size a window can grow to automatically fit an image. The value represents the percentage of the desktop size in width and height.</para>
143         </listitem>
144       </varlistentry>
145     </variablelist>
146   </section>
147   <section id="FullScreen">
148     <title>Full Screen</title>
149     <variablelist>
150       <varlistentry>
151         <term>
152           <guilabel>Location</guilabel>
153         </term>
154         <listitem>
155           <para>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.</para>
156         </listitem>
157       </varlistentry>
158     </variablelist>
159     <variablelist>
160       <varlistentry>
161         <term>
162           <guilabel>Smooth image flip</guilabel>
163         </term>
164         <listitem>
165           <para>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.</para>
166         </listitem>
167       </varlistentry>
168     </variablelist>
169     <variablelist>
170       <varlistentry>
171         <term>
172           <guilabel>Disable screen saver</guilabel>
173         </term>
174         <listitem>
175           <para>
176             This option will execute
177             <emphasis role="i">xscreensaver-command --deactivate</emphasis>
178             once per minute to avoid the screen saver from activating when Geeqie is displayed full screen.
179           </para>
180         </listitem>
181       </varlistentry>
182     </variablelist>
183   </section>
184 </section>