Skip to content

Commit 6e9329b

Browse files
committed
Updated manpage
1 parent d255348 commit 6e9329b

File tree

3 files changed

+72
-55
lines changed

3 files changed

+72
-55
lines changed

man/create-man.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88
TEST=$(txt2man -h 2> /dev/null)
99
[ "$TEST" ] || { echo -e "\nYou need to install txt2man, from https://github.com/mvertes/txt2man.\n"; exit 1; }
1010

11-
T2M_DATE="10 June 2019"
11+
T2M_DATE="09 July 2019"
1212
T2M_NAME=scrot
13-
T2M_VERSION=1.0
13+
T2M_VERSION=1.1
1414
T2M_LEVEL=1
1515
T2M_DESC="command line screen capture utility"
1616

man/scrot.1

Lines changed: 46 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
.\" Text automatically generated by txt2man
2-
.TH scrot 1 "10 June 2019" "scrot-1.0" "command line screen capture utility"
2+
.TH scrot 1 "09 July 2019" "scrot-1.1" "command line screen capture utility"
33
.SH NAME
44
\fBscrot \fP- command line screen capture utility
55
\fB
@@ -75,6 +75,16 @@ together.
7575
.B
7676
\fB-s\fP, \fB--select\fP
7777
Interactively select a window or rectangle with the mouse.
78+
See \fB-l\fP and \fB-f\fP \fIoptions\fP.
79+
.TP
80+
.B
81+
\fB-l\fP, \fB--line\fP
82+
Indicates the style of the line when the \fB-s\fP option is used.
83+
See SELECTION STYLE.
84+
.TP
85+
.B
86+
\fB-f\fP, \fB--freeze\fP
87+
Freeze the screen when the \fB-s\fP option is used.
7888
.TP
7989
.B
8090
\fB-u\fP, \fB--focused\fP
@@ -95,24 +105,13 @@ Prevent beeping.
95105
Capture the mouse pointer.
96106
.TP
97107
.B
98-
\fB-f\fP, \fB--freeze\fP
99-
Freeze the screen when the selection is used: \fB--select\fP
100-
.TP
101-
.B
102108
\fB-o\fP, \fB--overwrite\fP
103109
By default \fBscrot\fP does not overwrite the files, use this option to allow it.
104110
.TP
105111
.B
106-
\fB-l\fP, \fB--line\fP
107-
Indicates the style of the line when the selection is used: \fB--select\fP
108-
See SELECTION STYLE
109-
.TP
110-
.B
111112
\fB-n\fP, \fB--note\fP
112-
Draw a text note.
113-
See NOTE FORMAT
113+
Draw a text note. See NOTE FORMAT.
114114
.SH SPECIAL STRINGS
115-
116115
Both the \fB--exec\fP and filename parameters can take format specifiers that are
117116
expanded by \fBscrot\fP when encountered. There are two types of format specifier.
118117
Characters preceded by a '%' are interpreted by \fBstrftime\fP(2). See man strftime
@@ -136,37 +135,45 @@ following specifiers are recognised:
136135

137136
.fam T
138137
.fi
139-
.SH EXAMPLE
140-
.TP
141-
.B
142-
\fBscrot\fP '%Y-%m-%d_$wx$h.png' \fB-e\fP 'mv $f ~/shots/'
143-
This would create a \fIfile\fP called something like 2000-10-30_2560x1024.png
144-
and move it to your shots directory.
145-
.RE
138+
Example:
146139
.PP
140+
.nf
141+
.fam C
142+
scrot '%Y-%m-%d_$wx$h.png' -e 'mv $f ~/shots/'
147143

144+
.fam T
145+
.fi
146+
This would create a \fIfile\fP called something like 2000-10-30_2560x1024.png
147+
and move it to your shots directory.
148148
.SH SELECTION STYLE
149-
150149
When using \fB--select\fP you can indicate the style of the line with \fB--line\fP.
151150
.PP
152151
The following specifiers are recognised:
153152
.PP
154153
.nf
155154
.fam C
156-
style=(solid,dash),width=(range 1 to 8)
155+
style=(solid,dash),width=(range 1 to 8)
157156

158157
.fam T
159158
.fi
160-
The default style are:
161-
style=solid,width=1
162-
.SH EXAMPLE
163-
\fBscrot\fP \fB--line\fP style=dash,width=3 \fB--select\fP
164-
.RE
159+
The default style is:
165160
.PP
161+
.nf
162+
.fam C
163+
style=solid,width=1
166164

167-
.SH NOTE FORMAT
165+
.fam T
166+
.fi
167+
Example:
168+
.PP
169+
.nf
170+
.fam C
171+
scrot --line style=dash,width=3 --select
168172

169-
The following specifiers are recognised for the option \fB--note\fP
173+
.fam T
174+
.fi
175+
.SH NOTE FORMAT
176+
The following specifiers are recognised for the option \fB--note\fP:
170177
.PP
171178
.nf
172179
.fam C
@@ -178,10 +185,17 @@ The following specifiers are recognised for the option \fB--note\fP
178185

