CMake.README
1 == How to build expat with cmake (experimental) ==
2
3 The cmake based buildsystem for expat works on Windows (cygwin, mingw, Visual
4 Studio) and should work on all other platform cmake supports.
5
6 Assuming ~/expat-2.2.5 is the source directory of expat, add a subdirectory
7 build and change into that directory:
8 ~/expat-2.2.5$ mkdir build && cd build
9 ~/expat-2.2.5/build$
10
11 From that directory, call cmake first, then call make, make test and
12 make install in the usual way:
13 ~/expat-2.2.5/build$ cmake ..
14 -- The C compiler identification is GNU
15 -- The CXX compiler identification is GNU
16 ....
17 -- Configuring done
18 -- Generating done
19 -- Build files have been written to: /home/patrick/expat-2.2.5/build
20
21 If you want to specify the install location for your files, append
22 -DCMAKE_INSTALL_PREFIX=/your/install/path to the cmake call.
23
24 ~/expat-2.2.5/build$ make && make test && make install
25 Scanning dependencies of target expat
26 [ 5%] Building C object CMakeFiles/expat.dir/lib/xmlparse.c.o
27 [ 11%] Building C object CMakeFiles/expat.dir/lib/xmlrole.c.o
28 ....
29 -- Installing: /usr/local/lib/pkgconfig/expat.pc
30 -- Installing: /usr/local/bin/xmlwf
31 -- Installing: /usr/local/share/man/man1/xmlwf.1
32
33 For Windows builds, you must make sure to call cmake from an environment where
34 your compiler is reachable, that means either you call it from the
35 Visual Studio Command Prompt or when using mingw, you must open a cmd.exe and
36 make sure that gcc can be called. On Windows, you also might want to specify a
37 special Generator for CMake:
38 for Visual Studio builds do:
39 cmake .. -G "Visual Studio 10" && vcexpress expat.sln
40 for mingw builds do:
41 cmake .. -G "MinGW Makefiles" -DCMAKE_INSTALL_PREFIX=D:\expat-install
42 && gmake && gmake install
43
README
1
2 Expat, Release 2.2.0
3
4 This is Expat, a C library for parsing XML, written by James Clark.
5 Expat is a stream-oriented XML parser. This means that you register
6 handlers with the parser before starting the parse. These handlers
7 are called when the parser discovers the associated structures in the
8 document being parsed. A start tag is an example of the kind of
9 structures for which you may register handlers.
10
11 Windows users should use the expat_win32bin package, which includes
12 both precompiled libraries and executables, and source code for
13 developers.
14
15 Expat is free software. You may copy, distribute, and modify it under
16 the terms of the License contained in the file COPYING distributed
17 with this package. This license is the same as the MIT/X Consortium
18 license.
19
20 Versions of Expat that have an odd minor version (the middle number in
21 the release above), are development releases and should be considered
22 as beta software. Releases with even minor version numbers are
23 intended to be production grade software.
24
25 If you are building Expat from a check-out from the CVS repository,
26 you need to run a script that generates the configure script using the
27 GNU autoconf and libtool tools. To do this, you need to have
28 autoconf 2.58 or newer. Run the script like this:
29
30 ./buildconf.sh
31
32 Once this has been done, follow the same instructions as for building
33 from a source distribution.
34
35 To build Expat from a source distribution, you first run the
36 configuration shell script in the top level distribution directory:
37
38 ./configure
39
40 There are many options which you may provide to configure (which you
41 can discover by running configure with the --help option). But the
42 one of most interest is the one that sets the installation directory.
43 By default, the configure script will set things up to install
44 libexpat into /usr/local/lib, expat.h into /usr/local/include, and
45 xmlwf into /usr/local/bin. If, for example, you'd prefer to install
46 into /home/me/mystuff/lib, /home/me/mystuff/include, and
47 /home/me/mystuff/bin, you can tell configure about that with:
48
49 ./configure --prefix=/home/me/mystuff
50
51 Another interesting option is to enable 64-bit integer support for
52 line and column numbers and the over-all byte index:
53
54 ./configure CPPFLAGS=-DXML_LARGE_SIZE
55
56 However, such a modification would be a breaking change to the ABI
57 and is therefore not recommended for general use - e.g. as part of
58 a Linux distribution - but rather for builds with special requirements.
59
60 After running the configure script, the "make" command will build
61 things and "make install" will install things into their proper
62 location. Have a look at the "Makefile" to learn about additional
63 "make" options. Note that you need to have write permission into
64 the directories into which things will be installed.
65
66 If you are interested in building Expat to provide document
67 information in UTF-16 encoding rather than the default UTF-8, follow
68 these instructions (after having run "make distclean"):
69
70 1. For UTF-16 output as unsigned short (and version/error
71 strings as char), run:
72
73 ./configure CPPFLAGS=-DXML_UNICODE
74
75 For UTF-16 output as wchar_t (incl. version/error strings),
76 run:
77
78 ./configure CFLAGS="-g -O2 -fshort-wchar" \
79 CPPFLAGS=-DXML_UNICODE_WCHAR_T
80
81 2. Edit the MakeFile, changing:
82
83 LIBRARY = libexpat.la
84
85 to:
86
87 LIBRARY = libexpatw.la
88
89 (Note the additional "w" in the library name.)
90
91 3. Run "make buildlib" (which builds the library only).
92 Or, to save step 2, run "make buildlib LIBRARY=libexpatw.la".
93
94 4. Run "make installlib" (which installs the library only).
95 Or, if step 2 was omitted, run "make installlib LIBRARY=libexpatw.la".
96
97 Using DESTDIR or INSTALL_ROOT is enabled, with INSTALL_ROOT being the default
98 value for DESTDIR, and the rest of the make file using only DESTDIR.
99 It works as follows:
100 $ make install DESTDIR=/path/to/image
101 overrides the in-makefile set DESTDIR, while both
102 $ INSTALL_ROOT=/path/to/image make install
103 $ make install INSTALL_ROOT=/path/to/image
104 use DESTDIR=$(INSTALL_ROOT), even if DESTDIR eventually is defined in the
105 environment, because variable-setting priority is
106 1) commandline
107 2) in-makefile
108 3) environment
109
110 Note: This only applies to the Expat library itself, building UTF-16 versions
111 of xmlwf and the tests is currently not supported.
112
113 Note for Solaris users: The "ar" command is usually located in
114 "/usr/ccs/bin", which is not in the default PATH. You will need to
115 add this to your path for the "make" command, and probably also switch
116 to GNU make (the "make" found in /usr/ccs/bin does not seem to work
117 properly -- apparently it does not understand .PHONY directives). If
118 you're using ksh or bash, use this command to build:
119
120 PATH=/usr/ccs/bin:$PATH make
121
122 When using Expat with a project using autoconf for configuration, you
123 can use the probing macro in conftools/expat.m4 to determine how to
124 include Expat. See the comments at the top of that file for more
125 information.
126
127 A reference manual is available in the file doc/reference.html in this
128 distribution.
129
130 The homepage for this project is http://www.libexpat.org/. There
131 are links there to connect you to the bug reports page. If you need
132 to report a bug when you don't have access to a browser, you may also
133 send a bug report by email to expat-bugs (a] mail.libexpat.org.
134
135 Discussion related to the direction of future expat development takes
136 place on expat-discuss (a] mail.libexpat.org. Archives of this list and
137 other Expat-related lists may be found at:
138
139 http://mail.libexpat.org/mailman/listinfo/
140
README.md
1 [![Travis CI Build Status](https://travis-ci.org/libexpat/libexpat.svg?branch=master)](https://travis-ci.org/libexpat/libexpat)
2 [![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/libexpat/libexpat?svg=true)](https://ci.appveyor.com/project/libexpat/libexpat)
3
4
5 # Expat, Release 2.2.5
6
7 This is Expat, a C library for parsing XML, started by
8 [James Clark](https://en.wikipedia.org/wiki/James_Clark_(programmer)) in 1997.
9 Expat is a stream-oriented XML parser. This means that you register
10 handlers with the parser before starting the parse. These handlers
11 are called when the parser discovers the associated structures in the
12 document being parsed. A start tag is an example of the kind of
13 structures for which you may register handlers.
14
15 Windows users should use the
16 [`expat_win32` package](https://sourceforge.net/projects/expat/files/expat_win32/),
17 which includes both precompiled libraries and executables, and source code for
18 developers.
19
20 Expat is [free software](https://www.gnu.org/philosophy/free-sw.en.html).
21 You may copy, distribute, and modify it under the terms of the License
22 contained in the file
23 [`COPYING`](https://github.com/libexpat/libexpat/blob/master/expat/COPYING)
24 distributed with this package.
25 This license is the same as the MIT/X Consortium license.
26
27 If you are building Expat from a check-out from the
28 [Git repository](https://github.com/libexpat/libexpat/),
29 you need to run a script that generates the configure script using the
30 GNU autoconf and libtool tools. To do this, you need to have
31 autoconf 2.58 or newer. Run the script like this:
32
33 ```console
34 ./buildconf.sh
35 ```
36
37 Once this has been done, follow the same instructions as for building
38 from a source distribution.
39
40 To build Expat from a source distribution, you first run the
41 configuration shell script in the top level distribution directory:
42
43 ```console
44 ./configure
45 ```
46
47 There are many options which you may provide to configure (which you
48 can discover by running configure with the `--help` option). But the
49 one of most interest is the one that sets the installation directory.
50 By default, the configure script will set things up to install
51 libexpat into `/usr/local/lib`, `expat.h` into `/usr/local/include`, and
52 `xmlwf` into `/usr/local/bin`. If, for example, you'd prefer to install
53 into `/home/me/mystuff/lib`, `/home/me/mystuff/include`, and
54 `/home/me/mystuff/bin`, you can tell `configure` about that with:
55
56 ```console
57 ./configure --prefix=/home/me/mystuff
58 ```
59
60 Another interesting option is to enable 64-bit integer support for
61 line and column numbers and the over-all byte index:
62
63 ```console
64 ./configure CPPFLAGS=-DXML_LARGE_SIZE
65 ```
66
67 However, such a modification would be a breaking change to the ABI
68 and is therefore not recommended for general use — e.g. as part of
69 a Linux distribution — but rather for builds with special requirements.
70
71 After running the configure script, the `make` command will build
72 things and `make install` will install things into their proper
73 location. Have a look at the `Makefile` to learn about additional
74 `make` options. Note that you need to have write permission into
75 the directories into which things will be installed.
76
77 If you are interested in building Expat to provide document
78 information in UTF-16 encoding rather than the default UTF-8, follow
79 these instructions (after having run `make distclean`).
80 Please note that we configure with `--without-xmlwf` as xmlwf does not
81 support this mode of compilation (yet):
82
83 1. Mass-patch `Makefile.am` files to use `libexpatw.la` for a library name:
84 <br/>
85 `find -name Makefile.am -exec sed
86 -e 's,libexpat\.la,libexpatw.la,'
87 -e 's,libexpat_la,libexpatw_la,'
88 -i {} +`
89
90 1. Run `automake` to re-write `Makefile.in` files:<br/>
91 `automake`
92
93 1. For UTF-16 output as unsigned short (and version/error strings as char),
94 run:<br/>
95 `./configure CPPFLAGS=-DXML_UNICODE --without-xmlwf`<br/>
96 For UTF-16 output as `wchar_t` (incl. version/error strings), run:<br/>
97 `./configure CFLAGS="-g -O2 -fshort-wchar" CPPFLAGS=-DXML_UNICODE_WCHAR_T
98 --without-xmlwf`
99 <br/>Note: The latter requires libc compiled with `-fshort-wchar`, as well.
100
101 1. Run `make` (which excludes xmlwf).
102
103 1. Run `make install` (again, excludes xmlwf).
104
105 Using `DESTDIR` is supported. It works as follows:
106
107 ```console
108 make install DESTDIR=/path/to/image
109 ```
110
111 overrides the in-makefile set `DESTDIR`, because variable-setting priority is
112
113 1. commandline
114 1. in-makefile
115 1. environment
116
117 Note: This only applies to the Expat library itself, building UTF-16 versions
118 of xmlwf and the tests is currently not supported.
119
120 When using Expat with a project using autoconf for configuration, you
121 can use the probing macro in `conftools/expat.m4` to determine how to
122 include Expat. See the comments at the top of that file for more
123 information.
124
125 A reference manual is available in the file `doc/reference.html` in this
126 distribution.
127
README.version