From 44cf8ec67278bd1ab6c7f83a9993f7a5686a9541 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sat, 9 Mar 2024 01:06:44 +0100 Subject: Adding upstream version 0.23.93. Signed-off-by: Daniel Baumann --- doc/ref/commonoptions.xml | 165 +++++++++++++++++++++++++++++++ doc/ref/zbarcam.xml | 207 +++++++++++++++++++++++++++++++++++++++ doc/ref/zbarimg.xml | 242 ++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 614 insertions(+) create mode 100644 doc/ref/commonoptions.xml create mode 100644 doc/ref/zbarcam.xml create mode 100644 doc/ref/zbarimg.xml (limited to 'doc/ref') diff --git a/doc/ref/commonoptions.xml b/doc/ref/commonoptions.xml new file mode 100644 index 0000000..3552025 --- /dev/null +++ b/doc/ref/commonoptions.xml @@ -0,0 +1,165 @@ + + + + + Print a short help message describing command line + options to standard output and exit + + + + + + + Print program version information to standard output and + exit + + + + + + + + Increase debug output level. Multiple + options create more spew. Alternatively + specify n to + set the debug level directly + + + + + + + + + Set decoder configuration option config for symbology to value. value defaults to 1 if omitted. + symbology is one of + , , + , , + , , + , , , + , , + or the special value . + If symbology is + omitted or , the config will be set for all + applicable symbologies. These are the currently recognized + configs. Prefix a + config with "no-" to negate it. Not all configs are appropriate + for every symbology. + + + + + + Control decoding/reporting of a symbology. For + symbologies which are just subsets of + (, , + , ), this + config controls whether the subsets are detected and + reported as such. These special cases are disabled by + default, all other symbologies default to enabled + + + + + + + Antonym for + + + + + + + Control whether check digits are included in the + decoded output. Enabled by default. This config does not + apply for , which never returns the + check digit. It also not apply for cases where the check + digit is disabled (see ). Check + digits are currently not implemented for + or + + + + + + + Enable decode and verification of a check digit for + symbologies where it is optional: this will include + and , neither of + which implements the check digit yet + + + + + + + Enable escape sequences that encode the full ASCII + character set. This would apply to , + except that it's not implemented either... + + + + + + + Enable collection of symbol position information. + Enabled by default. Currently, the position information is + unusable, so you can save a few cycles by disabling + this. + + + + + + + Specially for QR code images, sometimes the image + is inverted, e. g. lines are written in white instead of black. + This option makes ZBar to invert the image and parse again, in + case it fails using the normal order. Enabling it affects all + decoders. + + + + + + + + Bound the number of decoded characters in a valid symbol. + If a decode result is outside the configured min/max range + (inclusive), it will not be reported. Set to 0 to disable the + corresponding check. This setting applies to variable-length + symbologies: , , + , and + . defaults to 6 + for and 1 for (per Code + 39 autodiscrimination recommendation); all others default to + 0 + + + + + + + + Adjust the density of the scanner passes. Lower values + scan more of the image at the cost of decreased performance. + Setting to 0 disables scanning along that axis. Defaults are both + 1. + + + + + + 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 @@ + + + + zbarcam + 1 + + + + zbarcam + + scan and decode bar codes from a video device + + + + + + zbarcam + + + + + + + + + device + + + + zbarcam + + + + + + + + + + Description + + zbarcam 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. + + device 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 + /dev/video0 + + 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. + + + + + Options + + This program follows the usual GNU command line syntax. + Single letter options may be bundled, long options start with two + dashes (`-'). + + + &refcommonoptions; + + + + + + Quiet operation; disable the audible beep otherwise + emitted when a symbol is decoded + + + + + + + Disable output video window. Video input will be + scanned until the program is interrupted or otherwise + signaled + + + + + + + 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 + + + + + + + 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 + + + + + + + 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 + + + + + + + + Examples + + 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: + + zbarcam /dev/video1 | upcrpc.py + + The upcrpc.py example script included in the + examples/ subdirectory of the distribution + will make an XMLRPC call to a popular internet UPC database and + print the product description if found. + + 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: + + zbarcam + + + 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: + + zbarcam + + + + + Exit Status + + zbarcam returns an exit code to indicate the + status of the program execution. Current exit codes are: + + + + 0 + + Successful program completion. + + + + + 1 + + An error occurred. This includes bad arguments and I/O + errors. + + + + + 2 + + A fatal error occurred. + + + + + + + See Also + + + + + + Bugs + + See + + + + diff --git a/doc/ref/zbarimg.xml b/doc/ref/zbarimg.xml new file mode 100644 index 0000000..572bea9 --- /dev/null +++ b/doc/ref/zbarimg.xml @@ -0,0 +1,242 @@ + + + + zbarimg + 1 + + + + zbarimg + + scan and decode bar codes from image file(s) + + + + + + zbarimg + + + + + + + + + + + + + + image + + + + + zbarimg + + + + + + + + + + Description + + For each specified + image file + zbarimg scans the image for bar codes and + prints any decoded data to stdout. Images may optionally be + displayed to the screen. + + 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. + + Note that "image" + + in this context refers to any format supported by ImageMagick, + including many vector formats such as PDF and PostScript. Keep in + mind that vector formats are rasterized before scanning; manually + rasterize vector images before scanning to avoid unintentionally + corrupting embedded barcode bitmaps. + + + + + Options + + This program follows the usual GNU command line syntax. + Single letter options may be bundled, long options start with two + dashes (`-'). + + + &refcommonoptions; + + + + + Ouput points of the polygon containing the code bar. + Using a format compatible with The <polygon> element + of the Scalable Vector Graphics (SVG) markup language + + + + + + + + Quiet operation; only output decoded symbol data. + specifically this disables the statistics line printed (to + stderr) before exiting, as well as the warning message + printed (also to stderr) when no barcodes are found in an + image + + + + + + + + + + Enable/disable display of subsequent + image files, + until next or + is encountered. This option + may appear multiple times to enable display of specific + images. Image display is disabled by default + + + + + + + + Enable/disable result output using an XML format. + This format wraps the raw data from the symbol with + information about the scan (such as page indices) in an + easy to parse format. The latest schema is available from + . + + + + + + + Enable raw symbol data output. This format prints symbol + data separated by newlines without the additional symbology type + information that is printed by default + + + + + + + + Examples + + Scan a PNG image of a UPC bar code symbol and pass + resulting data to a script that searches for the code in a + database and does something useful with it: + + zbarimg product.png | upcrpc.py + + The upcrpc.py example script included in the + examples/ subdirectory of the distribution + will make an XMLRPC call to a popular internet UPC database and + print the product description if found. + + Scan a JPEG image containing several barcodes and display + the image in a window, also disabling recognition of Interleaved 2 + of 5 codes to prevent confusion with other symbologies or + background noise: + + zbarimg label.jpg + + + Look in a scanned document only for Code 39, using XML + output format so the page numbers are available. To enable only + Code 39, first all symbologies are disabled, then Code 39 is + re-enabled: + + zbarimg scan.tiff + + + + + Exit Status + + zbarimg returns an exit code to indicate the + status of the program execution. Current exit codes are: + + + + 0 + + Barcodes successfully detected in all images. Warnings may + have been generated, but no errors. + + + + + 1 + + An error occurred while processing some image(s). This + includes bad arguments, I/O errors and image handling errors from + ImageMagick. + + + + + 2 + + ImageMagick fatal error. + + + + + 3 + + The user quit the program before all images were scanned. + Only applies when running in interactive mode + (with ) + + + + + 4 + + No barcode was detected in one or more of the images. No + other errors occurred. + + + + + + + See Also + + + + + + Bugs + + See + + + + -- cgit v1.2.3