main.doxy

Go to the documentation of this file.
00001 /*!\mainpage mRss Library
00002  *
00003  * \section Author
00004  * Andrea Marchesini <bakunin@autistici.org> - Web Site: 
00005  * http://www.autistici.org/bakunin/
00006  *
00007  * \section Description
00008  *
00009  * mRss is a C library for parsing, writing and creating RSS/ATOM files or
00010  * streams. This library can be also used not only in C or C++, but also
00011  * in PHP with the PHP extension.
00012  * 
00013  * This library supports:
00014  * - RSS 0.91 - http://my.netscape.com/publish/formats/rss-spec-0.91.html
00015  * - RSS 0.92 - http://backend.userland.com/rss092
00016  * - RSS 1.0  - http://web.resource.org/rss/1.0/
00017  * - RSS 2.0  - http://www.rssboard.org/rss-specification
00018  * - ATOM 0.3 - http://www.mnot.net/drafts/draft-nottingham-atom-format-02.html
00019  * - ATOM 1.0 - http://tools.ietf.org/html/rfc4287
00020  *
00021  * \section License
00022  *
00023  * mRss is a FreeSoftware project released under
00024  * <a href="http://www.gnu.org/licenses/lgpl.html">LGPL 2.0</a>.
00025  *
00026  * \section Required
00027  *
00028  * - <a href="http://www.autistici.org/bakunin/libnxml/">nXML</a> is a C
00029  * library for parsing, writing and creating XML 1.0 and 1.1 files or streams.
00030  * It supports utf-8, utf-16be and utf-16le, ucs-4 (1234, 4321, 2143, 2312).
00031  * - <a href="http://curl.haxx.se/">libcurl</a> is a free and easy-to-use 
00032  * client-side URL transfer library, supporting FTP, FTPS, HTTP, HTTPS, SCP, 
00033  * SFTP, TFTP, TELNET, DICT, FILE and LDAP. libcurl supports SSL certificates, 
00034  * HTTP POST, HTTP PUT, FTP uploading, HTTP form based upload, proxies, 
00035  * cookies, user+password authentication (Basic, Digest, NTLM, Negotiate, 
00036  * Kerberos4), file transfer resume, http proxy tunneling and more!
00037  *
00038  * For the PHP extension:
00039  * - php http://www.php.net/
00040  *
00041  * \section Download
00042  *
00043  * - libmrss http://www.autistici.org/bakunin/libmrss/
00044  *
00045  * \section install1 Installation from source
00046  *
00047  * \code
00048  * tar xvfz libmrss-<version>.tar.gz
00049  * cd libmrss-<version>
00050  * ./configure --prefix=/usr
00051  * make
00052  * make install
00053  * \endcode
00054  *
00055  * If you want the PHP extension:
00056  *
00057  * \code
00058  * cd phpmrss
00059  * ./phpmrss_install.sh
00060  * \endcode
00061  *
00062  * \section install2 Installation from CVS
00063  * Run the following commands in a directory that you have write access to
00064  * (such as your home dirctory):
00065  *
00066  * \code
00067  * cvs -d:pserver:anonymous@ippolita.net:/home/cvs login
00068  * \endcode
00069  * (Just hit enter for the password)
00070  * \code
00071  * cvs -z3 -d:pserver:anonymous@ippolita.net:/home/cvs co libmrss
00072  * \endcode
00073  *
00074  * Once you have checked the source of libmrss, run the following commands:
00075  *
00076  * \code
00077  * cd libmrss
00078  * ./autogen.sh
00079  * ./configure --prefix=/usr
00080  * make
00081  * make install
00082  * \endcode
00083  *
00084  * When there are changes to libmrss's code, you will want to update you local
00085  * copy. Run from the directory libmrss:
00086  *
00087  * \code
00088  * cvs update -dP
00089  * ./autogen.sh
00090  * ./configure --prefix=/usr
00091  * make
00092  * make install
00093  * \endcode
00094  *
00095  * \section Support
00096  *
00097  * Support for mRss is available to all via email: bakunin@autistici.org.
00098  *
00099  * \section support1 Commercial Support
00100  * Commercial users of mRss are strongly encouraged to purchase a commercial
00101  * support contract, please contact me for a quotation. I will always
00102  * prioritise support requests from those with support contracts.
00103  *
00104  * \section Donations
00105  * Users not purchasing commercial support are encouraged (but not obliged) to
00106  * make a donation. By donating you are supporting the principle of open
00107  * source software and you will help ensure continued development of mRss.
00108  */

Generated on Fri Aug 22 00:03:56 2008 for libmrss by  doxygen 1.5.5