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 &mdash; e.g. as part of
  69 a Linux distribution &mdash; 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.