# The &spectacle; Handbook

## Introduction

&spectacle; is an application for capturing and editing desktop screenshots. It can capture images of the entire desktop, a single monitor, the currently active window, the window currently under the mouse, or a rectangular region of the screen. The images can then be annotated, printed, sent to other applications for manipulation, or quickly be saved as-is.

Please report any problems or feature requests to the &kde; Bug Tracking System.

## Starting &spectacle;

&spectacle; can be started in a variety of ways, as described below:

- In the application launcher menu, &spectacle; can be found at Applications Utilities Screenshot Capture Utility &spectacle;

- Pressing the Print Screen button on the keyboard (often labeled PrtSc, PrtScn or similar) will immediately launch &spectacle;. Additionally, three more keyboard shortcuts are available to take screenshots and save them in your default save folder without showing the &GUI;:

  - Meta Print Screen will take a screenshot of the active window

  - &Shift;Print Screen will take a screenshot of your entire desktop, &ie; all monitors

  - Meta&Shift;Print Screen will take a rectangular region screenshot

  You can configure the default save location and filename by starting &spectacle; normally and clicking on the Configure... button, then navigating to the Save section.

- The mini command line &krunner; (invoked with &Alt;F2) may also be used to start &spectacle;.

- &spectacle; can be started from the command-line. &spectacle; has an extensive set of command-line options, including a background mode which can be used to script the capture of screenshots without showing the &GUI; or requiring user interaction.

  To start &spectacle; from the command prompt, type in:

                          % spectacle &

  To view the full list of command-line options and their explanation, type in:

                          % spectacle --help

## Using &spectacle;

Once &spectacle; starts, you will see a window like the following: &spectacle; Main Window

&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.

The snapshot taken by &spectacle; is displayed in the preview window, which is located on the left-hand side of the &spectacle; application window.

The image can be saved to a location of your choice by clicking on the Save As button or typing &Ctrl;&Shift;S. 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.

To save a screenshot to the default location, click on the arrow portion of the Save As... button and press the Save (&Ctrl;S) button. The new save mode will be remembered for next time. The default save location and filename can be configured, as described later.

To quickly save the image and quit &spectacle;, click on the checkbox beside Quit after manual Save or Copy, then click the arrow portion of the Save As... button and press the Save (&Ctrl;S) 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.

### Taking A Screenshot

When you open &spectacle;, it immediately takes a screenshot, unless otherwise set in the general options, 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.

To discard the current screenshot and take another screenshot, press the Take a New Screenshot (&Ctrl;N) button.

After capturing a screenshot, &spectacle; will show you an info panel with a link to the screenshot file and propose you to Open Containing Folder of this file.

You may configure certain options on the right hand side of the application window before taking a new screenshot. These options allow you to select the area of the screen that is to be captured, set a delay before capturing the image, and configure whether the mouse cursor and/or the window decorations should be captured along with the screenshot.

#### Capture Mode

The capture mode settings allow you to set the area of the screen that should be captured, and whether there should be a delay between pressing the Take a New Screenshot (&Ctrl;N) button and taking the screenshot. You may also enable the On Click checkbox, which disables the delay function and only takes the screenshot after you click anywhere on the screen after clicking the Take a New Screenshot (&Ctrl;N) button.

The Area combo-box allows you to set the area of the screen that should be captured. There are five options to select from, as described below.

- The Full Screen (All Monitors) option takes a screenshot of your entire desktop, spread across all the outputs, including all the monitors, projectors etc.

- The Current Screen option takes a screenshot of the output that currently contains the mouse pointer.

- The Rectangular Region option allows you to select a rectangular region of your desktop with your mouse. This region may be spread across different outputs.

  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.

  You can use the arrow keys to move and adjust the rectangle. Pressing the arrow keys will move the rectangle. Holding the &Shift; key while pressing the arrow keys will move the rectangle slowly, for fine-tuning your selection. Holding the &Alt; key while pressing the arrow keys will adjust the size of the rectangle.

- The Active Window 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.

- The Window Under Cursor 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.

  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 Capture the current pop-up only checkbox under Options

The Delay spin-box allows you to set the delay between pressing the Take a New Screenshot (&Ctrl;N) button and taking the screenshot. This delay can be set in increments of 1 seconds using the spinbox buttons or the keyboard.

When taking a time-delayed screenshot, &spectacle; displays the remaining time before the screenshot is taken in its window title, and makes it visible in its Task Manager item. &spectacle;'s Task Manager button also shows a progress bar, so you can keep track of when the snap will be taken.

While waiting for the delayed screenshot, you can un-minimize &spectacle; and the Take a New Screenshot button will turn into a Cancel button. The progress bar will also be shown here, giving you the chance to stop the countdown.

Enabling the On Click checkbox overrides the delay. When this checkbox is enabled, pressing the Take a New Screenshot (&Ctrl;N) 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.

#### Options

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 Window Under Cursor 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, Quit after Save or Copy will quit &spectacle; after any save or copy operations.

- Enabling the Include mouse pointer checkbox includes an image of the mouse pointer in the screenshot.

- The Include window titlebar and borders option is only enabled when either the Active Window mode or the Window Under Cursor mode is selected in the Area 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.

- The Capture the current pop-up only option is only enabled when the Window Under Cursor mode is selected in the Area combo-box. Checking this option captures only the popup menu under the cursor, without its parent window.

- The Quit after manual Save or Copy 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 Configure Clipboard..., and unchecking Ignore images.

## Additional Functionality

### Buttons

There are some buttons located at the bottom of the &spectacle; window. Their functions are described below:

Help

- Gives you the common menu items described in the Help Menu of the &kde; Fundamentals.

Configure...

