File: fbgrab.xml

package info (click to toggle)
fbcat 0.5.1-1
  • links: PTS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 156 kB
  • sloc: ansic: 258; xml: 232; sh: 138; makefile: 46
file content (187 lines) | stat: -rw-r--r-- 4,815 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
<?xml version='1.0' encoding='utf-8'?>
<!DOCTYPE refentry PUBLIC '-//OASIS//DTD DocBook XML V4.5//EN' 'http://www.docbook.org/xml/4.5/docbookx.dtd'
[
	<!ENTITY p 'fbgrab'>
	<!ENTITY version '0.5.1'>
]>

<refentry>

<refentryinfo>
	<title>&p; manual</title>
	<productname>&p;</productname>
	<date>2017-08-16</date>
	<!-- copyright information for THIS document: -->
	<copyright>
		<year>2009</year>
		<holder>Piotr Lewandowski</holder>
	</copyright>
	<copyright>
		<year>2009</year>
		<year>2011</year>
		<year>2013</year>
		<year>2017</year>
		<holder>Jakub Wilk</holder>
	</copyright>
	<copyright>
		<year>2017</year>
		<holder>David Lechner</holder>
	</copyright>
</refentryinfo>

<refmeta>
	<refentrytitle>&p;</refentrytitle>
	<manvolnum>1</manvolnum>
	<refmiscinfo class='version'>&version;</refmiscinfo>
</refmeta>

<refnamediv>
	<refname>&p;</refname>
	<refpurpose>takes a screenshot using the framebuffer device</refpurpose>
</refnamediv>

<refsynopsisdiv>
	<cmdsynopsis>
		<command>&p;</command>
		<arg choice='opt' rep='repeat'><replaceable>option</replaceable></arg>
		<arg choice='plain'><replaceable>png-file</replaceable></arg>
	</cmdsynopsis>
	<cmdsynopsis>
		<command>&p;</command>
		<arg choice='plain'><option>-?</option></arg>
	</cmdsynopsis>
</refsynopsisdiv>

<refsection>
	<title>Description</title>
	<para>
		<command>&p;</command> is a wrapper around <command>fbcat</command> which emulates the behaviour of Gunnar Monell's <command>&p;</command> utility.
	</para>
</refsection>

<refsection>
	<title>Options</title>
	<para>
		<command>&p;</command> accepts the following options:
		<variablelist>
			<varlistentry>
				<term><option>-c <replaceable>N</replaceable></option></term>
				<listitem>
					<para>
						Grab the <filename>/dev/ttyN</filename> virtual terminal.
					</para>
					<note>
						<para>
							This option might require root privileges (or <varname>CAP_SYS_TTY_CONFIG</varname>
							capability).
						</para>
					</note>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term><option>-C <replaceable>N</replaceable></option></term>
				<listitem>
					<para>
						Switch to the <filename>/dev/ttyN</filename> virtual terminal,
						then wait a few seconds before grabbing it.
					</para>
					<note>
						<para>
							This option might require root privileges (or <varname>CAP_SYS_TTY_CONFIG</varname>
							capability).
						</para>
					</note>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term><option>-d <replaceable>fb-device</replaceable></option></term>
				<listitem>
					<para>
						Use the <replaceable>fb-device</replaceable> framebuffer device.
					</para>
					<para>
						By default, the device name is taken from the <varname>FRAMEBUFFER</varname> environment
						variable. If it is unset or empty, the default is <filename>/dev/fb0</filename>.
					</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term><option>-i</option></term>
				<listitem>
					<para>Enable PNG interlacing.</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term><option>-s <replaceable>N</replaceable></option></term>
				<listitem>
					<para>
						Sleep <replaceable>N</replaceable> seconds before making the screenshot or switching virtual
						terminals.
					</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term><option>-?</option></term>
				<listitem>
					<para>
						Display help and exit.
					</para>
				</listitem>
			</varlistentry>
		</variablelist>
	</para>
	<para>
		Specify <replaceable>png-file</replaceable> as <quote><literal>-</literal></quote> to write to standard output.
	</para>
</refsection>

<refsection>
	<title>Unsupported options</title>
	<para>
		The following options of Gunnar Monell's <command>&p;</command> are recognized but not supported:
		<variablelist>
			<varlistentry>
				<term><option>-f <replaceable>fb-dump-file</replaceable></option></term>
				<listitem>
					<para></para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term><option>-b <replaceable>N</replaceable></option></term>
				<listitem>
					<para></para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term><option>-w <replaceable>N</replaceable></option></term>
				<listitem>
					<para></para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term><option>-h <replaceable>N</replaceable></option></term>
				<listitem>
					<para></para>
				</listitem>
			</varlistentry>
		</variablelist>
	</para>
</refsection>

<refsection>
	<title>See also</title>
	<para>
		<citerefentry>
			<refentrytitle>png</refentrytitle>
			<manvolnum>5</manvolnum>
		</citerefentry>,
		<citerefentry>
			<refentrytitle>fbcat</refentrytitle>
			<manvolnum>1</manvolnum>
		</citerefentry>
	</para>
</refsection>

</refentry>

<!-- vim:set ts=4 sts=4 sw=4 tw=120: -->