1 files changed, 29 insertions, 0 deletions
diff --git a/system/snapscreenshot/NOTES.txt b/system/snapscreenshot/NOTES.txt
new file mode 100644
index 0000000000000..3acfd2a9b9947
--- /dev/null
+++ b/system/snapscreenshot/NOTES.txt
@@ -0,0 +1,29 @@
+Notes:
+
+snapscreenshot is *fast*, when compared to fbdump and fbcat. However,
+the reason it's so fast is that it doesn't read the graphic content of
+the framebuffer. Instead, the text content of the screen is read (from
+the /dev/vcs* devices) and rendered in the current console font... which
+is the current font of the console you executed snapscreenshot from,
+*not* the font in the console you're taking a snapshot of!
+
+Also, custom fonts just don't work well with snapscreenshot. Depending
+on the font, you may get an error (GIO_FONTX), a segmentation fault,
+or else the resulting screenshot is garbled.
+
+Because /dev/vcs* is used, snapscreenshot does NOT work for taking
+screenshots of software that actually uses the framebuffer for graphics,
+e.g. fbpdf, feh, "mplayer -vo fbdev", "links -g -driver fb". For these,
+use fbcat or fbdump instead.
+
+By default, the text on all the consoles ends up in the output image. To
+take a shot of only one console, use a command like:
+
+# snapscreenshot --firstwin 1 -c1 -x1 > shot.tga
+
+...or use this:
+
+# snapscreenshot.cur > shot.tgz
+
+The snapscreenshot.cur script was written by the SlackBuild author,
+and is not part of snapscreenshot itself.