mirror of
https://github.com/zint/zint
synced 2024-11-16 20:57:25 +13:00
323b34502b
rename `ZINT_CAP_EXTENDABLE` -> `ZINT_CAP_EANUPC` (`ZINT_CAP_EXTENDABLE` marked as legacy) CODE128: increase no. symbol chars max 60 -> 99 EAN-2/EAN-5: fix `BARCODE_BIND_TOP/BIND/BOX` output GS1_128: warn if data > 48 (GS1 General Specifications max) common: `is_extendable()` -> `is_ucpean()` raster: add `ZFONT_HALIGN_CENTRE/LEFT/RIGHT` flags and process in `draw_string()` (for drawing EAN/UPC outside digits), and for `ZFONT_HALIGN_CENTRE` round when calculating centre (shifts some texts 1 pixel left) raster/vector: use offsets into `symbol->text` for EAN/UPC instead of `out_upcean_split_text()` (removed) BMP/EMF/GIF/PCX/PNG/PS/SVG/TIF: use new `out_colour_get_rgb()` routine (replaces `colour_to_XXX()`) general: simplify/fix some `error_number` handling/returning frontend: truncate overlong `--primary` instead of ignoring; negative floating pt option (for `--textgap`) man page: list size detail for matrix symbols (`--vers`) manual: further fiddling with scaling text; some typos
726 lines
25 KiB
Groff
726 lines
25 KiB
Groff
.\" Automatically generated by Pandoc 3.1.9
|
|
.\"
|
|
.TH "ZINT" "1" "November 2023" "Version 2.12.0.9" ""
|
|
.SH NAME
|
|
\f[CR]zint\f[R] - encode data as a barcode image
|
|
.SH SYNOPSIS
|
|
.PP
|
|
\f[CR]zint\f[R] [\f[CR]-h\f[R] | \f[CR]--help\f[R]]
|
|
.PD 0
|
|
.P
|
|
.PD
|
|
\f[CR]zint\f[R] [\f[I]options\f[R]]
|
|
.SH DESCRIPTION
|
|
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[CR]--binary\f[R] is specified.
|
|
.PP
|
|
Human Readable Text (HRT) is displayed by default for those barcodes
|
|
that support HRT, unless \f[CR]--notext\f[R] is specified.
|
|
.PP
|
|
The output image file (specified with \f[CR]-o\f[R] |
|
|
\f[CR]--output\f[R]) may be in one of these formats: Windows Bitmap
|
|
(\f[CR]BMP\f[R]), Enhanced Metafile Format (\f[CR]EMF\f[R]),
|
|
Encapsulated PostScript (\f[CR]EPS\f[R]), Graphics Interchange Format
|
|
(\f[CR]GIF\f[R]), ZSoft Paintbrush (\f[CR]PCX\f[R]), Portable Network
|
|
Format (\f[CR]PNG\f[R]), Scalable Vector Graphic (\f[CR]SVG\f[R]), or
|
|
Tagged Image File Format (\f[CR]TIF\f[R]).
|
|
.SH OPTIONS
|
|
.TP
|
|
\f[CR]-h\f[R], \f[CR]--help\f[R]
|
|
Print usage information summarizing command line options.
|
|
.TP
|
|
\f[CR]-b TYPE\f[R], \f[CR]--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[CR]-t\f[R] |
|
|
\f[CR]--types\f[R] option.
|
|
Type names are case-insensitive, and non-alphanumerics are ignored.
|
|
.TP
|
|
\f[CR]--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[CR]--batch\f[R]
|
|
Treat each line of an input file specified with \f[CR]-i\f[R] |
|
|
\f[CR]--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[CR]-o\f[R] | \f[CR]--output\f[R] option.
|
|
.TP
|
|
\f[CR]--bg=COLOUR\f[R]
|
|
Specify a background (paper) colour where \f[I]COLOUR\f[R] is in
|
|
hexadecimal \f[CR]RRGGBB\f[R] or \f[CR]RRGGBBAA\f[R] format or in
|
|
decimal \f[CR]C,M,Y,K\f[R] percentages format.
|
|
.TP
|
|
\f[CR]--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[CR]--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[CR]--border\f[R]
|
|
option.
|
|
\f[CR]--bind\f[R] can also be used to add row separator bars to symbols
|
|
stacked with multiple \f[CR]-d\f[R] | \f[CR]--data\f[R] inputs, in which
|
|
case the width of the separator bars is specified with the
|
|
\f[CR]--separator\f[R] option.
|
|
.TP
|
|
\f[CR]--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[CR]--border\f[R]
|
|
option.
|
|
.TP
|
|
\f[CR]--bold\f[R]
|
|
Use bold text for the Human Readable Text (HRT).
|
|
.TP
|
|
\f[CR]--border=INTEGER\f[R]
|
|
Set the width of boundary bars (\f[CR]--bind\f[R] or
|
|
\f[CR]--bindtop\f[R]) or box borders (\f[CR]--box\f[R]), where
|
|
\f[I]INTEGER\f[R] is in integral multiples of the X-dimension.
|
|
The default is zero.
|
|
.TP
|
|
\f[CR]--box\f[R]
|
|
Add a box around the symbol.
|
|
The width of the borders is specified by the \f[CR]--border\f[R] option.
|
|
.TP
|
|
\f[CR]--cmyk\f[R]
|
|
Use the CMYK colour space when outputting to Encapsulated PostScript
|
|
(EPS) or TIF files.
|
|
.TP
|
|
\f[CR]--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[CR]--compliantheight\f[R]
|
|
Warn if the height specified by the \f[CR]--height\f[R] option is not
|
|
compliant with the barcode\[cq]s specification, or if
|
|
\f[CR]--height\f[R] is not given, default to the height specified by the
|
|
specification (if any).
|
|
.TP
|
|
\f[CR]-d\f[R], \f[CR]--data=DATA\f[R]
|
|
Specify the input \f[I]DATA\f[R] to encode.
|
|
The \f[CR]--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[CR]--binary\f[R]
|
|
option is given, in which case it can be anything.
|
|
.TP
|
|
\f[CR]--direct\f[R]
|
|
Send output to stdout, which in most cases should be re-directed to a
|
|
pipe or a file.
|
|
Use \f[CR]--filetype\f[R] to specify output format.
|
|
.TP
|
|
\f[CR]--dmiso144\f[R]
|
|
For Data Matrix symbols, use the standard ISO/IEC codeword placement for
|
|
144 x 144 (\f[CR]--vers=24\f[R]) sized symbols, instead of the default
|
|
\[lq]de facto\[rq] placement (which rotates the placement of ECC
|
|
codewords).
|
|
.TP
|
|
\f[CR]--dmre\f[R]
|
|
For Data Matrix symbols, allow Data Matrix Rectangular Extended (DMRE)
|
|
sizes when considering automatic sizes.
|
|
See also \f[CR]--square\f[R].
|
|
.TP
|
|
\f[CR]--dotsize=NUMBER\f[R]
|
|
Set the radius of the dots in dotty mode (\f[CR]--dotty\f[R]).
|
|
\f[I]NUMBER\f[R] is in X-dimensions, and may be floating-point.
|
|
The default is 0.8.
|
|
.TP
|
|
\f[CR]--dotty\f[R]
|
|
Use dots instead of squares for matrix symbols.
|
|
DotCode is always in dotty mode.
|
|
.TP
|
|
\f[CR]--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[CR].txt\f[R] extension with \f[CR]-o\f[R] | \f[CR]--output\f[R] or by
|
|
specifying \f[CR]--filetype=txt\f[R].
|
|
.TP
|
|
\f[CR]-e\f[R], \f[CR]--ecinos\f[R]
|
|
Display the table of ECIs (Extended Channel Interpretations).
|
|
.TP
|
|
\f[CR]--eci=INTEGER\f[R]
|
|
Set the ECI code for the input data to \f[I]INTEGER\f[R].
|
|
See \f[CR]-e\f[R] | \f[CR]--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[CR]--embedfont\f[R]
|
|
For vector output, embed the font in the file for portability.
|
|
Currently only available for SVG output.
|
|
.TP
|
|
\f[CR]--esc\f[R]
|
|
Process escape characters in the input data.
|
|
The escape sequences are:
|
|
.RS
|
|
.IP
|
|
.EX
|
|
\[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
|
|
.EE
|
|
.RE
|
|
.TP
|
|
\f[CR]--extraesc\f[R]
|
|
Process the special escape sequences \f[CR]\[rs]\[ha]A\f[R],
|
|
\f[CR]\[rs]\[ha]B\f[R] and \f[CR]\[rs]\[ha]C\f[R] that allow manual
|
|
switching of Code Sets (Code 128 only).
|
|
The sequence \f[CR]\[rs]\[ha]\[ha]\f[R] can be used to encode data that
|
|
contains special escape sequences.
|
|
.TP
|
|
\f[CR]--fast\f[R]
|
|
Use faster if less optimal encodation or other shortcuts (affects Data
|
|
Matrix, MicroPDF417, PDF417, QRCODE & UPNQR only).
|
|
.TP
|
|
\f[CR]--fg=COLOUR\f[R]
|
|
Specify a foreground (ink) colour where \f[I]COLOUR\f[R] is in
|
|
hexadecimal \f[CR]RRGGBB\f[R] or \f[CR]RRGGBBAA\f[R] format or in
|
|
decimal \f[CR]C,M,Y,K\f[R] percentages format.
|
|
.TP
|
|
\f[CR]--filetype=TYPE\f[R]
|
|
Set the output file type to \f[I]TYPE\f[R], which is one of
|
|
\f[CR]BMP\f[R], \f[CR]EMF\f[R], \f[CR]EPS\f[R], \f[CR]GIF\f[R],
|
|
\f[CR]PCX\f[R], \f[CR]PNG\f[R], \f[CR]SVG\f[R], \f[CR]TIF\f[R],
|
|
\f[CR]TXT\f[R].
|
|
.TP
|
|
\f[CR]--fullmultibyte\f[R]
|
|
Use the multibyte modes of Grid Matrix, Han Xin and QR Code for
|
|
non-ASCII data.
|
|
.TP
|
|
\f[CR]--gs1\f[R]
|
|
Treat input as GS1 compatible data.
|
|
Application Identifiers (AIs) should be placed in square brackets
|
|
\f[CR]\[dq][]\[dq]\f[R] (but see \f[CR]--gs1parens\f[R]).
|
|
.TP
|
|
\f[CR]--gs1nocheck\f[R]
|
|
Do not check the validity of GS1 data.
|
|
.TP
|
|
\f[CR]--gs1parens\f[R]
|
|
Process parentheses \f[CR]\[dq]()\[dq]\f[R] as GS1 AI delimiters, rather
|
|
than square brackets \f[CR]\[dq][]\[dq]\f[R].
|
|
The input data must not otherwise contain parentheses.
|
|
.TP
|
|
\f[CR]--gssep\f[R]
|
|
For Data Matrix in GS1 mode, use \f[CR]GS\f[R] (0x1D) as the GS1 data
|
|
separator instead of \f[CR]FNC1\f[R].
|
|
.TP
|
|
\f[CR]--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 X-dimensions.
|
|
\f[I]NUMBER\f[R] may be floating-point.
|
|
.TP
|
|
\f[CR]--guardwhitespace\f[R]
|
|
For EAN/UPC symbols, add quiet zone indicators \f[CR]\[dq]<\[dq]\f[R]
|
|
and/or \f[CR]\[dq]>\[dq]\f[R] to HRT where applicable.
|
|
.TP
|
|
\f[CR]--height=NUMBER\f[R]
|
|
Set the height of the symbol in X-dimensions.
|
|
\f[I]NUMBER\f[R] may be floating-point.
|
|
.TP
|
|
\f[CR]--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[CR]-i\f[R], \f[CR]--input=FILE\f[R]
|
|
Read the input data from \f[I]FILE\f[R].
|
|
Specify a single hyphen (\f[CR]-\f[R]) for \f[I]FILE\f[R] to read from
|
|
stdin.
|
|
.TP
|
|
\f[CR]--init\f[R]
|
|
Create a Reader Initialisation (Programming) symbol.
|
|
.TP
|
|
\f[CR]--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[CR]--mirror\f[R]
|
|
Use the batch data to determine the filename in batch mode
|
|
(\f[CR]--batch\f[R]).
|
|
The \f[CR]-o\f[R] | \f[CR]--output\f[R] option can be used to specify an
|
|
output directory (any filename will be ignored).
|
|
.TP
|
|
\f[CR]--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
|
|
.EX
|
|
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)
|
|
.EE
|
|
.PP
|
|
For GS1 Composite symbols (names end in \f[CR]_CC\f[R], i.e.\ EANX_CC,
|
|
GS1_128_CC, DBAR_OMN_CC etc.):
|
|
.IP
|
|
.EX
|
|
1 CC-A
|
|
2 CC-B
|
|
3 CC-C (GS1_128_CC only)
|
|
.EE
|
|
.RE
|
|
.TP
|
|
\f[CR]--nobackground\f[R]
|
|
Remove the background colour (EMF, EPS, GIF, PNG, SVG and TIF only).
|
|
.TP
|
|
\f[CR]--noquietzones\f[R]
|
|
Disable any quiet zones for symbols that define them by default.
|
|
.TP
|
|
\f[CR]--notext\f[R]
|
|
Remove the Human Readable Text (HRT).
|
|
.TP
|
|
\f[CR]-o\f[R], \f[CR]--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[CR]--batch\f[R]), special characters can be used
|
|
to format the output filenames:
|
|
.RS
|
|
.IP
|
|
.EX
|
|
\[ti] Insert a number or 0
|
|
# Insert a number or space
|
|
\[at] Insert a number or * (+ on Windows)
|
|
Any other Insert literally
|
|
.EE
|
|
.RE
|
|
.TP
|
|
\f[CR]--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[CR]--quietzones\f[R]
|
|
Add compliant quiet zones for symbols that specify them.
|
|
This is in addition to any whitespace specified by \f[CR]-w\f[R] |
|
|
\f[CR]--whitesp\f[R] or \f[CR]--vwhitesp\f[R].
|
|
.TP
|
|
\f[CR]-r\f[R], \f[CR]--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[CR]--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[CR]--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[CR]--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[CR]--scalexdimdp\f[R] below.
|
|
.RE
|
|
.TP
|
|
\f[CR]--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).
|
|
\f[I]X\f[R] may be zero in which case a symbology-specific default is
|
|
used.
|
|
.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[CR]--scalexdimdp=0.013in,300dpi\f[R].
|
|
.RE
|
|
.TP
|
|
\f[CR]--scmvv=INTEGER\f[R]
|
|
For MaxiCode, prefix the Structured Carrier Message (SCM) with
|
|
\f[CR]\[dq][)>\[rs]R01\[rs]Gvv\[dq]\f[R], where \f[CR]vv\f[R] is a
|
|
2-digit \f[I]INTEGER\f[R].
|
|
.TP
|
|
\f[CR]--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
|
|
.EX
|
|
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%)
|
|
.EE
|
|
.RE
|
|
.TP
|
|
\f[CR]--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[CR]-d\f[R] | \f[CR]--data\f[R] must still be given, and counts as
|
|
segment 0, its ECI given by \f[CR]--eci\f[R].
|
|
Segments must be consecutive.
|
|
.TP
|
|
\f[CR]--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[CR]--small\f[R]
|
|
Use small text for Human Readable Text (HRT).
|
|
.TP
|
|
\f[CR]--square\f[R]
|
|
For Data Matrix symbols, exclude rectangular sizes when considering
|
|
automatic sizes.
|
|
See also \f[CR]--dmre\f[R].
|
|
.TP
|
|
\f[CR]--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[CR]-t\f[R], \f[CR]--types\f[R]
|
|
Display the table of barcode types (symbologies).
|
|
The numbers or names can be used with \f[CR]-b\f[R] |
|
|
\f[CR]--barcode\f[R].
|
|
.TP
|
|
\f[CR]--textgap=NUMBER\f[R]
|
|
Adjust the gap between the barcode and the Human Readable Text (HRT).
|
|
\f[I]NUMBER\f[R] is in X-dimensions, and may be floating-point.
|
|
Maximum is 10 and minimum is -5.
|
|
The default is 1.
|
|
.TP
|
|
\f[CR]--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
|
|
.EX
|
|
Aztec Code 1 to 36 (1 to 4 compact)
|
|
1 15x15 13 53x53 25 105x105
|
|
2 19x19 14 57x57 26 109x109
|
|
3 23x23 15 61x61 27 113x113
|
|
4 27x27 16 67x67 28 117x117
|
|
5 19x19 17 71x71 29 121x121
|
|
6 23x23 18 75x75 30 125x125
|
|
7 27x27 19 79x79 31 131x131
|
|
8 31x31 20 83x83 32 135x135
|
|
9 37x37 21 87x87 33 139x139
|
|
10 41x41 22 91x91 34 143x143
|
|
11 45x45 23 95x95 35 147x147
|
|
12 49x49 24 101x101 36 151x151
|
|
Code One 1 to 10 (9 and 10 variable width) (WxH)
|
|
1 16x18 6 70x76
|
|
2 22x22 7 104x98
|
|
3 28x28 8 148x134
|
|
4 40x42 9 Wx8
|
|
5 52x54 10 Wx16
|
|
Data Matrix 1 to 48 (31 to 48 DMRE) (HxW)
|
|
1 10x10 17 72x72 33 8x80
|
|
2 12x12 18 80x80 34 8x96
|
|
3 14x14 19 88x88 35 8x120
|
|
4 16x16 20 96x96 36 8x144
|
|
5 18x18 21 104x104 37 12x64
|
|
6 20x20 22 120x120 38 12x88
|
|
7 22x22 23 132x132 39 16x64
|
|
8 24x24 24 144x144 40 20x36
|
|
9 26x26 25 8x18 41 20x44
|
|
10 32x32 26 8x32 42 20x64
|
|
11 36x36 28 12x26 43 22x48
|
|
12 40x40 28 12x36 44 24x48
|
|
13 44x44 29 16x36 45 24x64
|
|
14 48x48 30 16x48 46 26x40
|
|
15 52x52 31 8x48 47 26x48
|
|
16 64x64 32 8x64 48 26x64
|
|
Grid Matrix 1 to 13
|
|
1 18x18 6 78x78 11 138x138
|
|
2 30x30 7 90x90 12 150x150
|
|
3 42x42 8 102x102 13 162x162
|
|
4 54x54 9 114x114
|
|
5 66x66 10 126x126
|
|
Han Xin 1 to 84
|
|
1 23x23 29 79x79 57 135x135
|
|
2 25x25 30 81x81 58 137x137
|
|
3 27x27 31 83x83 59 139x139
|
|
4 29x29 32 85x85 60 141x141
|
|
5 31x31 33 87x87 61 143x143
|
|
6 33x33 34 89x89 62 145x145
|
|
7 35x35 35 91x91 63 147x147
|
|
8 37x37 36 93x93 64 149x149
|
|
9 39x39 37 95x95 65 151x151
|
|
10 41x41 38 97x97 66 153x153
|
|
11 43x43 39 99x99 67 155x155
|
|
12 45x45 40 101x101 68 157x157
|
|
13 47x47 41 103x103 69 159x159
|
|
14 49x49 42 105x105 70 161x161
|
|
15 51x51 43 107x107 71 163x163
|
|
16 53x53 44 109x109 72 165x165
|
|
17 55x55 45 111x111 73 167x167
|
|
18 57x57 46 113x113 74 169x169
|
|
19 59x59 47 115x115 75 171x171
|
|
20 61x61 48 117x117 76 173x173
|
|
21 63x63 49 119x119 77 175x175
|
|
22 65x65 50 121x121 78 177x177
|
|
23 67x67 51 123x123 79 179x179
|
|
24 69x69 52 125x125 80 181x181
|
|
25 71x71 53 127x127 81 183x183
|
|
26 73x73 54 129x129 82 185x185
|
|
27 75x75 55 131x131 83 187x187
|
|
28 77x77 56 133x133 84 189x189
|
|
Micro QR 1 to 4 (M1, M2, M3, M4)
|
|
1 11x11 3 15x15
|
|
2 13x13 4 17x17
|
|
QR Code 1 to 40
|
|
1 21x21 15 77x77 29 133x133
|
|
2 25x25 16 81x81 30 137x137
|
|
3 29x29 17 85x85 31 141x141
|
|
4 33x33 18 89x89 32 145x145
|
|
5 37x37 19 93x93 33 149x149
|
|
6 41x41 20 97x97 34 153x153
|
|
7 45x45 21 101x101 35 157x157
|
|
8 49x49 22 105x105 36 161x161
|
|
9 53x53 23 109x109 37 165x165
|
|
10 57x57 24 113x113 38 169x169
|
|
11 61x61 25 117x117 39 173x173
|
|
12 65x65 26 121x121 40 177x177
|
|
13 69x69 27 125x125
|
|
14 73x73 28 129x129
|
|
rMQR 1 to 38 (33 to 38 automatic width) (HxW)
|
|
1 7x73 14 11x77 27 15x139
|
|
2 7x59 15 11x99 28 17x43
|
|
3 7x77 16 11x139 29 17x59
|
|
4 7x99 17 13x27 30 17x77
|
|
5 7x139 18 13x43 31 17x99
|
|
6 9x43 19 13x59 32 17x139
|
|
7 9x59 20 13x77 33 7xW
|
|
8 9x77 21 13x99 34 9xW
|
|
9 9x99 22 13x139 35 11xW
|
|
10 9x139 23 15x43 36 13xW
|
|
11 11x27 24 15x59 37 15xW
|
|
12 11x43 25 15x77 38 17xW
|
|
13 11x59 26 15x99
|
|
.EE
|
|
.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
|
|
.EX
|
|
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)
|
|
.EE
|
|
.PP
|
|
For a few other symbologies, it specifies other characteristics:
|
|
.IP
|
|
.EX
|
|
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)
|
|
.EE
|
|
.RE
|
|
.TP
|
|
\f[CR]-v\f[R], \f[CR]--version\f[R]
|
|
Display zint version.
|
|
.TP
|
|
\f[CR]--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[CR]-w\f[R], \f[CR]--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[CR]--werror\f[R]
|
|
Convert all warnings into errors.
|
|
.SH EXIT STATUS
|
|
.TP
|
|
\f[CR]0\f[R]
|
|
Success (including when given informational options \f[CR]-h\f[R] |
|
|
\f[CR]--help\f[R], \f[CR]-e\f[R] | \f[CR]--ecinos\f[R], \f[CR]-t\f[R] |
|
|
\f[CR]--types\f[R], \f[CR]-v\f[R] | \f[CR]--version\f[R]).
|
|
.TP
|
|
\f[CR]1\f[R]
|
|
Human Readable Text was truncated (maximum 199 bytes)
|
|
(\f[CR]ZINT_WARN_HRT_TRUNCATED\f[R])
|
|
.TP
|
|
\f[CR]2\f[R]
|
|
Invalid option given but overridden by Zint
|
|
(\f[CR]ZINT_WARN_INVALID_OPTION\f[R])
|
|
.TP
|
|
\f[CR]3\f[R]
|
|
Automatic ECI inserted by Zint (\f[CR]ZINT_WARN_USES_ECI\f[R])
|
|
.TP
|
|
\f[CR]4\f[R]
|
|
Symbol created not compliant with standards
|
|
(\f[CR]ZINT_WARN_NONCOMPLIANT\f[R])
|
|
.TP
|
|
\f[CR]5\f[R]
|
|
Input data wrong length (\f[CR]ZINT_ERROR_TOO_LONG\f[R])
|
|
.TP
|
|
\f[CR]6\f[R]
|
|
Input data incorrect (\f[CR]ZINT_ERROR_INVALID_DATA\f[R])
|
|
.TP
|
|
\f[CR]7\f[R]
|
|
Input check digit incorrect (\f[CR]ZINT_ERROR_INVALID_CHECK\f[R])
|
|
.TP
|
|
\f[CR]8\f[R]
|
|
Incorrect option given (\f[CR]ZINT_ERROR_INVALID_OPTION\f[R])
|
|
.TP
|
|
\f[CR]9\f[R]
|
|
Internal error (should not happen)
|
|
(\f[CR]ZINT_ERROR_ENCODING_PROBLEM\f[R])
|
|
.TP
|
|
\f[CR]10\f[R]
|
|
Error opening output file (\f[CR]ZINT_ERROR_FILE_ACCESS\f[R])
|
|
.TP
|
|
\f[CR]11\f[R]
|
|
Memory allocation (malloc) failure (\f[CR]ZINT_ERROR_MEMORY\f[R])
|
|
.TP
|
|
\f[CR]12\f[R]
|
|
Error writing to output file (\f[CR]ZINT_ERROR_FILE_WRITE\f[R])
|
|
.TP
|
|
\f[CR]13\f[R]
|
|
Error counterpart of warning if \f[CR]--werror\f[R] given
|
|
(\f[CR]ZINT_ERROR_USES_ECI\f[R])
|
|
.TP
|
|
\f[CR]14\f[R]
|
|
Error counterpart of warning if \f[CR]--werror\f[R] given
|
|
(\f[CR]ZINT_ERROR_NONCOMPLIANT\f[R])
|
|
.TP
|
|
\f[CR]15\f[R]
|
|
Error counterpart of warning if \f[CR]--werror\f[R] given
|
|
(\f[CR]ZINT_ERROR_HRT_TRUNCATED\f[R])
|
|
.SH EXAMPLES
|
|
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
|
|
.EX
|
|
zint -d \[aq]This Text\[aq]
|
|
.EE
|
|
.PP
|
|
Create \[lq]qr.svg\[rq] in the current directory, as a QR Code symbol.
|
|
.IP
|
|
.EX
|
|
zint -b QRCode -d \[aq]This Text\[aq] -o \[aq]qr.svg\[aq]
|
|
.EE
|
|
.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
|
|
.EX
|
|
zint -b EANX --batch -i \[aq]ean13nos.txt\[aq] -o \[aq]ean\[ti]\[ti]\[ti].gif\[aq]
|
|
.EE
|
|
.SH BUGS
|
|
Please send bug reports to https://sourceforge.net/p/zint/tickets/.
|
|
.SH SEE ALSO
|
|
Full documention for \f[CR]zint\f[R] (and the API \f[CR]libzint\f[R] and
|
|
the GUI \f[CR]zint-qt\f[R]) is available from
|
|
.IP
|
|
.EX
|
|
https://zint.org.uk/manual/
|
|
.EE
|
|
.PP
|
|
and at
|
|
.IP
|
|
.EX
|
|
https://sourceforge.net/p/zint/docs/manual.txt
|
|
.EE
|
|
.SH CONFORMING TO
|
|
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
|
|
Copyright © 2023 Robin Stuart.
|
|
Released under GNU GPL 3.0 or later.
|
|
.SH AUTHOR
|
|
Robin Stuart \c
|
|
.MT robin@zint.org.uk
|
|
.ME \c
|