Searching...

No Matches

Some Fossies usage hints in advance:

To see the Doxygen generated documentation please click on one of the items in the steelblue colored "quick index" bar above or use the side panel at the left which displays a hierarchical tree-like index structure and is adjustable in width.
If you want to search for something by keyword rather than browse for it you can use the client side search facility (using Javascript and DHTML) that provides live searching, i.e. the search results are presented and adapted as you type in the Search input field at the top right.
Doxygen doesn't incorporate all member files but just a definable subset (basically the main project source code files that are written in a supported language). So to search and browse all member files you may visit the Fossies ksnip-1.10.1.tar.gz contents page and use the Fossies standard member browsing features (also with source code highlighting and additionally with optional code folding).

ksnip

Version v1.10.1

Ksnip is a Qt-based cross-platform screenshot tool that provides many annotation features for your screenshots.

ksnip

Features

Latest ksnip version contains following features:

Supports Linux (X11, Plasma Wayland, GNOME Wayland and xdg-desktop-portal Wayland), Windows and macOS.
Screenshot of a custom rectangular area that can be drawn with mouse cursor.
Screenshot of last selected rectangular area without selecting again.
Screenshot of the screen/monitor where the mouse cursor is currently located.
Screenshot of full-screen, including all screens/monitors.
Screenshot of window that currently has focus.
Screenshot of window under mouse cursor.
Screenshot with or without mouse cursor.
Capture mouse cursor as annotation item that can be moved and deleted.
Customizable capture delay for all capture options.
Upload screenshots directly to imgur.com in anonymous or user mode.
Upload screenshots via FTP in anonymous or user mode.
Upload screenshots via custom user defined scripts.
Command-line support, for capturing screenshots and saving to default location, filename and format.
Filename wildcards for Year (Y), Month(M), Day (D), Time(T) and Counter (multiple # characters for number with zero-leading padding).
Print screenshot or save it to PDF/PS.
Annotate screenshots with pen, marker, rectangles, ellipses, texts and other tools.
Annotate screenshots with stickers and add custom stickers.
Crop and cut out vertical/horizontal slices of images.
Obfuscate image regions with blur and pixelate.
Add effects to image (Drop Shadow, Grayscale, invert color or Border).
Add watermarks to captured images.
Global hotkeys for capturing screenshots (currently only for Windows and X11).
Tabs for screenshots and images.
Open existing images via dialog, drag-and-drop or paste from clipboard.
Run as single instance application (secondary instances send cli parameter to primary instance).
Pin screenshots in frameless windows that stay atop other windows.
User-defined actions for taking screenshot and post-processing.
OCR support through plugin (Window and Linux/Unix).
Many configuration options.

Supported Screenshot Types

	Rect Area	Last Rect Area	Full Screen	Current Screen	Active Window	Window Under Cursor	Without Mouse Cursor	Screenshot Portal
X11	X	X	X	X	X		X
Plasma Wayland			X	X		X
Gnome Wayland `< 41`	X	X	X	X	X		X
xdg-desktop-portal*								X
Windows	X	X	X	X	X		X
macOS	X	X	X	X

* xdg-desktop-portal screenshots are screenshots taken by the compositor and passed to ksnip, you will see a popup dialog that required additional confirmation, the implementation can vary depending on the compositor. Currently, Snaps and Gnome Wayland >= 41 only support xdg-desktop-portal screenshots, this is a limitation coming from the Gnome and Snaps, non-native screenshot tools are not allowed to take screenshots in any other way except through the xdg-desktop-portal.

Installing Binaries

Binaries can be downloaded from the Releases page. Currently, RPM, DEB, APT, Snap, Flatpak and AppImage for Linux, zipped EXE for Windows and APP for macOS in a DMG package are available.

Continuous build

All supported binaries are built for every pushed commit, to be found at the top of the release page. Continuous build artifacts are not fully tested and in most cases they are work in progress, so use them with caution.

Linux

Click on the item, to expand information.

AppImage

To use AppImages, make them executable and run them, no installation required.

$ chmod a+x ksnip*.AppImage
$ ./ksnip*.AppImage

More info about setting to executable can be found here.

RPM

Just install them via RPM and use.

$ rpm -Uvh ksnip*.rpm
$ ksnip

DEB

Just install them via apt and start using.

$ sudo apt install ./ksnip*.deb
$ ksnip

APT

Starting with Ubuntu 21.04 Hirsute Hippo, you can install from the official package:

$ sudo apt install ksnip

For older Ubuntu versions, you can use @nemonein's unofficial PPA:

sudo add-apt-repository ppa:nemonein/ksnip
sudo apt update
sudo apt install ksnip

For Debian 11 and later releases, you can install from the official package:

$ sudo apt install ksnip

For Debian 10 and Debian 9, ksnip is available via Debian Backports. Please enable bullseye-backports and buster-backports repo for Debian 10 and Debian 9 respectively before installing using sudo apt install ksnip.

ArchLinux

Ksnip is in the Community repository, so you can install it directly via pacman.

$ sudo pacman -S ksnip

If you want to build from the GIT repository, you can use the AUR package (make sure you build the necessary dependencies too).

$ yay -S ksnip-git kimageannotator-git kcolorpicker-git

Snap

The usual method for Snaps, will install the latest version:

$ sudo snap install ksnip

The continuous build version is also available as edge, in order to install it you need to provide the edge flag:

$ sudo snap install ksnip --edge

Snap startup time can be sped up and console output cleaned up from following error Could not create AF_NETLINK socket (Permission denied) by running the following commands:

$ snap connect ksnip:network-observe
$ snap connect ksnip:network-manager-observe

If you need to save screenshots to a removable media, the following additional connection is required:

$ snap connect ksnip:removable-media

This only needs to be done once and connects some Snap plugs which are currently not auto-connected.

Flatpak

The usual method for Flatpaks will install the latest version:

$ flatpak install flathub org.ksnip.ksnip

Then just start it:

$ flatpak run org.ksnip.ksnip

Windows

MSI

The MSI installer installs ksnip on your system and is the preferred way for installing ksnip under Windows.

EXE

The EXE file with all required dependencies comes in a zipped package, which just need to be unzipped with your favorite unpacking tool. Ksnip can then be started by just double-clicking ksnip.exe.

macOS

APP

The app file comes in a DMG package which needs to be opened, and the ksnip.app file needs to be dragged and dropped into the "Application" folder. After that the application can be started by double clicking ksnip.app

Homebrew Cask

Just install via Homebrew and start using from your "Applications" folder.

$ brew install --cask ksnip

Plugins

ksnip functionality can be extended by using plugins that need to be downloaded separately and installed or unpacked, depending on the environment. Currently, under Options > Settings > Plugins a plugin detection can be triggered either in the default location(s) or by providing a search path where to look for plugins. After clicking on "Detect", ksnip searches for known plugins and when found will list the name and version.

Default search locations

Windows: plugins directory, next to ksnip.exe
Linux/Unix: /usr/local/lib, /usr/local/lib64, /usr/lib, /usr/lib64

Version selection

The plugin must match the Qt version and build type of ksnip. If you have a ksnip version that uses Qt 15.5.X and was build in DEBUG then the plugin must match the same criteria. In most cases the latest ksnip and plugin version will be using the same Qt version, the only think that you need to watch out for is to not mix DEBUG and RELEASE build.

OCR (Window and Linux/Unix)

ksnip supports OCR by using the ksnip-plugin-ocr which utilizes Tesseract to convert Image to text. When the OCR plugin was loaded, the OCR option becomes available under Options > OCR. The latest plugin version can be found here.

Dependencies

ksnip depends on kImageAnnotator and kColorPicker which needs to be installed before building ksnip from source. Installation instructions can be found on the Github pages.

Building from source

Get the latest release from GitHub by cloning the repo: $ git clone https://github.com/ksnip/ksnip
Change to repo directory: $ cd ksnip
Make new build directory and enter it: $ mkdir build && cd build
Create the makefile and build the project: $ cmake .. && make
Now install the application, eventually you need to run it with sudo: $ sudo make install
Run the application: $ ksnip

If you are using Archlinux, you may prefer to build ksnip through AUR.

Known Issues

Expand

X11

Snipping area with transparent background doesn't work when compositor is turned off, freeze background is used in that case.

macOS

Snipping area with transparent background doesn't work, freeze background is always used. Issue #151
Second activation of snipping area doesn't get focus, you need to switch to the right side in order to see the snipping area. Issue #152
Mouse cursor is always captured. Issue #153

Wayland

Portal and Native Screenshots not working under KDE Plasma >= 5.80. The issue is coming from a recent change in KDE Plasma that prevents access to DBUS Interfaces responsible for taking screenshots. This issue is going to be fixed in future Plasma releases for the Portal Screenshots. Workaround for making the Portal Screenshots work is adding the string X-KDE-DBUS-Restricted-Interfaces=org.kde.kwin.Screenshot to the /usr/share/applications/org.freedesktop.impl.portal.desktop.kde.desktop file and then restarting. Don't forget to enforce Portal screenshots in settings. Issue #424
Under Gnome Wayland copying images to clipboard and then pasting them somewhere might not work. This happens currently with native Wayland. A workaround is using XWayland by starting ksnip like this QT_QPA_PLATFORM=xcb /usr/bin/ksnip or switch to XWayland completely by exporting that variable export QT_QPA_PLATFORM=xcb. Issue #416
Native Wayland screenshots are no longer possible with Gnome >= 41. The Gnome developers have forbidden access to the DBus interface that provides Screenshots under Wayland and leave non Gnome application only the possibility to use xdg-desktop-portal screenshots. Security comes before usability for the Gnome developers. There is an open feature request to only grant screenshot permission once instead of for every screenshot, help us raise awareness for such feature here.
Global Hotkeys don't work under Wayland, this is due to the secure nature of Wayland. As long as compositor developers don't provide an interface for us to work with Global Hotkeys, does won't be supported.

Screen Scaling (HiDPI)

Qt is having issues with screen scaling, it can occur that the Snipping area is incorrectly positioned. As a workaround the Snipping Area position or offset can be configured so that it's placed correctly. Issue [#276]

Snap

Drag and Drop might not be working when ksnip or the application that you drag and drop from/to is installed as snap. the reason being that the image is shared via the temp directory which in case of snaps are restricted and every application can only see their own files or files of the user. The workaround for this is to change the temp directory location to a user owned directory like home, document or download directory via Options > Settings > Application > Temp Directory.

Discussion & Community

If you have general questions, ideas or just want to talk about ksnip, please join our Discord or IRC server.

Contribution

Any contribution is welcome, be it code, translations or other things. Currently, we need:

Developers for writing code and fixing bugs for linux, windows and macOS. We have only one developer and the feature requests and bugs are pilling up.
Testers for testing releases on different OS and Distros.
Docu writers, there are a lot of features that the casual users don't know about.
Bug reporting, Please report any bugs or feature requests related to the annotation editor on the kImageAnnotator GitHub page under the "Issue" section. All other bugs or feature requests can be reported on the ksnip GitHub page under the "Issue" section.
Translations - Weblate is used for translations. For translating annotator-related texts, please refer to kImageAnnotator

Translation status

Donation

ksnip is a non-profitable copylefted libre software project, and still has some costs that need to be covered, like domain costs or hardware costs for cross-platform support. If you want to help or just want to appreciate the work being done by treating developers to a beer or coffee, you can do that here, donations are always welcome :)

In order to improve our MacOS support, we are trying to collect some money to buy a MacBook, you can donate here.

Also in crypto:
BTC: bc1q6cke457fk8qhxxacl4nu5q2keudtdukrqe2gx0
ETH: 0xbde87a83427D61072055596e7a746CeC5316253C
BNB: bnb1fmy0vupsv23s36sejp07jetj6exj3hqeewkj6d