libnxml  0.18.3
main.doxy
Go to the documentation of this file.
1 /*!\mainpage nXml Library
2  *
3  * \section Author
4  * Andrea Marchesini <bakunin@autistici.org> - Web Site:
5  * http://www.autistici.org/bakunin/
6  *
7  * \section description Description
8  *
9  * nXML is a C library for parsing, writing and creating XML 1.0 and 1.1 files
10  * or streams. It supports utf-8, utf-16be and utf-16le, ucs-4 (1234, 4321,
11  * 2143, 2312).
12  *
13  * This library is tested on Linux, Windows, *BSD, Solaris, Minix 3.
14  *
15  * Why another XML library? Because it is fast, easy-to-use and -important- it
16  * is my personal work about the second layer of the Semantic Web. Other my
17  * softwares are based on this library. Annotea
18  * (http://www.autistici.org/bakunin/annotea/), Morla
19  * (http://www.autistici.org/bakunin/morla/) and libmrss
20  * (http://www.autistici.org/bakunin/libmrss/).
21  *
22  * Why Nxml ? N is from
23  * <a href="http://en.wikipedia.org/wiki/Naples">Naples</a> a beautiful italian
24  * city. I was there when I started to write this code. Who doesn't know
25  * Naples, maybe he should spend some day in that city because it is full of
26  * history, culture and wonderful people.
27  *
28  * \section License
29  *
30  * nXml is a FreeSoftware project released under
31  * <a href="http://www.gnu.org/licenses/lgpl.html">LGPL 2.0</a>.
32  *
33  * \section Required
34  *
35  * - <a href="http://curl.haxx.se/">libcurl</a> is a free and easy-to-use
36  * client-side URL transfer library, supporting FTP, FTPS, HTTP, HTTPS, SCP,
37  * SFTP, TFTP, TELNET, DICT, FILE and LDAP. libcurl supports SSL certificates,
38  * HTTP POST, HTTP PUT, FTP uploading, HTTP form based upload, proxies,
39  * cookies, user+password authentication (Basic, Digest, NTLM, Negotiate,
40  * Kerberos4), file transfer resume, http proxy tunneling and more!
41  *
42  * \section Download
43  *
44  * - libnxml http://www.autistici.org/bakunin/libnxml/
45  *
46  * \section install1 Installation from source
47  *
48  * \code
49  * tar xvfz libnxml-<version>.tar.gz
50  * cd libnxml-<version>
51  * ./configure --prefix=/usr
52  * make
53  * make install
54  * \endcode
55  *
56  * \section install2 Installation from CVS
57  * Run the following commands in a directory that you have write access to
58  * (such as your home dirctory):
59  *
60  * \code
61  * cvs -d:pserver:anonymous@ippolita.net:/home/cvs login
62  * \endcode
63  * (Just hit enter for the password)
64  * \code
65  * cvs -z3 -d:pserver:anonymous@ippolita.net:/home/cvs co libnxml
66  * \endcode
67  *
68  * Once you have checked the source of libnxml, run the following commands:
69  *
70  * \code
71  * cd libnxml
72  * ./autogen.sh
73  * ./configure --prefix=/usr
74  * make
75  * make install
76  * \endcode
77  *
78  * When there are changes to libnxml's code, you will want to update you local
79  * copy. Run from the directory libnxml:
80  *
81  * \code
82  * cvs update -dP
83  * ./configure --prefix=/usr
84  * make
85  * make install
86  * \endcode
87  *
88  * \section Support
89  *
90  * Support for nXml is available to all via email: bakunin@autistici.org.
91  *
92  * \section support1 Commercial Support
93  * Commercial users of nXml are strongly encouraged to purchase a commercial
94  * support contract, please contact me for a quotation. I will always
95  * prioritise support requests from those with support contracts.
96  *
97  * \section Donations
98  * Users not purchasing commercial support are encouraged (but not obliged) to
99  * make a donation. By donating you are supporting the principle of open
100  * source/free software and you will help ensure continued development of nXml.
101  */