flameshot.1 8.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332
  1. .\" Hey, EMACS: -*- nroff -*-
  2. .\" (C) Copyright 2018 Boyuan Yang <073plan@gmail.com>,
  3. .\" This file is released under CC0 1.0 Universal (CC0-1.0) license.
  4. .\"
  5. .TH "FLAMESHOT" "1" "2021-11-11"
  6. .\" Please adjust this date whenever revising the manpage.
  7. .\"
  8. .\" Some roff macros, for reference:
  9. .\" .nh disable hyphenation
  10. .\" .hy enable hyphenation
  11. .\" .ad l left justify
  12. .\" .ad b justify to both left and right margins
  13. .\" .nf disable filling
  14. .\" .fi enable filling
  15. .\" .br insert line break
  16. .\" .sp <n> insert n+1 empty lines
  17. .\" for manpage-specific macros, see man(7)
  18. .SH NAME
  19. Flameshot \- Powerful yet simple-to-use screenshot software
  20. .SH SYNOPSIS
  21. .B flameshot
  22. [subcommands] [arguments]
  23. .br
  24. .B flameshot gui
  25. [gui arguments]
  26. .br
  27. .B flameshot screen
  28. [screen arguments]
  29. .br
  30. .B flameshot full
  31. [fullscreen arguments]
  32. .br
  33. .B flameshot config
  34. [config arguments]
  35. .br
  36. .B flameshot launcher
  37. .br
  38. .
  39. .\"----------------------------------------------------------------------------
  40. .SH DESCRIPTION
  41. This manual page documents briefly the
  42. .B flameshot
  43. command as provided by
  44. .B flameshot
  45. package.
  46. .PP
  47. \fBflameshot\fP is a screenshot tool that aims to be powerful yet simple-to-use.
  48. Its notable features include customizable appearance, in-app screenshot editing,
  49. D-Bus interface, tray icon support, experimental GNOME/KDE Wayland support,
  50. integration with Imgur and support for both GUI and CLI interface.
  51. .PP
  52. Besides the usage information about \fBflameshot\fR in this manpage, you can find similar information using \fBflameshot --help\fR. Same \fB--help\fR can be used for each subcommand as well to get the valid arguments for them. The detailed usage of \fBflameshot\fP is documented in the \fIREADME.md\fR file on the project's Git repository page:
  53. https://github.com/flameshot-org/flameshot
  54. .
  55. .\"----------------------------------------------------------------------------
  56. .SH "SUBCOMMANDS"
  57. .PP
  58. Per default without subcommands, \fBflameshot\fR 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:
  59. .
  60. .TP
  61. .B gui
  62. Running Flameshot in \fBgui\fR mode would let the user to select the region from which the screenshot should be taken and then allow them to annotate the screenshot.
  63. .
  64. .TP
  65. .B full
  66. Takes screenshot of all monitors at the same time
  67. .
  68. .TP
  69. .B screen
  70. Takes screenshot of the specified monitor.
  71. .
  72. .TP
  73. .SH launcher
  74. Does not accept any arguments, it will just opens the launcher window
  75. .
  76. .TP
  77. .SH config
  78. If no argument is provided, it will open the config window, otherwise it can change the configurations based on the provided arguments.
  79. .
  80. .\"----------------------------------------------------------------------------
  81. .SH "ARGUMENTS"
  82. .PP
  83. 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 \fBflameshot [subcommand] --help\fR to know the list of available arguments for each subcommand.
  84. .
  85. .PP
  86. \-a, \-\-autostart <bool>
  87. .RS 4
  88. Enable or disable run at startup
  89. .br
  90. Valid for subcommands: config
  91. .RE
  92. .
  93. .PP
  94. \-\-check
  95. .RS 4
  96. Check the configuration for errors. This is useful if you manually change the config file and want to make sure it does not contain errors.
  97. .br
  98. Valid for subcommands: config
  99. .RE
  100. .
  101. .PP
  102. \-c, \-\-clipboard
  103. .RS 4
  104. Save the capture to the clipboard
  105. .br
  106. Valid for subcommands: full, gui, screen
  107. .RE
  108. .
  109. .PP
  110. \-d, \-\-delay <milliseconds>
  111. .RS 4
  112. How many milliseconds should Flameshot wait before taking the screenshot
  113. .br
  114. Valid for subcommands: full, gui, screen
  115. .RE
  116. .
  117. .PP
  118. \-f, \-\-filename <pattern>
  119. .RS 4
  120. Set the filename pattern
  121. .br
  122. Valid for subcommands: config
  123. .RE
  124. .
  125. .PP
  126. \-g, \-\-print-geometry
  127. .RS 4
  128. Print geometry of the selection in the format W H X Y. Does nothing if raw is specified
  129. .br
  130. Valid for subcommands: gui
  131. .RE
  132. .
  133. .PP
  134. \-h, \-\-help
  135. .RS 4
  136. Show a brief help message and list the arguments the valid arguments for that subcommand
  137. .br
  138. Valid for subcommands: config, full, gui, launcher, screen
  139. .RE
  140. .
  141. .PP
  142. \-k, \-\-contrastcolor <color-code>
  143. .RS 4
  144. Define the contrast UI color
  145. .br
  146. Valid for subcommands: config
  147. .RE
  148. .
  149. .PP
  150. \-m, \-\-maincolor <color-code>
  151. .RS 4
  152. Define the main UI color
  153. .br
  154. Valid for subcommands: config
  155. .RE
  156. .
  157. .PP
  158. \-n, \-\-number <Screen number>
  159. .RS 4
  160. Define the screen to capture (starting from 0), default: screen containing the cursor
  161. .br
  162. Valid for subcommands: screen
  163. .RE
  164. .
  165. .PP
  166. \-p, \-\-path <path>
  167. .RS 4
  168. Existing directory or new file to save to
  169. .br
  170. Valid for subcommands: full, gui, screen
  171. .RE
  172. .
  173. .PP
  174. \-\-pin
  175. .RS 4
  176. Pin the capture to the screen
  177. .br
  178. Valid for subcommands: gui, screen
  179. .RE
  180. .
  181. .PP
  182. \-r, \-\-raw
  183. .RS 4
  184. Send raw PNG to stdout
  185. .br
  186. Valid for subcommands: full, gui, screen
  187. .RE
  188. .
  189. .PP
  190. \-\-region <WxH+X+Y or string>
  191. .RS 4
  192. Screenshot region to select
  193. .br
  194. Valid for subcommands: full, gui, screen
  195. .RE
  196. .
  197. .PP
  198. \-s, \-\-accept-on-select
  199. .RS 4
  200. Accept capture as soon as a selection is made
  201. .br
  202. Valid for subcommands: gui
  203. .RE
  204. .
  205. .PP
  206. \-s, \-\-showhelp <bool>
  207. .RS 4
  208. Show the help message in the capture mode
  209. .br
  210. Valid for subcommands: config
  211. .RE
  212. .
  213. .PP
  214. \-t, \-\-trayicon <bool>
  215. .RS 4
  216. Enable or disable the trayicon
  217. .br
  218. Valid for subcommands: config
  219. .RE
  220. .
  221. .PP
  222. \-u, \-\-upload
  223. .RS 4
  224. Upload screenshot
  225. .br
  226. Valid for subcommands: full, gui, screen
  227. .RE
  228. .
  229. .\"----------------------------------------------------------------------------
  230. .SH "EXAMPLE USAGE"
  231. .PP
  232. This section lists some of the most common usage of \fBflameshot\fR via
  233. command line.
  234. .
  235. .TP
  236. .B flameshot
  237. Start flameshot and have it running in background. If enabled,
  238. an icon will appear in the tray area of current desktop environment.
  239. .
  240. .TP
  241. .B flameshot gui
  242. Capture with GUI.
  243. .
  244. .TP
  245. \fBflameshot gui\fR \-p /path/to/captures
  246. Capture with GUI and custom save path.
  247. .
  248. .TP
  249. \fBflameshot gui\fR \-d 2000
  250. Open GUI with a delay of 2 seconds.
  251. .
  252. .TP
  253. .B flameshot launcher
  254. Open a launcher dialog for advanced screenshot, such as custom
  255. time delay, etc.
  256. .
  257. .TP
  258. .B flameshot full \-\-help
  259. Shows help for \fBflameshot full\fR subcommand.
  260. .
  261. .TP
  262. \fBflameshot full\fR -p /path/to/captures -d 5000
  263. Fullscreen capture with custom save path (no GUI) and time delay.
  264. .
  265. .TP
  266. \fBflameshot full\fR -c -p /path/to/captures
  267. Fullscreen capture with custom savepath copying to clipboard.
  268. .
  269. .TP
  270. \fBflameshot screen\fR \-\-number <screen number>
  271. Define the screen to capture. Will capture the screen containing the
  272. cursor by default.
  273. .
  274. .TP
  275. \fBflameshot screen\fR \-\-help
  276. Shows help for \fBflameshot screen\fR subcommand.
  277. .
  278. .\"----------------------------------------------------------------------------
  279. .SH SEE ALSO
  280. .PP
  281. You may also find more detailed online documentation on upstream project homepage.
  282. .
  283. .HP
  284. Upstream project homepage:
  285. .br
  286. • \m[blue]\fBhttps://flameshot.org\fR\m[]
  287. .br
  288. • \m[blue]\fBhttps://github.com/flameshot-org/flameshot\fR\m[]
  289. .
  290. .\"----------------------------------------------------------------------------
  291. .SH "AUTHOR"
  292. .PP
  293. .ad l
  294. .B Flameshot
  295. was initially written by
  296. .MT izhe@\:hotmail.es
  297. lupoDharkael
  298. .ME
  299. and is currently maintained by
  300. Jeremy Borgman,
  301. .MT byang@\:debian.org
  302. Boyuan Yang
  303. .ME ,
  304. Haris Gušić,
  305. Ahmed Zetao Yang,
  306. Mehrad Mahmoudian,
  307. and
  308. Martin Eckleben
  309. (ordered based on number of contributions on the date of writing this manpage).
  310. .br
  311. The following URL gives you a more complete list of contributors:
  312. .RS
  313. \m[blue]\fBhttps://github.com/flameshot-org/flameshot/graphs/contributors\fR\m[]\&.
  314. .RE
  315. .
  316. .\"----------------------------------------------------------------------------
  317. .SH "LICENSE"
  318. .nh
  319. .PP
  320. • The main code is licensed under GPLv3
  321. .br
  322. • The logo of Flameshot is licensed under Free Art License v1.3
  323. .br
  324. • The button icons are licensed under Apache License 2.0. See: \m[blue]\fBhttps://github.com/google/material-design-icons\fR\m[]
  325. .br
  326. • The code at capture/capturewidget.cpp is based on \m[blue]\fBhttps://github.com/ckaiser/Lightscreen/blob/master/dialogs/areadialog.cpp\fR\m[] (GPLv2)
  327. .br
  328. • The code at capture/capturewidget.h is based on \m[blue]\fBhttps://github.com/ckaiser/Lightscreen/blob/master/dialogs/areadialog.h\fR\m[] (GPLv2)
  329. .br
  330. • Few lines of code from KSnapshot regiongrabber.cpp SVN revision 796531 (LGPL)
  331. .br
  332. • Qt-Color-Widgets taken and modified from \m[blue]\fBhttps://github.com/mbasaglia/Qt-Color-Widgets\fR\m[] (see their license and exceptions in the project) (LGPL/GPL)