aboutsummaryrefslogtreecommitdiff
path: root/misc/fbdump/fbdump.1
diff options
context:
space:
mode:
Diffstat (limited to 'misc/fbdump/fbdump.1')
-rw-r--r--misc/fbdump/fbdump.194
1 files changed, 94 insertions, 0 deletions
diff --git a/misc/fbdump/fbdump.1 b/misc/fbdump/fbdump.1
new file mode 100644
index 0000000000000..dfe262ea46d64
--- /dev/null
+++ b/misc/fbdump/fbdump.1
@@ -0,0 +1,94 @@
+.\" Man page generated from reStructuredText.
+.
+.TH FBDUMP 1 "2017-03-24" "0.4.2" "SlackBuilds.org"
+.SH NAME
+fbdump \- Dumps the contents of the framebuffer to stdout as a PPM file
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" RST source for fbdump(1) man page. Convert with:
+.
+.\" rst2man.py fbdump.rst > fbdump.1
+.
+.\" rst2man.py comes from the SBo development/docutils package.
+.
+.\" converting from pod:
+.
+.\" s/B<\([^>]*\)>/**\1**/g
+.
+.\" s/I<\([^>]*\)>/*\1*/g
+.
+.SH SYNOPSIS
+.sp
+fbdump [\fI\-fb <device>\fP] [\fI\-vt <terminal>\fP] [\fI\-delay <sec>\fP]
+.SH DESCRIPTION
+.sp
+fbdump is a simple tool that captures the contents of the visible portion
+of the Linux framebuffer device and writes it to the standard output as
+a PPM file. In other words, it takes a screenshot of anything running on
+the framebuffer. It currently has fairly complete support for packed\-pixel
+framebuffer types and also works with the VGA16 framebuffer driver.
+.SH OPTIONS
+.INDENT 0.0
+.TP
+.B \fB\-fb\fP \fIdevice\fP
+Path to the framebuffer device to dump. Default: \fI/dev/fb0\fP\&.
+.TP
+.B \fB\-vt\fP \fIterminal\fP
+Bring virtual terminal number \fIterminal\fP to the foreground before dumping.
+Default: dump current foreground terminal.
+.TP
+.B \fB\-delay\fP \fIsec\fP
+Wait \fIsec\fP seconds before dumping. Default: dump immediately.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-help
+Display usage and exit.
+.UNINDENT
+.SH EXAMPLES
+.sp
+To dump the framebuffer as a PNG image:
+.INDENT 0.0
+.INDENT 3.5
+fbdump | pnmtopng > grab.png
+.UNINDENT
+.UNINDENT
+.SH COPYRIGHT
+.sp
+See the file /usr/doc/fbdump\-0.4.2/COPYING for license information.
+.SH AUTHORS
+.sp
+fbdump was written by Richard Drummond <\fI\%evilrich@rcdrummond.net\fP>.
+.sp
+This man page written for the SlackBuilds.org project
+by B. Watson, and is licensed under the WTFPL.
+.SH SEE ALSO
+.sp
+The fbdump homepage: \fI\%http://www.rcdrummond.net/fbdump/\fP
+.\" Generated by docutils manpage writer.
+.