scrot.1 (scrot-1.6.tar.bz2) | : | scrot.1 (scrot-1.7.tar.bz2) | ||
---|---|---|---|---|
scrot(1) command line screen capture utility scrot(1) | scrot(1) command line screen capture utility scrot(1) | |||
NAME | NAME | |||
scrot - command line screen capture utility | scrot - command line screen capture utility | |||
SYNOPSIS | SYNOPSIS | |||
scrot [options] [file] | scrot [-bcfhikmopsuvz] [-a X,Y,W,H] [-C NAME] [-D DISPLAY] [-d SEC] [-e C | |||
MD] | ||||
[-F FILE] [-l STYLE] [-n OPTS] [-q NUM] [-S CMD] [-t NUM | GEOM] [F | ||||
ILE] | ||||
DESCRIPTION | DESCRIPTION | |||
scrot (SCReenshOT) is a simple command line screen capture utility t | scrot (SCReenshOT) is a simple command line screen capture utility, | |||
hat uses imlib2 to grab and save | it uses imlib2 to grab and save | |||
images. Multiple image formats are supported through imlib2's dynamic sav | images. | |||
er modules. | ||||
Some features of the scrot: | scrot has many useful features: | |||
· support to multiple image formats (JPG, PNG, GIF, etc.). | · Support for multiple image formats: JPG, PNG, GIF, and others. | |||
· optimization of the screen shots image quality. | · The screenshot's quality is configurable. | |||
· capture a specific window or a rectangular area on the screen w ith the help of switch. | · It is possible to capture a specific window or a rectangular ar ea on the screen. | |||
scrot also can be used to monitor a desktop PC in admin absent and regist | Because scrot is a command line utility, it can easily be scripted and pu | |||
er unwanted activities. | t to novel uses. For instance, | |||
scrot can be used to monitor an X server in absence. | ||||
scrot is free software under the MIT-advertising license. | ||||
OPTIONS | OPTIONS | |||
-h, --help | -a, --autoselect X,Y,W,H | |||
Display help output and exit. | Non-interactively choose a rectangle starting at position X,Y and | |||
of W by H resolution. | ||||
-v, --version | -b, --border | |||
Output version information and exit. | When selecting a window, grab the WM's border too. Use with -s to | |||
raise the focus of the window. | ||||
-D, --display | -C, --class NAME | |||
Specify the display to use; see X(7). | NAME is a window class name. Associative with -k. | |||
-a, --autoselect | -c, --count | |||
Non-interactively choose a rectangle of x,y,w,h. | Display a countdown when used with -d. | |||
-b, --border | -D, --display DISPLAY | |||
When selecting a window, grab wm border too. Use with --select to | DISPLAY is the display to use; see X(7). | |||
raise the focus of the window. | ||||
-c, --count | -d, --delay SEC | |||
Display a countdown when used with delay. | Wait SEC seconds before taking a shot. | |||
-d, --delay NUM | -e, --exec CMD | |||
Wait NUM seconds before taking a shot. | Execute CMD on the saved image. | |||
-e, --exec APP | -F, --file | |||
Exec APP on the saved image. | File name. See SPECIAL STRINGS. | |||
-q, --quality NUM | -f, --freeze | |||
Image quality (1-100) high value means high size, low compression | Freeze the screen when -s is used. | |||
. Default: 75. (Effect differs | ||||
depending on file format chosen). | -h, --help | |||
Display help and exit. | ||||
-i, --ignorekeyboard | ||||
Don't exit for keyboard input. ESC still exits. | ||||
-k, --stack OPT | ||||
Capture stack/overlapped windows and join them. A running Compo | ||||
site Manager is needed. OPT it's | ||||
optional join letter: v/h (vertical/horizontal). Default: h | ||||
-l, --line STYLE | ||||
STYLE indicates the style of the line when the -s option is used; | ||||
see SELECTION STYLE. | ||||
-m, --multidisp | -m, --multidisp | |||
For multiple heads, grab shot from each and join them together. | For multiple heads, screenshot all of them in order. | |||
-s, --select | -n, --note OPTS | |||
Interactively select a window or rectangle with the mouse (use th | OPTS is a collection of options which specify notes to bake into t | |||
e arrow keys to resize). See -l | he image. See NOTE FORMAT. | |||
and -f options. | ||||
-l, --line | -o, --overwrite | |||
Indicates the style of the line when the -s option is used. See S | By default scrot does not overwrite the output FILE, use this opti | |||
ELECTION STYLE. | on to enable it. | |||
-f, --freeze | -p, --pointer | |||
Freeze the screen when the -s option is used. | Capture the mouse pointer. | |||
-q, --quality NUM | ||||
NUM must be between 1 and 100. For lossless output formats, a high | ||||
er value represents better but | ||||
slower compression. For lossy output formats, a higher value repr | ||||
esents higher quality and larger | ||||
file size. Default: 75. | ||||
-S, --script CMD | ||||
CMD is an imlib2 script. | ||||
-s, --select OPT | ||||
Interactively select a window or rectangle with the mouse, use the | ||||
arrow keys to resize. See the | ||||
-l and -f options. OPT it's optional; see SELECTION MODE | ||||
-t, --thumb NUM | GEOM | ||||
Also generate a thumbnail. The argument is the resolution of the t | ||||
humbnail, it may be a percentage | ||||
NUM or a resolution GEOM. Examples: 10, 25, 320x240, 500x200. | ||||
-u, --focused | -u, --focused | |||
Use the currently focused window. | Use the currently focused window. | |||
-t, --thumb NUM|GEOM | -v, --version | |||
Generate thumbnail too. NUM is the percentage of the original size | Output version information and exit. | |||
for the thumbnail to be. Alter- | ||||
natively, a GEOMetry can be specified, example: 300x200. | ||||
-z, --silent | -z, --silent | |||
Prevent beeping. | Prevent beeping. | |||
-p, --pointer | - Redirection to standard output. The output image format is PNG. | |||
Capture the mouse pointer. | ||||
-o, --overwrite | SPECIAL STRINGS | |||
By default scrot does not overwrite the files, use this option to | -e, -F and FILE parameters can take format specifiers that are expanded b | |||
allow it. | y scrot when encountered. There | |||
are two types of format specifier: Characters preceded by a '%' are inte | ||||
rpreted by strftime(2). The sec- | ||||
ond kind are internal to scrot and are prefixed by '$'. The following spe | ||||
cifiers are recognised by scrot: | ||||
$$ 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. | ||||
\n A literal newline (ignored when used in the filename). | ||||
-n, --note | Example: | |||
Draw a text note. See NOTE FORMAT. | ||||
-k, --stack | $ scrot '%Y-%m-%d_$wx$h.png' -e 'optipng $f' | |||
Capture stack/overlapped windows and join them together. A runnin | ||||
g Composite Manager is needed. | ||||
-C, --class NAME | This would create a PNG file with a name similar to 2000-10-30_2560x1 | |||
Window class name. Associative with options: -k. | 024.png and optimize it with | |||
optipng(1). | ||||
-S, --script CMD | SELECTION MODE | |||
Imlib2 script commands. | When using -s, optionally you can indicate the action to perform with t | |||
he selection area. Some actions | ||||
allow optional parameters too. | ||||
SPECIAL STRINGS | capture Capture the selection area, this action is by def | |||
Both the --exec and filename parameters can take format specifiers | ault and | |||
that are expanded by scrot when | does not need to be specified. | |||
encountered. There are two types of format specifier. Characters precede | ||||
d by a '%' are interpreted by | ||||
strftime(2). See man strftime for examples. These options may be used | ||||
to refer to the current date and | ||||
time. The second kind are internal to scrot and are prefixed by '$' The f | ||||
ollowing specifiers are recog- | ||||
nised: | ||||
$a hostname | ||||
$f image path/filename (ignored when used in the filename) | ||||
$m thumb image path/filename (ignored when used in the filename) | ||||
$n image name (ignored when used in the filename) | ||||
$s image size (bytes) (ignored when used in the filename) | ||||
$p image pixel size | ||||
$w image width | ||||
$h image height | ||||
$t image format (ignored when used in the filename) | ||||
$$ print a literal '$' | ||||
\n print a newline (ignored when used in the filename) | ||||
Example: | hole Highlight the selected area overshadowing the res t of the capture. | |||
$ scrot '%Y-%m-%d_$wx$h.png' -e 'mv $f ~/shots/' | hide,IMAGE Hide the selection area by drawing an area of col | |||
or (or image) over it. | ||||
Optionally indicate name of the image to use as c | ||||
over. | ||||
Image has priority over color. | ||||
This would create a file called something like 2000-10-30_2560x1024.png | blur,AMOUNT Blurs the selection area. | |||
and move it to your shots direc- | Optionally you can specify the amount of blur. | |||
tory. | Amount,range: 1..30, default: 18 | |||
SELECTION STYLE | In modes 'hole' and 'hide' the color of the area is indicated by 'color' | |||
When using --select you can indicate the style of the line with --line. | property of the line style and | |||
the opacity of the color (or image) is indicated by property 'opacity', S | ||||
ELECTION STYLE | ||||
The following specifiers are recognised: | If the 'hide' mode uses an image that does not have an alpha channe | |||
l, the opacity parameter will be | ||||
ignored and it will be drawn fully opaque. | ||||
style=(solid,dash),width=(range 1 to 8),color="value", | Examples: | |||
opacity=(range 10 to 100),mode=(edge,classic) | ||||
The default style is: | $ scrot --select=hide | |||
$ scrot -shole --line color="Dark Salmon",opacity=200 | ||||
$ scrot -sblur,10 | ||||
$ scrot -shide,stamp.png --line opacity=120 | ||||
mode=classic,style=solid,width=1,opacity=100 | SELECTION STYLE | |||
When using -s, you can indicate the style of the line with -l. | ||||
-l takes a comma-separated list of specifiers as argument: | ||||
style=STYLE STYLE is either "solid" or "dash" without quotes. | ||||
Mode 'edge' ignore: style, --freeze | width=NUM NUM is a pixel count between 1 and 8 inclusive. | |||
Mode 'classic' ignore: opacity | 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). | ||||
The 'opacity' specifier is only effective if a Composite Manager is runni | opacity=NUM NUM is between 0 and 255 inclusive. 255 means | |||
ng. | 100% opaque, 0 means 100% transparent. For the | |||
opacity of the line this is only effective if a | ||||
Composite Manager is running. | ||||
For the color you can use a name or a hexadecimal value. | 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. | ||||
color="red" or color="#ff0000" | Without the -l option, a default style is used: | |||
mode=classic,style=solid,width=1,opacity=100 | ||||
Example: | Example: | |||
$ scrot --line style=dash,width=3,color="red" --select | $ scrot -l style=dash,width=3,color="red" -s | |||
NOTE FORMAT | NOTE FORMAT | |||
The following specifiers are recognised for the option --note: | The -n option's argument is more arguments: | |||
-f 'FontName/size' | -f 'FontName/size' | |||
-t 'text' | -t 'text' | |||
-x position (optional) | -x position (optional) | |||
-y position (optional) | -y position (optional) | |||
-c color(RGBA) (optional) | -c color(RGBA, range 0..255) (optional) | |||
-a angle (optional) | -a angle (optional) | |||
Example: | Example: | |||
$ scrot --note "-f '/usr/share/fonts/TTF/DroidSans-Bold/40' -x 10 -y | $ scrot -n "-f '/usr/share/fonts/TTF/DroidSans-Bold/40' -x 10 | |||
20 -c 255,0,0,255 -t 'Hi'" | -y 20 -c 255,0,0,255 -t 'Hi'" | |||
AUTHOR | AUTHOR | |||
scrot was originally developed by Tom Gilbert under MIT-advertising licen | scrot was originally developed by Tom Gilbert. | |||
se and is maintained by some | ||||
people. | ||||
Currently, source code and newer versions are available at https://gith | Currently, source code is maintained by volunteers. Newer | |||
ub.com/resurrecting-open-source- | versions are available at | |||
projects/scrot | https://github.com/resurrecting-open-source-projects/scrot | |||
scrot-1.6 25 Jul 2021 scrot(1) | scrot-1.7 09 Nov 2021 scrot(1) | |||
End of changes. 48 change blocks. | ||||
116 lines changed or deleted | 173 lines changed or added |