| 1 |
================================================================= |
| 2 |
libdmtx - Open Source Data Matrix Software |
| 3 |
================================================================= |
| 4 |
|
| 5 |
dmtx-utils README file (all platforms) |
| 6 |
|
| 7 |
This summary of the dmtx-utils package applies generally to all |
| 8 |
platforms. For instructions regarding your specific platform |
| 9 |
please also read the README.xxx file in this directory that |
| 10 |
matches your system (e.g., README.linux, README.cygwin, |
| 11 |
README.osx, etc...). |
| 12 |
|
| 13 |
|
| 14 |
1. Introduction |
| 15 |
----------------------------------------------------------------- |
| 16 |
|
| 17 |
libdmtx is a software library that enables programs to read and |
| 18 |
write Data Matrix barcodes of the modern ECC200 variety. This |
| 19 |
package, dmtx-utils, provides command line utilities that allow |
| 20 |
scripts and command line users to use libdmtx functionality. |
| 21 |
|
| 22 |
|
| 23 |
2. Installation |
| 24 |
----------------------------------------------------------------- |
| 25 |
|
| 26 |
In theory the following 3 steps will compile and install libdmtx |
| 27 |
on your system: |
| 28 |
|
| 29 |
$ ./configure |
| 30 |
$ make |
| 31 |
$ sudo make install |
| 32 |
|
| 33 |
However, you may need to install additional software for these |
| 34 |
steps to work properly. Details are provided below to handle |
| 35 |
error messages or if you want to customize beyond the defaults. |
| 36 |
|
| 37 |
Details on "configure" step |
| 38 |
---------------------------------------- |
| 39 |
If you obtained libdmtx from Git you may have received an error |
| 40 |
like "./configure: No such file or directory". Run this command |
| 41 |
and try again: |
| 42 |
|
| 43 |
$ ./autogen.sh |
| 44 |
|
| 45 |
The autogen.sh command requires autoconf, automake, libtool, and |
| 46 |
pkgconfig to be installed on your system. |
| 47 |
|
| 48 |
Also, if you built and installed the libdmtx library from source |
| 49 |
it's like that configure gave you an error similar to this: |
| 50 |
|
| 51 |
configure: error: dmtxread/dmtxwrite requires libdmtx >= 0.7.0 |
| 52 |
|
| 53 |
You can fix this by telling configure where to find libdmtx.pc: |
| 54 |
|
| 55 |
$ ./configure PKG_CONFIG_PATH=/usr/local/lib/pkgconfig |
| 56 |
|
| 57 |
Note: This path may be different on your system. |
| 58 |
|
| 59 |
Details on "make" step |
| 60 |
---------------------------------------- |
| 61 |
Errors encountered during the "make" step are often a result of |
| 62 |
missing software dependencies. Install any missing software and |
| 63 |
try again. |
| 64 |
|
| 65 |
Details on "sudo make install" step |
| 66 |
---------------------------------------- |
| 67 |
If the 'sudo' command is not configured on your system then |
| 68 |
alternatively you can yell "Yeeehaww!" as you log in as root and |
| 69 |
run this instead: |
| 70 |
|
| 71 |
$ make install |
| 72 |
|
| 73 |
|
| 74 |
3. Basic Usage |
| 75 |
----------------------------------------------------------------- |
| 76 |
|
| 77 |
New users are encouraged to read the man pages for the library |
| 78 |
and command line utilities. However, here are a few simple cases |
| 79 |
to get you started: |
| 80 |
|
| 81 |
The dmtxwrite utility turns a message into a barcode image. The |
| 82 |
message is passed to dmtxwrite via file or standard input, and |
| 83 |
the output image is written to file or standard output. The |
| 84 |
following examples all produce an equivalent result: |
| 85 |
|
| 86 |
$ echo -n 123456 | dmtxwrite > image.png |
| 87 |
$ echo -n 123456 | dmtxwrite -o image.png |
| 88 |
$ echo -n 123456 > mesg.txt; dmtxwrite mesg.txt > image.png |
| 89 |
$ dmtxwrite <(echo -n 123456) -o image.png |
| 90 |
|
| 91 |
Conversely, the dmtxread utility turns barcode images back into |
| 92 |
messages. Images are passed to dmtxread via standard input or |
| 93 |
file, and the output is written to standard output. The following |
| 94 |
examples will produce an equivalent result: |
| 95 |
|
| 96 |
$ dmtxread -n image.png |
| 97 |
$ cat image.png | dmtxread -n |
| 98 |
|
| 99 |
Other typical cases: |
| 100 |
|
| 101 |
$ dmtxread -n -N1 image1.png image2.png image3.png |
| 102 |
$ dmtxread -n -N1 -m500 image.png |
| 103 |
|
| 104 |
You can even combine the utilities like this: |
| 105 |
|
| 106 |
$ echo 'Hello, world!' | dmtxwrite | dmtxread |
| 107 |
Hello, world! |
| 108 |
|
| 109 |
$ dmtxread image1.png | dmtxwrite -o image2.png |
| 110 |
|
| 111 |
Note: In this example the barcode in image2.png might appear |
| 112 |
different than the one in image1.png. Both barcodes will encode |
| 113 |
the same message, but the overall barcode shape and its internal |
| 114 |
bit pattern might be different. |
| 115 |
|
| 116 |
|
| 117 |
4. Contact |
| 118 |
----------------------------------------------------------------- |
| 119 |
|
| 120 |
Project website: http://www.libdmtx.org |
| 121 |
Documentation wiki: http://libdmtx.wikidot.com |
| 122 |
SourceForge.net page: http://www.sourceforge.net/projects/libdmtx |
| 123 |
OhLoh.net page: https://www.ohloh.net/projects/libdmtx |
| 124 |
Open mailing list: [email protected] |
| 125 |
Professional support: www.dragonflylogic.com/products |