README 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
  1. Expat, Release 2.2.1
  2. This is Expat, a C library for parsing XML, written by James Clark.
  3. Expat is a stream-oriented XML parser. This means that you register
  4. handlers with the parser before starting the parse. These handlers
  5. are called when the parser discovers the associated structures in the
  6. document being parsed. A start tag is an example of the kind of
  7. structures for which you may register handlers.
  8. Windows users should use the expat_win32bin package, which includes
  9. both precompiled libraries and executables, and source code for
  10. developers.
  11. Expat is free software. You may copy, distribute, and modify it under
  12. the terms of the License contained in the file COPYING distributed
  13. with this package. This license is the same as the MIT/X Consortium
  14. license.
  15. Versions of Expat that have an odd minor version (the middle number in
  16. the release above), are development releases and should be considered
  17. as beta software. Releases with even minor version numbers are
  18. intended to be production grade software.
  19. If you are building Expat from a check-out from the CVS repository,
  20. you need to run a script that generates the configure script using the
  21. GNU autoconf and libtool tools. To do this, you need to have
  22. autoconf 2.58 or newer. Run the script like this:
  23. ./buildconf.sh
  24. Once this has been done, follow the same instructions as for building
  25. from a source distribution.
  26. To build Expat from a source distribution, you first run the
  27. configuration shell script in the top level distribution directory:
  28. ./configure
  29. There are many options which you may provide to configure (which you
  30. can discover by running configure with the --help option). But the
  31. one of most interest is the one that sets the installation directory.
  32. By default, the configure script will set things up to install
  33. libexpat into /usr/local/lib, expat.h into /usr/local/include, and
  34. xmlwf into /usr/local/bin. If, for example, you'd prefer to install
  35. into /home/me/mystuff/lib, /home/me/mystuff/include, and
  36. /home/me/mystuff/bin, you can tell configure about that with:
  37. ./configure --prefix=/home/me/mystuff
  38. Another interesting option is to enable 64-bit integer support for
  39. line and column numbers and the over-all byte index:
  40. ./configure CPPFLAGS=-DXML_LARGE_SIZE
  41. However, such a modification would be a breaking change to the ABI
  42. and is therefore not recommended for general use - e.g. as part of
  43. a Linux distribution - but rather for builds with special requirements.
  44. After running the configure script, the "make" command will build
  45. things and "make install" will install things into their proper
  46. location. Have a look at the "Makefile" to learn about additional
  47. "make" options. Note that you need to have write permission into
  48. the directories into which things will be installed.
  49. If you are interested in building Expat to provide document
  50. information in UTF-16 encoding rather than the default UTF-8, follow
  51. these instructions (after having run "make distclean"):
  52. 1. For UTF-16 output as unsigned short (and version/error
  53. strings as char), run:
  54. ./configure CPPFLAGS=-DXML_UNICODE
  55. For UTF-16 output as wchar_t (incl. version/error strings),
  56. run:
  57. ./configure CFLAGS="-g -O2 -fshort-wchar" \
  58. CPPFLAGS=-DXML_UNICODE_WCHAR_T
  59. 2. Edit the MakeFile, changing:
  60. LIBRARY = libexpat.la
  61. to:
  62. LIBRARY = libexpatw.la
  63. (Note the additional "w" in the library name.)
  64. 3. Run "make buildlib" (which builds the library only).
  65. Or, to save step 2, run "make buildlib LIBRARY=libexpatw.la".
  66. 4. Run "make installlib" (which installs the library only).
  67. Or, if step 2 was omitted, run "make installlib LIBRARY=libexpatw.la".
  68. Using DESTDIR or INSTALL_ROOT is enabled, with INSTALL_ROOT being the default
  69. value for DESTDIR, and the rest of the make file using only DESTDIR.
  70. It works as follows:
  71. $ make install DESTDIR=/path/to/image
  72. overrides the in-makefile set DESTDIR, while both
  73. $ INSTALL_ROOT=/path/to/image make install
  74. $ make install INSTALL_ROOT=/path/to/image
  75. use DESTDIR=$(INSTALL_ROOT), even if DESTDIR eventually is defined in the
  76. environment, because variable-setting priority is
  77. 1) commandline
  78. 2) in-makefile
  79. 3) environment
  80. Note: This only applies to the Expat library itself, building UTF-16 versions
  81. of xmlwf and the tests is currently not supported.
  82. Note for Solaris users: The "ar" command is usually located in
  83. "/usr/ccs/bin", which is not in the default PATH. You will need to
  84. add this to your path for the "make" command, and probably also switch
  85. to GNU make (the "make" found in /usr/ccs/bin does not seem to work
  86. properly -- apparently it does not understand .PHONY directives). If
  87. you're using ksh or bash, use this command to build:
  88. PATH=/usr/ccs/bin:$PATH make
  89. When using Expat with a project using autoconf for configuration, you
  90. can use the probing macro in conftools/expat.m4 to determine how to
  91. include Expat. See the comments at the top of that file for more
  92. information.
  93. A reference manual is available in the file doc/reference.html in this
  94. distribution.
  95. The homepage for this project is http://www.libexpat.org/. There
  96. are links there to connect you to the bug reports page. If you need
  97. to report a bug when you don't have access to a browser, you may also
  98. send a bug report by email to expat-bugs@mail.libexpat.org.
  99. Discussion related to the direction of future expat development takes
  100. place on expat-discuss@mail.libexpat.org. Archives of this list and
  101. other Expat-related lists may be found at:
  102. http://mail.libexpat.org/mailman/listinfo/