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 188 189 190 191 192 193 194
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY app "<application>Zapping</application>">
<!ENTITY cmd "<command>zapping_setup_fb</command>">
<!ENTITY version "0.13">
]>
<refentry id="zapping_setup_fb">
<refmeta>
<refentrytitle>zapping_setup_fb</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>zapping_setup_fb</refname>
<refpurpose>prepares V4L/V4L2 driver for overlay</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
&cmd;
<arg>-?, -h, --help, --usage</arg>
<arg>-b, --bpp <replaceable>NUMBER</replaceable></arg>
<arg>-c, --child</arg>
<arg>-d, --device <replaceable>FILENAME</replaceable></arg>
<arg>-D, --display <replaceable>NAME</replaceable></arg>
<arg>-f, --fd</arg>
<arg>-q, --quiet</arg>
<arg>-S, --screen <replaceable>SCREEN NUMBER</replaceable></arg>
<arg>-v, --verbose</arg>
<arg>-V, --version</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="description">
<title>Description</title>
<para>&cmd; is a small program to prepare Video For Linux (V4L) or
Video For Linux Two (V4L2) video capture drivers for video
overlay. It must be executed by <citerefentry>
<refentrytitle>pam</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry> with root privileges, or owned by root with the
set-user-ID bit set (see <citerefentry>
<refentrytitle>chmod</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>). This manual page refers to &cmd; version
&version;.</para>
</refsect1>
<refsect1 id="purpose">
<title>Background</title>
<para>To enable video overlay V4L and V4L2 drivers need to know
the screen memory address. For security reasons only the system
administrator can program this address. <citerefentry>
<refentrytitle>zapping</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry> delegates the task to this helper
application.</para>
</refsect1>
<refsect1 id="options">
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>-?, -h, --help, --usage</option></term>
<listitem>
<para>Prints usage information on stdout, then terminates
the program.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-b, --bpp
<replaceable>NUMBER</replaceable></option></term>
<listitem>
<para>Color depth hint, the number of bits per pixel on the
display in question, either 24 or 32. Usually &cmd; can determine
this number automatically.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-c, --child</option></term>
<listitem>
<para>&app; sets this flag when executing &cmd; as child
process to enable the output of localized error messages in
UTF-8 encoding on stderr.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-d, --device
<replaceable>FILENAME</replaceable></option></term>
<listitem>
<para>The video capture device to open, by default
<filename>/dev/video0</filename>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-D, --display
<replaceable>NAME</replaceable></option></term>
<listitem>
<para>The X display to use. Defaults to the name defined by
the <envar>DISPLAY</envar> environment variable.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-f, --fd
<replaceable>NUMBER</replaceable></option></term>
<listitem>
<para>&app; uses this option when executing &cmd; as child
process to access the video capture driver by this shared
file descriptor instead of opening the device file by
name.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-q, --quiet</option></term>
<listitem>
<para>Decrements the verbosity level.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-S, --screen
<replaceable>NUMBER</replaceable></option></term>
<listitem>
<para>The X screen to use (Xinerama), defaults to 0.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-v, --verbose</option></term>
<listitem>
<para>Increments the verbosity level.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-V, --version</option></term>
<listitem>
<para>Prints the version of &cmd; on stdout, then terminates
the program.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="bugs">
<title>Bugs</title>
<para>None known.</para>
</refsect1>
<refsect1 id="see-also">
<title>See also</title>
<para><citerefentry>
<refentrytitle>zapping</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>, <citerefentry>
<refentrytitle>zapping_remote</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>, <citerefentry>
<refentrytitle>pam</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry></para>
</refsect1>
<refsect1 id="authors">
<title>Authors</title>
<para>&app; and &cmd; were written by Iñaki García Etxebarria,
Michael H. Schimek (mschimek@users.sourceforge.net) and many
contributors.</para>
<para>This manual page was written by Michael H. Schimek based on
work by Christian Marillat.</para>
</refsect1>
</refentry>
<!--
Local Variables:
mode: sgml
coding: utf-8
indent-tabs-mode: nil
End:
-->
|