- Gives you access to &spectacle;'s Configure window where you can change the capture settings and default save location and filename.

Annotate

- Opens an annotation editor window that offers various annotating tools:

  Annotation editor

  Give a try to the annotating tools. You might find everything that is needed to explain your screenshots there: arrows, pen, markers, text boxes, numbers, even smileys. It is possible to change the tool parameters and add effects (shadow, grayscale, and border).

  When you think that annotating is finished press the Annotation Done button.

Tools

- Opens a drop-down menu which offers various tools:

  - Open Default Screenshots Folder will highlight the last saved screenshot in the default file manager

  - Access to the Print dialog

  - A range of external programs for Screen Recording

Export

- Opens a drop-down menu that will allow you to directly open the screenshot with all programs that are associated with the PNG (Portable Network Graphics) &MIME; type. Depending on what programs are installed, you will be able to open and edit the snapshot in your graphics applications or viewers.

Copy Image to Clipboard/Copy Location to Clipboard

- Copies the current screenshot or its location to the clipboard. You can also use the &Ctrl;C keyboard shortcut for this.

Save As

- Saves the screenshot as a PNG image in your default Pictures folder and immediately exits the application.

### Configure

Use the Configure... button to open the configuration dialog.

#### General

General

When launching Spectacle

- Allows to Take full screen screenshot, use last-used capture mode, or do not take a screenshot automatically. The last-used capture mode is the one set in Capture Mode

After taking a screenshot

- Allows Save file to default folder, switching off any clipboard actions, copying the image to clipboard, or copying screenshot path to the clipboard. The default location can be configured using the Save configuration page. It is possible to Copy file location to clipboard. You can then paste it anywhere that accepts text input. Note that you must be running a clipboard manager in order to keep the path in the clipboard after &spectacle; quits.

Press screenshot key to

- When a shortcut to make screenshot is pressed and &spectacle; is already running it is possible to configure the behavior of the screenshoting system. You can choose between taking a new screenshot, opening of a new &spectacle; window, and returning focus to the existing &spectacle; window.

Use light background

- Use a light background color to mask the cropped-out area in the rectangular region selector. This may make dark cursors easier to see.

Show magnifier

- When a screenshot is saved, copy the location at which the file was saved to the clipboard. You can then paste it anywhere that accepts text input. Note that you must be running a clipboard manager in order to keep the path in the clipboard after &spectacle; quits.

Accept on click-and-release

- If checked, accept the selected region as soon as the mouse button is released in the Rectangular Region mode.

  When selecting a new region, without a previously saved region available, clicking, dragging, and releasing the mouse button should immediately capture the selected region. When a previously saved region is shown, the saved region can be manipulated further and saving this region requires manual confirmation (&Enter; or double click with the &LMB;). Clicking and dragging outside of the previously saved region captures the newly selected region immediately.

Remember selected area

- By default, &spectacle; remembers an initial selection when you take a screenshot of a rectangular region until you close the &spectacle; window. You can also choose to make &spectacle; never remember selected area or remember it between the screenshoting sessions.

#### Save

When you use the Save 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.

The Save page allows you to set the default save location and filename. Clicking this option brings up a dialog box like the following: Save

Save Location

- In the location text box set the folder where you'd like to save your screenshots when you press Save.

Compression Quality

- Choose the image quality when saving with lossy image formats like JPEG. The higher values give better quality but increase the file size. See Wikipedia page for the details on the image formats that are used in &spectacle;.

Filename

- Set a default filename for saved screenshots.

  You can use the following placeholders in the filename, which will be replaced with actual text when the file is saved:

  - `%D`: Day

  - `%H`: Hour

  - `%M`: Month

  - `%Nd`: Sequential number padded to N digits

  - `%S`: Second

  - `%T`: Window title

  - `%Y`: Year (4 digit)

  - `%Nd`: Sequential number

  - `%m`: Minute

  - `%y`: Year (2 digit)

  You can click on placeholders in the reference list below to insert them into the Filename line.

  If a file with this name already exists, a serial number will be appended to the filename. For example, if the filename is `Screenshot`, and `Screenshot.png` already exists, the image will be saved as `Screenshot-1.png`.

  Use the drop-down box next to the text field to select the default image format for screenshots. See Wikipedia page for the details on the image formats that are used in &spectacle;.

#### Shortcuts

This configuration page can be used to change the default shortcuts of &spectacle;. It is possible to configure shortcuts for starting &spectacle; and capturing different parts of your desktop.

### Drag and Drop

A captured image can be dragged to another application or document. If the application is able to handle images, a copy of the full image is inserted there.

If you drag a screenshot into a file manager window, a dialog pops up where you can edit the filename and select the image format and the file will be inserted into the actual folder.

If you drag the screenshot to a text box, the path to the temporary saved file is inserted. This is useful for example to upload a screenshot through web forms or to attach screenshots into bug reports on the &kde; bugtracker.

This works with all clients that do not pick up the image data, but only look for a &URL; in the dragged mimedata.

## Credits and License

Program copyright © 2015 &Boudhayan.Gupta; &Boudhayan.Gupta.mail;.

Portions of the code are based directly on code from the &ksnapshot; project. Copyright © 1997-2011 The &ksnapshot; Developers. Detailed copyright assignment notices are available in the headers in the source code.

Portions of the code are based directly on code from the &kwin; project. Copyright © 2008, 2013 The &kwin; Developers. Detailed copyright assignment notices are available in the headers in the source code.

Documentation based on the original &ksnapshot; documentation:

- Copyright © 1997-2000 &Richard.J.Moore; &Richard.J.Moore.mail;

- Copyright © 2000 &Matthias.Ettrich; &Matthias.Ettrich.mail;

&underFDL; &underGPL;
&documentation.index;