scrot.1 4.61 KB
Newer Older
1
.\" Text automatically generated by txt2man
2
.TH scrot 1 "11 July 2019" "scrot-1.1.1" "command line screen capture utility"
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
.SH NAME
\fBscrot \fP- command line screen capture utility
\fB
.SH SYNOPSIS
.nf
.fam C
\fBscrot\fP [\fIoptions\fP] [\fIfile\fP]

.fam T
.fi
.fam T
.fi
.SH DESCRIPTION
\fBscrot\fP (SCReenshOT) is a simple command line screen capture
utility that uses imlib2 to grab and save images. Multiple
image formats are supported through imlib2's dynamic saver
modules.
.PP
Some features of the \fBscrot\fP:
.RS
.IP \(bu 3
support to multiple image formats (JPG, PNG, GIF, etc.).
.IP \(bu 3
optimization of the screen shots image quality.
.IP \(bu 3
capture a specific window or a rectangular area on the
screen with the help of switch.
.RE
.PP
\fBscrot\fP also can be used to monitor a desktop PC in admin absent
and register unwanted activities.
.SH OPTIONS
.TP
.B
\fB-h\fP, \fB--help\fP
Display help output and exit.
.TP
.B
\fB-v\fP, \fB--version\fP
Output version information and exit.
.TP
.B
\fB-a\fP, \fB--autoselect\fP
Non-interactively choose a rectangle of x,y,w,h.
.TP
.B
\fB-b\fP, \fB--border\fP
When selecting a window, grab wm border too.
.TP
.B
\fB-c\fP, \fB--count\fP
Display a countdown when used with delay.
.TP
.B
\fB-d\fP, \fB--delay\fP NUM
Wait NUM seconds before taking a shot.
.TP
.B
\fB-e\fP, \fB--exec\fP APP
Exec APP on the saved image.
.TP
.B
\fB-q\fP, \fB--quality\fP NUM
Image  quality (1-100) high value means high size, low
compression. Default: 75. (Effect differs depending on
\fIfile\fP format chosen).
.TP
.B
\fB-m\fP, \fB--multidisp\fP
For multiple heads, grab shot from each and join them
together.
.TP
.B
\fB-s\fP, \fB--select\fP
Interactively select a window or rectangle with the mouse.
78 79 80 81 82 83 84 85 86 87
See \fB-l\fP and \fB-f\fP \fIoptions\fP.
.TP
.B
\fB-l\fP, \fB--line\fP
Indicates the style of the line when the \fB-s\fP option is used.
See SELECTION STYLE.
.TP
.B
\fB-f\fP, \fB--freeze\fP
Freeze the screen when the \fB-s\fP option is used.
88 89 90 91 92 93
.TP
.B
\fB-u\fP, \fB--focused\fP
Use the currently focused window.
.TP
.B
94
\fB-t\fP, \fB--thumb\fP NUM|GEOM
95
Generate thumbnail too. NUM is the percentage of the
96 97
original size for the thumbnail to be. Alternatively,
a GEOMetry can be specified, example: 300x200
98 99 100 101
.TP
.B
\fB-z\fP, \fB--silent\fP
Prevent beeping.
102 103 104 105 106 107 108 109
.TP
.B
\fB-p\fP, \fB--pointer\fP
Capture the mouse pointer.
.TP
.B
\fB-o\fP, \fB--overwrite\fP
By default \fBscrot\fP does not overwrite the files, use this option to allow it.
110 111 112 113
.TP
.B
\fB-n\fP, \fB--note\fP
Draw a text note. See NOTE FORMAT.
114 115 116 117 118 119 120 121 122 123
.SH SPECIAL STRINGS
Both the \fB--exec\fP and filename 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). See man strftime
for examples. These \fIoptions\fP may be used to refer to the current date and
time. The second kind are internal to \fBscrot\fP and are prefixed by '$' The
following specifiers are recognised:
.PP
.nf
.fam C
124
    $a  hostname
125
    $f  image path/filename (ignored when used in the filename)
126
    $m  thumb image path/filename (ignored when used in the filename)
127 128 129 130 131
    $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
132
    $t  image format (ignored when used in the filename)
133 134 135 136 137
    $$  print a literal '$'
    \\n  print a newline (ignored when used in the filename)

.fam T
.fi
138 139 140 141 142 143 144 145
Example:
.PP
.nf
.fam C
    scrot '%Y-%m-%d_$wx$h.png' -e 'mv $f ~/shots/'

.fam T
.fi
146 147
This would create a \fIfile\fP called something like 2000-10-30_2560x1024.png
and move it to your shots directory.
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
.SH SELECTION STYLE
When using \fB--select\fP you can indicate the style of the line with \fB--line\fP.
.PP
The following specifiers are recognised:
.PP
.nf
.fam C
    style=(solid,dash),width=(range 1 to 8)

.fam T
.fi
The default style is:
.PP
.nf
.fam C
    style=solid,width=1

.fam T
.fi
Example:
.PP
.nf
.fam C
    scrot --line style=dash,width=3 --select

.fam T
.fi
.SH NOTE FORMAT
The following specifiers are recognised for the option \fB--note\fP:
.PP
.nf
.fam C
    -f 'FontName/size'
    -t 'text'
    -x position (optional)
    -y position (optional)
    -c color(RGBA) (optional)
185
    -a angle (optional)
186 187 188 189 190 191 192 193 194 195 196

.fam T
.fi
Example:
.PP
.nf
.fam C
    scrot --note "-f '/usr/share/fonts/TTF/DroidSans-Bold/40' -x 10 -y 20 -c 255,0,0,255 -t 'Hi'"

.fam T
.fi
197
.SH AUTHOR
198 199
\fBscrot\fP was originally developed by Tom Gilbert under MIT-advertising license
and is maintained by some people.
200 201 202
.PP
Currently, source code and newer versions are available at
https://github.com/resurrecting-open-source-projects/\fBscrot\fP