mirror of
https://git.code.sf.net/p/zint/code
synced 2024-09-19 15:28:56 -04:00
32c9e6a98e
(was only set on BMP output to length of BMP pixel array) EXCODE39: change to display check digit in HRT by default CODE39/EXCODE39/LOGMARS: new hidden check digit option (`option_2 = 2`) qr.c: suppress bogus gcc-13 warning (only appears on optimize) GUI: move some symbology-specific options into Data Tab so separate tab unnecessary (those with few options and no Composite/ECI), namely: all C25XXX, CODE39/EXCODE39/LOGMARS, MSI_PLESSEY, CODABAR, DAFT, DPD, MAILMARK_2D, ITF-14, PZN, UPNQR, CHANNEL, CODE93 and VIN, adjusting grp uis. change Data dialog button (ellipsis) QToolButton -> QPushButton & vice versa zap/clear/eye/swap/scale buttons QPushButton -> QToolButton for better mac compat (also makes sense); remove some mac hacks that no longer seem necessary; use folder icon for Export dialog directory button manual: document new Symbology-specific groupbox & CODE39/etc hidden check digit option; add annexes on Qt and Tcl backends; narrow some tables for better txt output; remove echoed image tags in txt (pandoc 3.1.5 regression?); add one-page HTML output to Makefile; also tex output (debug); add class attributes to images to aid HTML styling; various other fiddlings
667 lines
21 KiB
Groff
667 lines
21 KiB
Groff
.\" Automatically generated by Pandoc 3.1.5
|
|
.\"
|
|
.\" Define V font for inline verbatim, using C font in formats
|
|
.\" that render this, and otherwise B font.
|
|
.ie "\f[CB]x\f[]"x" \{\
|
|
. ftr V B
|
|
. ftr VI BI
|
|
. ftr VB B
|
|
. ftr VBI BI
|
|
.\}
|
|
.el \{\
|
|
. ftr V CR
|
|
. ftr VI CI
|
|
. ftr VB CB
|
|
. ftr VBI CBI
|
|
.\}
|
|
.TH "ZINT" "1" "July 2023" "Version 2.12.0.9" ""
|
|
.hy
|
|
.SH NAME
|
|
.PP
|
|
\f[V]zint\f[R] - encode data as a barcode image
|
|
.SH SYNOPSIS
|
|
.PP
|
|
\f[V]zint\f[R] [\f[V]-h\f[R] | \f[V]--help\f[R]]
|
|
.PD 0
|
|
.P
|
|
.PD
|
|
\f[V]zint\f[R] [\f[I]options\f[R]]
|
|
.SH DESCRIPTION
|
|
.PP
|
|
zint takes input data from the command line or a file to encode in a
|
|
barcode which is then output to an image file.
|
|
.PP
|
|
Input data is UTF-8, unless \f[V]--binary\f[R] is specified.
|
|
.PP
|
|
Human Readable Text (HRT) is displayed by default for those barcodes
|
|
that support HRT, unless \f[V]--notext\f[R] is specified.
|
|
.PP
|
|
The output image file (specified with \f[V]-o\f[R] | \f[V]--output\f[R])
|
|
may be in one of these formats: Windows Bitmap (\f[V]BMP\f[R]), Enhanced
|
|
Metafile Format (\f[V]EMF\f[R]), Encapsulated PostScript
|
|
(\f[V]EPS\f[R]), Graphics Interchange Format (\f[V]GIF\f[R]), ZSoft
|
|
Paintbrush (\f[V]PCX\f[R]), Portable Network Format (\f[V]PNG\f[R]),
|
|
Scalable Vector Graphic (\f[V]SVG\f[R]), or Tagged Image File Format
|
|
(\f[V]TIF\f[R]).
|
|
.SH OPTIONS
|
|
.TP
|
|
\f[V]-h\f[R], \f[V]--help\f[R]
|
|
Print usage information summarizing command line options.
|
|
.TP
|
|
\f[V]-b TYPE\f[R], \f[V]--barcode=TYPE\f[R]
|
|
Set the barcode symbology that will be used to encode the data.
|
|
\f[I]TYPE\f[R] is the number or name of the barcode symbology.
|
|
If not given, the symbology defaults to 20 (Code 128).
|
|
To see what types are available, use the \f[V]-t\f[R] |
|
|
\f[V]--types\f[R] option.
|
|
Type names are case-insensitive, and non-alphanumerics are ignored.
|
|
.TP
|
|
\f[V]--addongap=INTEGER\f[R]
|
|
For EAN/UPC symbologies, set the gap between the main data and the
|
|
add-on.
|
|
\f[I]INTEGER\f[R] is in integral multiples of the X-dimension.
|
|
The maximum gap that can be set is 12.
|
|
The minimum is 7, except for UPC-A, when the minimum is 9.
|
|
.TP
|
|
\f[V]--batch\f[R]
|
|
Treat each line of an input file specified with \f[V]-i\f[R] |
|
|
\f[V]--input\f[R] as a separate data set and produce a barcode image for
|
|
each one.
|
|
The barcode images are outputted by default to numbered filenames
|
|
starting with \[lq]00001.png\[rq], \[lq]00002.png\[rq] etc., which can
|
|
be changed by using the \f[V]-o\f[R] | \f[V]--output\f[R] option.
|
|
.TP
|
|
\f[V]--bg=COLOUR\f[R]
|
|
Specify a background (paper) colour where \f[I]COLOUR\f[R] is in
|
|
hexadecimal \f[V]RRGGBB\f[R] or \f[V]RRGGBBAA\f[R] format or in decimal
|
|
\f[V]C,M,Y,K\f[R] percentages format.
|
|
.TP
|
|
\f[V]--binary\f[R]
|
|
Treat input data as raw 8-bit binary data instead of the default UTF-8.
|
|
Automatic code page translation to an ECI page is disabled, and no
|
|
validation of the data\[cq]s character encoding takes place.
|
|
.TP
|
|
\f[V]--bind\f[R]
|
|
Add horizontal boundary bars (also known as bearer bars) to the symbol.
|
|
The width of the boundary bars is specified by the \f[V]--border\f[R]
|
|
option.
|
|
\f[V]--bind\f[R] can also be used to add row separator bars to symbols
|
|
stacked with multiple \f[V]-d\f[R] | \f[V]--data\f[R] inputs, in which
|
|
case the width of the separator bars is specified with the
|
|
\f[V]--separator\f[R] option.
|
|
.TP
|
|
\f[V]--bindtop\f[R]
|
|
Add a horizontal boundary bar to the top of the symbol.
|
|
The width of the boundary bar is specified by the \f[V]--border\f[R]
|
|
option.
|
|
.TP
|
|
\f[V]--bold\f[R]
|
|
Use bold text for the Human Readable Text (HRT).
|
|
.TP
|
|
\f[V]--border=INTEGER\f[R]
|
|
Set the width of boundary bars (\f[V]--bind\f[R] or \f[V]--bindtop\f[R])
|
|
or box borders (\f[V]--box\f[R]), where \f[I]INTEGER\f[R] is in integral
|
|
multiples of the X-dimension.
|
|
The default is zero.
|
|
.TP
|
|
\f[V]--box\f[R]
|
|
Add a box around the symbol.
|
|
The width of the borders is specified by the \f[V]--border\f[R] option.
|
|
.TP
|
|
\f[V]--cmyk\f[R]
|
|
Use the CMYK colour space when outputting to Encapsulated PostScript
|
|
(EPS) or TIF files.
|
|
.TP
|
|
\f[V]--cols=INTEGER\f[R]
|
|
Set the number of data columns in the symbol to \f[I]INTEGER\f[R].
|
|
Affects Codablock-F, DotCode, GS1 DataBar Expanded Stacked
|
|
(DBAR_EXPSTK), MicroPDF417 and PDF417 symbols.
|
|
.TP
|
|
\f[V]--compliantheight\f[R]
|
|
Warn if the height specified by the \f[V]--height\f[R] option is not
|
|
compliant with the barcode\[cq]s specification, or if \f[V]--height\f[R]
|
|
is not given, default to the height specified by the specification (if
|
|
any).
|
|
.TP
|
|
\f[V]-d\f[R], \f[V]--data=DATA\f[R]
|
|
Specify the input \f[I]DATA\f[R] to encode.
|
|
The \f[V]--esc\f[R] option may be used to enter non-printing characters
|
|
using escape sequences.
|
|
The \f[I]DATA\f[R] should be UTF-8, unless the \f[V]--binary\f[R] option
|
|
is given, in which case it can be anything.
|
|
.TP
|
|
\f[V]--direct\f[R]
|
|
Send output to stdout, which in most cases should be re-directed to a
|
|
pipe or a file.
|
|
Use \f[V]--filetype\f[R] to specify output format.
|
|
.TP
|
|
\f[V]--dmre\f[R]
|
|
For Data Matrix symbols, allow Data Matrix Rectangular Extended (DMRE)
|
|
sizes when considering automatic sizes.
|
|
.TP
|
|
\f[V]--dotsize=NUMBER\f[R]
|
|
Set the radius of the dots in dotty mode (\f[V]--dotty\f[R]).
|
|
\f[I]NUMBER\f[R] is in multiples of the X-dimension, and may be
|
|
floating-point.
|
|
The default is 0.8.
|
|
.TP
|
|
\f[V]--dotty\f[R]
|
|
Use dots instead of squares for matrix symbols.
|
|
DotCode is always in dotty mode.
|
|
.TP
|
|
\f[V]--dump\f[R]
|
|
Dump a hexadecimal representation of the symbol\[cq]s encodation to
|
|
stdout.
|
|
The same representation may be outputted to a file by using a
|
|
\f[V].txt\f[R] extension with \f[V]-o\f[R] | \f[V]--output\f[R] or by
|
|
specifying \f[V]--filetype=txt\f[R].
|
|
.TP
|
|
\f[V]-e\f[R], \f[V]--ecinos\f[R]
|
|
Display the table of ECIs (Extended Channel Interpretations).
|
|
.TP
|
|
\f[V]--eci=INTEGER\f[R]
|
|
Set the ECI code for the input data to \f[I]INTEGER\f[R].
|
|
See \f[V]-e\f[R] | \f[V]--ecinos\f[R] for a list of the ECIs available.
|
|
ECIs are supported by Aztec Code, Code One, Data Matrix, DotCode, Grid
|
|
Matrix, Han Xin Code, MaxiCode, MicroPDF417, PDF417, QR Code, rMQR and
|
|
Ultracode.
|
|
.TP
|
|
\f[V]--embedfont\f[R]
|
|
For vector output, embed the font in the file for portability.
|
|
Currently only available for SVG output.
|
|
.TP
|
|
\f[V]--esc\f[R]
|
|
Process escape characters in the input data.
|
|
The escape sequences are:
|
|
.RS
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
\[rs]0 (0x00) NUL Null character
|
|
\[rs]E (0x04) EOT End of Transmission
|
|
\[rs]a (0x07) BEL Bell
|
|
\[rs]b (0x08) BS Backspace
|
|
\[rs]t (0x09) HT Horizontal Tab
|
|
\[rs]n (0x0A) LF Line Feed
|
|
\[rs]v (0x0B) VT Vertical Tab
|
|
\[rs]f (0x0C) FF Form Feed
|
|
\[rs]r (0x0D) CR Carriage Return
|
|
\[rs]e (0x1B) ESC Escape
|
|
\[rs]G (0x1D) GS Group Separator
|
|
\[rs]R (0x1E) RS Record Separator
|
|
\[rs]\[rs] (0x5C) \[rs] Backslash
|
|
\[rs]dNNN (NNN) Any 8-bit character where NNN is
|
|
decimal (000-255)
|
|
\[rs]oNNN (0oNNN) Any 8-bit character where NNN is
|
|
octal (000-377)
|
|
\[rs]xNN (0xNN) Any 8-bit character where NN is
|
|
hexadecimal (00-FF)
|
|
\[rs]uNNNN (U+NNNN) Any 16-bit Unicode BMP character
|
|
where NNNN is hexadecimal
|
|
\[rs]UNNNNNN (U+NNNNNN) Any 21-bit Unicode character
|
|
where NNNNNN is hexadecimal
|
|
\f[R]
|
|
.fi
|
|
.RE
|
|
.TP
|
|
\f[V]--extraesc\f[R]
|
|
Process the special escape sequences \f[V]\[rs]\[ha]A\f[R],
|
|
\f[V]\[rs]\[ha]B\f[R] and \f[V]\[rs]\[ha]C\f[R] that allow manual
|
|
switching of Code Sets (Code 128 only).
|
|
The sequence \f[V]\[rs]\[ha]\[ha]\f[R] can be used to encode data that
|
|
contains special escape sequences.
|
|
.TP
|
|
\f[V]--fast\f[R]
|
|
Use faster if less optimal encodation or other shortcuts (affects Data
|
|
Matrix, MicroPDF417, PDF417, QRCODE & UPNQR only).
|
|
.TP
|
|
\f[V]--fg=COLOUR\f[R]
|
|
Specify a foreground (ink) colour where \f[I]COLOUR\f[R] is in
|
|
hexadecimal \f[V]RRGGBB\f[R] or \f[V]RRGGBBAA\f[R] format or in decimal
|
|
\f[V]C,M,Y,K\f[R] percentages format.
|
|
.TP
|
|
\f[V]--filetype=TYPE\f[R]
|
|
Set the output file type to \f[I]TYPE\f[R], which is one of
|
|
\f[V]BMP\f[R], \f[V]EMF\f[R], \f[V]EPS\f[R], \f[V]GIF\f[R],
|
|
\f[V]PCX\f[R], \f[V]PNG\f[R], \f[V]SVG\f[R], \f[V]TIF\f[R],
|
|
\f[V]TXT\f[R].
|
|
.TP
|
|
\f[V]--fullmultibyte\f[R]
|
|
Use the multibyte modes of Grid Matrix, Han Xin and QR Code for
|
|
non-ASCII data.
|
|
.TP
|
|
\f[V]--gs1\f[R]
|
|
Treat input as GS1 compatible data.
|
|
Application Identifiers (AIs) should be placed in square brackets
|
|
\f[V]\[dq][]\[dq]\f[R] (but see \f[V]--gs1parens\f[R]).
|
|
.TP
|
|
\f[V]--gs1nocheck\f[R]
|
|
Do not check the validity of GS1 data.
|
|
.TP
|
|
\f[V]--gs1parens\f[R]
|
|
Process parentheses \f[V]\[dq]()\[dq]\f[R] as GS1 AI delimiters, rather
|
|
than square brackets \f[V]\[dq][]\[dq]\f[R].
|
|
The input data must not otherwise contain parentheses.
|
|
.TP
|
|
\f[V]--gssep\f[R]
|
|
For Data Matrix in GS1 mode, use \f[V]GS\f[R] (0x1D) as the GS1 data
|
|
separator instead of \f[V]FNC1\f[R].
|
|
.TP
|
|
\f[V]--guarddescent=NUMBER\f[R]
|
|
For EAN/UPC symbols, set the height the guard bars descend below the
|
|
main bars, where \f[I]NUMBER\f[R] is in multiples of the X-dimension.
|
|
\f[I]NUMBER\f[R] may be floating-point.
|
|
.TP
|
|
\f[V]--guardwhitespace\f[R]
|
|
For EAN/UPC symbols, add quiet zone indicators \f[V]\[dq]<\[dq]\f[R]
|
|
and/or \f[V]\[dq]>\[dq]\f[R] to HRT where applicable.
|
|
.TP
|
|
\f[V]--height=NUMBER\f[R]
|
|
Set the height of the symbol in multiples of the X-dimension.
|
|
\f[I]NUMBER\f[R] may be floating-point.
|
|
.TP
|
|
\f[V]--heightperrow\f[R]
|
|
Treat height as per-row.
|
|
Affects Codablock-F, Code 16K, Code 49, GS1 DataBar Expanded Stacked
|
|
(DBAR_EXPSTK), MicroPDF417 and PDF417.
|
|
.TP
|
|
\f[V]-i\f[R], \f[V]--input=FILE\f[R]
|
|
Read the input data from \f[I]FILE\f[R].
|
|
Specify a single hyphen (\f[V]-\f[R]) for \f[I]FILE\f[R] to read from
|
|
stdin.
|
|
.TP
|
|
\f[V]--init\f[R]
|
|
Create a Reader Initialisation (Programming) symbol.
|
|
.TP
|
|
\f[V]--mask=INTEGER\f[R]
|
|
Set the masking pattern to use for DotCode, Han Xin or QR Code to
|
|
\f[I]INTEGER\f[R], overriding the automatic selection.
|
|
.TP
|
|
\f[V]--mirror\f[R]
|
|
Use the batch data to determine the filename in batch mode
|
|
(\f[V]--batch\f[R]).
|
|
The \f[V]-o\f[R] | \f[V]--output\f[R] option can be used to specify an
|
|
output directory (any filename will be ignored).
|
|
.TP
|
|
\f[V]--mode=INTEGER\f[R]
|
|
For MaxiCode and GS1 Composite symbols, set the encoding mode to
|
|
\f[I]INTEGER\f[R].
|
|
.RS
|
|
.PP
|
|
For MaxiCode (SCM is Structured Carrier Message, with 3 fields:
|
|
postcode, 3-digit ISO 3166-1 country code, 3-digit service code):
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
2 SCM with 9-digit numeric postcode
|
|
3 SCM with 6-character alphanumeric postcode
|
|
4 Enhanced ECC for the primary part of the message
|
|
5 Enhanced ECC for all of the message
|
|
6 Reader Initialisation (Programming)
|
|
\f[R]
|
|
.fi
|
|
.PP
|
|
For GS1 Composite symbols (names end in \f[V]_CC\f[R], i.e.\ EANX_CC,
|
|
GS1_128_CC, DBAR_OMN_CC etc.):
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
1 CC-A
|
|
2 CC-B
|
|
3 CC-C (GS1_128_CC only)
|
|
\f[R]
|
|
.fi
|
|
.RE
|
|
.TP
|
|
\f[V]--nobackground\f[R]
|
|
Remove the background colour (EMF, EPS, GIF, PNG, SVG and TIF only).
|
|
.TP
|
|
\f[V]--noquietzones\f[R]
|
|
Disable any quiet zones for symbols that define them by default.
|
|
.TP
|
|
\f[V]--notext\f[R]
|
|
Remove the Human Readable Text (HRT).
|
|
.TP
|
|
\f[V]-o\f[R], \f[V]--output=FILE\f[R]
|
|
Send the output to \f[I]FILE\f[R].
|
|
When not in batch mode, the default is \[lq]out.png\[rq] (or
|
|
\[lq]out.gif\[rq] if zint built without PNG support).
|
|
When in batch mode (\f[V]--batch\f[R]), special characters can be used
|
|
to format the output filenames:
|
|
.RS
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
\[ti] Insert a number or 0
|
|
# Insert a number or space
|
|
\[at] Insert a number or * (+ on Windows)
|
|
Any other Insert literally
|
|
\f[R]
|
|
.fi
|
|
.RE
|
|
.TP
|
|
\f[V]--primary=STRING\f[R]
|
|
For MaxiCode, set the content of the primary message.
|
|
For GS1 Composite symbols, set the content of the linear symbol.
|
|
.TP
|
|
\f[V]--quietzones\f[R]
|
|
Add compliant quiet zones for symbols that specify them.
|
|
This is in addition to any whitespace specified by \f[V]-w\f[R] |
|
|
\f[V]--whitesp\f[R] or \f[V]--vwhitesp\f[R].
|
|
.TP
|
|
\f[V]-r\f[R], \f[V]--reverse\f[R]
|
|
Reverse the foreground and background colours (white on black).
|
|
Known as \[lq]reflectance reversal\[rq] or \[lq]reversed
|
|
reflectance\[rq].
|
|
.TP
|
|
\f[V]--rotate=INTEGER\f[R]
|
|
Rotate the symbol by \f[I]INTEGER\f[R] degrees, where \f[I]INTEGER\f[R]
|
|
can be 0, 90, 270 or 360.
|
|
.TP
|
|
\f[V]--rows=INTEGER\f[R]
|
|
Set the number of rows for Codablock-F or PDF417 to \f[I]INTEGER\f[R].
|
|
It will also set the minimum number of rows for Code 16K or Code 49, and
|
|
the maximum number of rows for GS1 DataBar Expanded Stacked
|
|
(DBAR_EXPSTK).
|
|
.TP
|
|
\f[V]--scale=NUMBER\f[R]
|
|
Adjust the size of the X-dimension.
|
|
\f[I]NUMBER\f[R] may be floating-point, and is multiplied by 2 (except
|
|
for MaxiCode) before being applied.
|
|
The default scale is 1.
|
|
.RS
|
|
.PP
|
|
For MaxiCode, the scale is multiplied by 10 for raster output, by 40 for
|
|
EMF output, and by 2 otherwise.
|
|
.PP
|
|
Increments of 0.5 (half-integers) are recommended for non-MaxiCode
|
|
raster output (BMP, GIF, PCX, PNG and TIF).
|
|
.PP
|
|
See also \f[V]--scalexdimdp\f[R] below.
|
|
.RE
|
|
.TP
|
|
\f[V]--scalexdimdp=X[,R]\f[R]
|
|
Scale the image according to X-dimension \f[I]X\f[R] and resolution
|
|
\f[I]R\f[R], where \f[I]X\f[R] is in mm and \f[I]R\f[R] is in dpmm (dots
|
|
per mm).
|
|
\f[I]X\f[R] and \f[I]R\f[R] may be floating-point.
|
|
\f[I]R\f[R] is optional and defaults to 12 dpmm (approximately 300 dpi).
|
|
.RS
|
|
.PP
|
|
The scaling takes into account the output filetype, and deals with all
|
|
the details mentioned above.
|
|
Units may be specified for \f[I]X\f[R] by appending \[lq]in\[rq] (inch)
|
|
or \[lq]mm\[rq], and for \f[I]R\f[R] by appending \[lq]dpi\[rq] (dots
|
|
per inch) or \[lq]dpmm\[rq] -
|
|
e.g.\ \f[V]--scalexdimdp=0.013in,300dpi\f[R].
|
|
.RE
|
|
.TP
|
|
\f[V]--scmvv=INTEGER\f[R]
|
|
For MaxiCode, prefix the Structured Carrier Message (SCM) with
|
|
\f[V]\[dq][)>\[rs]R01\[rs]Gvv\[dq]\f[R], where \f[V]vv\f[R] is a 2-digit
|
|
\f[I]INTEGER\f[R].
|
|
.TP
|
|
\f[V]--secure=INTEGER\f[R]
|
|
Set the error correction level (ECC) to \f[I]INTEGER\f[R].
|
|
The meaning is specific to the following matrix symbols (all except
|
|
PDF417 are approximate):
|
|
.RS
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
Aztec Code 1 to 4 (10%, 23%, 36%, 50%)
|
|
Grid Matrix 1 to 5 (10% to 50%)
|
|
Han Xin 1 to 4 (8%, 15%, 23%, 30%)
|
|
Micro QR 1 to 3 (7%, 15%, 25%) (L, M, Q)
|
|
PDF417 0 to 8 (2\[ha](INTEGER + 1) codewords)
|
|
QR Code 1 to 4 (7%, 15%, 25%, 30%) (L, M, Q, H)
|
|
rMQR 2 or 4 (15% or 30%) (M or H)
|
|
Ultracode 1 to 6 (0%, 5%, 9%, 17%, 25%, 33%)
|
|
\f[R]
|
|
.fi
|
|
.RE
|
|
.TP
|
|
\f[V]--segN=ECI,DATA\f[R]
|
|
Set the \f[I]ECI\f[R] & \f[I]DATA\f[R] content for segment N, where N is
|
|
1 to 9.
|
|
\f[V]-d\f[R] | \f[V]--data\f[R] must still be given, and counts as
|
|
segment 0, its ECI given by \f[V]--eci\f[R].
|
|
Segments must be consecutive.
|
|
.TP
|
|
\f[V]--separator=INTEGER\f[R]
|
|
Set the height of row separator bars for stacked symbologies, where
|
|
\f[I]INTEGER\f[R] is in integral multiples of the X-dimension.
|
|
The default is zero.
|
|
.TP
|
|
\f[V]--small\f[R]
|
|
Use small text for Human Readable Text (HRT).
|
|
.TP
|
|
\f[V]--square\f[R]
|
|
For Data Matrix symbols, exclude rectangular sizes when considering
|
|
automatic sizes.
|
|
.TP
|
|
\f[V]--structapp=I,C[,ID]\f[R]
|
|
Set Structured Append info, where \f[I]I\f[R] is the 1-based index,
|
|
\f[I]C\f[R] is the total number of symbols in the sequence, and
|
|
\f[I]ID\f[R], which is optional, is the identifier that all symbols in
|
|
the sequence share.
|
|
Structured Append is supported by Aztec Code, Code One, Data Matrix,
|
|
DotCode, Grid Matrix, MaxiCode, MicroPDF417, PDF417, QR Code and
|
|
Ultracode.
|
|
.TP
|
|
\f[V]-t\f[R], \f[V]--types\f[R]
|
|
Display the table of barcode types (symbologies).
|
|
The numbers or names can be used with \f[V]-b\f[R] |
|
|
\f[V]--barcode\f[R].
|
|
.TP
|
|
\f[V]--textgap=NUMBER\f[R]
|
|
Adjust the gap between the barcode and the Human Readable Text (HRT).
|
|
\f[I]NUMBER\f[R] is in multiples of the X-dimension, and may be
|
|
floating-point.
|
|
Maximum is 10; zero results in the default 1X being used.
|
|
.TP
|
|
\f[V]--vers=INTEGER\f[R]
|
|
Set the symbol version (size, check digits, other options) to
|
|
\f[I]INTEGER\f[R].
|
|
The meaning is symbol-specific.
|
|
.RS
|
|
.PP
|
|
For most matrix symbols, it specifies size:
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
Aztec Code 1 to 36 (1 to 4 compact)
|
|
Code One 1 to 10
|
|
Data Matrix 1 to 48 (31 to 48 DMRE)
|
|
Grid Matrix 1 to 13
|
|
Han Xin 1 to 84
|
|
Micro QR 1 to 4 (M1, M2, M3, M4)
|
|
QR Code 1 to 40
|
|
rMQR 1 to 38 (33 to 38 automatic width)
|
|
\f[R]
|
|
.fi
|
|
.PP
|
|
For a number of linear symbols, it specifies check character options
|
|
(\[lq]hide\[rq] or \[lq]hidden\[rq] means don\[cq]t show in HRT,
|
|
\[lq]visible\[rq] means do display in HRT):
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
C25IATA 1 or 2 (add visible or hidden check digit)
|
|
C25IND ditto
|
|
C25INTER ditto
|
|
C25LOGIC ditto
|
|
C25STANDARD ditto
|
|
Codabar 1 or 2 (add hidden or visible check digit)
|
|
Code 11 0 to 2 (2 visible check digits to none)
|
|
0 (default 2 visible check digits)
|
|
1 (1 visible check digit)
|
|
2 (no check digits)
|
|
Code 39 1 or 2 (add visible or hidden check digit)
|
|
Code 93 1 (hide the default check characters)
|
|
EXCODE39 1 or 2 (add visible or hidden check digit)
|
|
LOGMARS 1 or 2 (add visible or hidden check digit)
|
|
MSI Plessey 0 to 6 (none to various visible options)
|
|
1, 2 (mod-10, mod-10 + mod-10)
|
|
3, 4 (mod-11 IBM, mod-11 IBM + mod-10)
|
|
5, 6 (mod-11 NCR, mod-11 NCR + mod-10)
|
|
+10 (hide)
|
|
\f[R]
|
|
.fi
|
|
.PP
|
|
For a few other symbologies, it specifies other characteristics:
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
Channel Code 3 to 8 (no. of channels)
|
|
DAFT 50 to 900 (permille tracker ratio)
|
|
DPD 1 (relabel)
|
|
PZN 1 (PZN7 instead of default PZN8)
|
|
Ultracode 2 (revision 2)
|
|
VIN 1 (add international prefix)
|
|
\f[R]
|
|
.fi
|
|
.RE
|
|
.TP
|
|
\f[V]-v\f[R], \f[V]--version\f[R]
|
|
Display zint version.
|
|
.TP
|
|
\f[V]--vwhitesp=INTEGER\f[R]
|
|
Set the height of vertical whitespace above and below the barcode, where
|
|
\f[I]INTEGER\f[R] is in integral multiples of the X-dimension.
|
|
.TP
|
|
\f[V]-w\f[R], \f[V]--whitesp=INTEGER\f[R]
|
|
Set the width of horizontal whitespace either side of the barcode, where
|
|
\f[I]INTEGER\f[R] is in integral multiples of the X-dimension.
|
|
.TP
|
|
\f[V]--werror\f[R]
|
|
Convert all warnings into errors.
|
|
.SH EXIT STATUS
|
|
.TP
|
|
\f[V]0\f[R]
|
|
Success (including when given informational options \f[V]-h\f[R] |
|
|
\f[V]--help\f[R], \f[V]-e\f[R] | \f[V]--ecinos\f[R], \f[V]-t\f[R] |
|
|
\f[V]--types\f[R], \f[V]-v\f[R] | \f[V]--version\f[R]).
|
|
.TP
|
|
\f[V]1\f[R]
|
|
Human Readable Text was truncated (maximum 159 bytes)
|
|
(\f[V]ZINT_WARN_HRT_TRUNCATED\f[R])
|
|
.TP
|
|
\f[V]2\f[R]
|
|
Invalid option given but overridden by Zint
|
|
(\f[V]ZINT_WARN_INVALID_OPTION\f[R])
|
|
.TP
|
|
\f[V]3\f[R]
|
|
Automatic ECI inserted by Zint (\f[V]ZINT_WARN_USES_ECI\f[R])
|
|
.TP
|
|
\f[V]4\f[R]
|
|
Symbol created not compliant with standards
|
|
(\f[V]ZINT_WARN_NONCOMPLIANT\f[R])
|
|
.TP
|
|
\f[V]5\f[R]
|
|
Input data wrong length (\f[V]ZINT_ERROR_TOO_LONG\f[R])
|
|
.TP
|
|
\f[V]6\f[R]
|
|
Input data incorrect (\f[V]ZINT_ERROR_INVALID_DATA\f[R])
|
|
.TP
|
|
\f[V]7\f[R]
|
|
Input check digit incorrect (\f[V]ZINT_ERROR_INVALID_CHECK\f[R])
|
|
.TP
|
|
\f[V]8\f[R]
|
|
Incorrect option given (\f[V]ZINT_ERROR_INVALID_OPTION\f[R])
|
|
.TP
|
|
\f[V]9\f[R]
|
|
Internal error (should not happen)
|
|
(\f[V]ZINT_ERROR_ENCODING_PROBLEM\f[R])
|
|
.TP
|
|
\f[V]10\f[R]
|
|
Error opening output file (\f[V]ZINT_ERROR_FILE_ACCESS\f[R])
|
|
.TP
|
|
\f[V]11\f[R]
|
|
Memory allocation (malloc) failure (\f[V]ZINT_ERROR_MEMORY\f[R])
|
|
.TP
|
|
\f[V]12\f[R]
|
|
Error writing to output file (\f[V]ZINT_ERROR_FILE_WRITE\f[R])
|
|
.TP
|
|
\f[V]13\f[R]
|
|
Error counterpart of warning if \f[V]--werror\f[R] given
|
|
(\f[V]ZINT_ERROR_USES_ECI\f[R])
|
|
.TP
|
|
\f[V]14\f[R]
|
|
Error counterpart of warning if \f[V]--werror\f[R] given
|
|
(\f[V]ZINT_ERROR_NONCOMPLIANT\f[R])
|
|
.TP
|
|
\f[V]15\f[R]
|
|
Error counterpart of warning if \f[V]--werror\f[R] given
|
|
(\f[V]ZINT_ERROR_HRT_TRUNCATED\f[R])
|
|
.SH EXAMPLES
|
|
.PP
|
|
Create \[lq]out.png\[rq] (or \[lq]out.gif\[rq] if zint built without PNG
|
|
support) in the current directory, as a Code 128 symbol.
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
zint -d \[aq]This Text\[aq]
|
|
\f[R]
|
|
.fi
|
|
.PP
|
|
Create \[lq]qr.svg\[rq] in the current directory, as a QR Code symbol.
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
zint -b QRCode -d \[aq]This Text\[aq] -o \[aq]qr.svg\[aq]
|
|
\f[R]
|
|
.fi
|
|
.PP
|
|
Use batch mode to read from an input file \[lq]ean13nos.txt\[rq]
|
|
containing 13-digit GTINs, to create a series of EAN-13 barcodes,
|
|
formatting the output filenames to \[lq]ean001.gif\[rq],
|
|
\[lq]ean002.gif\[rq] etc.
|
|
using the special character \[lq]\[ti]\[rq].
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
zint -b EANX --batch -i \[aq]ean13nos.txt\[aq] -o \[aq]ean\[ti]\[ti]\[ti].gif\[aq]
|
|
\f[R]
|
|
.fi
|
|
.SH BUGS
|
|
.PP
|
|
Please send bug reports to https://sourceforge.net/p/zint/tickets/.
|
|
.SH SEE ALSO
|
|
.PP
|
|
Full documention for \f[V]zint\f[R] (and the API \f[V]libzint\f[R] and
|
|
the GUI \f[V]zint-qt\f[R]) is available from
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
https://zint.org.uk/manual/
|
|
\f[R]
|
|
.fi
|
|
.PP
|
|
and at
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
https://sourceforge.net/p/zint/docs/manual.txt
|
|
\f[R]
|
|
.fi
|
|
.SH CONFORMING TO
|
|
.PP
|
|
Zint is designed to be compliant with a number of international
|
|
standards, including:
|
|
.PP
|
|
ISO/IEC 24778:2008, ANSI/AIM BC12-1998, EN 798:1996, AIM ISS-X-24
|
|
(1995), ISO/IEC 15417:2007, EN 12323:2005, ISO/IEC 16388:2007, ANSI/AIM
|
|
BC6-2000, ANSI/AIM BC5-1995, AIM USS Code One (1994), ISO/IEC
|
|
16022:2006, ISO/IEC 21471:2019, ISO/IEC 15420:2009, AIMD014 (v 1.63)
|
|
(2008), ISO/IEC 24723:2010, ISO/IEC 24724:2011, ISO/IEC 20830:2021,
|
|
ISO/IEC 16390:2007, ISO/IEC 16023:2000, ISO/IEC 24728:2006, ISO/IEC
|
|
15438:2015, ISO/IEC 18004:2015, ISO/IEC 23941:2022, AIM ITS/04-023
|
|
(2022)
|
|
.SH COPYRIGHT
|
|
.PP
|
|
Copyright © 2023 Robin Stuart.
|
|
Released under GNU GPL 3.0 or later.
|
|
.SH AUTHOR
|
|
.PP
|
|
Robin Stuart <robin@zint.org.uk>
|