Skip to content

Commit 2d1d8f5

Browse files
committed
Updated manpage
1 parent 3c184e3 commit 2d1d8f5

File tree

2 files changed

+39
-23
lines changed

2 files changed

+39
-23
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="20 Jan 2023"
19+
T2M_DATE="10 Apr 2023"
2020
T2M_NAME=scrot
21-
T2M_VERSION=1.8.1
21+
T2M_VERSION=1.9
2222
T2M_LEVEL=1
2323
T2M_DESC="command line screen capture utility"
2424
create-man

man/scrot.1

Lines changed: 37 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
.\" Text automatically generated by txt2man
2-
.TH scrot 1 "20 Jan 2023" "scrot-1.8.1" "command line screen capture utility"
2+
.TH scrot 1 "10 Apr 2023" "scrot-1.9" "command line screen capture utility"
33
.SH NAME
44
\fBscrot \fP- command line screen capture utility
55
\fB
66
.SH SYNOPSIS
77
.nf
88
.fam C
99
\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]
10-
[\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]
11-
[\fB-t\fP \fINUM\fP | \fIGEOM\fP] [\fIFILE\fP]
10+
[\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 \fIOPTS\fP] [\fB-t\fP % | \fIWxH\fP]
11+
[\fB-w\fP \fINUM\fP] [[\fB-F\fP] \fIFILE\fP]
1212

1313
.fam T
1414
.fi
@@ -58,16 +58,22 @@ Display a countdown when used with \fB-d\fP.
5858
\fIDISPLAY\fP is the display to use; see \fBX\fP(7).
5959
.TP
6060
.B
61-
\fB-d\fP, \fB--delay\fP \fISEC\fP
61+
\fB-d\fP, \fB--delay\fP [b]\fISEC\fP
6262
Wait \fISEC\fP seconds before taking a shot.
63+
When given the `b` prefix, e.g `\fB-d\fP b8`, the delay
64+
will be applied before selection.
6365
.TP
6466
.B
6567
\fB-e\fP, \fB--exec\fP \fICMD\fP
6668
Execute \fICMD\fP on the saved image.
6769
.TP
6870
.B
69-
\fB-F\fP, \fB--file\fP
70-
File name. See SPECIAL STRINGS.
71+
\fB-F\fP, \fB--file\fP \fIFILE\fP
72+
Specify the output file. If \fIFILE\fP is "-", \fBscrot\fP will
73+
output a PNG image to stdout. The filename is
74+
expanded according to the format specified in
75+
SPECIAL STRINGS. The output file may be specified
76+
through the \fB-F\fP option, or as a non-option argument.
7177
.TP
7278
.B
7379
\fB-f\fP, \fB--freeze\fP
@@ -82,7 +88,7 @@ Display help and exit.
8288
Don't exit for keyboard input. ESC still exits.
8389
.TP
8490
.B
85-
\fB-k\fP, \fB--stack\fP \fIOPT\fP
91+
\fB-k\fP, \fB--stack\fP[=\fIOPT\fP]
8692
Capture stack/overlapped windows and join them. A
8793
running Composite Manager is needed. \fIOPT\fP it's optional
8894
join letter: v/h (vertical/horizontal). Default: h
@@ -123,21 +129,22 @@ value represents higher quality and larger
123129
file size. Default: 75.
124130
.TP
125131
.B
126-
\fB-S\fP, \fB--script\fP \fICMD\fP
127-
\fICMD\fP is an imlib2 script.
128-
.TP
129-
.B
130-
\fB-s\fP, \fB--select\fP \fIOPTS\fP
132+
\fB-s\fP, \fB--select\fP[=\fIOPTS\fP]
131133
Interactively select a window or rectangle with the
132134
mouse, use the arrow keys to resize. See the \fB-l\fP and
133135
\fB-f\fP options. \fIOPTS\fP it's optional; see SELECTION MODE
134136
.TP
135137
.B
136-
\fB-t\fP, \fB--thumb\fP \fINUM\fP | \fIGEOM\fP
137-
Also generate a thumbnail. The argument is the
138-
resolution of the thumbnail, it may be a percentage
139-
\fINUM\fP or a resolution \fIGEOM\fP. Examples: 10, 25, 320x240,
140-
500x200.
138+
\fB-t\fP, \fB--thumb\fP % | \fIWxH\fP
139+
Also generate a thumbnail. The argument represents
140+
the thumbnail's resolution: if the argument is a
141+
single number, it is a percentage of the full size
142+
screenshot's resolution; if it is 2 numbers
143+
separated by an "x" character, it is a resolution.
144+
If one of the resolution's dimensions is 0, it is
145+
replaced by a number that maintains the full size
146+
screenshot's aspect ratio. Examples: 10, 25, 320x240,
147+
500x200, 100x0, 0x480.
141148
.TP
142149
.B
143150
\fB-u\fP, \fB--focused\fP
@@ -148,13 +155,21 @@ Use the currently focused window.
148155
Output version information and exit.
149156
.TP
150157
.B
158+
\fB-w\fP, \fB--window\fP
159+
Window identifier to capture.
160+
Must be a valid identifier (see \fBxwininfo\fP(1)).
161+
.TP
162+
.B
151163
\fB-z\fP, \fB--silent\fP
152164
Prevent beeping.
153165
.TP
154166
.B
155-
-
156-
Redirection to standard output. The output image
157-
format is PNG.
167+
\fB--format\fP FMT
168+
Specify the output file format. E.g "\fB--format\fP png".
169+
If no format is specified, \fBscrot\fP will use the file
170+
extension to determine the format. If filename
171+
does not have an extension either, then PNG will
172+
be used as fallback.
158173
.SH SPECIAL STRINGS
159174
\fB-e\fP, \fB-F\fP and \fIFILE\fP parameters can take format specifiers that are expanded
160175
by \fBscrot\fP when encountered. There are two types of format specifier:
@@ -174,7 +189,7 @@ recognised by \fBscrot\fP:
174189
$s The image's size in bytes (ignored when used in the filename).
175190
$t The image's file format (ignored when used in the filename).
176191
$w The image's width.
177-
$W The name of the window (only for --select and --focused).
192+
$W The name of the window (only for --select, --focused and --window).
178193
\\n A literal newline (ignored when used in the filename).
179194

180195
.fam T
@@ -298,6 +313,7 @@ Example:
298313
.fi
299314
.SH SEE ALSO
300315
\fBoptipng\fP(1)
316+
\fBxwininfo\fP(1)
301317
.SH AUTHOR
302318
\fBscrot\fP was originally developed by Tom Gilbert.
303319
.PP

0 commit comments

Comments
 (0)