~ubuntu-dev/ubuntu/lucid/expat/lucid-201002101922

« back to all changes in this revision

Viewing changes to README

  • Committer: Bazaar Package Importer
  • Author(s): Ardo van Rangelrooij
  • Date: 2001-12-09 12:19:40 UTC
  • Revision ID: james.westby@ubuntu.com-20011209121940-zu64acbvutfed4hh
Tags: upstream-1.95.2
ImportĀ upstreamĀ versionĀ 1.95.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
 
 
2
                        Expat, Release 1.95.2
 
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 executalbes, 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
To build expat, you first run the configuration shell script in the
 
26
top level distribution directory:
 
27
 
 
28
        ./configure
 
29
 
 
30
There are many options which you may provide to configure (which you
 
31
can discover by running configure with the --help option).  But the
 
32
one of most interest is the one that sets the installation directory.
 
33
By default, the configure script will set things up to install
 
34
libexpat into /usr/local/lib, expat.h into /usr/local/include, and
 
35
xmlwf into /usr/local/bin.  If, for example, you'd prefer to install
 
36
into /home/me/mystuff/lib, /home/me/mystuff/include, and
 
37
/home/me/mystuff/bin, you can tell configure about that with:
 
38
 
 
39
        ./configure --prefix=/home/me/mystuff
 
40
 
 
41
After running the configure script, the "make" command will build
 
42
things and "make install" will install things into their proper
 
43
location.  Note that you need to have write permission into the
 
44
directories into which things will be installed.
 
45
 
 
46
When building for use with C++, you may need to add additional
 
47
compiler flags to support proper interaction with exceptions.  This
 
48
can be done by setting the CFLAGS environment variable.  For example,
 
49
when using GCC, you can use:
 
50
 
 
51
        CFLAGS=-fexceptions ./configure
 
52
 
 
53
Note for Solaris users:  The "ar" command is usually located in
 
54
"/usr/ccs/bin", which is not in the default PATH.  You will need to
 
55
add this to your path for the "make" command, and probably also switch
 
56
to GNU make (the "make" found in /usr/ccs/bin does not seem to work
 
57
properly -- appearantly it does not understand .PHONY directives).  If
 
58
you're using ksh or bash, use this command to build:
 
59
 
 
60
        PATH=/usr/ccs/bin:$PATH make
 
61
 
 
62
A reference manual is available in the file doc/reference.html in this
 
63
distribution.
 
64
 
 
65
The homepage for this project is http://expat.sourceforge.net/.  There
 
66
are links there to connect you to the bug reports page.  If you need
 
67
to report a bug when you don't have access to a browser, you may also
 
68
send a bug report by email to expat-bugs@lists.sourceforge.net.
 
69
 
 
70
Discussion related to the direction of future expat development takes
 
71
place on expat-discuss@lists.sourceforge.net.  Archives of this list
 
72
may be found at http://www.geocrawler.com/redir-sf.php3?list=expat-discuss.