flameshot1

Usage

Overview

This manual page documents briefly the flameshot command as provided by flameshot package.

flameshot is a screenshot tool that aims to be powerful yet simple-to-use. Its notable features include customizable appearance, in-app screenshot editing, D-Bus interface, tray icon support, experimental GNOME/KDE Wayland support, integration with Imgur and support for both GUI and CLI interface.

Besides the usage information about flameshot in this manpage, you can find similar information using flameshot --help. Same --help can be used for each subcommand as well to get the valid arguments for them. The detailed usage of flameshot is documented in the README.md file on the project's Git repository page: https://github.com/flameshot-org/flameshot

Subcommands

Per default without subcommands, flameshot runs the Flameshot in the background and adds a tray icon for configuration. Note that it will not take a screenshot unless you define one of the modes though the subcommands. There are various subcommands that can be used to use flameshot in different modes:

gui

Running Flameshot in gui mode would let the user to select the region from which the screenshot should be taken and then allow them to annotate the screenshot.

full

Takes screenshot of all monitors at the same time

screen

Takes screenshot of the specified monitor.

Does not accept any arguments, it will just opens the launcher window

launcher

If no argument is provided, it will open the config window, otherwise it can change the configurations based on the provided arguments.

config

Arguments

Here we list all the arguments available for all subcommands. The subcommands that accept each argument are listed after each argument. Alternatively, you can use the flameshot [subcommand] --help to know the list of available arguments for each subcommand.

-s, --accept-on-select

-a, --autostart <bool>

--check

-c, --clipboard

-k, --contrastcolor <color-code>

-d, --delay <milliseconds>

-e, --edit

-f, --filename <pattern>

-h, --help

--last-region

-m, --maincolor <color-code>

-n, --notifications

-n, --number <Screen number>

-p, --path <path>

--pin

-g, --print-geometry

-r, --raw

--region <WxH+X+Y or string>

-s, --showhelp <bool>

-t, --trayicon <bool>

Example usage

This section lists some of the most common usage of flameshot via command line.

flameshot

Start flameshot and have it running in background. If enabled, an icon will appear in the tray area of current desktop environment.

flameshot gui

Capture with GUI.

flameshot gui -p /path/to/captures

Capture with GUI and custom save path.

flameshot gui -d 2000

Open GUI with a delay of 2 seconds.

flameshot launcher

Open a launcher dialog for advanced screenshot, such as custom time delay, etc.

flameshot full --help

Shows help for flameshot full subcommand.

flameshot full -p /path/to/captures -d 5000

Fullscreen capture with custom save path (no GUI) and time delay.

flameshot full -c -p /path/to/captures

Fullscreen capture with custom savepath copying to clipboard.

flameshot screen --number <screen number>

Define the screen to capture. Will capture the screen containing the cursor by default.

flameshot screen --help

Shows help for flameshot screen subcommand.

Return value

Returns 0 on normal exit, 2 on screenshot aborted, 3 on dbus connection lost, 130 on SIGINT received, 143 on SIGTERM received.