diff options
Diffstat (limited to 'doc/ref/zbarcam.xml')
| -rw-r--r-- | doc/ref/zbarcam.xml | 207 |
1 files changed, 207 insertions, 0 deletions
diff --git a/doc/ref/zbarcam.xml b/doc/ref/zbarcam.xml new file mode 100644 index 0000000..69ad593 --- /dev/null +++ b/doc/ref/zbarcam.xml @@ -0,0 +1,207 @@ +<refentry xml:id="zbarcam" + xmlns:xlink="http://www.w3.org/1999/xlink"> + + <refmeta> + <refentrytitle>zbarcam</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>zbarcam</refname> + + <refpurpose>scan and decode bar codes from a video device + </refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>zbarcam</command> + <arg><option>-qv</option></arg> + <arg><option>--quiet</option></arg> + <arg><option>--nodisplay</option></arg> + <arg><option>--xml</option></arg> + <arg><option>--verbose<arg>=<replaceable + class="parameter">n</replaceable></arg></option></arg> + <arg><option>--prescale=<replaceable + class="parameter">W</replaceable>x<replaceable + class="parameter">H</replaceable></option></arg> + <arg><option>-S<optional><replaceable + class="parameter">symbology</replaceable>.</optional><replaceable + class="parameter">config</replaceable><optional>=<replaceable + class="parameter">value</replaceable></optional></option></arg> + <arg><option>--set <optional><replaceable + class="parameter">symbology</replaceable>.</optional><replaceable + class="parameter">config</replaceable><optional>=<replaceable + class="parameter">value</replaceable></optional></option></arg> + <arg><replaceable class="parameter">device</replaceable></arg> + </cmdsynopsis> + + <cmdsynopsis> + <command>zbarcam</command> + <group choice="req"> + <arg choice="plain"><option>-h</option></arg> + <arg choice="plain"><option>--help</option></arg> + <arg choice="plain"><option>--version</option></arg> + </group> + </cmdsynopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para><command>zbarcam</command> scans a video4linux video source + (eg, a webcam) for bar codes and prints any decoded data to the + standard output. The video stream is also displayed to the + screen. </para> + + <para><replaceable class="parameter">device</replaceable> is the + path to the video4linux (version 1 or 2) character device special + file (major number 81 and minor number 0 thru 63). It defaults to + <filename>/dev/video0</filename></para> + + <para>The underlying library currently supports EAN-13 (including + UPC and ISBN subsets), EAN-8, DataBar, DataBar Expanded, Code 128, + Code 93, Code 39, Codabar, Interleaved 2 of 5 and QR Code symbologies. + The specific type of each detected symbol is printed with the decoded + data.</para> + + </refsection> + + <refsection> + <title>Options</title> + + <para>This program follows the usual GNU command line syntax. + Single letter options may be bundled, long options start with two + dashes (`-').</para> + + <variablelist> + &refcommonoptions; + + <varlistentry> + <term><option>-q</option></term> + <term><option>--quiet</option></term> + <listitem> + <simpara>Quiet operation; disable the audible beep otherwise + emitted when a symbol is decoded</simpara> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--nodisplay</option></term> + <listitem> + <simpara>Disable output video window. Video input will be + scanned until the program is interrupted or otherwise + signaled</simpara> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--xml</option></term> + <listitem> + <simpara>Stream results using an XML output format. This + format wraps the raw data from the symbol with information + about the scan in an easy to parse format. The latest + schema is available from <link xlink:href="http://zbar.sourceforge.net/2008/barcode.xsd"/></simpara> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--raw</option></term> + <listitem> + <simpara>Use raw symbol data output format. This format + prints symbol data separated by newlines without the + additional symbology type information that is printed by + default</simpara> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--prescale=<replaceable + class="parameter">W</replaceable>x<replaceable + class="parameter">H</replaceable></option></term> + <listitem> + <simpara>Request video input scaling from the camera driver. + Possibly useful for reducing huge frames to achieve a higher + frame rate. Note that the driver may adjust or completely + ignore the scaling request</simpara> + </listitem> + </varlistentry> + + </variablelist> + </refsection> + + <refsection> + <title>Examples</title> + + <para>Scan for barcodes using the second video device and pipe the + resulting data through a script that searches for each code in a + database and does something useful with them: + + <screen><command>zbarcam</command> <filename>/dev/video1</filename> | <command>upcrpc.py</command></screen> + + The <command>upcrpc.py</command> example script included in the + <filename>examples/</filename> subdirectory of the distribution + will make an XMLRPC call to a popular internet UPC database and + print the product description if found.</para> + + <para>Scan for barcodes using the default video device and stream + results to stdout in XML format, also disable recognition of + Interleaved 2 of 5 codes to prevent confusion with other + symbologies or background noise: + + <screen><command>zbarcam</command> <option>--xml</option> <option>-Si25.disable</option></screen> + </para> + + <para>Scan only for Code 39, without using the preview window - + maybe for a fixed installation. To enable only Code 39, first all + symbologies are disabled, then Code 39 is re-enabled: + + <screen><command>zbarcam</command> <option>--nodisplay</option> <option>-Sdisable</option> <option>-Scode39.enable</option></screen> + </para> + </refsection> + + <refsection> + <title>Exit Status</title> + + <para><command>zbarcam</command> returns an exit code to indicate the + status of the program execution. Current exit codes are:</para> + + <variablelist> + <varlistentry> + <term>0</term> + <listitem> + <para>Successful program completion.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>1</term> + <listitem> + <para>An error occurred. This includes bad arguments and I/O + errors.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>2</term> + <listitem> + <para>A fatal error occurred.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + + <refsection> + <title>See Also</title> + <para><xref linkend="zbarimg"/></para> + <para><link xlink:href="http://zbar.sf.net/"/></para> + </refsection> + + <refsection> + <title>Bugs</title> + + <para>See <link xlink:href="http://sf.net/tracker/?group_id=189236&atid=928515"/></para> + + </refsection> + +</refentry> |