aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMattias Andrée <maandree@member.fsf.org>2015-12-10 22:57:51 +0100
committerMattias Andrée <maandree@member.fsf.org>2015-12-10 22:57:51 +0100
commit6a4cbfccbd649b6e9dd92be74d106f7a8336a264 (patch)
tree4f9f38fe21853c92dc3622db5857d6507613cfd6 /doc
parentmostly splitting the source (diff)
downloadscrotty-6a4cbfccbd649b6e9dd92be74d106f7a8336a264.tar.gz
scrotty-6a4cbfccbd649b6e9dd92be74d106f7a8336a264.tar.bz2
scrotty-6a4cbfccbd649b6e9dd92be74d106f7a8336a264.tar.xz
soon, convert will not be used
Signed-off-by: Mattias Andrée <maandree@member.fsf.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/info/chap/invoking.texinfo28
-rw-r--r--doc/info/chap/overview.texinfo11
-rw-r--r--doc/man/scrotty.126
-rw-r--r--doc/man/scrotty.sv.128
4 files changed, 52 insertions, 41 deletions
diff --git a/doc/info/chap/invoking.texinfo b/doc/info/chap/invoking.texinfo
index 25c0b25..d418fc2 100644
--- a/doc/info/chap/invoking.texinfo
+++ b/doc/info/chap/invoking.texinfo
@@ -4,26 +4,30 @@
@command{scrotty} recognises four options:
@table @option
-@item --help
+@item -h
+@itemx --help
Print usage information and exit.
-@item --version
+@item -v
+@itemx --version
Print program name and version and exit.
-@item --copyright
+@item -c
+@itemx --copyright
Print copyright information and exit.
-@item --raw
+@item -r
+@itemx --raw
Save the images in portable anymap format
-(PNM), rather than in Portable Network
-Graphics (PNG). If this option is used,
-and no arguments for @command{convert}
-is specified, @command{convert} will not
-be used, and there will be not requirement
-to have ImageMagick installed.
+(@sc{PNM}), rather than in Portable Network
+Graphics (@sc{PNG}).
-PNM images are highly compressable with
+@sc{PNM} images are highly compressable with
@command{bzip2}. Compressed images are comparable
in size with @sc{PNG},@footnote{Usually a few
bytes in difference.} and can in fact be smaller.
-@item --exec CMD
+
+@sc{PNM} is a good alternative for anything
+but storage. (Unless you compress them.)
+@item -e
+@itemx --exec CMD
Run a command for each saved image.
@end table
diff --git a/doc/info/chap/overview.texinfo b/doc/info/chap/overview.texinfo
index f5d1ff3..26765f4 100644
--- a/doc/info/chap/overview.texinfo
+++ b/doc/info/chap/overview.texinfo
@@ -10,11 +10,16 @@ rendered on the framebuffer.}
@command{scrotty} is designed after @command{scrot}, but
includes a some improvements. Namely it does not support
delaying the screenshot, selecting image quality or creating
-thumbnails, but it has support for adding arbitrary arguments
-to @command{convert} (from the ImageMagick project), which
-is used to save the image.
+thumbnails. Such operations is left to be done by the user
+with the option @option{--exec} and a utility such as
+@command{convert} (from the ImageMagick project.)
@command{scrotty} reads the data stored in the framebuffers,
convert it the @sc{PNM} images and pipes it to @command{convert}
to create @sc{PNG} images.
+@command{scrotty} can appear to be a bit slow. This is not
+@command{scrotty}'s fault. Reading a framebuffer, even if
+not processing the data, takes time. In fact, screenshots
+for @sc{X} are slow too.
+
diff --git a/doc/man/scrotty.1 b/doc/man/scrotty.1
index 430c7e2..aacb092 100644
--- a/doc/man/scrotty.1
+++ b/doc/man/scrotty.1
@@ -3,9 +3,8 @@
scrotty \- Framebuffer screenshot program
.SH SYNOPSIS
.B scrotty
-.RI [ OPTION ]...\ [ FILENAME_PATTERN ]
-[\-\-
-.IR CONVERT_OPTION ...]
+.RI [ OPTION ]...\ [\-\-]
+.RI [ FILENAME_PATTERN ]
.SH DESCRIPTION
.B scrotty
is a minimalist screenshoter for your framebuffers.
@@ -18,25 +17,26 @@ is designed after
.BR scrot (1),
but includes a some improvements. Namely it does not support
delaying the screenshot, selecting image quality or creating
-thumbnails, but it has support for adding arbitrary arguments
-to
-.BR convert (1),
-which is used to save the image.
+thumbnails. Such operations is left to be done by the user
+with the option
+.B \-\-exec
+and a utility such as
+.BR convert (1).
.SH OPTIONS
.TP
-.B \-\-help
+.B \-h ,\ \-\-help
Print usage information.
.TP
-.B \-\-version
+.B \-v ,\ \-\-version
Print program name and version.
.TP
-.B \-\-copyright
+.B \-c ,\ \-\-copyright
Print copyright information.
.TP
-.B \-\-raw
+.B \-r ,\ \-\-raw
Save in PNM rather than in PNG.
.TP
-.BR \-\-exec \ \fICMD\fP
+.BR \-e ,\ \-\-exec \ \fICMD\fP
Command to run for each saved image.
.SH "SPECIAL STRINGS"
Both the
@@ -89,8 +89,8 @@ Screenshots are useful if you want to remember something or
send an image of how something looks.
.SH "SEE ALSO"
.BR scrot (1),
-.BR convert (1),
.BR strftime (3),
+.BR convert (1),
.BR fbcat (1),
.BR setterm (1)
.PP
diff --git a/doc/man/scrotty.sv.1 b/doc/man/scrotty.sv.1
index 56fb2ce..2cc157e 100644
--- a/doc/man/scrotty.sv.1
+++ b/doc/man/scrotty.sv.1
@@ -4,9 +4,8 @@
scrotty \- Bildrutebuffertskärmsdumpsprogram
.SH ÖVERSIKT
.B scrotty
-.RI [ ALTERNATIV ]...\ [ FILNAMNSMÖNSTER ]
-[\-\-
-.IR ALTERNATIV_FÖR_CONVERT ...]
+.RI [ ALTERNATIV ]...\ [\-\-]
+.RI [ FILNAMNSMÖNSTER ]
.SH BESKRIVNING
.B scrotty
är ett minimalistiskt skärmsdumpsprogram för dina
@@ -19,25 +18,26 @@ Det finns inget stöd för
.BR scrot (1),
men har en del förbättringar: inget stöd för fördröjda
skrämdumpar, val av bildkvalitet eller stöd för att skapa
-miniatyrer, men det finns stöd för att specifiera valfria
-alternativ för
-.BR convert (1),
-som används för att spara bilden.
+miniatyrer. Sådana operations är lämnat till användaren
+att utföra med hjälp av alternativet
+.B \-\-exec
+och verktyg såsom
+.BR convert (1).
.SH ALTERNATIV
.TP
-.B \-\-help
+.B \-h ,\ \-\-help
Skriv ut burksanvisningar.
.TP
-.B \-\-version
+.B \-v ,\ \-\-version
Skriv ut programmets namn och version.
.TP
-.B \-\-copyright
+.B \-c ,\ \-\-copyright
Skriv ut upphovsrätts information.
.TP
-.B \-\-raw
+.B \-r ,\ \-\-raw
Spara som PNM-bild snarare än som PNG-bild.
.TP
-.BR \-\-exec \ \fIKMD\fP
+.BR \-e ,\ \-\-exec \ \fIKMD\fP
Kommando att köra för varje sparad bild.
.SH "SÄRSKILDA STRÄNGAR"
Både
@@ -91,8 +91,10 @@ redan fanns utan författarens kännedom.) Skärmdumpar
du vill skicka en bild på hur någonting ser hur.
.SH "SE ÄVEN"
.BR scrot (1),
+.BR strftime (3),
.BR convert (1),
-.BR strftime (3)
+.BR fbcat (1),
+.BR setterm (1)
.PP
Full dokumentation finns tillgängligt lokalt via: info \(aq(scrotty)\(aq
.SH FÖRFATTARE