Skip to content

Commit 4d5acf9

Browse files
committed
Re-generate manpage
1 parent 28cf77e commit 4d5acf9

File tree

2 files changed

+30
-45
lines changed

2 files changed

+30
-45
lines changed

man/create-man.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ txt2man -d "$T2M_DATE" -t $T2M_NAME -r $T2M_NAME-$T2M_VERSION -s $T2M_LEVEL -v "
1616
#--------------------------------------------------------
1717

1818
# Put here all data for your first manpage (in T2M lines)
19-
T2M_DATE="10 Apr 2023"
19+
T2M_DATE="10 Jun 2023"
2020
T2M_NAME=scrot
21-
T2M_VERSION=1.9
21+
T2M_VERSION=1.10
2222
T2M_LEVEL=1
2323
T2M_DESC="command line screen capture utility"
2424
create-man

man/scrot.1

Lines changed: 28 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
.\" Text automatically generated by txt2man
2-
.TH scrot 1 "10 Apr 2023" "scrot-1.9" "command line screen capture utility"
2+
.TH scrot 1 "10 Jun 2023" "scrot-1.10" "command line screen capture utility"
33
.SH NAME
44
\fBscrot \fP- command line screen capture utility
55
\fB
@@ -32,7 +32,7 @@ screen.
3232
Because \fBscrot\fP is a command line utility, it can easily be scripted and put to
3333
novel uses. For instance, \fBscrot\fP can be used to monitor an X server in absence.
3434
.PP
35-
\fBscrot\fP is free software under the MIT-advertising license.
35+
\fBscrot\fP is free software under the MIT-feh license.
3636
.SH OPTIONS
3737
.TP
3838
.B
@@ -70,7 +70,7 @@ Execute \fICMD\fP on the saved image.
7070
.B
7171
\fB-F\fP, \fB--file\fP \fIFILE\fP
7272
Specify the output file. If \fIFILE\fP is "-", \fBscrot\fP will
73-
output a PNG image to stdout. The filename is
73+
output the image to stdout. The filename is
7474
expanded according to the format specified in
7575
SPECIAL STRINGS. The output file may be specified
7676
through the \fB-F\fP option, or as a non-option argument.
@@ -107,11 +107,6 @@ Capture Xinerama monitor number \fINUM\fP.
107107
For multiple heads, screenshot all of them in order.
108108
.TP
109109
.B
110-
\fB-n\fP, \fB--note\fP \fIOPTS\fP
111-
\fIOPTS\fP is a collection of options which specify notes
112-
to bake into the image. See NOTE FORMAT.
113-
.TP
114-
.B
115110
\fB-o\fP, \fB--overwrite\fP
116111
By default \fBscrot\fP does not overwrite the output
117112
\fIFILE\fP, use this option to enable it.
@@ -122,11 +117,11 @@ Capture the mouse pointer.
122117
.TP
123118
.B
124119
\fB-q\fP, \fB--quality\fP \fINUM\fP
125-
\fINUM\fP must be between 1 and 100. For lossless output
126-
formats, a higher value represents better but slower
127-
compression. For lossy output formats, a higher
128-
value represents higher quality and larger
129-
file size. Default: 75.
120+
\fINUM\fP must be within [1, 100]. A higher value
121+
represents better quality image and a lower value
122+
represents worse quality image. Effect of this flag
123+
depends on the file format, see COMPRESSION QUALITY
124+
section. Default: 75.
130125
.TP
131126
.B
132127
\fB-s\fP, \fB--select\fP[=\fIOPTS\fP]
@@ -155,9 +150,17 @@ Use the currently focused window.
155150
Output version information and exit.
156151
.TP
157152
.B
158-
\fB-w\fP, \fB--window\fP
153+
\fB-w\fP, \fB--window\fP WID
159154
Window identifier to capture.
160-
Must be a valid identifier (see \fBxwininfo\fP(1)).
155+
WID must be a valid identifier (see \fBxwininfo\fP(1)).
156+
.TP
157+
.B
158+
\fB-Z\fP, \fB--compression\fP LVL
159+
Compression level to use, LVL must be within
160+
[0, 9]. Higher level compression provides lower file
161+
size at the cost of slower encoding/saving speed.
162+
Effect of this flag depends on the file format, see
163+
COMPRESSION QUALITY section. Default: 7.
161164
.TP
162165
.B
163166
\fB-z\fP, \fB--silent\fP
@@ -221,7 +224,7 @@ Some actions allow optional parameters too.
221224

222225
blur,AMOUNT Blurs the selection area.
223226
Optionally you can specify the amount of blur.
224-
Amount,range: 1..30, default: 18
227+
Amount must be within [1, 30]. Default: 18.
225228

226229
.fam T
227230
.fi
@@ -251,7 +254,7 @@ When using \fB-s\fP, you can indicate the style of the line with \fB-l\fP.
251254
.fam C
252255
style=STYLE STYLE is either "solid" or "dash" without quotes.
253256

254-
width=NUM NUM is a pixel count between 1 and 8 inclusive.
257+
width=NUM NUM is a pixel count within [1, 8].
255258

256259
color="COLOR" Color is a hexadecimal HTML color code or the name of
257260
a color. HTML color codes are composed of a pound
@@ -260,10 +263,9 @@ When using \fB-s\fP, you can indicate the style of the line with \fB-l\fP.
260263
blue respectively. Examples: #FF0000 (red), #E0FFFF
261264
(light cyan), #000000 (black).
262265

263-
opacity=NUM NUM is between 0 and 255 inclusive. 255 means
264-
100% opaque, 0 means 100% transparent. For the
265-
opacity of the line this is only effective if a
266-
Composite Manager is running.
266+
opacity=NUM NUM is within [0, 255]. 255 means 100% opaque, 0 means
267+
100% transparent. For the opacity of the line, this is only
268+
effective if the compositor supports _NET_WM_WINDOW_OPACITY.
267269

268270
mode=MODE MODE is either "edge" or "classic" without quotes.
269271
edge is the new selection, classic uses the old one.
@@ -288,29 +290,12 @@ Example:
288290

289291
.fam T
290292
.fi
291-
.SH NOTE FORMAT
292-
The \fB-n\fP option's argument is more arguments:
293-
.PP
294-
.nf
295-
.fam C
296-
-f 'FontName/size'
297-
-t 'text'
298-
-x position (optional)
299-
-y position (optional)
300-
-c color(RGBA, range 0..255) (optional)
301-
-a angle (optional)
302-
303-
.fam T
304-
.fi
305-
Example:
306-
.PP
307-
.nf
308-
.fam C
309-
$ scrot -n "-f '/usr/share/fonts/TTF/DroidSans-Bold/40' -x 10
310-
-y 20 -c 255,0,0,255 -t 'Hi'"
293+
.SH COMPRESSION QUALITY
311294

312-
.fam T
313-
.fi
295+
For lossless formats (e.g PNG), the quality options is ignored. For lossy
296+
formats where the quality and compression are tied together (e.g JPEG),
297+
compression will be ignored. And for image formats where quality and
298+
compression can be independently set (e.g WebP, JXL), both flags are respected.
314299
.SH SEE ALSO
315300
\fBoptipng\fP(1)
316301
\fBxwininfo\fP(1)

0 commit comments

Comments
 (0)