Skip to content

Commit

Permalink
Updated manpage
Browse files Browse the repository at this point in the history
  • Loading branch information
eribertomota committed Apr 11, 2023
1 parent 3c184e3 commit 2d1d8f5
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 23 deletions.
4 changes: 2 additions & 2 deletions man/create-man.sh
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ txt2man -d "$T2M_DATE" -t $T2M_NAME -r $T2M_NAME-$T2M_VERSION -s $T2M_LEVEL -v "
#--------------------------------------------------------

# Put here all data for your first manpage (in T2M lines)
T2M_DATE="20 Jan 2023"
T2M_DATE="10 Apr 2023"
T2M_NAME=scrot
T2M_VERSION=1.8.1
T2M_VERSION=1.9
T2M_LEVEL=1
T2M_DESC="command line screen capture utility"
create-man
58 changes: 37 additions & 21 deletions man/scrot.1
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
.\" Text automatically generated by txt2man
.TH scrot 1 "20 Jan 2023" "scrot-1.8.1" "command line screen capture utility"
.TH scrot 1 "10 Apr 2023" "scrot-1.9" "command line screen capture utility"
.SH NAME
\fBscrot \fP- command line screen capture utility
\fB
.SH SYNOPSIS
.nf
.fam C
\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]
[\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]
[\fB-t\fP \fINUM\fP | \fIGEOM\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 \fIOPTS\fP] [\fB-t\fP % | \fIWxH\fP]
[\fB-w\fP \fINUM\fP] [[\fB-F\fP] \fIFILE\fP]

.fam T
.fi
Expand Down Expand Up @@ -58,16 +58,22 @@ Display a countdown when used with \fB-d\fP.
\fIDISPLAY\fP is the display to use; see \fBX\fP(7).
.TP
.B
\fB-d\fP, \fB--delay\fP \fISEC\fP
\fB-d\fP, \fB--delay\fP [b]\fISEC\fP
Wait \fISEC\fP seconds before taking a shot.
When given the `b` prefix, e.g `\fB-d\fP b8`, the delay
will be applied before selection.
.TP
.B
\fB-e\fP, \fB--exec\fP \fICMD\fP
Execute \fICMD\fP on the saved image.
.TP
.B
\fB-F\fP, \fB--file\fP
File name. See SPECIAL STRINGS.
\fB-F\fP, \fB--file\fP \fIFILE\fP
Specify the output file. If \fIFILE\fP is "-", \fBscrot\fP will
output a PNG image to stdout. The filename is
expanded according to the format specified in
SPECIAL STRINGS. The output file may be specified
through the \fB-F\fP option, or as a non-option argument.
.TP
.B
\fB-f\fP, \fB--freeze\fP
Expand All @@ -82,7 +88,7 @@ Display help and exit.
Don't exit for keyboard input. ESC still exits.
.TP
.B
\fB-k\fP, \fB--stack\fP \fIOPT\fP
\fB-k\fP, \fB--stack\fP[=\fIOPT\fP]
Capture stack/overlapped windows and join them. A
running Composite Manager is needed. \fIOPT\fP it's optional
join letter: v/h (vertical/horizontal). Default: h
Expand Down Expand Up @@ -123,21 +129,22 @@ value represents higher quality and larger
file size. Default: 75.
.TP
.B
\fB-S\fP, \fB--script\fP \fICMD\fP
\fICMD\fP is an imlib2 script.
.TP
.B
\fB-s\fP, \fB--select\fP \fIOPTS\fP
\fB-s\fP, \fB--select\fP[=\fIOPTS\fP]
Interactively select a window or rectangle with the
mouse, use the arrow keys to resize. See the \fB-l\fP and
\fB-f\fP options. \fIOPTS\fP it's optional; see SELECTION MODE
.TP
.B
\fB-t\fP, \fB--thumb\fP \fINUM\fP | \fIGEOM\fP
Also generate a thumbnail. The argument is the
resolution of the thumbnail, it may be a percentage
\fINUM\fP or a resolution \fIGEOM\fP. Examples: 10, 25, 320x240,
500x200.
\fB-t\fP, \fB--thumb\fP % | \fIWxH\fP
Also generate a thumbnail. The argument represents
the thumbnail's resolution: if the argument is a
single number, it is a percentage of the full size
screenshot's resolution; if it is 2 numbers
separated by an "x" character, it is a resolution.
If one of the resolution's dimensions is 0, it is
replaced by a number that maintains the full size
screenshot's aspect ratio. Examples: 10, 25, 320x240,
500x200, 100x0, 0x480.
.TP
.B
\fB-u\fP, \fB--focused\fP
Expand All @@ -148,13 +155,21 @@ Use the currently focused window.
Output version information and exit.
.TP
.B
\fB-w\fP, \fB--window\fP
Window identifier to capture.
Must be a valid identifier (see \fBxwininfo\fP(1)).
.TP
.B
\fB-z\fP, \fB--silent\fP
Prevent beeping.
.TP
.B
-
Redirection to standard output. The output image
format is PNG.
\fB--format\fP FMT
Specify the output file format. E.g "\fB--format\fP png".
If no format is specified, \fBscrot\fP will use the file
extension to determine the format. If filename
does not have an extension either, then PNG will
be used as fallback.
.SH SPECIAL STRINGS
\fB-e\fP, \fB-F\fP and \fIFILE\fP parameters can take format specifiers that are expanded
by \fBscrot\fP when encountered. There are two types of format specifier:
Expand All @@ -174,7 +189,7 @@ recognised by \fBscrot\fP:
$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.
$W The name of the window (only for --select and --focused).
$W The name of the window (only for --select, --focused and --window).
\\n A literal newline (ignored when used in the filename).

.fam T
Expand Down Expand Up @@ -298,6 +313,7 @@ Example:
.fi
.SH SEE ALSO
\fBoptipng\fP(1)
\fBxwininfo\fP(1)
.SH AUTHOR
\fBscrot\fP was originally developed by Tom Gilbert.
.PP
Expand Down

0 comments on commit 2d1d8f5

Please sign in to comment.