diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Makefile.am | 6 | ||||
-rw-r--r-- | doc/hellobrowser.inc | 2 | ||||
-rw-r--r-- | doc/introduction.inc | 18 | ||||
-rw-r--r-- | doc/tutorial.texi | 12 |
4 files changed, 18 insertions, 20 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 20973c4f..b51e9847 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am | |||
@@ -1,7 +1,7 @@ | |||
1 | man_MANS = libmicrohttpd.3 | 1 | man_MANS = libmicrohttpd.3 |
2 | EXTRA_DIST = $(man_MANS) Doxyfile | 2 | EXTRA_DIST = $(man_MANS) Doxyfile |
3 | 3 | ||
4 | DISTCLEANFILES = microhttpd.cps | 4 | DISTCLEANFILES = microhttpd.cps tutorial.cps |
5 | info_TEXINFOS = microhttpd.texi | 5 | info_TEXINFOS = microhttpd.texi tutorial.texi |
6 | microhttpd_TEXINFOS = lgpl.texi | 6 | microhttpd_TEXINFOS = lgpl.texi basicauthentication.inc bibliography.inc exploringrequests.inc fdl-1.2.texi hellobrowser.inc introduction.inc processingpost.inc responseheaders.inc |
7 | 7 | ||
diff --git a/doc/hellobrowser.inc b/doc/hellobrowser.inc index 422162af..552846f1 100644 --- a/doc/hellobrowser.inc +++ b/doc/hellobrowser.inc | |||
@@ -1,5 +1,5 @@ | |||
1 | The most basic task for a HTTP server is to deliver a static text message to any client connecting to it. | 1 | The most basic task for a HTTP server is to deliver a static text message to any client connecting to it. |
2 | Given that this is also very easy to implement, it is an excellent problem to start with. | 2 | Given that this is also easy to implement, it is an excellent problem to start with. |
3 | 3 | ||
4 | For now, the particular filename the client asks for shall have no effect on the message that will | 4 | For now, the particular filename the client asks for shall have no effect on the message that will |
5 | be returned. In addition, the server shall end the connection after the message has been sent so that | 5 | be returned. In addition, the server shall end the connection after the message has been sent so that |
diff --git a/doc/introduction.inc b/doc/introduction.inc index 3eb1248d..722d0fb7 100644 --- a/doc/introduction.inc +++ b/doc/introduction.inc | |||
@@ -1,19 +1,17 @@ | |||
1 | This tutorial is aimed at developers who want to learn how they can add HTTP serving | 1 | This tutorial is for developers who want to learn how they can add HTTP serving |
2 | capabilities to their applications with the @emph{GNU libmicrohttpd} library, | 2 | capabilities to their applications with the @emph{GNU libmicrohttpd} library, |
3 | abbreviated @emph{MHD}, and who do not know how to start. It tries to help these | 3 | abbreviated @emph{MHD}. The reader will learn how to |
4 | developers to implement common basic HTTP serving tasks by discussing executable | 4 | implement basic HTTP functions from simple executable |
5 | sample programs implementing different features. | 5 | sample programs that implement various features. |
6 | 6 | ||
7 | The text is supposed to be a supplement to the API reference manual of | 7 | The text is supposed to be a supplement to the API reference manual of |
8 | @emph{GNU libmicrohttpd} and for that reason does not explain many of the parameters. | 8 | @emph{GNU libmicrohttpd} and for that reason does not explain many of the parameters. |
9 | Therefore, the reader should always consult the manual to find the exact meaning | 9 | Therefore, the reader should always consult the manual to find the exact meaning |
10 | of the functions used in the tutorial. In the same sense, the tutorial seeks to | 10 | of the functions used in the tutorial. Furthermore, the reader is |
11 | encourage the use of the @emph{RFCs}, which document the conventions the Internet | 11 | encouraged to study the relevant @emph{RFCs}, which document the HTTP standard. |
12 | is built upon. | ||
13 | 12 | ||
14 | @emph{GNU libmicrohttpd} is assumed to be already installed and it has been | 13 | @emph{GNU libmicrohttpd} is assumed to be already installed. This tutorial |
15 | written with respect to version @value{VERSION}. As the library is still in its | 14 | is written for version @value{VERSION}. At the time being, |
16 | beta stages, later versions may show different behaviour. At the time being, | ||
17 | this tutorial has only been tested on @emph{GNU/Linux} machines even though | 15 | this tutorial has only been tested on @emph{GNU/Linux} machines even though |
18 | efforts were made not to rely on anything that would prevent the samples from being | 16 | efforts were made not to rely on anything that would prevent the samples from being |
19 | built on similar systems. | 17 | built on similar systems. |
diff --git a/doc/tutorial.texi b/doc/tutorial.texi index fed834f8..e715058a 100644 --- a/doc/tutorial.texi +++ b/doc/tutorial.texi | |||
@@ -36,8 +36,8 @@ Free Documentation License". | |||
36 | * Hello browser example:: | 36 | * Hello browser example:: |
37 | * Exploring requests:: | 37 | * Exploring requests:: |
38 | * Response headers:: | 38 | * Response headers:: |
39 | * A basic authentication:: | 39 | * Supporting basic authentication:: |
40 | * Processing post data:: | 40 | * Processing POST data:: |
41 | * Bibliography:: | 41 | * Bibliography:: |
42 | * License text:: | 42 | * License text:: |
43 | * Example programs:: | 43 | * Example programs:: |
@@ -59,12 +59,12 @@ Free Documentation License". | |||
59 | @chapter Response headers | 59 | @chapter Response headers |
60 | @include responseheaders.inc | 60 | @include responseheaders.inc |
61 | 61 | ||
62 | @node A basic authentication | 62 | @node Supporting basic authentication |
63 | @chapter A basic authentication | 63 | @chapter Supporting basic authentication |
64 | @include basicauthentication.inc | 64 | @include basicauthentication.inc |
65 | 65 | ||
66 | @node Processing post data | 66 | @node Processing POST data |
67 | @chapter Processing post data | 67 | @chapter Processing POST data |
68 | @include processingpost.inc | 68 | @include processingpost.inc |
69 | 69 | ||
70 | 70 | ||