[GNUnet-SVN] r14079 - libmicrohttpd-docs/WWW

[gnunet]

Author: grothoff
Date: 2010-12-24 11:21:15 +0100 (Fri, 24 Dec 2010)
New Revision: 14079

Modified:
   libmicrohttpd-docs/WWW/index.html
Log:
english

Modified: libmicrohttpd-docs/WWW/index.html
===================================================================
--- libmicrohttpd-docs/WWW/index.html   2010-12-24 09:04:57 UTC (rev 14078)
+++ libmicrohttpd-docs/WWW/index.html   2010-12-24 10:21:15 UTC (rev 14079)
@@ -5,7 +5,7 @@
 <meta name="content-language" content="en">
 <meta name="language" content="en">
 <meta name="author" content="Christian Grothoff">
-<meta name="keywords" 
content="libmicrohttpd,http,daemon,server,library,C,LGPL,eCos,free,Linux,GNU,GPL,SSL,TLS">
+<meta name="keywords" 
content="libmicrohttpd,http,daemon,server,library,C,LGPL,eCos,free,Linux,GNU,GPL,SSL,TLS,digest,authentication,SHOUTcast">
 <meta name="robots" content="index,follow">
 <meta name="revisit-after" content="28 days">
 <meta name="publisher" content="Christian Grothoff">
@@ -28,14 +28,14 @@
 <li>API is simple, expressive and fully reentrant</li>
 <li>Implementation is HTTP 1.1 compliant</li>
 <li>HTTP server can listen on multiple ports</li>
+<li>Four different threading models (select, poll, pthread, thread pool)</li>
+<li>Supported platforms include GNU/Linux, FreeBSD, OpenBSD, NetBSD, OS X, 
W32, Symbian and z/OS</li>
 <li>Support for IPv6</li>
-<li>Support for incremental processing of POST data</li>
-<li>Support for digest authentication</li>
-<li>Creates binary of only 32k (without TLS/SSL support)</li>
-<li>Four different threading models (select, poll, pthread, thread pool)</li>
-<li>Supported platforms include GNU/Linux, FreeBSD, OpenBSD, NetBSD, 
-   OS X, W32, Symbian and z/OS</li>
-<li>Optional support for SSL3 and TLS (requires libgcrypt and libgnutls)</li>
+<li>Support for SHOUTcast</li>
+<li>Support for incremental processing of POST data (optional)</li>
+<li>Support for digest authentication (optional)</li>
+<li>Support for SSL3 and TLS (requires libgcrypt and libgnutls, optional)</li>
+<li>Binary is only about 32k (without TLS/SSL support and other optional 
features)</li>
 </ul>
 libmicrohttpd was started because the author needed an easy way to add
 a concurrent HTTP server to other projects.  Existing alternatives
@@ -51,6 +51,8 @@
 href="http://www.gnu.org/licenses/lgpl.html";>GNU LGPL</a>.  If you
 disable HTTPS/SSL support, you can also choose the second license,
 the <a href="http://ecos.sourceware.org/license-overview.html";>eCos 
License</a>.
+If you have questions about licensing, please contact the 
+<a href="http://grothoff.org/christian/";>maintainer</a>.
 </p>
 <a name="download"></a>
 <h2>Download</h2>
@@ -63,7 +65,7 @@
 <pre>$ svn checkout https://gnunet.org/svn/libmicrohttpd/</pre>
 <br>
 libmicrohttpd can be used without any dependencies; however,
-for SSL/TLS support, we currently require 
+for SSL/TLS support we require 
 <a href="http://www.gnupg.org/documentation/manuals/gcrypt/";>libgcrypt</a> and
 <a href="http://www.gnutls.org/";>libgnutls</a>.
 Furthermore, the testcases use <a
@@ -96,24 +98,22 @@
  <dd>The libmicrohttpd tutorial is available as one document in 
     <a href="tutorial.pdf">pdf</a> and <a href="tutorial.html">html</a>
     formats.
-<dt><a href="coverage/">Coverage reports</a></dt>
- <dd>This link refers to code coverage reports for our testsuite.</dd>
 </dl>
 <p >
 The rest of this section gives a general overview.
 </p>
 <p >
-Before including the <tt>microhttpd.h</tt> header you must include the
+Before including the <tt>microhttpd.h</tt> header you must should the
 headers in your operating system that define the <tt>size_t</tt>,
 <tt>fd_set</tt>, <tt>socklen_t</tt> and <tt>struct sockaddr</tt> data
-types.
+types and define <tt>MHD_PLATFORM_H</tt>.  Otherwise
+the <tt>microhttpd.h</tt> header will attempt to include the
+appropriate headers automatically, which may fail for more exotic
+platforms.
 </p>
 <p>
 Here is a minimal example for GNU/Linux (included in the distribution):
 <pre>
-#include &lt;sys/types.h&gt;
-#include &lt;sys/select.h&gt;
-#include &lt;sys/socket.h&gt;
 #include &lt;microhttpd.h&gt;
 #include &lt;stdlib.h&gt;
 #include &lt;string.h&gt;
@@ -199,8 +199,9 @@
 connection would be costly.  If the HTTP server is able to quickly
 produce responses without much computational overhead for each
 connection, this model can be a great choice.  Note that MHD will
-still start a single thread -- the main program can continue with its
-operations.  Naturally, if the HTTP server needs to interact with
+still start a single thread for itself -- this way, the main program 
+can continue with its operations after calling <tt>MHD_daemon_start</tt>.  
+Naturally, if the HTTP server needs to interact with
 shared state in the main application, synchronization will be
 required.  If such synchronization in code providing a response
 results in blocking, all HTTP server operations on all connections
@@ -217,7 +218,7 @@
 The third model combines a thread pool with
 the <tt>MHD_USE_SELECT_INTERNALLY</tt> mode, which can benefit
 implementations that require scalability. As said before, by default
-this mode only uses a single thread.  With the thread pool option, it
+this mode only uses a single thread.  When combined with the thread pool 
option, it
 is possible to handle multiple connections with multiple threads.  The
 number of threads is specified using the
 <tt>MHD_OPTION_THREAD_POOL_SIZE</tt>; any value greater than one for