+
+
+
+
+
+
+ Flameshot
+
+
Powerful yet simple to use screenshot software.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-## Usage Preview
-![image](./img/preview/animatedUsage.gif)
+
+
+## Preview
+
+![image](img/preview/animatedUsage.gif)
## Index
+
- [Features](#features)
-- [Contribute](#contribute)
- [Usage](#usage)
+ - [CLI configuration](#cli-configuration)
- [Keyboard Shortcuts](#keyboard-shortcuts)
+ - [Local](#local)
+ - [Global](#global)
+ - [On KDE Plasma desktop](#on-kde-plasma-desktop)
- [Considerations](#considerations)
- [Installation](#installation)
- [Compilation](#compilation)
- - [Debian](#debian)
- - [Fedora](#fedora)
- - [Arch](#arch)
+ - [Dependencies](#dependencies)
+ - [Compile-time](#compile-time)
+ - [Run-time](#run-time)
+ - [Optional](#optional)
+ - [Debian](#debian)
+ - [Fedora](#fedora)
+ - [Arch](#arch)
+ - [Build](#build)
- [Install](#install)
- [Packaging](#packaging)
- [License](#license)
+- [Contribute](#contribute)
- [Donations](#donations)
+- [Acknowledgment](#acknowledgment)
## Features
+
- Customizable appearance.
- Easy to use.
- In-app screenshot edition.
- DBus interface.
- Upload to Imgur.
-## Contribute
-If you want to contribute check the [CONTRIBUTING.md](./CONTRIBUTING.md)
-
## Usage
+
Example commands:
-- capture with GUI:
- `flameshot gui`
+- Capture with GUI:
-- capture with GUI with custom save path:
+ ```shell
+ flameshot gui
+ ```
- `flameshot gui -p ~/myStuff/captures`
+- Capture with GUI with custom save path:
-- open GUI with a delay of 2 seconds:
+ ```shell
+ flameshot gui -p ~/myStuff/captures
+ ```
- `flameshot gui -d 2000`
+- Open GUI with a delay of 2 seconds:
-- fullscreen capture with custom save path (no GUI) and delayed:
+ ```shell
+ flameshot gui -d 2000
+ ```
- `flameshot full -p ~/myStuff/captures -d 5000`
+- Fullscreen capture with custom save path (no GUI) and delayed:
-- fullscreen capture with custom save path copying to clipboard:
+ ```shell
+ flameshot full -p ~/myStuff/captures -d 5000
+ ```
- `flameshot full -c -p ~/myStuff/captures`
+- Fullscreen capture with custom save path copying to clipboard:
-- capture the screen containing the mouse and print the image (bytes) in PNG format:
+ ```shell
+ flameshot full -c -p ~/myStuff/captures
+ ```
- `flameshot screen -r`
+- Capture the screen containing the mouse and print the image (bytes) in PNG format:
-- capture the screen number 1 and copy it to the clipboard:
+ ```shell
+ flameshot screen -r
+ ```
- `flameshot screen -n 1 -c`
+- Capture the screen number 1 and copy it to the clipboard:
+
+ ```shell
+ flameshot screen -n 1 -c
+ ```
In case of doubt choose the first or the second command as shortcut in your favorite desktop environment.
@@ -73,19 +125,26 @@
Check out the information window to see all the available shortcuts in the graphical capture mode.
### CLI configuration
+
You can use the graphical menu to configure Flameshot, but alternatively you can use your terminal or scripts to do so.
-- open the configuration menu:
+- Open the configuration menu:
- `flameshot config`
+ ```shell
+ flameshot config
+ ```
-- show the initial help message in the capture mode:
+- Show the initial help message in the capture mode:
- `flameshot config --showhelp true`
+ ```shell
+ flameshot config --showhelp true
+ ```
-- for more information about the available options use the help flag:
+- For more information about the available options use the help flag:
- `flameshot config -h`
+ ```shell
+ flameshot config -h
+ ```
## Keyboard shortcuts
@@ -93,16 +152,17 @@
These shortcuts are available in GUI mode:
-| Keys | Description |
-|--- |--- |
-|