Changeset View
Changeset View
Standalone View
Standalone View
doc/index.docbook
Show First 20 Lines • Show All 109 Lines • ▼ Show 20 Line(s) | 96 | <chapter id="using"> | |||
---|---|---|---|---|---|
110 | <para>&spectacle; grabs an image of your entire desktop immediately after it is started, but before it displays itself on screen. This allows you to quickly create full-desktop screenshot images.</para> | 110 | <para>&spectacle; grabs an image of your entire desktop immediately after it is started, but before it displays itself on screen. This allows you to quickly create full-desktop screenshot images.</para> | ||
111 | 111 | | |||
112 | <para>The snapshot taken by &spectacle; is displayed in the preview window, which is located on the left-hand side of the &spectacle; application window.</para> | 112 | <para>The snapshot taken by &spectacle; is displayed in the preview window, which is located on the left-hand side of the &spectacle; application window.</para> | ||
113 | 113 | | |||
114 | <para>The image can be saved to a location of your choice by clicking on the <guibutton>Save As</guibutton> button or typing <keycombo action="simul">&Ctrl;&Shift;<keycap>S</keycap></keycombo>. This opens the standard save dialog, where you can choose the filename, the folder location, and the format that your screenshot will be saved in. You may edit the filename to anything you wish, including the name of a previously saved screenshot.</para> | 114 | <para>The image can be saved to a location of your choice by clicking on the <guibutton>Save As</guibutton> button or typing <keycombo action="simul">&Ctrl;&Shift;<keycap>S</keycap></keycombo>. This opens the standard save dialog, where you can choose the filename, the folder location, and the format that your screenshot will be saved in. You may edit the filename to anything you wish, including the name of a previously saved screenshot.</para> | ||
115 | 115 | | |||
116 | <para>To save a screenshot to the default location, click on the arrow portion of the <guibutton>Save As...</guibutton> button and press the <guimenuitem>Save </guimenuitem> (<keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo>) button. The new save mode will be remembered for next time; this behavior can be configured in Spectacle's settings. The default save location and filename can also be configured there, as described later.</para> | 116 | <para>To save a screenshot to the default location, click on the arrow portion of the <guibutton>Save As...</guibutton> button and press the <guimenuitem>Save </guimenuitem> (<keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo>) button. The new save mode will be remembered for next time; this behavior can be configured in Spectacle's settings. The default save location and filename can also be configured there, as described later.</para> | ||
117 | 117 | | |||
118 | <para>To quickly save the image and quit &spectacle;, click on the arrow portion of the <guibutton>Save As...</guibutton> button and press the <guimenuitem>Save & Exit</guimenuitem> (<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>) item. This saves the image as a PNG file in your default Pictures folder, and exits the application immediately. As above, this new save mode will be remembered.</para> | 118 | <para>To quickly save the image and quit &spectacle;, click on the checkbox beside <guilabel>Quit after Save or Copy</guilabel>, then click the arrow portion of the <guibutton>Save As...</guibutton> button and press the <guimenuitem>Save</guimenuitem> (<keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo>) item. This saves the image as a PNG file in your default Pictures folder, and exits the application immediately. As above, this new save mode will be remembered.</para> | ||
119 | 119 | | |||
120 | <sect1 id="taking-screenshot"> | 120 | <sect1 id="taking-screenshot"> | ||
121 | <title>Taking A Screenshot</title> | 121 | <title>Taking A Screenshot</title> | ||
122 | 122 | | |||
123 | <para>When you open spectacle, it immediately takes a screenshot of the whole screen as a convenience and shows a preview of it in the main window. You can save this screenshot using the buttons on the bottom of the window, or take a new one using the controls to the right of the preview.</para> | 123 | <para>When you open spectacle, it immediately takes a screenshot of the whole screen as a convenience and shows a preview of it in the main window. You can save this screenshot using the buttons on the bottom of the window, or take a new one using the controls to the right of the preview.</para> | ||
124 | 124 | | |||
125 | <para>To discard the current screenshot and take another screenshot, press the <guibutton>Take a New Screenshot</guibutton> (<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>) button.</para> | 125 | <para>To discard the current screenshot and take another screenshot, press the <guibutton>Take a New Screenshot</guibutton> (<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>) button.</para> | ||
126 | 126 | | |||
Show All 14 Lines | 140 | <listitem> | |||
141 | <para>The <guilabel>Current Screen</guilabel> option takes a screenshot of the output that currently contains the mouse pointer.</para> | 141 | <para>The <guilabel>Current Screen</guilabel> option takes a screenshot of the output that currently contains the mouse pointer.</para> | ||
142 | </listitem> | 142 | </listitem> | ||
143 | <listitem> | 143 | <listitem> | ||
144 | <para>The <guilabel>Active Window</guilabel> option takes a screenshot of the window that currently has focus. It is advisable to use a delay with this mode, to give you time to select and activate a window before the screenshot is taken.</para> | 144 | <para>The <guilabel>Active Window</guilabel> option takes a screenshot of the window that currently has focus. It is advisable to use a delay with this mode, to give you time to select and activate a window before the screenshot is taken.</para> | ||
145 | </listitem> | 145 | </listitem> | ||
146 | <listitem> | 146 | <listitem> | ||
147 | <para>The <guilabel>Window Under Cursor</guilabel> option takes a screenshot of the window that is under the mouse cursor. If the cursor is on top of a popup menu, &spectacle; tries to take a screenshot of the menu as well as its parent window.</para> | 147 | <para>The <guilabel>Window Under Cursor</guilabel> option takes a screenshot of the window that is under the mouse cursor. If the cursor is on top of a popup menu, &spectacle; tries to take a screenshot of the menu as well as its parent window.</para> | ||
148 | 148 | | |||
149 | <para>While this works most of the time, in certain cases it may fail to obtain information about the parent window. In this case, &spectacle; falls back to old way of capturing the image automatically, and captures an image of only the popup menu. You can also force the old way of capturing the image by checking the <guilabel>Capture the current pop-up only</guilabel> checkbox under <guilabel>Content Options</guilabel></para> | 149 | <para>While this works most of the time, in certain cases it may fail to obtain information about the parent window. In this case, &spectacle; falls back to old way of capturing the image automatically, and captures an image of only the popup menu. You can also force the old way of capturing the image by checking the <guilabel>Capture the current pop-up only</guilabel> checkbox under <guilabel>Options</guilabel></para> | ||
150 | </listitem> | 150 | </listitem> | ||
151 | <listitem> | 151 | <listitem> | ||
152 | <para>The <guilabel>Rectangular Region</guilabel> option allows you to select a rectangular region of your desktop with your mouse. This region may be spread across different outputs.</para> | 152 | <para>The <guilabel>Rectangular Region</guilabel> option allows you to select a rectangular region of your desktop with your mouse. This region may be spread across different outputs.</para> | ||
153 | 153 | | |||
154 | <para>This mode does not immediately take a screenshot but allows you to draw a rectangle on your screen, which can be moved and resized as needed. Once the desired selection rectangle has been drawn, double-clicking anywhere on the screen, or pressing the &Enter; button on the keyboard will capture the screenshot.</para> | 154 | <para>This mode does not immediately take a screenshot but allows you to draw a rectangle on your screen, which can be moved and resized as needed. Once the desired selection rectangle has been drawn, double-clicking anywhere on the screen, or pressing the &Enter; button on the keyboard will capture the screenshot.</para> | ||
155 | </listitem> | 155 | </listitem> | ||
156 | </itemizedlist> | 156 | </itemizedlist> | ||
157 | 157 | | |||
158 | <para>The <guilabel>Delay</guilabel> spin-box allows you to set the delay between pressing the <guibutton>Take a New Screenshot</guibutton> (<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>) button and taking the screenshot. This delay can be set in increments of 1 seconds using the spinbox buttons or the keyboard.</para> | 158 | <para>The <guilabel>Delay</guilabel> spin-box allows you to set the delay between pressing the <guibutton>Take a New Screenshot</guibutton> (<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>) button and taking the screenshot. This delay can be set in increments of 1 seconds using the spinbox buttons or the keyboard.</para> | ||
159 | 159 | | |||
160 | <para>Enabling the <guilabel>On Click</guilabel> checkbox overrides the delay. When this checkbox is enabled, pressing the <guibutton>Take a New Screenshot</guibutton> (<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>) button hides the &spectacle; window and changes the mouse cursor to a crosshair. The screenshot is captured when the mouse is left-clicked, or aborted if any other mouse buttons are clicked. Note that you cannot interact with the desktop using the mouse while the cursor is a crosshair, but you can use the keyboard.</para> | 160 | <para>Enabling the <guilabel>On Click</guilabel> checkbox overrides the delay. When this checkbox is enabled, pressing the <guibutton>Take a New Screenshot</guibutton> (<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>) button hides the &spectacle; window and changes the mouse cursor to a crosshair. The screenshot is captured when the mouse is left-clicked, or aborted if any other mouse buttons are clicked. Note that you cannot interact with the desktop using the mouse while the cursor is a crosshair, but you can use the keyboard.</para> | ||
161 | </sect2> | 161 | </sect2> | ||
162 | 162 | | |||
163 | <sect2> | 163 | <sect2> | ||
164 | <title>Content Options</title> | 164 | <title>Options</title> | ||
165 | 165 | | |||
166 | <para>The content options settings allow you to select whether the mouse cursor should be included in the screenshots, and whether to capture window decorations along with the image of a single application window. In <guilabel>Window Under Cursor</guilabel> mode, it also allows you to select if &spectacle; shall only capture the image of the current popup menu under the cursor, or also include the parent window.</para> | 166 | <para>The Options settings allow you to select whether the mouse cursor should be included in the screenshots, and whether to capture window decorations along with the image of a single application window. In <guilabel>Window Under Cursor</guilabel> mode, it also allows you to select if &spectacle; shall only capture the image of the current popup menu under the cursor, or also include the parent window. Finally, <guilabel>Quit after Save or Copy</guilabel> will quit Spectacle after any save or copy operations.</para> | ||
rkflx: "will quit": prepend "option" or remove "The"
Save or Copy → save or copy
Quit → Close? | |||||
167 | 167 | | |||
168 | <itemizedlist> | 168 | <itemizedlist> | ||
169 | <listitem> | 169 | <listitem> | ||
170 | <para>Enabling the <guilabel>Include mouse pointer</guilabel> checkbox includes an image of the mouse pointer in the screenshot.</para> | 170 | <para>Enabling the <guilabel>Include mouse pointer</guilabel> checkbox includes an image of the mouse pointer in the screenshot.</para> | ||
171 | </listitem> | 171 | </listitem> | ||
172 | <listitem> | 172 | <listitem> | ||
173 | <para>The <guilabel>Include window titlebar and borders</guilabel> option is only enabled when either the <guilabel>Active Window</guilabel> mode or the <guilabel>Window Under Cursor</guilabel> mode is selected in the <guilabel>Area</guilabel> combo-box. Checking this option includes the window borders and decoration in the screenshot, while unchecking it gives an image of only the window contents.</para> | 173 | <para>The <guilabel>Include window titlebar and borders</guilabel> option is only enabled when either the <guilabel>Active Window</guilabel> mode or the <guilabel>Window Under Cursor</guilabel> mode is selected in the <guilabel>Area</guilabel> combo-box. Checking this option includes the window borders and decoration in the screenshot, while unchecking it gives an image of only the window contents.</para> | ||
174 | </listitem> | 174 | </listitem> | ||
175 | <listitem> | 175 | <listitem> | ||
176 | <para>The <guilabel>Capture the current pop-up only</guilabel> option is only enabled when the <guilabel>Window Under Cursor</guilabel> mode is selected in the <guilabel>Area</guilabel> combo-box. Checking this option captures only the popup menu under the cursor, without its parent window.</para> | 176 | <para>The <guilabel>Capture the current pop-up only</guilabel> option is only enabled when the <guilabel>Window Under Cursor</guilabel> mode is selected in the <guilabel>Area</guilabel> combo-box. Checking this option captures only the popup menu under the cursor, without its parent window.</para> | ||
177 | </listitem> | 177 | </listitem> | ||
178 | <listitem> | ||||
179 | <para>The <guilabel>Quit after Save or Copy</guilabel> option will quit Spectacle after any saving or copying operations. Note that a copied screenshot will only be retained if you are running a clipboard manager that accepts images. KDE Klipper can be configured in this manner by right-clicking on its icon, selecting <guilabel>Configure Clipboard...</guilabel>, and unchecking <guilabel>Ignore images</guilabel>.</para> | ||||
"No context available", but please make sure to also replace all references to "Save & Exit" with the new option. rkflx: "No context available", but please make sure to also replace all references to "Save &… | |||||
Save or Copy → saving or copying? Quit → Close? (would help those not knowing what quitting is) rkflx: Save or Copy → saving or copying?
Quit → Close? (would help those not knowing what quitting is) | |||||
180 | </listitem> | ||||
178 | </itemizedlist> | 181 | </itemizedlist> | ||
179 | </sect2> | 182 | </sect2> | ||
180 | </sect1> | 183 | </sect1> | ||
181 | </chapter> | 184 | </chapter> | ||
182 | 185 | | |||
183 | <chapter id="additional-functionality"> | 186 | <chapter id="additional-functionality"> | ||
184 | <title>Additional Functionality</title> | 187 | <title>Additional Functionality</title> | ||
185 | 188 | | |||
Show All 31 Lines | 194 | <variablelist> | |||
217 | </varlistentry> | 220 | </varlistentry> | ||
218 | <varlistentry> | 221 | <varlistentry> | ||
219 | <term><guibutton>Copy To Clipboard</guibutton></term> | 222 | <term><guibutton>Copy To Clipboard</guibutton></term> | ||
220 | <listitem> | 223 | <listitem> | ||
221 | <para>This button copies the current screenshot to the clipboard. You can also use the <keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo> keyboard shortcut for this.</para> | 224 | <para>This button copies the current screenshot to the clipboard. You can also use the <keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo> keyboard shortcut for this.</para> | ||
222 | </listitem> | 225 | </listitem> | ||
223 | </varlistentry> | 226 | </varlistentry> | ||
224 | <varlistentry> | 227 | <varlistentry> | ||
225 | <term><guibutton>Save & Exit</guibutton></term> | 228 | <term><guibutton>Save As</guibutton></term> | ||
rkflx: Instead of removing, adapt to {nav Save / Save As}. | |||||
226 | <listitem> | 229 | <listitem> | ||
227 | <para>Clicking this button saves the screenshot as a PNG image in your default Pictures folder and immediately exits the application.</para> | 230 | <para>Clicking this button saves the screenshot as a PNG image to a location of your choosing. Clicking on the arrow on the side will expose the other save mode, <guimenuitem>Save</guimenuitem>, which will save the screenshot as a PNG image to the standard location (which defaults to your Pictures folder). By default, the last-used save mode is remembered for next time.</para> | ||
228 | </listitem> | 231 | </listitem> | ||
229 | </varlistentry> | 232 | </varlistentry> | ||
230 | </variablelist> | 233 | </variablelist> | ||
231 | </sect1> | 234 | </sect1> | ||
232 | 235 | | |||
233 | <sect1> | 236 | <sect1> | ||
234 | <title>Configure</title> | 237 | <title>Configure</title> | ||
235 | <para>Use the <guibutton>Configure...</guibutton> button to open the configuration dialog.</para> | 238 | <para>Use the <guibutton>Configure...</guibutton> button to open the configuration dialog.</para> | ||
Show All 33 Lines | 271 | <listitem> | |||
269 | <para>By default, &spectacle; does not show an initial selection when you take a screenshot of a rectangular region. Enable this option to remember | 272 | <para>By default, &spectacle; does not show an initial selection when you take a screenshot of a rectangular region. Enable this option to remember | ||
270 | the last selected region of the screen, and set it as the initial selection when you use the rectangular region selector the next time.</para> | 273 | the last selected region of the screen, and set it as the initial selection when you use the rectangular region selector the next time.</para> | ||
271 | </listitem> | 274 | </listitem> | ||
272 | </varlistentry> | 275 | </varlistentry> | ||
273 | </variablelist> | 276 | </variablelist> | ||
274 | </sect2> | 277 | </sect2> | ||
275 | <sect2> | 278 | <sect2> | ||
276 | <title>Save</title> | 279 | <title>Save</title> | ||
277 | <para>When you use the <guilabel>Save & Exit</guilabel> or the <guilabel>Save</guilabel> functions, &spectacle; saves the image with a default filename, in your Pictures folder under your home folder. The default filename includes the date and time when the image was taken.</para> | 280 | <para>When you use the <guilabel>Save</guilabel> function, &spectacle; saves the image with a default filename, in your Pictures folder (which is inside your home folder). The default filename includes the date and time when the image was taken.</para> | ||
278 | 281 | | |||
279 | <para>The <guilabel>Save</guilabel> page allows you to set the default save location and filename. Clicking this option brings up a dialog box like the following: | 282 | <para>The <guilabel>Save</guilabel> page allows you to set the default save location and filename. Clicking this option brings up a dialog box like the following: | ||
280 | <mediaobject> | 283 | <mediaobject> | ||
281 | <imageobject> | 284 | <imageobject> | ||
282 | <imagedata fileref="SaveOptions.png" format="PNG"/> | 285 | <imagedata fileref="SaveOptions.png" format="PNG"/> | ||
283 | </imageobject> | 286 | </imageobject> | ||
284 | <textobject> | 287 | <textobject> | ||
285 | <phrase>Save</phrase> | 288 | <phrase>Save</phrase> | ||
286 | </textobject> | 289 | </textobject> | ||
287 | </mediaobject> | 290 | </mediaobject> | ||
288 | </para> | 291 | </para> | ||
289 | <variablelist> | 292 | <variablelist> | ||
290 | <varlistentry> | 293 | <varlistentry> | ||
291 | <term><guilabel>Default Save Location</guilabel></term> | 294 | <term><guilabel>Default Save Location</guilabel></term> | ||
292 | <listitem> | 295 | <listitem> | ||
293 | <para>In the <guilabel>Location</guilabel> text box set the folder where you'd like to save your screenshots when you press <guibutton>Save</guibutton> or <guibutton>Save & Exit</guibutton>.</para> | 296 | <para>In the <guilabel>Location</guilabel> text box set the folder where you'd like to save your screenshots when you press <guibutton>Save</guibutton>.</para> | ||
294 | </listitem> | 297 | </listitem> | ||
295 | </varlistentry> | 298 | </varlistentry> | ||
296 | <varlistentry> | 299 | <varlistentry> | ||
297 | <term><guilabel>Default Save Filename</guilabel></term> | 300 | <term><guilabel>Default Save Filename</guilabel></term> | ||
298 | <listitem> | 301 | <listitem> | ||
299 | <para>Set a default filename for saved screenshots.</para> | 302 | <para>Set a default filename for saved screenshots.</para> | ||
300 | <para>You can use the following placeholders in the filename, which will be replaced with actual text when the file is saved:</para> | 303 | <para>You can use the following placeholders in the filename, which will be replaced with actual text when the file is saved:</para> | ||
301 | <itemizedlist> | 304 | <itemizedlist> | ||
▲ Show 20 Lines • Show All 56 Lines • Show Last 20 Lines |
"will quit": prepend "option" or remove "The"
Save or Copy → save or copy
Quit → Close? (would help those not knowing what quitting is)