README
1=================================================================
2 libdmtx - Open Source Data Matrix Software
3=================================================================
4
5 dmtx-utils README file (all platforms)
6
7This summary of the dmtx-utils package applies generally to all
8platforms. For instructions regarding your specific platform
9please also read the README.xxx file in this directory that
10matches your system (e.g., README.linux, README.cygwin,
11README.osx, etc...).
12
13
141. Introduction
15-----------------------------------------------------------------
16
17libdmtx is a software library that enables programs to read and
18write Data Matrix barcodes of the modern ECC200 variety. This
19package, dmtx-utils, provides command line utilities that allow
20scripts and command line users to use libdmtx functionality.
21
22
232. Installation
24-----------------------------------------------------------------
25
26In theory the following 3 steps will compile and install libdmtx
27on your system:
28
29 $ ./configure
30 $ make
31 $ sudo make install
32
33However, you may need to install additional software for these
34steps to work properly. Details are provided below to handle
35error messages or if you want to customize beyond the defaults.
36
37Details on "configure" step
38----------------------------------------
39If you obtained libdmtx from Git you may have received an error
40like "./configure: No such file or directory". Run this command
41and try again:
42
43 $ ./autogen.sh
44
45The autogen.sh command requires autoconf, automake, libtool, and
46pkgconfig to be installed on your system.
47
48Also, if you built and installed the libdmtx library from source
49it's like that configure gave you an error similar to this:
50
51 configure: error: dmtxread/dmtxwrite requires libdmtx >= 0.7.0
52
53You can fix this by telling configure where to find libdmtx.pc:
54
55 $ ./configure PKG_CONFIG_PATH=/usr/local/lib/pkgconfig
56
57Note: This path may be different on your system.
58
59Details on "make" step
60----------------------------------------
61Errors encountered during the "make" step are often a result of
62missing software dependencies. Install any missing software and
63try again.
64
65Details on "sudo make install" step
66----------------------------------------
67If the 'sudo' command is not configured on your system then
68alternatively you can yell "Yeeehaww!" as you log in as root and
69run this instead:
70
71 $ make install
72
73
743. Basic Usage
75-----------------------------------------------------------------
76
77New users are encouraged to read the man pages for the library
78and command line utilities. However, here are a few simple cases
79to get you started:
80
81The dmtxwrite utility turns a message into a barcode image. The
82message is passed to dmtxwrite via file or standard input, and
83the output image is written to file or standard output. The
84following 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
91Conversely, the dmtxread utility turns barcode images back into
92messages. Images are passed to dmtxread via standard input or
93file, and the output is written to standard output. The following
94examples will produce an equivalent result:
95
96 $ dmtxread -n image.png
97 $ cat image.png | dmtxread -n
98
99Other typical cases:
100
101 $ dmtxread -n -N1 image1.png image2.png image3.png
102 $ dmtxread -n -N1 -m500 image.png
103
104You 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
111Note: In this example the barcode in image2.png might appear
112different than the one in image1.png. Both barcodes will encode
113the same message, but the overall barcode shape and its internal
114bit pattern might be different.
115
116
1174. Contact
118-----------------------------------------------------------------
119
120Project website: http://www.libdmtx.org
121Documentation wiki: http://libdmtx.wikidot.com
122SourceForge.net page: http://www.sourceforge.net/projects/libdmtx
123OhLoh.net page: https://www.ohloh.net/projects/libdmtx
124Open mailing list: libdmtx-open_discussion@lists.sourceforge.net
125Professional support: www.dragonflylogic.com/products
126
README.cygwin
1=================================================================
2 libdmtx - Open Source Data Matrix Software
3=================================================================
4
5 dmtx-utils README file (Cygwin)
6
7This README.cygwin file contains information on installing and
8using libdmtx on Windows in a Cygwin environment. The general
9README file, also found in this directory, contains a high level
10summary of libdmtx and its components.
11
12
131. Installing dmtx-utils on Windows using Cygwin
14-----------------------------------------------------------------
15
16dmtx-utils can be installed on Cygwin using the instructions
17provided in the general README file. However, please see below
18for additional details that might benefit users on this platform.
19
20
212. Dependencies
22-----------------------------------------------------------------
23
24The following packages must be installed to compile libdmtx on
25Cygwin:
26
27 * gcc
28 * make
29 * automake
30 * pkg-config
31
32Also, if libdmtx was obtained from Subversion:
33
34 * autoconf
35 * libtool
36
37Also, if compiling dmtxread and/or dmtxwrite:
38
39 * libSM-devel
40 * libXt-devel
41 * ImageMagick
42 * libMagick-devel
43
README.freebsd
1=================================================================
2 libdmtx - Open Source Data Matrix Software
3=================================================================
4
5 dmtx-utils README file (FreeBSD)
6
7This README.freebsd file contains information on installing and
8using libdmtx on FreeBSD. The general README file, also found in
9this directory, contains a high level summary of libdmtx and its
10components.
11
12
131. Installing dmtx-utils on FreeBSD
14-----------------------------------------------------------------
15
16dmtx-utils can be installed on FreeBSD using the instructions
17provided in the general README file. However, please read below
18for additional details that might benefit users on this platform.
19
20
212. Running configure
22-----------------------------------------------------------------
23
24FreeBSD users may need to export the CPPFLAGS and LDFLAGS
25variables as follows before running configure:
26
27 $ export CPPFLAGS=-I/usr/local/include
28 $ export LDFLAGS=-L/usr/local/lib
29 $ ./configure
30 $ make
31 $ sudo make install
32
README.linux
1=================================================================
2 libdmtx - Open Source Data Matrix Software
3=================================================================
4
5 dmtx-utils README file (GNU/Linux)
6
7This README.linux file contains information on installing and
8using libdmtx on GNU/Linux. The general README file, also found
9in this directory, contains a high level summary of libdmtx and
10its components.
11
12
131. Installing dmtx-utils on GNU/Linux
14-----------------------------------------------------------------
15
16dmtx-utils can be installed on GNU/Linux using the instructions
17provided in the general README file. However, please see below
18for additional details that might benefit users on this platform.
19
20
212. Pre-Compiled Binaries
22-----------------------------------------------------------------
23
24Many Linux distributions offer pre-compiled libdmtx binaries in
25their package repositories. This can be a real time saver if you
26aren't required to build from source for other reasons.
27
28Go to http://www.dragonflylogic.com/downloads for a list of all
29download options available on your system.
30
README.mingw
1=================================================================
2 libdmtx - Open Source Data Matrix Software
3=================================================================
4
5 dmtx-utils README file (MinGW)
6
7This README.mingw file contains information on installing and
8using libdmtx using MinGW. The general README file, also found in
9this directory, contains a high level summary of libdmtx and its
10components.
11
12
131. Installing dmtx-utils on Windows using MinGW and MSYS
14-----------------------------------------------------------------
15
16dmtx-utils can be installed on MinGW using the instructions provided
17in the general README file. However, please see below for
18additional details that might benefit users on this platform.
19
20
212. Installing MinGW and MSYS
22-----------------------------------------------------------------
23
24If you haven't done so already, first install MinGW, MSYS, and
25all recommended updates to your Windows system. Instructions for
26doing this are provided here:
27
28 http://www.mingw.org/wiki/msys
29
30
313. External Dependencies
32-----------------------------------------------------------------
33
34The dmtxread and dmtxwrite command line utilities require
35ImageMagick to be installed on your system. To satisfy this
36requirement you can download and install the current stable
37branch of ImageMagick from:
38
39 https://sourceforge.net/projects/imagemagick/
40
41After downloading, unpack the ImageMagick sources and run:
42
43 $ ./configure
44 $ make
45 $ sudo make install
46
47Once ImageMagick is installed, change into the libdmtx directory
48and perform a full install:
49
50 $ ./configure
51 $ make
52 $ sudo make install
53
README.osx
1=================================================================
2 libdmtx - Open Source Data Matrix Software
3=================================================================
4
5 dmtx-utils README file (Mac OS X)
6
7This README.osx file contains information on installing and using
8libdmtx on Mac OS X. The general README file, also found in this
9directory, contains a high level summary of libdmtx and its
10components.
11
12
131. Installing dmtx-utils on Mac OS X
14-----------------------------------------------------------------
15
16dmtx-utils can be installed on OS X using the instructions
17provided in the general README file. However, please see below
18for additional details that might benefit users on this platform.
19
20
212. Universal Binaries
22-----------------------------------------------------------------
23
24You can tweak configure's parameters to build an Universal Binary
25version of the library. Recommendations are provided at:
26
27 http://developer.apple.com/technotes/tn2005/tn2137.html
28
29
303. Dependencies
31-----------------------------------------------------------------
32
33Mac OS X does not have pkg-config installed by default. Even
34though I specified -L and -I options for ImageMagick the compiler
35losses this info at some point and looks to pkg-config to find
36it. Once pkg-config was installed it compiled perfectly. After
37installing pkg-config you do not need to re-install ImageMagick.
38
39The command line utilities dmtxread and dmtxwrite have a
40dependency on ImageMagick, which must be downloaded and built
41from its source distribution. After doing this, simply add the
42relevant "-L" and "-I" options to the CFLAGS and LDFLAGS
43environment variables before running the ./configure script.
44
45Compiling from Subversion requires a working autoconf/pkg-config
46setup:
47
48 * autoconf, automake, libtool, and pkgconfig are required to
49 generate the configure script. These packages are available
50 from MacPorts.
51
52 * You may run into issues if you mix the autotools packages in
53 MacPorts with the ones installed from Xcode Tools. Make sure
54 /opt/local/bin appears before /usr/bin in your $PATH.
55
README.unix
1=================================================================
2 libdmtx - Open Source Data Matrix Software
3=================================================================
4
5 dmtx-utils README file (Unix)
6
7This README.unix file contains information on installing and
8using libdmtx on Unix. The general README file, also found in
9this directory, contains a high level summary of libdmtx and its
10components.
11
12
131. Installing dmtx-utils on Unix
14-----------------------------------------------------------------
15
16dmtx-utils can be installed on Unix using the instructions
17provided in the general README file. However, please see below
18for additional details that might benefit users on this platform.
19
20
212. Known Issues
22-----------------------------------------------------------------
23
24dmtx-utils is known to work on the following commercial Unix
25versions:
26
27 * AIX
28 * HP-UX
29 * Solaris
30
31However, building libdmtx from source on these operating systems
32can be tricky due to their non-GNU conventions. Users may wish to
33evaluate the trial binaries available at:
34
35 http://www.dragonflylogic.com/downloads
36
