zint.1 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739
  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. Code One 1 to 10 (9 and 10 variable width) (WxH)
  475. 1 16x18 6 70x76
  476. 2 22x22 7 104x98
  477. 3 28x28 8 148x134
  478. 4 40x42 9 Wx8
  479. 5 52x54 10 Wx16
  480. Data Matrix 1 to 48 (31 to 48 DMRE) (HxW)
  481. 1 10x10 17 72x72 33 8x80
  482. 2 12x12 18 80x80 34 8x96
  483. 3 14x14 19 88x88 35 8x120
  484. 4 16x16 20 96x96 36 8x144
  485. 5 18x18 21 104x104 37 12x64
  486. 6 20x20 22 120x120 38 12x88
  487. 7 22x22 23 132x132 39 16x64
  488. 8 24x24 24 144x144 40 20x36
  489. 9 26x26 25 8x18 41 20x44
  490. 10 32x32 26 8x32 42 20x64
  491. 11 36x36 28 12x26 43 22x48
  492. 12 40x40 28 12x36 44 24x48
  493. 13 44x44 29 16x36 45 24x64
  494. 14 48x48 30 16x48 46 26x40
  495. 15 52x52 31 8x48 47 26x48
  496. 16 64x64 32 8x64 48 26x64
  497. Grid Matrix 1 to 13
  498. 1 18x18 6 78x78 11 138x138
  499. 2 30x30 7 90x90 12 150x150
  500. 3 42x42 8 102x102 13 162x162
  501. 4 54x54 9 114x114
  502. 5 66x66 10 126x126
  503. Han Xin 1 to 84
  504. 1 23x23 29 79x79 57 135x135
  505. 2 25x25 30 81x81 58 137x137
  506. 3 27x27 31 83x83 59 139x139
  507. 4 29x29 32 85x85 60 141x141
  508. 5 31x31 33 87x87 61 143x143
  509. 6 33x33 34 89x89 62 145x145
  510. 7 35x35 35 91x91 63 147x147
  511. 8 37x37 36 93x93 64 149x149
  512. 9 39x39 37 95x95 65 151x151
  513. 10 41x41 38 97x97 66 153x153
  514. 11 43x43 39 99x99 67 155x155
  515. 12 45x45 40 101x101 68 157x157
  516. 13 47x47 41 103x103 69 159x159
  517. 14 49x49 42 105x105 70 161x161
  518. 15 51x51 43 107x107 71 163x163
  519. 16 53x53 44 109x109 72 165x165
  520. 17 55x55 45 111x111 73 167x167
  521. 18 57x57 46 113x113 74 169x169
  522. 19 59x59 47 115x115 75 171x171
  523. 20 61x61 48 117x117 76 173x173
  524. 21 63x63 49 119x119 77 175x175
  525. 22 65x65 50 121x121 78 177x177
  526. 23 67x67 51 123x123 79 179x179
  527. 24 69x69 52 125x125 80 181x181
  528. 25 71x71 53 127x127 81 183x183
  529. 26 73x73 54 129x129 82 185x185
  530. 27 75x75 55 131x131 83 187x187
  531. 28 77x77 56 133x133 84 189x189
  532. Micro QR 1 to 4 (M1, M2, M3, M4)
  533. 1 11x11 3 15x15
  534. 2 13x13 4 17x17
  535. QR Code 1 to 40
  536. 1 21x21 15 77x77 29 133x133
  537. 2 25x25 16 81x81 30 137x137
  538. 3 29x29 17 85x85 31 141x141
  539. 4 33x33 18 89x89 32 145x145
  540. 5 37x37 19 93x93 33 149x149
  541. 6 41x41 20 97x97 34 153x153
  542. 7 45x45 21 101x101 35 157x157
  543. 8 49x49 22 105x105 36 161x161
  544. 9 53x53 23 109x109 37 165x165
  545. 10 57x57 24 113x113 38 169x169
  546. 11 61x61 25 117x117 39 173x173
  547. 12 65x65 26 121x121 40 177x177
  548. 13 69x69 27 125x125
  549. 14 73x73 28 129x129
  550. rMQR 1 to 38 (33 to 38 automatic width) (HxW)
  551. 1 7x43 14 11x77 27 15x139
  552. 2 7x59 15 11x99 28 17x43
  553. 3 7x77 16 11x139 29 17x59
  554. 4 7x99 17 13x27 30 17x77
  555. 5 7x139 18 13x43 31 17x99
  556. 6 9x43 19 13x59 32 17x139
  557. 7 9x59 20 13x77 33 7xW
  558. 8 9x77 21 13x99 34 9xW
  559. 9 9x99 22 13x139 35 11xW
  560. 10 9x139 23 15x43 36 13xW
  561. 11 11x27 24 15x59 37 15xW
  562. 12 11x43 25 15x77 38 17xW
  563. 13 11x59 26 15x99
  564. .EE
  565. .PP
  566. For a number of linear symbols, it specifies check character options
  567. (\[lq]hide\[rq] or \[lq]hidden\[rq] means don\[cq]t show in HRT,
  568. \[lq]visible\[rq] means do display in HRT):
  569. .IP
  570. .EX
  571. C25IATA 1 or 2 (add visible or hidden check digit)
  572. C25IND ditto
  573. C25INTER ditto
  574. C25LOGIC ditto
  575. C25STANDARD ditto
  576. Codabar 1 or 2 (add hidden or visible check digit)
  577. Code 11 0 to 2 (2 visible check digits to none)
  578. 0 (default 2 visible check digits)
  579. 1 (1 visible check digit)
  580. 2 (no check digits)
  581. Code 39 1 or 2 (add visible or hidden check digit)
  582. Code 93 1 (hide the default check characters)
  583. EXCODE39 1 or 2 (add visible or hidden check digit)
  584. LOGMARS 1 or 2 (add visible or hidden check digit)
  585. MSI Plessey 0 to 6 (none to various visible options)
  586. 1, 2 (mod\-10, mod\-10 + mod\-10)
  587. 3, 4 (mod\-11 IBM, mod\-11 IBM + mod\-10)
  588. 5, 6 (mod\-11 NCR, mod\-11 NCR + mod\-10)
  589. +10 (hide)
  590. .EE
  591. .PP
  592. For a few other symbologies, it specifies other characteristics:
  593. .IP
  594. .EX
  595. Channel Code 3 to 8 (no. of channels)
  596. DAFT 50 to 900 (permille tracker ratio)
  597. DPD 1 (relabel)
  598. PZN 1 (PZN7 instead of default PZN8)
  599. Ultracode 2 (revision 2)
  600. VIN 1 (add international prefix)
  601. .EE
  602. .RE
  603. .TP
  604. \f[CR]\-v\f[R], \f[CR]\-\-version\f[R]
  605. Display zint version.
  606. .TP
  607. \f[CR]\-\-vwhitesp=INTEGER\f[R]
  608. Set the height of vertical whitespace above and below the barcode, where
  609. \f[I]INTEGER\f[R] is in integral multiples of the X\-dimension.
  610. .TP
  611. \f[CR]\-w\f[R], \f[CR]\-\-whitesp=INTEGER\f[R]
  612. Set the width of horizontal whitespace either side of the barcode, where
  613. \f[I]INTEGER\f[R] is in integral multiples of the X\-dimension.
  614. .TP
  615. \f[CR]\-\-werror\f[R]
  616. Convert all warnings into errors.
  617. .SH EXIT STATUS
  618. .TP
  619. \f[CR]0\f[R]
  620. Success (including when given informational options \f[CR]\-h\f[R] |
  621. \f[CR]\-\-help\f[R], \f[CR]\-e\f[R] | \f[CR]\-\-ecinos\f[R],
  622. \f[CR]\-t\f[R] | \f[CR]\-\-types\f[R], \f[CR]\-v\f[R] |
  623. \f[CR]\-\-version\f[R]).
  624. .TP
  625. \f[CR]1\f[R]
  626. Human Readable Text was truncated (maximum 199 bytes)
  627. (\f[CR]ZINT_WARN_HRT_TRUNCATED\f[R])
  628. .TP
  629. \f[CR]2\f[R]
  630. Invalid option given but overridden by Zint
  631. (\f[CR]ZINT_WARN_INVALID_OPTION\f[R])
  632. .TP
  633. \f[CR]3\f[R]
  634. Automatic ECI inserted by Zint (\f[CR]ZINT_WARN_USES_ECI\f[R])
  635. .TP
  636. \f[CR]4\f[R]
  637. Symbol created not compliant with standards
  638. (\f[CR]ZINT_WARN_NONCOMPLIANT\f[R])
  639. .TP
  640. \f[CR]5\f[R]
  641. Input data wrong length (\f[CR]ZINT_ERROR_TOO_LONG\f[R])
  642. .TP
  643. \f[CR]6\f[R]
  644. Input data incorrect (\f[CR]ZINT_ERROR_INVALID_DATA\f[R])
  645. .TP
  646. \f[CR]7\f[R]
  647. Input check digit incorrect (\f[CR]ZINT_ERROR_INVALID_CHECK\f[R])
  648. .TP
  649. \f[CR]8\f[R]
  650. Incorrect option given (\f[CR]ZINT_ERROR_INVALID_OPTION\f[R])
  651. .TP
  652. \f[CR]9\f[R]
  653. Internal error (should not happen)
  654. (\f[CR]ZINT_ERROR_ENCODING_PROBLEM\f[R])
  655. .TP
  656. \f[CR]10\f[R]
  657. Error opening output file (\f[CR]ZINT_ERROR_FILE_ACCESS\f[R])
  658. .TP
  659. \f[CR]11\f[R]
  660. Memory allocation (malloc) failure (\f[CR]ZINT_ERROR_MEMORY\f[R])
  661. .TP
  662. \f[CR]12\f[R]
  663. Error writing to output file (\f[CR]ZINT_ERROR_FILE_WRITE\f[R])
  664. .TP
  665. \f[CR]13\f[R]
  666. Error counterpart of warning if \f[CR]\-\-werror\f[R] given
  667. (\f[CR]ZINT_ERROR_USES_ECI\f[R])
  668. .TP
  669. \f[CR]14\f[R]
  670. Error counterpart of warning if \f[CR]\-\-werror\f[R] given
  671. (\f[CR]ZINT_ERROR_NONCOMPLIANT\f[R])
  672. .TP
  673. \f[CR]15\f[R]
  674. Error counterpart of warning if \f[CR]\-\-werror\f[R] given
  675. (\f[CR]ZINT_ERROR_HRT_TRUNCATED\f[R])
  676. .SH EXAMPLES
  677. Create \[lq]out.png\[rq] (or \[lq]out.gif\[rq] if zint built without PNG
  678. support) in the current directory, as a Code 128 symbol.
  679. .IP
  680. .EX
  681. zint \-d \[aq]This Text\[aq]
  682. .EE
  683. .PP
  684. Create \[lq]qr.svg\[rq] in the current directory, as a QR Code symbol.
  685. .IP
  686. .EX
  687. zint \-b QRCode \-d \[aq]This Text\[aq] \-o \[aq]qr.svg\[aq]
  688. .EE
  689. .PP
  690. Use batch mode to read from an input file \[lq]ean13nos.txt\[rq]
  691. containing a list of 13\-digit GTINs, each on a separate line, to create
  692. a series of EAN\-13 barcodes, formatting the output filenames to
  693. \[lq]ean001.gif\[rq], \[lq]ean002.gif\[rq] etc.
  694. using the special character \[lq]\[ti]\[rq].
  695. .IP
  696. .EX
  697. zint \-b EANX \-\-batch \-i \[aq]ean13nos.txt\[aq] \-o \[aq]ean\[ti]\[ti]\[ti].gif\[aq]
  698. .EE
  699. .SH BUGS
  700. Please send bug reports to https://sourceforge.net/p/zint/tickets/.
  701. .SH SEE ALSO
  702. Full documention for \f[CR]zint\f[R] (and the API \f[CR]libzint\f[R] and
  703. the GUI \f[CR]zint\-qt\f[R]) is available from
  704. .IP
  705. .EX
  706. https://zint.org.uk/manual/
  707. .EE
  708. .PP
  709. and at
  710. .IP
  711. .EX
  712. https://sourceforge.net/p/zint/docs/manual.txt
  713. .EE
  714. .SH CONFORMING TO
  715. Zint is designed to be compliant with a number of international
  716. standards, including:
  717. .PP
  718. ISO/IEC 24778:2008, ANSI/AIM BC12\-1998, EN 798:1996, AIM ISS\-X\-24
  719. (1995), ISO/IEC 15417:2007, EN 12323:2005, ISO/IEC 16388:2007, ANSI/AIM
  720. BC6\-2000, ANSI/AIM BC5\-1995, AIM USS Code One (1994), ISO/IEC
  721. 16022:2006, ISO/IEC 21471:2019, ISO/IEC 15420:2009, AIMD014 (v 1.63)
  722. (2008), ISO/IEC 24723:2010, ISO/IEC 24724:2011, ISO/IEC 20830:2021,
  723. ISO/IEC 16390:2007, ISO/IEC 16023:2000, ISO/IEC 24728:2006, ISO/IEC
  724. 15438:2015, ISO/IEC 18004:2015, ISO/IEC 23941:2022, AIM ITS/04\-023
  725. (2022)
  726. .SH COPYRIGHT
  727. Copyright © 2024 Robin Stuart.
  728. Released under GNU GPL 3.0 or later.
  729. .SH AUTHOR
  730. Robin Stuart \c
  731. .MT robin@zint.org.uk
  732. .ME \c