.\" Text automatically generated by txt2man .TH scrot 1 "20 Jan 2023" "scrot-1.8.1" "command line screen capture utility" .SH NAME \fBscrot \fP- command line screen capture utility \fB .SH SYNOPSIS .nf .fam C \fBscrot\fP [\fB-bcfhimopuvz\fP] [\fB-a\fP \fIX,Y,W,H\fP] [\fB-C\fP \fINAME\fP] [\fB-D\fP \fIDISPLAY\fP] [\fB-d\fP \fISEC\fP] [\fB-e\fP \fICMD\fP] [\fB-F\fP \fIFILE\fP] [\fB-k\fP \fIOPT\fP] [\fB-l\fP \fISTYLE\fP] [\fB-M\fP \fINUM\fP] [\fB-n\fP \fIOPTS\fP] [\fB-q\fP \fINUM\fP] [\fB-S\fP \fICMD\fP] [\fB-s\fP \fIOPTS\fP] [\fB-t\fP \fINUM\fP | \fIGEOM\fP] [\fIFILE\fP] .fam T .fi .fam T .fi .SH DESCRIPTION \fBscrot\fP (SCReenshOT) is a simple command line screen capture utility, it uses imlib2 to grab and save images. .PP \fBscrot\fP has many useful features: .RS .IP \(bu 3 Support for multiple image formats: JPG, PNG, GIF, and others. .IP \(bu 3 The screenshot's quality is configurable. .IP \(bu 3 It is possible to capture a specific window or a rectangular area on the screen. .RE .PP Because \fBscrot\fP is a command line utility, it can easily be scripted and put to novel uses. For instance, \fBscrot\fP can be used to monitor an X server in absence. .PP \fBscrot\fP is free software under the MIT-advertising license. .SH OPTIONS .TP .B \fB-a\fP, \fB--autoselect\fP \fIX,Y,W,H\fP Non-interactively choose a rectangle starting at position X,Y and of W by H resolution. .TP .B \fB-b\fP, \fB--border\fP When selecting a window, grab the WM's border too. Use with \fB-s\fP to raise the focus of the window. .TP .B \fB-C\fP, \fB--class\fP \fINAME\fP \fINAME\fP is a window class name. Associative with \fB-k\fP. .TP .B \fB-c\fP, \fB--count\fP Display a countdown when used with \fB-d\fP. .TP .B \fB-D\fP, \fB--display\fP \fIDISPLAY\fP \fIDISPLAY\fP is the display to use; see \fBX\fP(7). .TP .B \fB-d\fP, \fB--delay\fP \fISEC\fP Wait \fISEC\fP seconds before taking a shot. .TP .B \fB-e\fP, \fB--exec\fP \fICMD\fP Execute \fICMD\fP on the saved image. .TP .B \fB-F\fP, \fB--file\fP File name. See SPECIAL STRINGS. .TP .B \fB-f\fP, \fB--freeze\fP Freeze the screen when \fB-s\fP is used. .TP .B \fB-h\fP, \fB--help\fP Display help and exit. .TP .B \fB-i\fP, \fB--ignorekeyboard\fP Don't exit for keyboard input. ESC still exits. .TP .B \fB-k\fP, \fB--stack\fP \fIOPT\fP Capture stack/overlapped windows and join them. A running Composite Manager is needed. \fIOPT\fP it's optional join letter: v/h (vertical/horizontal). Default: h .TP .B \fB-l\fP, \fB--line\fP \fISTYLE\fP \fISTYLE\fP indicates the style of the line when the \fB-s\fP option is used; see SELECTION \fISTYLE\fP. .TP .B \fB-M\fP, \fB--monitor\fP \fINUM\fP Capture Xinerama monitor number \fINUM\fP. .TP .B \fB-m\fP, \fB--multidisp\fP For multiple heads, screenshot all of them in order. .TP .B \fB-n\fP, \fB--note\fP \fIOPTS\fP \fIOPTS\fP is a collection of options which specify notes to bake into the image. See NOTE FORMAT. .TP .B \fB-o\fP, \fB--overwrite\fP By default \fBscrot\fP does not overwrite the output \fIFILE\fP, use this option to enable it. .TP .B \fB-p\fP, \fB--pointer\fP Capture the mouse pointer. .TP .B \fB-q\fP, \fB--quality\fP \fINUM\fP \fINUM\fP must be between 1 and 100. For lossless output formats, a higher value represents better but slower compression. For lossy output formats, a higher value represents higher quality and larger file size. Default: 75. .TP .B \fB-S\fP, \fB--script\fP \fICMD\fP \fICMD\fP is an imlib2 script. .TP .B \fB-s\fP, \fB--select\fP \fIOPTS\fP Interactively select a window or rectangle with the mouse, use the arrow keys to resize. See the \fB-l\fP and \fB-f\fP options. \fIOPTS\fP it's optional; see SELECTION MODE .TP .B \fB-t\fP, \fB--thumb\fP \fINUM\fP | \fIGEOM\fP Also generate a thumbnail. The argument is the resolution of the thumbnail, it may be a percentage \fINUM\fP or a resolution \fIGEOM\fP. Examples: 10, 25, 320x240, 500x200. .TP .B \fB-u\fP, \fB--focused\fP Use the currently focused window. .TP .B \fB-v\fP, \fB--version\fP Output version information and exit. .TP .B \fB-z\fP, \fB--silent\fP Prevent beeping. .TP .B - Redirection to standard output. The output image format is PNG. .SH SPECIAL STRINGS \fB-e\fP, \fB-F\fP and \fIFILE\fP parameters can take format specifiers that are expanded by \fBscrot\fP when encountered. There are two types of format specifier: Characters preceded by a '%' are interpreted by \fBstrftime\fP(2). The second kind are internal to \fBscrot\fP and are prefixed by '$'. The following specifiers are recognised by \fBscrot\fP: .PP .nf .fam C $$ A literal '$'. $a The system's hostname. $f The image's full path (ignored when used in the filename). $h The image's height. $m The thumbnail's full path (ignored when used in the filename). $n The image's basename (ignored when used in the filename). $p The image's pixel size. $s The image's size in bytes (ignored when used in the filename). $t The image's file format (ignored when used in the filename). $w The image's width. $W The name of the window (only for --select and --focused). \\n A literal newline (ignored when used in the filename). .fam T .fi Example: .PP .nf .fam C $ scrot '%Y-%m-%d_$wx$h.png' -e 'optipng $f' .fam T .fi This would create a PNG file with a name similar to 2000-10-30_2560x1024.png and optimize it with \fBoptipng\fP(1). .SH SELECTION MODE When using \fB-s\fP, optionally you can indicate the action to perform with the selection area. Some actions allow optional parameters too. .PP .nf .fam C capture Capture the selection area, this action is by default and does not need to be specified. hole Highlight the selected area overshadowing the rest of the capture. hide,IMAGE Hide the selection area by drawing an area of color (or image) over it. Optionally indicate name of the image to use as cover. Image has priority over color. blur,AMOUNT Blurs the selection area. Optionally you can specify the amount of blur. Amount,range: 1..30, default: 18 .fam T .fi In modes 'hole' and 'hide' the color of the area is indicated by 'color' property of the line style and the opacity of the color (or image) is indicated by property 'opacity', SELECTION \fISTYLE\fP .PP If the 'hide' mode uses an image that does not have an alpha channel, the opacity parameter will be ignored and it will be drawn fully opaque. .PP Examples: .PP .nf .fam C $ scrot --select=hide $ scrot -shole --line color="Dark Salmon",opacity=200 $ scrot -sblur,10 $ scrot -shide,stamp.png --line opacity=120 .fam T .fi .SH SELECTION STYLE When using \fB-s\fP, you can indicate the style of the line with \fB-l\fP. .PP \fB-l\fP takes a comma-separated list of specifiers as argument: .PP .nf .fam C style=STYLE STYLE is either "solid" or "dash" without quotes. width=NUM NUM is a pixel count between 1 and 8 inclusive. color="COLOR" Color is a hexadecimal HTML color code or the name of a color. HTML color codes are composed of a pound sign '#' followed by a sequence of 3 2-digit hexadecimal numbers which represent red, green, and blue respectively. Examples: #FF0000 (red), #E0FFFF (light cyan), #000000 (black). opacity=NUM NUM is between 0 and 255 inclusive. 255 means 100% opaque, 0 means 100% transparent. For the opacity of the line this is only effective if a Composite Manager is running. mode=MODE MODE is either "edge" or "classic" without quotes. edge is the new selection, classic uses the old one. "edge" ignores the style specifier and the -f flag, "classic" ignores the opacity specifier. .fam T .fi Without the \fB-l\fP option, a default style is used: .PP .nf .fam C mode=classic,style=solid,width=1,opacity=100 .fam T .fi Example: .PP .nf .fam C $ scrot -l style=dash,width=3,color="red" -s .fam T .fi .SH NOTE FORMAT The \fB-n\fP option's argument is more arguments: .PP .nf .fam C -f 'FontName/size' -t 'text' -x position (optional) -y position (optional) -c color(RGBA, range 0..255) (optional) -a angle (optional) .fam T .fi Example: .PP .nf .fam C $ scrot -n "-f '/usr/share/fonts/TTF/DroidSans-Bold/40' -x 10 -y 20 -c 255,0,0,255 -t 'Hi'" .fam T .fi .SH SEE ALSO \fBoptipng\fP(1) .SH AUTHOR \fBscrot\fP was originally developed by Tom Gilbert. .PP Currently, source code is maintained by volunteers. Newer versions are available at https://github.com/resurrecting-open-source-projects/\fBscrot\fP