mirror of
https://github.com/fergalmoran/flameshot.git
synced 2026-01-02 15:17:41 +00:00
155 lines
5.0 KiB
Markdown
155 lines
5.0 KiB
Markdown
# Flameshot
|
|
|
|
> Powerful yet simple to use screenshot software.
|
|
|
|
## Usage Preview
|
|
|
|
|
|
## Index
|
|
- [Features](#features)
|
|
- [Usage](#usage)
|
|
- [Shortcuts](#shortcuts)
|
|
- [Considerations](#considerations)
|
|
- [Compilation](#compilation)
|
|
- [Debian](#debian)
|
|
- [Fedora](#fedora)
|
|
- [Arch](#arch)
|
|
- [Install](#install)
|
|
- [Packaging](#packaging)
|
|
- [License](#license)
|
|
|
|
## Features
|
|
- Customizable appearance.
|
|
- Easy to use.
|
|
- In-app screenshot edition.
|
|
- DBus interface.
|
|
- Upload to Imgur.
|
|
|
|
## Usage
|
|
Example commands:
|
|
- capture with GUI:
|
|
|
|
`flameshot gui`
|
|
- open GUI with a delay of 2 seconds:
|
|
|
|
`flameshot gui -d 2000`
|
|
- capture with GUI with custom save path:
|
|
|
|
`flameshot gui -p ~/myStuff/captures`
|
|
- fullscreen capture (asking savepath):
|
|
|
|
`flameshot full`
|
|
- fullscreen capture with custom save path (no GUI) and delayed:
|
|
|
|
`flameshot full -p ~/myStuff/captures -d 5000`
|
|
- fullscreen capture with custom save path copying to clipboard:
|
|
|
|
`flameshot full -c -p ~/myStuff/captures`
|
|
|
|
In case of doubt choose the first or the second command as shortcut in your favorite desktop environment.
|
|
|
|
A systray icon will be in your system's panel while Flameshot is running.
|
|
Do a right click on the tray icon and you'll see some menu items to open the configuration window and the information window.
|
|
Check out the information window to see all the available shortcuts in the graphical capture mode.
|
|
|
|
## Shortcuts
|
|
|
|
These shortcuts are available in GUI mode:
|
|
|
|
| Keys | Description |
|
|
|--- |--- |
|
|
| ←↓↑→ | Move selection 1px |
|
|
| SHIFT + ←↓↑→ | Resize selection 1px |
|
|
| ESC | Quit capture |
|
|
| CTRL + C | Copy to clipboard |
|
|
| CTRL + S | Save selection as a file |
|
|
| CTRL + Z | Undo the last modification |
|
|
| Right Click | Show color picker |
|
|
|
|
Shift + drag a handler of the selection area: mirror redimension in the opposite handler.
|
|
|
|
## Considerations
|
|
|
|
- **Not working on Wayland**
|
|
|
|
- If you are using Gnome you need to install the [TopIcons](https://extensions.gnome.org/extension/495/topicons/) extension in order to see the systemtray icon.
|
|
|
|
- In order to speed up the first launch of Flameshot (DBus init of the app can be slow), consider starting the application automatically on boot.
|
|
|
|
- Press `Enter` or `Ctrl + C` when you are in a capture mode and you don't have an active selection and the whole desktop will be copied to your clipboard! Pressing `Ctrl + S` will save your capture in a file! Check the [Shortcuts](#shortcuts) for more information.
|
|
|
|
- Execute the command `flameshot` without parameters or use the "Launch Flameshot" desktop entry to launch a running instance of the program without taking actions.
|
|
|
|
## Compilation
|
|
### Debian
|
|
Compilation Dependencies:
|
|
````
|
|
apt install -y git g++ build-essential qt5-qmake qt5-default
|
|
````
|
|
|
|
Compilation: run `qmake && make` in the main directory.
|
|
|
|
### Fedora
|
|
Compilation Dependencies:
|
|
````
|
|
dnf install -y qt5-devel gcc-c++ git qt5-qtbase-devel
|
|
````
|
|
|
|
Compilation: run `qmake-qt5 && make` in the main directory.
|
|
|
|
### Arch
|
|
Compilation Dependencies:
|
|
````
|
|
pacman -S git qt5-base base-devel
|
|
````
|
|
|
|
Compilation: run `qmake && make` in the main directory.
|
|
|
|
### Install
|
|
|
|
Simply use `make install` with privileges.
|
|
|
|
## Packaging
|
|
|
|
In order to generate the makefile installing in `/usr` instead of in `/usr/local` you can use the `packaging` option to generate the proper makefile (`qmake CONFIG+=packaging` instead of just `qmake`).
|
|
|
|
If you want to install in a custom directory you can define the `BASEDIR` variable.
|
|
|
|
**Example**:
|
|
You whant to install Flameshot in ~/myBuilds/test. You would execute the following to do so:
|
|
`qmake CONFIG+=packaging BASEDIR=~/myBuilds/test && make install`
|
|
|
|
### Runtime Dependencies
|
|
|
|
**Debian**:
|
|
````
|
|
libqt5dbus5, libqt5network5, libqt5core5a, libqt5widgets5, libqt5gui5
|
|
````
|
|
|
|
**Fedora**:
|
|
````
|
|
qt5-qtbase
|
|
````
|
|
|
|
**Arch**:
|
|
````
|
|
qt5-base
|
|
````
|
|
|
|
## License
|
|
- The main code is licensed under [GPLv3](./LICENSE)
|
|
- The logo of Flameshot is licensed under [Free Art License v1.3](./img/flameshotLogoLicense.txt)
|
|
- The button icons are licensed under Apache License 2.0. See: https://github.com/google/material-design-icons
|
|
- The code at capture/capturewidget.cpp is based on https://github.com/ckaiser/Lightscreen/blob/master/dialogs/areadialog.cpp (GPLv2)
|
|
- The code at capture/capturewidget.h is based on https://github.com/ckaiser/Lightscreen/blob/master/dialogs/areadialog.h (GPLv2)
|
|
- I copied a few lines of code from KSnapshot regiongrabber.cpp revision 796531 (LGPL)
|
|
- Qt-Color-Widgets taken and modified from https://github.com/mbasaglia/Qt-Color-Widgets (see their license and exceptions in the project) (LGPL/GPL)
|
|
|
|
Info: If I take code from your project and that implies a relicense to GPLv3, you can reuse my changes with the original previous license of ypur project applied.
|
|
|
|
## Acknowledgment
|
|
I really appreciate those who have shown interest in the develpment process:
|
|
- Cosmo.
|
|
- ismatori.
|
|
- The members of the Sugus GNU/Linux association.
|