179186
.fam T
180187
.fi
181-
.SH EXAMPLE
182-
\fBscrot\fP \fB--note\fP "\fB-f\fP '/usr/share/fonts/TTF/DroidSans-Bold/40' \fB-x\fP 10 \fB-y\fP 20 \fB-c\fP 255,0,0,255 \fB-t\fP 'Hi'"
188+
Example:
189+
.PP
190+
.nf
191+
.fam C
192+
scrot --note "-f '/usr/share/fonts/TTF/DroidSans-Bold/40' -x 10 -y 20 -c 255,0,0,255 -t 'Hi'"
193+
194+
.fam T
195+
.fi
183196
.SH AUTHOR
184-
\fBscrot\fP was originally developed by Tom Gilbert under MIT-advertising license.
197+
\fBscrot\fP was originally developed by Tom Gilbert under MIT-advertising license
198+
and is maintained by some people.
185199
.PP
186200
Currently, source code and newer versions are available at
187201
https://github.com/resurrecting-open-source-projects/\fBscrot\fP

man/scrot.txt

Lines changed: 24 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -33,21 +33,21 @@ OPTIONS
3333
-m, --multidisp For multiple heads, grab shot from each and join them
3434
together.
3535
-s, --select Interactively select a window or rectangle with the mouse.
36+
See -l and -f options.
37+
-l, --line Indicates the style of the line when the -s option is used.
38+
See SELECTION STYLE.
39+
-f, --freeze Freeze the screen when the -s option is used.
3640
-u, --focused Use the currently focused window.
3741
-t, --thumb NUM|GEOM Generate thumbnail too. NUM is the percentage of the
3842
original size for the thumbnail to be. Alternatively,
3943
a GEOMetry can be specified, example: 300x200
4044
-z, --silent Prevent beeping.
4145
-p, --pointer Capture the mouse pointer.
42-
-f, --freeze Freeze the screen when the selection is used: --select
46+
4347
-o, --overwrite By default scrot does not overwrite the files, use this option to allow it.
44-
-l, --line Indicates the style of the line when the selection is used: --select
45-
See SELECTION STYLE
46-
-n, --note Draw a text note.
47-
See NOTE FORMAT
48+
-n, --note Draw a text note. See NOTE FORMAT.
4849

4950
SPECIAL STRINGS
50-
5151
Both the --exec and filename parameters can take format specifiers that are
5252
expanded by scrot when encountered. There are two types of format specifier.
5353
Characters preceded by a '%' are interpreted by strftime(2). See man strftime
@@ -67,41 +67,44 @@ SPECIAL STRINGS
6767
$$ print a literal '$'
6868
\\n print a newline (ignored when used in the filename)
6969

70-
EXAMPLE
71-
scrot '%Y-%m-%d_$wx$h.png' -e 'mv $f ~/shots/'
72-
This would create a file called something like 2000-10-30_2560x1024.png
73-
and move it to your shots directory.
70+
Example:
7471

72+
scrot '%Y-%m-%d_$wx$h.png' -e 'mv $f ~/shots/'
7573

76-
SELECTION STYLE
74+
This would create a file called something like 2000-10-30_2560x1024.png
75+
and move it to your shots directory.
7776

77+
SELECTION STYLE
7878
When using --select you can indicate the style of the line with --line.
7979

8080
The following specifiers are recognised:
8181

82-
style=(solid,dash),width=(range 1 to 8)
82+
style=(solid,dash),width=(range 1 to 8)
8383

84-
The default style are:
85-
style=solid,width=1
86-
EXAMPLE
87-
scrot --line style=dash,width=3 --select
84+
The default style is:
8885

86+
style=solid,width=1
8987

90-
NOTE FORMAT
88+
Example:
89+
90+
scrot --line style=dash,width=3 --select
9191

92-
The following specifiers are recognised for the option --note
92+
NOTE FORMAT
93+
The following specifiers are recognised for the option --note:
9394

9495
-f 'FontName/size'
9596
-t 'text'
9697
-x position (optional)
9798
-y position (optional)
9899
-c color(RGBA) (optional)
99100

100-
EXAMPLE
101-
scrot --note "-f '/usr/share/fonts/TTF/DroidSans-Bold/40' -x 10 -y 20 -c 255,0,0,255 -t 'Hi'"
101+
Example:
102+
103+
scrot --note "-f '/usr/share/fonts/TTF/DroidSans-Bold/40' -x 10 -y 20 -c 255,0,0,255 -t 'Hi'"
102104

103105
AUTHOR
104-
scrot was originally developed by Tom Gilbert under MIT-advertising license.
106+
scrot was originally developed by Tom Gilbert under MIT-advertising license
107+
and is maintained by some people.
105108

106109
Currently, source code and newer versions are available at
107110
https://github.com/resurrecting-open-source-projects/scrot

0 commit comments

Comments
 (0)