1FLAMESHOT(1) General Commands Manual FLAMESHOT(1)
2
6 Flameshot - Powerful yet simple-to-use screenshot software
7
9 flameshot [subcommands] [arguments]
10 flameshot gui [gui arguments]
11 flameshot screen [screen arguments]
12 flameshot full [fullscreen arguments]
13 flameshot config [config arguments]
14 flameshot launcher
15
17 This manual page documents briefly the flameshot command as provided by
18 flameshot package.
19 flameshot is a screenshot tool that aims to be powerful yet simple-to-
21 use. Its notable features include customizable appearance, in-app
22 screenshot editing, D-Bus interface, tray icon support, experimental
23 GNOME/KDE Wayland support, integration with Imgur and support for both
24 GUI and CLI interface.
25 Besides the usage information about flameshot in this manpage, you can
27 find similar information using flameshot --help. Same --help can be
28 used for each subcommand as well to get the valid arguments for them.
29 The detailed usage of flameshot is documented in the README.md file on
30 the project's Git repository page: https://github.com/flameshot-
31 org/flameshot
32
34 Per default without subcommands, flameshot runs the Flameshot in the
35 background and adds a tray icon for configuration. Note that it will
36 not take a screenshot unless you define one of the modes though the
37 subcommands. There are various subcommands that can be used to use
38 flameshot in different modes:
39 gui Running Flameshot in gui mode would let the user to select the
41 region from which the screenshot should be taken and then allow
42 them to annotate the screenshot.
43 full Takes screenshot of all monitors at the same time
45 screen Takes screenshot of the specified monitor.
47 launcher
50 Does not accept any arguments, it will just opens the launcher
51 window
52 config
55 If no argument is provided, it will open the config window, oth‐
56 erwise it can change the configurations based on the provided
57 arguments.
58
60 Here we list all the arguments available for all subcommands. The sub‐
61 commands that accept each argument are listed after each argument. Al‐
62 ternatively, you can use the flameshot [subcommand] --help to know the
63 list of available arguments for each subcommand.
64 -a, --autostart <bool>
66 Enable or disable run at startup
67 Valid for subcommands: config
68 --check
70 Check the configuration for errors. This is useful if you manually
71 change the config file and want to make sure it does not contain
72 errors.
73 Valid for subcommands: config
74 -c, --clipboard
76 Save the capture to the clipboard
77 Valid for subcommands: full, gui, screen
78 -d, --delay <milliseconds>
80 How many milliseconds should Flameshot wait before taking the
81 screenshot
82 Valid for subcommands: full, gui, screen
83 -f, --filename <pattern>
85 Set the filename pattern
86 Valid for subcommands: config
87 -g, --print-geometry
89 Print geometry of the selection in the format W H X Y. Does nothing
90 if raw is specified
91 Valid for subcommands: gui
92 -h, --help
94 Show a brief help message and list the arguments the valid argu‐
95 ments for that subcommand
96 Valid for subcommands: config, full, gui, launcher, screen
97 -k, --contrastcolor <color-code>
99 Define the contrast UI color
100 Valid for subcommands: config
101 -m, --maincolor <color-code>
103 Define the main UI color
104 Valid for subcommands: config
105 -n, --number <Screen number>
107 Define the screen to capture (starting from 0), default: screen
108 containing the cursor
109 Valid for subcommands: screen
110 -p, --path <path>
112 Existing directory or new file to save to
113 Valid for subcommands: full, gui, screen
114 --pin
116 Pin the capture to the screen
117 Valid for subcommands: gui, screen
118 -r, --raw
120 Send raw PNG to stdout
121 Valid for subcommands: full, gui, screen
122 --region <WxH+X+Y or string>
124 Screenshot region to select
125 Valid for subcommands: full, gui, screen
126 -s, --accept-on-select
128 Accept capture as soon as a selection is made
129 Valid for subcommands: gui
130 -s, --showhelp <bool>
132 Show the help message in the capture mode
133 Valid for subcommands: config
134 -t, --trayicon <bool>
136 Enable or disable the trayicon
137 Valid for subcommands: config
138 -u, --upload
140 Upload screenshot
141 Valid for subcommands: full, gui, screen
142
144 This section lists some of the most common usage of flameshot via com‐
145 mand line.
146 flameshot
148 Start flameshot and have it running in background. If enabled,
149 an icon will appear in the tray area of current desktop environ‐
150 ment.
151 flameshot gui
153 Capture with GUI.
154 flameshot gui -p /path/to/captures
156 Capture with GUI and custom save path.
157 flameshot gui -d 2000
159 Open GUI with a delay of 2 seconds.
160 flameshot launcher
162 Open a launcher dialog for advanced screenshot, such as custom
163 time delay, etc.
164 flameshot full --help
166 Shows help for flameshot full subcommand.
167 flameshot full -p /path/to/captures -d 5000
169 Fullscreen capture with custom save path (no GUI) and time de‐
170 lay.
171 flameshot full -c -p /path/to/captures
173 Fullscreen capture with custom savepath copying to clipboard.
174 flameshot screen --number <screen number>
176 Define the screen to capture. Will capture the screen containing
177 the cursor by default.
178 flameshot screen --help
180 Shows help for flameshot screen subcommand.
181
183 You may also find more detailed online documentation on upstream
184 project homepage.
185 Upstream project homepage:
187 • https://flameshot.org
188 • https://github.com/flameshot-org/flameshot
189
191 Flameshot was initially written by lupoDharkael ⟨izhe@hotmail.es⟩ and
192 is currently maintained by Jeremy Borgman, Boyuan Yang ⟨byang@
193 debian.org⟩, Haris Gušić, Ahmed Zetao Yang, Mehrad Mahmoudian, and Mar‐
194 tin Eckleben (ordered based on number of contributions on the date of
195 writing this manpage).
196 The following URL gives you a more complete list of contributors:
197 https://github.com/flameshot-org/flameshot/graphs/contributors.
198
200 • The main code is licensed under GPLv3
201 • The logo of Flameshot is licensed under Free Art License v1.3
202 • The button icons are licensed under Apache License 2.0. See:
203 https://github.com/google/material-design-icons
204 • The code at capture/capturewidget.cpp is based on
205 https://github.com/ckaiser/Lightscreen/blob/master/dialogs/areadialog.cpp
206 (GPLv2)
207 • The code at capture/capturewidget.h is based on
208 https://github.com/ckaiser/Lightscreen/blob/master/dialogs/areadialog.h
209 (GPLv2)
210 • Few lines of code from KSnapshot regiongrabber.cpp SVN revision
211 796531 (LGPL)
212 • Qt-Color-Widgets taken and modified from
213 https://github.com/mbasaglia/Qt-Color-Widgets (see their license and
214 exceptions in the project) (LGPL/GPL)
215 2021-11-11 FLAMESHOT(1)