Command line reference

command line format barcodereadercli \[options] \[sources] \[@configuration file] where \options\ options specified in this document see option rules /#option rules \sources\ files, folders, or urls identifying input files \configuration file\ zero one or more configurations files source the \source\ parameter specifies the location of image files to read barcodes from multiple sources can be specified sources can be local image file local folder web based image the source name should start with \http //\ , \ htpps\ //\ the rules for source values are the value of the source should use utf 8 to represent non english file names the value containing spaces should be enclosed in double quotes ( \""\ ) the value containing environmental and user macro references docid\ lcj sxpqwhwur1q 9vvgz expanded at runtime options option rules most options are specified as \ name=value\ , except options with a value described as a flag are specified as \ name\ the \ d\ option is specified as \ d="macro name=macro value"\ if the value is described as a list , zero or more valid values can be set multiple values should be separated by a comma (,) no spaces are allowed in the list all options (except \ type\ ) are optional a new option value (except \ output\ ) replaces the previous value an empty string value sets the option to its default value for options specifying file names \ output\ and \ output text\ if the value contains spaces, it should be enclosed in double quotes ( \""\ ) environmental and user macro references are expanded at runtime the order of the options on the command line and in configuration files is important reader options and source options should be specified before the \source\ parameter thus different options can be applied to individual sources output options that apply to output should be specified before the \ output\ option thus, different options can be applied to individual outputs reader options reader options configure the barcode reader parameters to be applied to a source name value description default valid values \ type\ \ t\ required list of barcode types code39 code128 ucc128 pdf417 qr datamatrix drvlic code39 code128 codabar ucc128 code93 upca ean8 upce ean13 i25 datamatrix pdf417 qr drvlic imb bpo aust sing 4state patch \ tbr\ list of tbr codes docid\ krbh lutyawzphraj5lqs 0 valid tbr codes for a given type are displayed by the tbr wizard docid\ glmgkfkxrclppzzasnvwc \ dir\ list of barcode directions all all horz vert \ max bc\ \ m\ a maximum number of barcodes to read on a page 0 means read all barcodes 0 0 100 \ timeout\ barcode reading timeout in seconds 0 means no timeout 0 \ encoding\ encoding to convert barcode data to utf 8 text see here docid\ n6svssr4bwti0m0b m3rr tbr codes valid codes for specific barcode types are reported in the tbr wizard docid\ glmgkfkxrclppzzasnvwc each tbr code set in \ tbr\ option (if more than one) is applied sequentially to each source page if the number of barcodes found on a page after applying a tbr code from the list is equal to or more than \ max bc\ value (if set), the rest of the tbr codes are ignored for this page if \ tbr\ option is not set, the default algorithm is used if tbr codes are changed, to return to the default algorithm to the next source set \ tbr=0\ source options multi page file format this option control processing of multi page file formats pdf , tiff , gif name value description default valid values \ pages\ list of page selectors to limit reading to a set of pages nmb is an explicit page number (1 based) start is an explicit page number or first stop is an explicit page number or last cnt is the maximum number of barcodes to detect in a file all all even odd first last nmb start stop maxbc\ cnt if the page range is maxbc\ cnt and the value of cnt > 0, then file processing stops once cnt barcodes are found setting a barcode count limit might increase overall processing time since multi threading is disabled source options web based images images from \http //\ , \ htpps\ //\ sources are downloaded by the curl https //curl haxx se/docs/manpage html command line application linux version is installed with the barcodereadercli windows version is available here https //curl haxx se/download html and should be installed in the path the curl is invoked with the following default curl options \ s s d m o l\ additional options should be set as needed based on the system requirements barcodereadercli reports errors returned from the curl to resolve any problems invoke curl from the command line to identify required curl options name value description default valid values \ curl timeout\ total timeout in seconds to download an image with curl a value of 0 0 disables the timeout 15 0 floating point number \ curl options\ additional curl options the list of options should be enclosed in the double quotes ( \""\ ) use an escape character before any double quotes in the list curl command line options https //curl se/docs/manpage html \ curl no redirect\ disable request redirect source options folder processing these options control the selection of image files when the \source\ is a folder name value description default valid values \ sub\ \ subfolders\ include subfolders of the source folder in the processing true true false \ incl\ list of file name masks to be included in the processing tif, tiff, jpg, jpeg, pdf, bmp, png \ excl\ list of file name masks to be excluded from processing output options these options control the output https //www inliteresearch com/help/barcodereadercli/output htm generated by barcodereadercli name value description default valid values \ output\ \ o\ file path output is sent to the specified file zero or more output files can be specified, each requires a separate output option entry console output is sent to \stdout\ using format option file path console \ format\ console output format, text value requires output text option to be specified json json csv text bin \ output text\ string with macro reference to define text output in a file, the string should be \file //text file path\ , where text file path is a template file path \ if exists\ action to take if the output file already exists overwrite replaces the existing file append adds new data to an existing file (not allowed for bin output) unique adds a unique file index to the filename before the extension error generates a runtime error overwrite overwrite append unique error \ fields\ for barcodes fields to output in json and csv output fields values are obtained through macro expansion except barcode outputs all default fields text , data , length , type barcode macros docid\ lcj sxpqwhwur1q 9vvgz barcode \ fields\ for driver license barcodes fields to output in json and csv output fields values are obtained through macro expansion except drvlic outputs all default fields last , first , middle , dob , eyes , hair , sex , height , weight , street , city , state , postal,id , issued , expires driver license macros docid\ lcj sxpqwhwur1q 9vvgz drvlic miscellaneous options name value description \ help\ \ h\ flag to output command line help to console no processing is done \ silent\ \ s\ silent mode flag do not output the barcodereadercli version and information \ timeout\ execution timeout in seconds the default value of 0 0 disables the timeout error is returned if total execution time exceeds timeout \ d\ command line use macros docid\ lcj sxpqwhwur1q 9vvgz the format is \ d="macro name=macro value"\ configuration file a configuration file is a convenient way to define a set of options and/or sources shared by multiple systems or sessions for example, they can be used to define macros specific to a system, such as the location of source or output files define reader options applied to sources specified on a command line zero or more configuration files can be set on the command line multiple files are processed in the order of appearance the format rules for configuration files are \ name\ sets command line flags \ name=value\ sets command line options with values \ d="macro name=macro value"\ specifies a command line use macros docid\ lcj sxpqwhwur1q 9vvgz \source\ specifies the location of image files to read barcodes from it can be an image file , a folder containing image files, or a url values with spaces should be enclosed in double quotes ( \"some text"\ ) \#\ starts the comment portion of a line if \#\ is the first character, the whole line is treated as a comment \exit\ ends the processing of a configuration file the rest of the file is ignored the configuration file should be in utf 8 to include non english file names