Mercurial > hgrepos > Python2 > PyMuPDF

comparison mupdf-source/thirdparty/zint/docs/zint.1 @ 2:b50eed0cc0ef upstream

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. The directory name has changed: no version number in the expanded directory now.
author Franz Glasner <fzglas.hg@dom66.de>
date Mon, 15 Sep 2025 11:43:07 +0200
parents
children
comparison
equal deleted inserted replaced
1:1d09e1dec1d9 2:b50eed0cc0ef
1 .\" Automatically generated by Pandoc 3.6
2 .\"
3 .TH "ZINT" "1" "December 2024" "Version 2.13.0.9"
4 .SH NAME
5 \f[CR]zint\f[R] \- encode data as a barcode image
6 .SH SYNOPSIS
7 .PP
8 \f[CR]zint\f[R] [\f[CR]\-h\f[R] | \f[CR]\-\-help\f[R]]
9 .PD 0
10 .P
11 .PD
12 \f[CR]zint\f[R] [\f[I]options\f[R]]
13 .SH DESCRIPTION
14 zint takes input data from the command line or a file to encode in a
15 barcode which is then output to an image file.
16 .PP
17 Input data is UTF\-8, unless \f[CR]\-\-binary\f[R] is specified.
18 .PP
19 Human Readable Text (HRT) is displayed by default for those barcodes
20 that support HRT, unless \f[CR]\-\-notext\f[R] is specified.
21 .PP
22 The output image file (specified with \f[CR]\-o\f[R] |
23 \f[CR]\-\-output\f[R]) may be in one of these formats: Windows Bitmap
24 (\f[CR]BMP\f[R]), Enhanced Metafile Format (\f[CR]EMF\f[R]),
25 Encapsulated PostScript (\f[CR]EPS\f[R]), Graphics Interchange Format
26 (\f[CR]GIF\f[R]), ZSoft Paintbrush (\f[CR]PCX\f[R]), Portable Network
27 Format (\f[CR]PNG\f[R]), Scalable Vector Graphic (\f[CR]SVG\f[R]), or
28 Tagged Image File Format (\f[CR]TIF\f[R]).
29 .SH OPTIONS
30 .TP
31 \f[CR]\-h\f[R], \f[CR]\-\-help\f[R]
32 Print usage information summarizing command line options.
33 .TP
34 \f[CR]\-b TYPE\f[R], \f[CR]\-\-barcode=TYPE\f[R]
35 Set the barcode symbology that will be used to encode the data.
36 \f[I]TYPE\f[R] is the number or name of the barcode symbology.
37 If not given, the symbology defaults to 20 (Code 128).
38 To see what types are available, use the \f[CR]\-t\f[R] |
39 \f[CR]\-\-types\f[R] option.
40 Type names are case\-insensitive, and non\-alphanumerics are ignored.
41 .TP
42 \f[CR]\-\-addongap=INTEGER\f[R]
43 For EAN/UPC symbologies, set the gap between the main data and the
44 add\-on.
45 \f[I]INTEGER\f[R] is in integral multiples of the X\-dimension.
46 The maximum gap that can be set is 12.
47 The minimum is 7, except for UPC\-A, when the minimum is 9.
48 .TP
49 \f[CR]\-\-batch\f[R]
50 Treat each line of an input file specified with \f[CR]\-i\f[R] |
51 \f[CR]\-\-input\f[R] as a separate data set and produce a barcode image
52 for each one.
53 The barcode images are outputted by default to numbered filenames
54 starting with \[lq]00001.png\[rq], \[lq]00002.png\[rq] etc., which can
55 be changed by using the \f[CR]\-o\f[R] | \f[CR]\-\-output\f[R] option.
56 .TP
57 \f[CR]\-\-bg=COLOUR\f[R]
58 Specify a background (paper) colour where \f[I]COLOUR\f[R] is in
59 hexadecimal \f[CR]RRGGBB\f[R] or \f[CR]RRGGBBAA\f[R] format or in
60 decimal \f[CR]C,M,Y,K\f[R] percentages format.
61 .TP
62 \f[CR]\-\-binary\f[R]
63 Treat input data as raw 8\-bit binary data instead of the default
64 UTF\-8.
65 Automatic code page translation to an ECI page is disabled, and no
66 validation of the data\[cq]s character encoding takes place.
67 .TP
68 \f[CR]\-\-bind\f[R]
69 Add horizontal boundary bars (also known as bearer bars) to the symbol.
70 The width of the boundary bars is specified by the \f[CR]\-\-border\f[R]
71 option.
72 \f[CR]\-\-bind\f[R] can also be used to add row separator bars to
73 symbols stacked with multiple \f[CR]\-d\f[R] | \f[CR]\-\-data\f[R]
74 inputs, in which case the width of the separator bars is specified with
75 the \f[CR]\-\-separator\f[R] option.
76 .TP
77 \f[CR]\-\-bindtop\f[R]
78 Add a horizontal boundary bar to the top of the symbol.
79 The width of the boundary bar is specified by the \f[CR]\-\-border\f[R]
80 option.
81 .TP
82 \f[CR]\-\-bold\f[R]
83 Use a bold font for the Human Readable Text (HRT).
84 .TP
85 \f[CR]\-\-border=INTEGER\f[R]
86 Set the width of boundary bars (\f[CR]\-\-bind\f[R] or
87 \f[CR]\-\-bindtop\f[R]) or box borders (\f[CR]\-\-box\f[R]), where
88 \f[I]INTEGER\f[R] is in integral multiples of the X\-dimension.
89 The default is zero.
90 .TP
91 \f[CR]\-\-box\f[R]
92 Add a box around the symbol.
93 The width of the borders is specified by the \f[CR]\-\-border\f[R]
94 option.
95 .TP
96 \f[CR]\-\-cmyk\f[R]
97 Use the CMYK colour space when outputting to Encapsulated PostScript
98 (EPS) or TIF files.
99 .TP
100 \f[CR]\-\-cols=INTEGER\f[R]
101 Set the number of data columns in the symbol to \f[I]INTEGER\f[R].
102 Affects Codablock\-F, DotCode, GS1 DataBar Expanded Stacked
103 (DBAR_EXPSTK), MicroPDF417 and PDF417 symbols.
104 .TP
105 \f[CR]\-\-compliantheight\f[R]
106 Warn if the height specified by the \f[CR]\-\-height\f[R] option is not
107 compliant with the barcode\[cq]s specification, or if
108 \f[CR]\-\-height\f[R] is not given, default to the height specified by
109 the specification (if any).
110 .TP
111 \f[CR]\-d\f[R], \f[CR]\-\-data=DATA\f[R]
112 Specify the input \f[I]DATA\f[R] to encode.
113 The \f[CR]\-\-esc\f[R] option may be used to enter non\-printing
114 characters using escape sequences.
115 The \f[I]DATA\f[R] should be UTF\-8, unless the \f[CR]\-\-binary\f[R]
116 option is given, in which case it can be anything.
117 .TP
118 \f[CR]\-\-direct\f[R]
119 Send output to stdout, which in most cases should be re\-directed to a
120 pipe or a file.
121 Use \f[CR]\-\-filetype\f[R] to specify output format.
122 .TP
123 \f[CR]\-\-dmiso144\f[R]
124 For Data Matrix symbols, use the standard ISO/IEC codeword placement for
125 144 x 144 (\f[CR]\-\-vers=24\f[R]) sized symbols, instead of the default
126 \[lq]de facto\[rq] placement (which rotates the placement of ECC
127 codewords).
128 .TP
129 \f[CR]\-\-dmre\f[R]
130 For Data Matrix symbols, allow Data Matrix Rectangular Extended (DMRE)
131 sizes when considering automatic sizes.
132 See also \f[CR]\-\-square\f[R].
133 .TP
134 \f[CR]\-\-dotsize=NUMBER\f[R]
135 Set the radius of the dots in dotty mode (\f[CR]\-\-dotty\f[R]).
136 \f[I]NUMBER\f[R] is in X\-dimensions, and may be floating\-point.
137 The default is 0.8.
138 .TP
139 \f[CR]\-\-dotty\f[R]
140 Use dots instead of squares for matrix symbols.
141 DotCode is always in dotty mode.
142 .TP
143 \f[CR]\-\-dump\f[R]
144 Dump a hexadecimal representation of the symbol\[cq]s encodation to
145 stdout.
146 The same representation may be outputted to a file by using a
147 \f[CR].txt\f[R] extension with \f[CR]\-o\f[R] | \f[CR]\-\-output\f[R] or
148 by specifying \f[CR]\-\-filetype=txt\f[R].
149 .TP
150 \f[CR]\-e\f[R], \f[CR]\-\-ecinos\f[R]
151 Display the table of ECIs (Extended Channel Interpretations).
152 .TP
153 \f[CR]\-\-eci=INTEGER\f[R]
154 Set the ECI code for the input data to \f[I]INTEGER\f[R].
155 See \f[CR]\-e\f[R] | \f[CR]\-\-ecinos\f[R] for a list of the ECIs
156 available.
157 ECIs are supported by Aztec Code, Code One, Data Matrix, DotCode, Grid
158 Matrix, Han Xin Code, MaxiCode, MicroPDF417, PDF417, QR Code, rMQR and
159 Ultracode.
160 .TP
161 \f[CR]\-\-embedfont\f[R]
162 For vector output, embed the font in the file for portability.
163 Currently only available for SVG output.
164 .TP
165 \f[CR]\-\-esc\f[R]
166 Process escape characters in the input data.
167 The escape sequences are:
168 .RS
169 .IP
170 .EX
171 \[rs]0 (0x00) NUL Null character
172 \[rs]E (0x04) EOT End of Transmission
173 \[rs]a (0x07) BEL Bell
174 \[rs]b (0x08) BS Backspace
175 \[rs]t (0x09) HT Horizontal Tab
176 \[rs]n (0x0A) LF Line Feed
177 \[rs]v (0x0B) VT Vertical Tab
178 \[rs]f (0x0C) FF Form Feed
179 \[rs]r (0x0D) CR Carriage Return
180 \[rs]e (0x1B) ESC Escape
181 \[rs]G (0x1D) GS Group Separator
182 \[rs]R (0x1E) RS Record Separator
183 \[rs]\[rs] (0x5C) \[rs] Backslash
184 \[rs]dNNN (NNN) Any 8\-bit character where NNN is
185 decimal (000\-255)
186 \[rs]oNNN (0oNNN) Any 8\-bit character where NNN is
187 octal (000\-377)
188 \[rs]xNN (0xNN) Any 8\-bit character where NN is
189 hexadecimal (00\-FF)
190 \[rs]uNNNN (U+NNNN) Any 16\-bit Unicode BMP character
191 where NNNN is hexadecimal
192 \[rs]UNNNNNN (U+NNNNNN) Any 21\-bit Unicode character
193 where NNNNNN is hexadecimal
194 .EE
195 .RE
196 .TP
197 \f[CR]\-\-extraesc\f[R]
198 For Code 128 only, as well as processing the normal escape sequences
199 above, process the special escape sequences \f[CR]\[rs]\[ha]A\f[R],
200 \f[CR]\[rs]\[ha]B\f[R], \f[CR]\[rs]\[ha]C\f[R] and
201 \f[CR]\[rs]\[ha]\[at]\f[R] that allow manual switching of Code Sets, and
202 the special escape sequence \f[CR]\[rs]\[ha]1\f[R] that inserts an
203 \f[CR]FNC1\f[R] character.
204 The sequence \f[CR]\[rs]\[at]\f[R] turns off manual switching.
205 The sequence \f[CR]\[rs]\[ha]\[ha]\f[R] can be used to encode data that
206 contains special escape sequences.
207 .TP
208 \f[CR]\-\-fast\f[R]
209 Use faster if less optimal encodation or other shortcuts (affects Data
210 Matrix, MicroPDF417, PDF417, QRCODE & UPNQR only).
211 .TP
212 \f[CR]\-\-fg=COLOUR\f[R]
213 Specify a foreground (ink) colour where \f[I]COLOUR\f[R] is in
214 hexadecimal \f[CR]RRGGBB\f[R] or \f[CR]RRGGBBAA\f[R] format or in
215 decimal \f[CR]C,M,Y,K\f[R] percentages format.
216 .TP
217 \f[CR]\-\-filetype=TYPE\f[R]
218 Set the output file type to \f[I]TYPE\f[R], which is one of
219 \f[CR]BMP\f[R], \f[CR]EMF\f[R], \f[CR]EPS\f[R], \f[CR]GIF\f[R],
220 \f[CR]PCX\f[R], \f[CR]PNG\f[R], \f[CR]SVG\f[R], \f[CR]TIF\f[R],
221 \f[CR]TXT\f[R].
222 .TP
223 \f[CR]\-\-fullmultibyte\f[R]
224 Use the multibyte modes of Grid Matrix, Han Xin and QR Code for
225 non\-ASCII data.
226 .TP
227 \f[CR]\-\-gs1\f[R]
228 Treat input as GS1 compatible data.
229 Application Identifiers (AIs) should be placed in square brackets
230 \f[CR]\[dq][]\[dq]\f[R] (but see \f[CR]\-\-gs1parens\f[R]).
231 .TP
232 \f[CR]\-\-gs1nocheck\f[R]
233 Do not check the validity of GS1 data.
234 .TP
235 \f[CR]\-\-gs1parens\f[R]
236 Process parentheses \f[CR]\[dq]()\[dq]\f[R] as GS1 AI delimiters, rather
237 than square brackets \f[CR]\[dq][]\[dq]\f[R].
238 The input data must not otherwise contain parentheses.
239 .TP
240 \f[CR]\-\-gssep\f[R]
241 For Data Matrix in GS1 mode, use \f[CR]GS\f[R] (0x1D) as the GS1 data
242 separator instead of \f[CR]FNC1\f[R].
243 .TP
244 \f[CR]\-\-guarddescent=NUMBER\f[R]
245 For EAN/UPC symbols, set the height the guard bars descend below the
246 main bars, where \f[I]NUMBER\f[R] is in X\-dimensions.
247 \f[I]NUMBER\f[R] may be floating\-point.
248 .TP
249 \f[CR]\-\-guardwhitespace\f[R]
250 For EAN/UPC symbols, add quiet zone indicators \f[CR]\[dq]<\[dq]\f[R]
251 and/or \f[CR]\[dq]>\[dq]\f[R] to HRT where applicable.
252 .TP
253 \f[CR]\-\-height=NUMBER\f[R]
254 Set the height of the symbol in X\-dimensions.
255 \f[I]NUMBER\f[R] may be floating\-point.
256 .TP
257 \f[CR]\-\-heightperrow\f[R]
258 Treat height as per\-row.
259 Affects Codablock\-F, Code 16K, Code 49, GS1 DataBar Expanded Stacked
260 (DBAR_EXPSTK), MicroPDF417 and PDF417.
261 .TP
262 \f[CR]\-i\f[R], \f[CR]\-\-input=FILE\f[R]
263 Read the input data from \f[I]FILE\f[R].
264 Specify a single hyphen (\f[CR]\-\f[R]) for \f[I]FILE\f[R] to read from
265 stdin.
266 .TP
267 \f[CR]\-\-init\f[R]
268 Create a Reader Initialisation (Programming) symbol.
269 .TP
270 \f[CR]\-\-mask=INTEGER\f[R]
271 Set the masking pattern to use for DotCode, Han Xin or QR Code to
272 \f[I]INTEGER\f[R], overriding the automatic selection.
273 .TP
274 \f[CR]\-\-mirror\f[R]
275 Use the batch data to determine the filename in batch mode
276 (\f[CR]\-\-batch\f[R]).
277 The \f[CR]\-o\f[R] | \f[CR]\-\-output\f[R] option can be used to specify
278 an output directory (any filename will be ignored).
279 .TP
280 \f[CR]\-\-mode=INTEGER\f[R]
281 For MaxiCode and GS1 Composite symbols, set the encoding mode to
282 \f[I]INTEGER\f[R].
283 .RS
284 .PP
285 For MaxiCode (SCM is Structured Carrier Message, with 3 fields:
286 postcode, 3\-digit ISO 3166\-1 country code, 3\-digit service code):
287 .IP
288 .EX
289 2 SCM with 9\-digit numeric postcode
290 3 SCM with 6\-character alphanumeric postcode
291 4 Enhanced ECC for the primary part of the message
292 5 Enhanced ECC for all of the message
293 6 Reader Initialisation (Programming)
294 .EE
295 .PP
296 For GS1 Composite symbols (names end in \f[CR]_CC\f[R], i.e.\ EANX_CC,
297 GS1_128_CC, DBAR_OMN_CC etc.):
298 .IP
299 .EX
300 1 CC\-A
301 2 CC\-B
302 3 CC\-C (GS1_128_CC only)
303 .EE
304 .RE
305 .TP
306 \f[CR]\-\-nobackground\f[R]
307 Remove the background colour (EMF, EPS, GIF, PNG, SVG and TIF only).
308 .TP
309 \f[CR]\-\-noquietzones\f[R]
310 Disable any quiet zones for symbols that define them by default.
311 .TP
312 \f[CR]\-\-notext\f[R]
313 Remove the Human Readable Text (HRT).
314 .TP
315 \f[CR]\-o\f[R], \f[CR]\-\-output=FILE\f[R]
316 Send the output to \f[I]FILE\f[R].
317 When not in batch mode, the default is \[lq]out.png\[rq] (or
318 \[lq]out.gif\[rq] if zint built without PNG support).
319 When in batch mode (\f[CR]\-\-batch\f[R]), special characters can be
320 used to format the output filenames:
321 .RS
322 .IP
323 .EX
324 \[ti] Insert a number or 0
325 # Insert a number or space
326 \[at] Insert a number or * (+ on Windows)
327 Any other Insert literally
328 .EE
329 .RE
330 .TP
331 \f[CR]\-\-primary=STRING\f[R]
332 For MaxiCode, set the content of the primary message.
333 For GS1 Composite symbols, set the content of the linear symbol.
334 .TP
335 \f[CR]\-\-quietzones\f[R]
336 Add compliant quiet zones for symbols that specify them.
337 This is in addition to any whitespace specified by \f[CR]\-w\f[R] |
338 \f[CR]\-\-whitesp\f[R] or \f[CR]\-\-vwhitesp\f[R].
339 .TP
340 \f[CR]\-r\f[R], \f[CR]\-\-reverse\f[R]
341 Reverse the foreground and background colours (white on black).
342 Known as \[lq]reflectance reversal\[rq] or \[lq]reversed
343 reflectance\[rq].
344 .TP
345 \f[CR]\-\-rotate=INTEGER\f[R]
346 Rotate the symbol by \f[I]INTEGER\f[R] degrees, where \f[I]INTEGER\f[R]
347 can be 0, 90, 270 or 360.
348 .TP
349 \f[CR]\-\-rows=INTEGER\f[R]
350 Set the number of rows for Codablock\-F or PDF417 to \f[I]INTEGER\f[R].
351 It will also set the minimum number of rows for Code 16K or Code 49, and
352 the maximum number of rows for GS1 DataBar Expanded Stacked
353 (DBAR_EXPSTK).
354 .TP
355 \f[CR]\-\-scale=NUMBER\f[R]
356 Adjust the size of the X\-dimension.
357 \f[I]NUMBER\f[R] may be floating\-point, and is multiplied by 2 (except
358 for MaxiCode) before being applied.
359 The default scale is 1.
360 .RS
361 .PP
362 For MaxiCode, the scale is multiplied by 10 for raster output, by 40 for
363 EMF output, and by 2 otherwise.
364 .PP
365 Increments of 0.5 (half\-integers) are recommended for non\-MaxiCode
366 raster output (BMP, GIF, PCX, PNG and TIF).
367 .PP
368 See also \f[CR]\-\-scalexdimdp\f[R] below.
369 .RE
370 .TP
371 \f[CR]\-\-scalexdimdp=X[,R]\f[R]
372 Scale the image according to X\-dimension \f[I]X\f[R] and resolution
373 \f[I]R\f[R], where \f[I]X\f[R] is in mm and \f[I]R\f[R] is in dpmm (dots
374 per mm).
375 \f[I]X\f[R] and \f[I]R\f[R] may be floating\-point.
376 \f[I]R\f[R] is optional and defaults to 12 dpmm (approximately 300 dpi).
377 \f[I]X\f[R] may be zero in which case a symbology\-specific default is
378 used.
379 .RS
380 .PP
381 The scaling takes into account the output filetype, and deals with all
382 the details mentioned above.
383 Units may be specified for \f[I]X\f[R] by appending \[lq]in\[rq] (inch)
384 or \[lq]mm\[rq], and for \f[I]R\f[R] by appending \[lq]dpi\[rq] (dots
385 per inch) or \[lq]dpmm\[rq] \-
386 e.g.\ \f[CR]\-\-scalexdimdp=0.013in,300dpi\f[R].
387 .RE
388 .TP
389 \f[CR]\-\-scmvv=INTEGER\f[R]
390 For MaxiCode, prefix the Structured Carrier Message (SCM) with
391 \f[CR]\[dq][)>\[rs]R01\[rs]Gvv\[dq]\f[R], where \f[CR]vv\f[R] is a
392 2\-digit \f[I]INTEGER\f[R].
393 .TP
394 \f[CR]\-\-secure=INTEGER\f[R]
395 Set the error correction level (ECC) to \f[I]INTEGER\f[R].
396 The meaning is specific to the following matrix symbols (all except
397 PDF417 are approximate):
398 .RS
399 .IP
400 .EX
401 Aztec Code 1 to 4 (10%, 23%, 36%, 50%)
402 Grid Matrix 1 to 5 (10% to 50%)
403 Han Xin 1 to 4 (8%, 15%, 23%, 30%)
404 Micro QR 1 to 3 (7%, 15%, 25%) (L, M, Q)
405 PDF417 0 to 8 (2\[ha](INTEGER + 1) codewords)
406 QR Code 1 to 4 (7%, 15%, 25%, 30%) (L, M, Q, H)
407 rMQR 2 or 4 (15% or 30%) (M or H)
408 Ultracode 1 to 6 (0%, 5%, 9%, 17%, 25%, 33%)
409 .EE
410 .RE
411 .TP
412 \f[CR]\-\-segN=ECI,DATA\f[R]
413 Set the \f[I]ECI\f[R] & \f[I]DATA\f[R] content for segment N, where N is
414 1 to 9.
415 \f[CR]\-d\f[R] | \f[CR]\-\-data\f[R] must still be given, and counts as
416 segment 0, its ECI given by \f[CR]\-\-eci\f[R].
417 Segments must be consecutive.
418 .TP
419 \f[CR]\-\-separator=INTEGER\f[R]
420 Set the height of row separator bars for stacked symbologies, where
421 \f[I]INTEGER\f[R] is in integral multiples of the X\-dimension.
422 The default is zero.
423 .TP
424 \f[CR]\-\-small\f[R]
425 Use a smaller font for Human Readable Text (HRT).
426 .TP
427 \f[CR]\-\-square\f[R]
428 For Data Matrix symbols, exclude rectangular sizes when considering
429 automatic sizes.
430 See also \f[CR]\-\-dmre\f[R].
431 .TP
432 \f[CR]\-\-structapp=I,C[,ID]\f[R]
433 Set Structured Append info, where \f[I]I\f[R] is the 1\-based index,
434 \f[I]C\f[R] is the total number of symbols in the sequence, and
435 \f[I]ID\f[R], which is optional, is the identifier that all symbols in
436 the sequence share.
437 Structured Append is supported by Aztec Code, Code One, Data Matrix,
438 DotCode, Grid Matrix, MaxiCode, MicroPDF417, PDF417, QR Code and
439 Ultracode.
440 .TP
441 \f[CR]\-t\f[R], \f[CR]\-\-types\f[R]
442 Display the table of barcode types (symbologies).
443 The numbers or names can be used with \f[CR]\-b\f[R] |
444 \f[CR]\-\-barcode\f[R].
445 .TP
446 \f[CR]\-\-textgap=NUMBER\f[R]
447 Adjust the gap between the barcode and the Human Readable Text (HRT).
448 \f[I]NUMBER\f[R] is in X\-dimensions, and may be floating\-point.
449 Maximum is 10 and minimum is \-5.
450 The default is 1.
451 .TP
452 \f[CR]\-\-vers=INTEGER\f[R]
453 Set the symbol version (size, check digits, other options) to
454 \f[I]INTEGER\f[R].
455 The meaning is symbol\-specific.
456 .RS
457 .PP
458 For most matrix symbols, it specifies size:
459 .IP
460 .EX
461 Aztec Code 1 to 36 (1 to 4 compact)
462 1 15x15 13 53x53 25 105x105
463 2 19x19 14 57x57 26 109x109
464 3 23x23 15 61x61 27 113x113
465 4 27x27 16 67x67 28 117x117
466 5 19x19 17 71x71 29 121x121
467 6 23x23 18 75x75 30 125x125
468 7 27x27 19 79x79 31 131x131
469 8 31x31 20 83x83 32 135x135
470 9 37x37 21 87x87 33 139x139
471 10 41x41 22 91x91 34 143x143
472 11 45x45 23 95x95 35 147x147
473 12 49x49 24 101x101 36 151x151
474
475 Code One 1 to 10 (9 and 10 variable width) (WxH)
476 1 16x18 6 70x76
477 2 22x22 7 104x98
478 3 28x28 8 148x134
479 4 40x42 9 Wx8
480 5 52x54 10 Wx16
481
482 Data Matrix 1 to 48 (31 to 48 DMRE) (HxW)
483 1 10x10 17 72x72 33 8x80
484 2 12x12 18 80x80 34 8x96
485 3 14x14 19 88x88 35 8x120
486 4 16x16 20 96x96 36 8x144
487 5 18x18 21 104x104 37 12x64
488 6 20x20 22 120x120 38 12x88
489 7 22x22 23 132x132 39 16x64
490 8 24x24 24 144x144 40 20x36
491 9 26x26 25 8x18 41 20x44
492 10 32x32 26 8x32 42 20x64
493 11 36x36 28 12x26 43 22x48
494 12 40x40 28 12x36 44 24x48
495 13 44x44 29 16x36 45 24x64
496 14 48x48 30 16x48 46 26x40
497 15 52x52 31 8x48 47 26x48
498 16 64x64 32 8x64 48 26x64
499
500 Grid Matrix 1 to 13
501 1 18x18 6 78x78 11 138x138
502 2 30x30 7 90x90 12 150x150
503 3 42x42 8 102x102 13 162x162
504 4 54x54 9 114x114
505 5 66x66 10 126x126
506
507 Han Xin 1 to 84
508 1 23x23 29 79x79 57 135x135
509 2 25x25 30 81x81 58 137x137
510 3 27x27 31 83x83 59 139x139
511 4 29x29 32 85x85 60 141x141
512 5 31x31 33 87x87 61 143x143
513 6 33x33 34 89x89 62 145x145
514 7 35x35 35 91x91 63 147x147
515 8 37x37 36 93x93 64 149x149
516 9 39x39 37 95x95 65 151x151
517 10 41x41 38 97x97 66 153x153
518 11 43x43 39 99x99 67 155x155
519 12 45x45 40 101x101 68 157x157
520 13 47x47 41 103x103 69 159x159
521 14 49x49 42 105x105 70 161x161
522 15 51x51 43 107x107 71 163x163
523 16 53x53 44 109x109 72 165x165
524 17 55x55 45 111x111 73 167x167
525 18 57x57 46 113x113 74 169x169
526 19 59x59 47 115x115 75 171x171
527 20 61x61 48 117x117 76 173x173
528 21 63x63 49 119x119 77 175x175
529 22 65x65 50 121x121 78 177x177
530 23 67x67 51 123x123 79 179x179
531 24 69x69 52 125x125 80 181x181
532 25 71x71 53 127x127 81 183x183
533 26 73x73 54 129x129 82 185x185
534 27 75x75 55 131x131 83 187x187
535 28 77x77 56 133x133 84 189x189
536
537 Micro QR 1 to 4 (M1, M2, M3, M4)
538 1 11x11 3 15x15
539 2 13x13 4 17x17
540
541 QR Code 1 to 40
542 1 21x21 15 77x77 29 133x133
543 2 25x25 16 81x81 30 137x137
544 3 29x29 17 85x85 31 141x141
545 4 33x33 18 89x89 32 145x145
546 5 37x37 19 93x93 33 149x149
547 6 41x41 20 97x97 34 153x153
548 7 45x45 21 101x101 35 157x157
549 8 49x49 22 105x105 36 161x161
550 9 53x53 23 109x109 37 165x165
551 10 57x57 24 113x113 38 169x169
552 11 61x61 25 117x117 39 173x173
553 12 65x65 26 121x121 40 177x177
554 13 69x69 27 125x125
555 14 73x73 28 129x129
556
557 rMQR 1 to 38 (33 to 38 automatic width) (HxW)
558 1 7x43 14 11x77 27 15x139
559 2 7x59 15 11x99 28 17x43
560 3 7x77 16 11x139 29 17x59
561 4 7x99 17 13x27 30 17x77
562 5 7x139 18 13x43 31 17x99
563 6 9x43 19 13x59 32 17x139
564 7 9x59 20 13x77 33 7xW
565 8 9x77 21 13x99 34 9xW
566 9 9x99 22 13x139 35 11xW
567 10 9x139 23 15x43 36 13xW
568 11 11x27 24 15x59 37 15xW
569 12 11x43 25 15x77 38 17xW
570 13 11x59 26 15x99
571 .EE
572 .PP
573 For a number of linear symbols, it specifies check character options
574 (\[lq]hide\[rq] or \[lq]hidden\[rq] means don\[cq]t show in HRT,
575 \[lq]visible\[rq] means do display in HRT):
576 .IP
577 .EX
578 C25IATA 1 or 2 (add visible or hidden check digit)
579 C25IND ditto
580 C25INTER ditto
581 C25LOGIC ditto
582 C25STANDARD ditto
583 Codabar 1 or 2 (add hidden or visible check digit)
584 Code 11 0 to 2 (2 visible check digits to none)
585 0 (default 2 visible check digits)
586 1 (1 visible check digit)
587 2 (no check digits)
588 Code 39 1 or 2 (add visible or hidden check digit)
589 Code 93 1 (hide the default check characters)
590 EXCODE39 1 or 2 (add visible or hidden check digit)
591 LOGMARS 1 or 2 (add visible or hidden check digit)
592 MSI Plessey 0 to 6 (none to various visible options)
593 1, 2 (mod\-10, mod\-10 + mod\-10)
594 3, 4 (mod\-11 IBM, mod\-11 IBM + mod\-10)
595 5, 6 (mod\-11 NCR, mod\-11 NCR + mod\-10)
596 +10 (hide)
597 .EE
598 .PP
599 For a few other symbologies, it specifies other characteristics:
600 .IP
601 .EX
602 Channel Code 3 to 8 (no. of channels)
603 DAFT 50 to 900 (permille tracker ratio)
604 DPD 1 (relabel)
605 PZN 1 (PZN7 instead of default PZN8)
606 Ultracode 2 (revision 2)
607 VIN 1 (add international prefix)
608 .EE
609 .RE
610 .TP
611 \f[CR]\-v\f[R], \f[CR]\-\-version\f[R]
612 Display zint version.
613 .TP
614 \f[CR]\-\-vwhitesp=INTEGER\f[R]
615 Set the height of vertical whitespace above and below the barcode, where
616 \f[I]INTEGER\f[R] is in integral multiples of the X\-dimension.
617 .TP
618 \f[CR]\-w\f[R], \f[CR]\-\-whitesp=INTEGER\f[R]
619 Set the width of horizontal whitespace either side of the barcode, where
620 \f[I]INTEGER\f[R] is in integral multiples of the X\-dimension.
621 .TP
622 \f[CR]\-\-werror\f[R]
623 Convert all warnings into errors.
624 .SH EXIT STATUS
625 .TP
626 \f[CR]0\f[R]
627 Success (including when given informational options \f[CR]\-h\f[R] |
628 \f[CR]\-\-help\f[R], \f[CR]\-e\f[R] | \f[CR]\-\-ecinos\f[R],
629 \f[CR]\-t\f[R] | \f[CR]\-\-types\f[R], \f[CR]\-v\f[R] |
630 \f[CR]\-\-version\f[R]).
631 .TP
632 \f[CR]1\f[R]
633 Human Readable Text was truncated (maximum 199 bytes)
634 (\f[CR]ZINT_WARN_HRT_TRUNCATED\f[R])
635 .TP
636 \f[CR]2\f[R]
637 Invalid option given but overridden by Zint
638 (\f[CR]ZINT_WARN_INVALID_OPTION\f[R])
639 .TP
640 \f[CR]3\f[R]
641 Automatic ECI inserted by Zint (\f[CR]ZINT_WARN_USES_ECI\f[R])
642 .TP
643 \f[CR]4\f[R]
644 Symbol created not compliant with standards
645 (\f[CR]ZINT_WARN_NONCOMPLIANT\f[R])
646 .TP
647 \f[CR]5\f[R]
648 Input data wrong length (\f[CR]ZINT_ERROR_TOO_LONG\f[R])
649 .TP
650 \f[CR]6\f[R]
651 Input data incorrect (\f[CR]ZINT_ERROR_INVALID_DATA\f[R])
652 .TP
653 \f[CR]7\f[R]
654 Input check digit incorrect (\f[CR]ZINT_ERROR_INVALID_CHECK\f[R])
655 .TP
656 \f[CR]8\f[R]
657 Incorrect option given (\f[CR]ZINT_ERROR_INVALID_OPTION\f[R])
658 .TP
659 \f[CR]9\f[R]
660 Internal error (should not happen)
661 (\f[CR]ZINT_ERROR_ENCODING_PROBLEM\f[R])
662 .TP
663 \f[CR]10\f[R]
664 Error opening output file (\f[CR]ZINT_ERROR_FILE_ACCESS\f[R])
665 .TP
666 \f[CR]11\f[R]
667 Memory allocation (malloc) failure (\f[CR]ZINT_ERROR_MEMORY\f[R])
668 .TP
669 \f[CR]12\f[R]
670 Error writing to output file (\f[CR]ZINT_ERROR_FILE_WRITE\f[R])
671 .TP
672 \f[CR]13\f[R]
673 Error counterpart of warning if \f[CR]\-\-werror\f[R] given
674 (\f[CR]ZINT_ERROR_USES_ECI\f[R])
675 .TP
676 \f[CR]14\f[R]
677 Error counterpart of warning if \f[CR]\-\-werror\f[R] given
678 (\f[CR]ZINT_ERROR_NONCOMPLIANT\f[R])
679 .TP
680 \f[CR]15\f[R]
681 Error counterpart of warning if \f[CR]\-\-werror\f[R] given
682 (\f[CR]ZINT_ERROR_HRT_TRUNCATED\f[R])
683 .SH EXAMPLES
684 Create \[lq]out.png\[rq] (or \[lq]out.gif\[rq] if zint built without PNG
685 support) in the current directory, as a Code 128 symbol.
686 .IP
687 .EX
688 zint \-d \[aq]This Text\[aq]
689 .EE
690 .PP
691 Create \[lq]qr.svg\[rq] in the current directory, as a QR Code symbol.
692 .IP
693 .EX
694 zint \-b QRCode \-d \[aq]This Text\[aq] \-o \[aq]qr.svg\[aq]
695 .EE
696 .PP
697 Use batch mode to read from an input file \[lq]ean13nos.txt\[rq]
698 containing a list of 13\-digit GTINs, each on a separate line, to create
699 a series of EAN\-13 barcodes, formatting the output filenames to
700 \[lq]ean001.gif\[rq], \[lq]ean002.gif\[rq] etc.
701 using the special character \[lq]\[ti]\[rq].
702 .IP
703 .EX
704 zint \-b EANX \-\-batch \-i \[aq]ean13nos.txt\[aq] \-o \[aq]ean\[ti]\[ti]\[ti].gif\[aq]
705 .EE
706 .SH BUGS
707 Please send bug reports to https://sourceforge.net/p/zint/tickets/.
708 .SH SEE ALSO
709 Full documention for \f[CR]zint\f[R] (and the API \f[CR]libzint\f[R] and
710 the GUI \f[CR]zint\-qt\f[R]) is available from
711 .IP
712 .EX
713 https://zint.org.uk/manual/
714 .EE
715 .PP
716 and at
717 .IP
718 .EX
719 https://sourceforge.net/p/zint/docs/manual.txt
720 .EE
721 .SH CONFORMING TO
722 Zint is designed to be compliant with a number of international
723 standards, including:
724 .PP
725 ISO/IEC 24778:2008, ANSI/AIM BC12\-1998, EN 798:1996, AIM ISS\-X\-24
726 (1995), ISO/IEC 15417:2007, EN 12323:2005, ISO/IEC 16388:2007, ANSI/AIM
727 BC6\-2000, ANSI/AIM BC5\-1995, AIM USS Code One (1994), ISO/IEC
728 16022:2006, ISO/IEC 21471:2019, ISO/IEC 15420:2009, AIMD014 (v 1.63)
729 (2008), ISO/IEC 24723:2010, ISO/IEC 24724:2011, ISO/IEC 20830:2021,
730 ISO/IEC 16390:2007, ISO/IEC 16023:2000, ISO/IEC 24728:2006, ISO/IEC
731 15438:2015, ISO/IEC 18004:2015, ISO/IEC 23941:2022, AIM ITS/04\-023
732 (2022)
733 .SH COPYRIGHT
734 Copyright © 2024 Robin Stuart.
735 Released under GNU GPL 3.0 or later.
736 .SH AUTHOR
737 Robin Stuart \c
738 .MT robin@zint.org.uk
739 .ME \c