# The KSnapshot Handbook

Richard
J.
Moore

    rich@kde.org

07/11/1999
0.04.00

This Handbook describes KSnapshot Version 0.4.0

KDE
graphics
snapshot
screenshot

## Introduction

KSnapshot is a simple applet for taking screenshots. It is capable of capturing images of either the whole desktop or just a single window. The images can then be saved in a variety of formats.

### KSnapshot License

KSnapshot is copyright Richard J. Moore 1997-1999 (rich@kde.org)

KSnapshot is released under the terms of the LGPL. As KSnapshot is free, there is no warranty.

## Using KSnapshot

### Starting KSnapshot

Currently you can start KSnapshot either by selecting it from the 'Graphics' menu of kpanel or by typing `ksnapshot` at the command line. Kwm's mini command line (invoked with Alt-F2) is useful for this.

When KSnapshot is first executed it captures an image of the desktop before it display's it's window. If this is what you want, you can simply enter a filename then press the 'Save' button.

### Taking a snapshot

Taking a snapshot is easy, just press the 'Grab' button and KSnapshot will capture an image. A small preview of the captured image is shown in the KSnapshot window and you can see the image at it's full size if you left click on the preview image.

### Saving the image

You can save the image you've grabbed by entering a filename then pressing the 'Save' button. You can set the filename without having to remember long paths by pressing the 'Browse' button. You can specify the format by selecting one from the list below the filename.

### Controlling what the snapshot will contain

You can control which parts of the screen will appear in the snapshot using the check boxes in the 'Options' group. The options available are as follows:

Auto Raise

  If this box is checked then KSnapshot will bring the selected window to the front of the desktop before grabbing the image. This option has no effect if you are grabbing the whole desktop.

Hide KSnapshot window

  If this box is checked then KSnapshot will hide itself as soon as you press the 'Grab' button. It will remain hidden until the snapshot has been taken.

Only grab the window containing the cursor

  If this box is checked then KSnapshot will grab an image of the window which the mouse cursor is currently pointing to, if it is not checked the whole desktop is grabbed.

## What's new?

Version 0.4.0

  - Merged the changes from Kurt's 0.3.x development releases.

  - Merged the changes from my 0.3.x development releases in to the HEAD code.

  - Now warns before overwriting existing files.

  - The much requested autoincrementing filename. Just put a number somewhere in the filename and it will be incremented.

  - You can now ask for a number of snapshots to be taken. Each snapshot has a name assigned by the autoincrement. The specified delay is waited for between each snapshot. Note that the ksnapshot window will remain hidden until all of the images have been captured.

  - Automatically chooses an unused filename at start up.

Version 0.2.7

  - Fixed the bug identified in version 0.2.6 (finally).

  - Tested with Qt 1.40 and KDE 1.0.

Version 0.2.6

  - Added postscript/encapsulated postscript support. This code was written by Sven Wiegand <SWiegand@tfh-berlin.de> Thanks Sven!

  - I've converted the postscript code to a QImageIO handler so any other KDE applications that want to write images as PS or EPS can use it.

  - Bugs There is currently a reproducible bug that if you select the root window in `Only grab a window' mode then ksnapshot exits. I *am* testing for this, but it isn't working, if anyone can see what's wrong please let me know. Grep the sources for THISISABUG to find the problem. This bug is now fixed.

Version 0.2.5

  - Updated the configure to the latest version (it was causing some problems).

Version 0.2.4

  - Added an error message when saving fails

Version 0.2.3

  - Fixed WM close of preview window

Version 0.2.2

  - Fixed autohide bug

  - Fixed bug with filename when changing format

Version 0.2.1

  - Fixed a problem with writing GIF files

  - Made GIF the default format

  - Fixed a problem that occured when you tried to grab the KSnapshot window when auto-hide was enabled.

  - Changed the way the initial filename is chosen

  - Stopped 'Browse' starting in the wrong directory

Version 0.2

  - Added support for multiple formats