diff --git a/docs/Makefile b/docs/Makefile index cc8d3623..ff691615 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -156,4 +156,3 @@ $(OUT_MAN) : $(SOURCE_MAN) Makefile pandoc $(SOURCE_MAN) -f markdown \ $(MAN_OPTS) \ -o $(OUT_MAN) - gzip -c -9 $(OUT_MAN) > $(OUT_MAN).gz diff --git a/docs/manual.pdf b/docs/manual.pdf deleted file mode 100644 index 5215446a..00000000 Binary files a/docs/manual.pdf and /dev/null differ diff --git a/docs/zint.1 b/docs/zint.1 new file mode 100644 index 00000000..f412ae53 --- /dev/null +++ b/docs/zint.1 @@ -0,0 +1,404 @@ +.\" Automatically generated by Pandoc 2.18 +.\" +.\" 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" "May 2022" "Version 2.10.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 +The output image file (specified with \f[V]-o\f[R] or +\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] or +\f[V]--types\f[R] option. +Type names are case-insensitive, and non-alphanumerics are ignored. +.TP +\f[V]--addongap=INTEGER\f[R] +For UPC/EAN 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] or +\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] or \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 hex +RRGGBB or RRGGGAA 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 encodation takes place. +.TP +\f[V]--bind\f[R] +Add horizontal boundary bars, aka bearer bars, to the symbol. +The width of the boundary bars must be 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] or \f[V]--data\f[R] inputs, in which +case the width of the separator bars must be specified with the +\f[V]--separator\f[R] option. +.TP +\f[V]--bold\f[R] +Use bold text for the Human Readable Text. +.TP +\f[V]--border=INTEGER\f[R] +Set the width of boundary bars (\f[V]--bind\f[R]) or box borders +(\f[V]--box\f[R]), where \f[I]INTEGER\f[R] is in integral multiples of +the X-dimension. +.TP +\f[V]--box\f[R] +Add a box around the symbol. +The width of the borders must be 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, PDF417, MicroPDF417, GS1 DataBar Expanded Stacked +(DBar_ExpStk) and DotCode 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. +.TP +\f[V]--direct\f[R] +Send output to stdout, which in most cases should be re-directed via a +pipe. +.TP +\f[V]--dmre\f[R] +For Data Matrix symbols, allow Data Matrix Rectangular Extended (RMRE) +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. +.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. +.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] or \f[V]--ecinos\f[R] for a list of the ECIs available. +.TP +\f[V]--esc\f[R] +Process escape characters in the input data. +The escape sequences are: +.RS +.IP \[bu] 2 +\f[V]\[rs]0\f[R] (0x00) \f[V]NUL\f[R] Null character +.IP \[bu] 2 +\f[V]\[rs]E\f[R] (0x04) \f[V]EOT\f[R] End of Transmission +.IP \[bu] 2 +\f[V]\[rs]a\f[R] (0x07) \f[V]BEL\f[R] Bell +.IP \[bu] 2 +\f[V]\[rs]b\f[R] (0x08) \f[V]BS\f[R] Backspace +.IP \[bu] 2 +\f[V]\[rs]t\f[R] (0x09) \f[V]HT\f[R] Horizontal Tab +.IP \[bu] 2 +\f[V]\[rs]n\f[R] (0x0A) \f[V]LF\f[R] Line Feed +.IP \[bu] 2 +\f[V]\[rs]v\f[R] (0x0B) \f[V]VT\f[R] Vertical Tab +.IP \[bu] 2 +\f[V]\[rs]f\f[R] (0x0C) \f[V]FF\f[R] Form Feed +.IP \[bu] 2 +\f[V]\[rs]r\f[R] (0x0D) \f[V]CR\f[R] Carriage Return +.IP \[bu] 2 +\f[V]\[rs]e\f[R] (0x1B) \f[V]ESC\f[R] Escape +.IP \[bu] 2 +\f[V]\[rs]G\f[R] (0x1D) \f[V]GS\f[R] Group Separator +.IP \[bu] 2 +\f[V]\[rs]R\f[R] (0x1E) \f[V]RS\f[R] Record Separator +.IP \[bu] 2 +\f[V]\[rs]\[rs]\f[R] (0x5C) \f[V]\[rs]\f[R] Backslash +.IP \[bu] 2 +\f[V]\[rs]xNN\f[R] (0xNN) Any 8-bit character where NN is hexadecimal +.IP \[bu] 2 +\f[V]\[rs]uNNNN\f[R] (U+NNNN) Any 16-bit Unicode BMP character where +NNNN is hexadecimal +.RE +.TP +\f[V]--fast\f[R] +Use faster if less optimal encodation (currently affects Data Matrix +only). +.TP +\f[V]--fg=COLOUR\f[R] +Specify a foreground (ink) colour where \f[I]COLOUR\f[R] is in hex +RRGGBB or RRGGGAA 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 QR Code, Han Xin, and Grid Matrix 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 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=INTEGER\f[R] +For UPC/EAN symbols, set the height of the guard bars\[cq] descent, +where \f[I]INTEGER\f[R] is in integral multiples of the X-dimension. +.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. +Increments of 0.5 are recommended for raster output (BMP, GIF, PCX, PNG +and TIF). +.TP +\f[V]--heightperrow\f[R] +Treat height as per-row. +Affects Codablock-F, Code16K, 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]. +.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 QR Code, Han Xin or DotCode 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]). +.TP +\f[V]--mode=INTEGER\f[R] +For MaxiCode and composite symbols, set the encoding mode to +\f[I]INTEGER\f[R]. +The meaning is symbol-specific. +.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. +.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 \[bu] 2 +\f[V]\[ti]\f[R] Insert a number or 0 +.IP \[bu] 2 +\f[V]#\f[R] Insert a number or space +.IP \[bu] 2 +\f[V]\[at]\f[R] Insert a number or \f[V]*\f[R] +.IP \[bu] 2 +Any other Insert literally +.RE +.TP +\f[V]--primary=STRING\f[R] +For MaxiCode, set the content of the primary message. +For Composite symbols, set the content of the linear symbol. +.TP +\f[V]--quietzones\f[R] +Add compliant quiet zones for symbols that specify one. +.TP +\f[V]-r\f[R], \f[V]--reverse\f[R] +Reverse the foreground and background colours (white on black). +.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]. +.TP +\f[V]--scale=NUMBER\f[R] +Set the X-dimension. +\f[I]NUMBER\f[R] may be floating-point. +.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 vv is a 2-digit +\f[I]INTEGER\f[R]. +.TP +\f[V]--secure=INTEGER\f[R] +Set the error correction level (ECC) or check character options to +\f[I]INTEGER\f[R]. +The meaning is symbol-specific. +.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] or \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. +.TP +\f[V]--small\f[R] +Use small text for Human Readable Text. +.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[V]I\f[R] is the 1-based index, +\f[V]C\f[R] is the count of total symbols in the sequence, and +\f[V]ID\f[R], which is optional, is the identifier that all symbols in +the sequence share. +.TP +\f[V]-t\f[R], \f[V]--types\f[R] +Display the table of barcode types (symbologies). +.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. +.TP +\f[V]-v\f[R], \f[V]--version\f[R] +Display the zint version. +.TP +\f[V]--vwhitesp=INTEGER\f[R] +Set the height of vertical whitespace either side of 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 above and below 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 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 +.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 +http://zint.org.uk/Manual.aspx, and at +https://sourceforge.net/p/zint/docs/manual.pmd. +.SH STANDARDS +.PP +Zint is designed to be compliant with a number of international +standards, including: +.IP \[bu] 2 +EN 798:1996, EN 12323:2005, ISO/IEC 15420:2009, ISO/IEC 15417:2007, +.IP \[bu] 2 +ISO/IEC 15438:2015, ISO/IEC 16022:2006, ISO/IEC 16023:2000, +.IP \[bu] 2 +ISO/IEC 16388:2007, ISO/IEC 18004:2015, ISO/IEC 20830:2021, +.IP \[bu] 2 +ISO/IEC 24723:2010, ISO/IEC 24724:2011, ISO/IEC 24728:2006, +.IP \[bu] 2 +ISO/IEC 24778:2008, ISO/IEC 16390:2007, ISO/IEC 21471:2019, +.IP \[bu] 2 +ANSI-HIBC 2.6-2016, ANSI/AIM BC12-1998, ANSI/AIM BC6-2000, +.IP \[bu] 2 +ANSI/AIM BC5-1995, AIM ISS-X-24, AIMD014 (v 1.63), USPS-B-3200, +.IP \[bu] 2 +USS Code One (1994), GS1 22.0 (2022), AIM ITS/04-023 (2022) +.SH AUTHORS +Robin Stuart . diff --git a/docs/zint.1.gz b/docs/zint.1.gz deleted file mode 100644 index 69e7766b..00000000 Binary files a/docs/zint.1.gz and /dev/null differ diff --git a/frontend/CMakeLists.txt b/frontend/CMakeLists.txt index 0e6787a2..155fe6ba 100644 --- a/frontend/CMakeLists.txt +++ b/frontend/CMakeLists.txt @@ -23,7 +23,7 @@ endif() install(TARGETS ${PROJECT_NAME} DESTINATION "${BIN_INSTALL_DIR}" RUNTIME) if(UNIX) - install(FILES "${CMAKE_SOURCE_DIR}/docs/zint.1.gz" DESTINATION "${MAN_INSTALL_DIR}/man1" COMPONENT doc) + install(FILES "${CMAKE_SOURCE_DIR}/docs/zint.1" DESTINATION "${MAN_INSTALL_DIR}/man1" COMPONENT doc) endif() if(ZINT_TEST)