diff options
-rw-r--r-- | doc/ecos.texi | 420 | ||||
-rw-r--r-- | doc/microhttpd.texi | 41 |
2 files changed, 453 insertions, 8 deletions
diff --git a/doc/ecos.texi b/doc/ecos.texi new file mode 100644 index 00000000..4ebe40b9 --- /dev/null +++ b/doc/ecos.texi | |||
@@ -0,0 +1,420 @@ | |||
1 | @cindex GPL, GNU General Public License | ||
2 | @cindex eCos, GNU General Public License with eCos Extension | ||
3 | @center Version 2, June 1991 | ||
4 | |||
5 | @display | ||
6 | Copyright @copyright{} 1989, 1991 Free Software Foundation, Inc. | ||
7 | 59 Temple Place -- Suite 330, Boston, MA 02111-1307, USA | ||
8 | |||
9 | Everyone is permitted to copy and distribute verbatim copies | ||
10 | of this license document, but changing it is not allowed. | ||
11 | @end display | ||
12 | |||
13 | |||
14 | |||
15 | |||
16 | @subheading Preamble | ||
17 | |||
18 | The licenses for most software are designed to take away your | ||
19 | freedom to share and change it. By contrast, the GNU General Public | ||
20 | License is intended to guarantee your freedom to share and change free | ||
21 | software---to make sure the software is free for all its users. This | ||
22 | General Public License applies to most of the Free Software | ||
23 | Foundation's software and to any other program whose authors commit to | ||
24 | using it. (Some other Free Software Foundation software is covered by | ||
25 | the GNU Library General Public License instead.) You can apply it to | ||
26 | your programs, too. | ||
27 | |||
28 | When we speak of free software, we are referring to freedom, not | ||
29 | price. Our General Public Licenses are designed to make sure that you | ||
30 | have the freedom to distribute copies of free software (and charge for | ||
31 | this service if you wish), that you receive source code or can get it | ||
32 | if you want it, that you can change the software or use pieces of it | ||
33 | in new free programs; and that you know you can do these things. | ||
34 | |||
35 | To protect your rights, we need to make restrictions that forbid | ||
36 | anyone to deny you these rights or to ask you to surrender the rights. | ||
37 | These restrictions translate to certain responsibilities for you if you | ||
38 | distribute copies of the software, or if you modify it. | ||
39 | |||
40 | For example, if you distribute copies of such a program, whether | ||
41 | gratis or for a fee, you must give the recipients all the rights that | ||
42 | you have. You must make sure that they, too, receive or can get the | ||
43 | source code. And you must show them these terms so they know their | ||
44 | rights. | ||
45 | |||
46 | We protect your rights with two steps: (1) copyright the software, and | ||
47 | (2) offer you this license which gives you legal permission to copy, | ||
48 | distribute and/or modify the software. | ||
49 | |||
50 | Also, for each author's protection and ours, we want to make certain | ||
51 | that everyone understands that there is no warranty for this free | ||
52 | software. If the software is modified by someone else and passed on, we | ||
53 | want its recipients to know that what they have is not the original, so | ||
54 | that any problems introduced by others will not reflect on the original | ||
55 | authors' reputations. | ||
56 | |||
57 | Finally, any free program is threatened constantly by software | ||
58 | patents. We wish to avoid the danger that redistributors of a free | ||
59 | program will individually obtain patent licenses, in effect making the | ||
60 | program proprietary. To prevent this, we have made it clear that any | ||
61 | patent must be licensed for everyone's free use or not licensed at all. | ||
62 | |||
63 | The precise terms and conditions for copying, distribution and | ||
64 | modification follow. | ||
65 | |||
66 | @iftex | ||
67 | @subheading TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION | ||
68 | @end iftex | ||
69 | @ifinfo | ||
70 | @center TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION | ||
71 | @end ifinfo | ||
72 | |||
73 | @enumerate | ||
74 | @item | ||
75 | This License applies to any program or other work which contains | ||
76 | a notice placed by the copyright holder saying it may be distributed | ||
77 | under the terms of this General Public License. The ``Program'', below, | ||
78 | refers to any such program or work, and a ``work based on the Program'' | ||
79 | means either the Program or any derivative work under copyright law: | ||
80 | that is to say, a work containing the Program or a portion of it, | ||
81 | either verbatim or with modifications and/or translated into another | ||
82 | language. (Hereinafter, translation is included without limitation in | ||
83 | the term ``modification''.) Each licensee is addressed as ``you''. | ||
84 | |||
85 | Activities other than copying, distribution and modification are not | ||
86 | covered by this License; they are outside its scope. The act of | ||
87 | running the Program is not restricted, and the output from the Program | ||
88 | is covered only if its contents constitute a work based on the | ||
89 | Program (independent of having been made by running the Program). | ||
90 | Whether that is true depends on what the Program does. | ||
91 | |||
92 | @item | ||
93 | You may copy and distribute verbatim copies of the Program's | ||
94 | source code as you receive it, in any medium, provided that you | ||
95 | conspicuously and appropriately publish on each copy an appropriate | ||
96 | copyright notice and disclaimer of warranty; keep intact all the | ||
97 | notices that refer to this License and to the absence of any warranty; | ||
98 | and give any other recipients of the Program a copy of this License | ||
99 | along with the Program. | ||
100 | |||
101 | You may charge a fee for the physical act of transferring a copy, and | ||
102 | you may at your option offer warranty protection in exchange for a fee. | ||
103 | |||
104 | @item | ||
105 | You may modify your copy or copies of the Program or any portion | ||
106 | of it, thus forming a work based on the Program, and copy and | ||
107 | distribute such modifications or work under the terms of Section 1 | ||
108 | above, provided that you also meet all of these conditions: | ||
109 | |||
110 | @enumerate a | ||
111 | @item | ||
112 | You must cause the modified files to carry prominent notices | ||
113 | stating that you changed the files and the date of any change. | ||
114 | |||
115 | @item | ||
116 | You must cause any work that you distribute or publish, that in | ||
117 | whole or in part contains or is derived from the Program or any | ||
118 | part thereof, to be licensed as a whole at no charge to all third | ||
119 | parties under the terms of this License. | ||
120 | |||
121 | @item | ||
122 | If the modified program normally reads commands interactively | ||
123 | when run, you must cause it, when started running for such | ||
124 | interactive use in the most ordinary way, to print or display an | ||
125 | announcement including an appropriate copyright notice and a | ||
126 | notice that there is no warranty (or else, saying that you provide | ||
127 | a warranty) and that users may redistribute the program under | ||
128 | these conditions, and telling the user how to view a copy of this | ||
129 | License. (Exception: if the Program itself is interactive but | ||
130 | does not normally print such an announcement, your work based on | ||
131 | the Program is not required to print an announcement.) | ||
132 | @end enumerate | ||
133 | |||
134 | These requirements apply to the modified work as a whole. If | ||
135 | identifiable sections of that work are not derived from the Program, | ||
136 | and can be reasonably considered independent and separate works in | ||
137 | themselves, then this License, and its terms, do not apply to those | ||
138 | sections when you distribute them as separate works. But when you | ||
139 | distribute the same sections as part of a whole which is a work based | ||
140 | on the Program, the distribution of the whole must be on the terms of | ||
141 | this License, whose permissions for other licensees extend to the | ||
142 | entire whole, and thus to each and every part regardless of who wrote it. | ||
143 | |||
144 | Thus, it is not the intent of this section to claim rights or contest | ||
145 | your rights to work written entirely by you; rather, the intent is to | ||
146 | exercise the right to control the distribution of derivative or | ||
147 | collective works based on the Program. | ||
148 | |||
149 | In addition, mere aggregation of another work not based on the Program | ||
150 | with the Program (or with a work based on the Program) on a volume of | ||
151 | a storage or distribution medium does not bring the other work under | ||
152 | the scope of this License. | ||
153 | |||
154 | @item | ||
155 | You may copy and distribute the Program (or a work based on it, | ||
156 | under Section 2) in object code or executable form under the terms of | ||
157 | Sections 1 and 2 above provided that you also do one of the following: | ||
158 | |||
159 | @enumerate a | ||
160 | @item | ||
161 | Accompany it with the complete corresponding machine-readable | ||
162 | source code, which must be distributed under the terms of Sections | ||
163 | 1 and 2 above on a medium customarily used for software interchange; or, | ||
164 | |||
165 | @item | ||
166 | Accompany it with a written offer, valid for at least three | ||
167 | years, to give any third party, for a charge no more than your | ||
168 | cost of physically performing source distribution, a complete | ||
169 | machine-readable copy of the corresponding source code, to be | ||
170 | distributed under the terms of Sections 1 and 2 above on a medium | ||
171 | customarily used for software interchange; or, | ||
172 | |||
173 | @item | ||
174 | Accompany it with the information you received as to the offer | ||
175 | to distribute corresponding source code. (This alternative is | ||
176 | allowed only for noncommercial distribution and only if you | ||
177 | received the program in object code or executable form with such | ||
178 | an offer, in accord with Subsection b above.) | ||
179 | @end enumerate | ||
180 | |||
181 | The source code for a work means the preferred form of the work for | ||
182 | making modifications to it. For an executable work, complete source | ||
183 | code means all the source code for all modules it contains, plus any | ||
184 | associated interface definition files, plus the scripts used to | ||
185 | control compilation and installation of the executable. However, as a | ||
186 | special exception, the source code distributed need not include | ||
187 | anything that is normally distributed (in either source or binary | ||
188 | form) with the major components (compiler, kernel, and so on) of the | ||
189 | operating system on which the executable runs, unless that component | ||
190 | itself accompanies the executable. | ||
191 | |||
192 | If distribution of executable or object code is made by offering | ||
193 | access to copy from a designated place, then offering equivalent | ||
194 | access to copy the source code from the same place counts as | ||
195 | distribution of the source code, even though third parties are not | ||
196 | compelled to copy the source along with the object code. | ||
197 | |||
198 | @item | ||
199 | You may not copy, modify, sublicense, or distribute the Program | ||
200 | except as expressly provided under this License. Any attempt | ||
201 | otherwise to copy, modify, sublicense or distribute the Program is | ||
202 | void, and will automatically terminate your rights under this License. | ||
203 | However, parties who have received copies, or rights, from you under | ||
204 | this License will not have their licenses terminated so long as such | ||
205 | parties remain in full compliance. | ||
206 | |||
207 | @item | ||
208 | You are not required to accept this License, since you have not | ||
209 | signed it. However, nothing else grants you permission to modify or | ||
210 | distribute the Program or its derivative works. These actions are | ||
211 | prohibited by law if you do not accept this License. Therefore, by | ||
212 | modifying or distributing the Program (or any work based on the | ||
213 | Program), you indicate your acceptance of this License to do so, and | ||
214 | all its terms and conditions for copying, distributing or modifying | ||
215 | the Program or works based on it. | ||
216 | |||
217 | @item | ||
218 | Each time you redistribute the Program (or any work based on the | ||
219 | Program), the recipient automatically receives a license from the | ||
220 | original licensor to copy, distribute or modify the Program subject to | ||
221 | these terms and conditions. You may not impose any further | ||
222 | restrictions on the recipients' exercise of the rights granted herein. | ||
223 | You are not responsible for enforcing compliance by third parties to | ||
224 | this License. | ||
225 | |||
226 | @item | ||
227 | If, as a consequence of a court judgment or allegation of patent | ||
228 | infringement or for any other reason (not limited to patent issues), | ||
229 | conditions are imposed on you (whether by court order, agreement or | ||
230 | otherwise) that contradict the conditions of this License, they do not | ||
231 | excuse you from the conditions of this License. If you cannot | ||
232 | distribute so as to satisfy simultaneously your obligations under this | ||
233 | License and any other pertinent obligations, then as a consequence you | ||
234 | may not distribute the Program at all. For example, if a patent | ||
235 | license would not permit royalty-free redistribution of the Program by | ||
236 | all those who receive copies directly or indirectly through you, then | ||
237 | the only way you could satisfy both it and this License would be to | ||
238 | refrain entirely from distribution of the Program. | ||
239 | |||
240 | If any portion of this section is held invalid or unenforceable under | ||
241 | any particular circumstance, the balance of the section is intended to | ||
242 | apply and the section as a whole is intended to apply in other | ||
243 | circumstances. | ||
244 | |||
245 | It is not the purpose of this section to induce you to infringe any | ||
246 | patents or other property right claims or to contest validity of any | ||
247 | such claims; this section has the sole purpose of protecting the | ||
248 | integrity of the free software distribution system, which is | ||
249 | implemented by public license practices. Many people have made | ||
250 | generous contributions to the wide range of software distributed | ||
251 | through that system in reliance on consistent application of that | ||
252 | system; it is up to the author/donor to decide if he or she is willing | ||
253 | to distribute software through any other system and a licensee cannot | ||
254 | impose that choice. | ||
255 | |||
256 | This section is intended to make thoroughly clear what is believed to | ||
257 | be a consequence of the rest of this License. | ||
258 | |||
259 | @item | ||
260 | If the distribution and/or use of the Program is restricted in | ||
261 | certain countries either by patents or by copyrighted interfaces, the | ||
262 | original copyright holder who places the Program under this License | ||
263 | may add an explicit geographical distribution limitation excluding | ||
264 | those countries, so that distribution is permitted only in or among | ||
265 | countries not thus excluded. In such case, this License incorporates | ||
266 | the limitation as if written in the body of this License. | ||
267 | |||
268 | @item | ||
269 | The Free Software Foundation may publish revised and/or new versions | ||
270 | of the General Public License from time to time. Such new versions will | ||
271 | be similar in spirit to the present version, but may differ in detail to | ||
272 | address new problems or concerns. | ||
273 | |||
274 | Each version is given a distinguishing version number. If the Program | ||
275 | specifies a version number of this License which applies to it and ``any | ||
276 | later version'', you have the option of following the terms and conditions | ||
277 | either of that version or of any later version published by the Free | ||
278 | Software Foundation. If the Program does not specify a version number of | ||
279 | this License, you may choose any version ever published by the Free Software | ||
280 | Foundation. | ||
281 | |||
282 | @item | ||
283 | If you wish to incorporate parts of the Program into other free | ||
284 | programs whose distribution conditions are different, write to the author | ||
285 | to ask for permission. For software which is copyrighted by the Free | ||
286 | Software Foundation, write to the Free Software Foundation; we sometimes | ||
287 | make exceptions for this. Our decision will be guided by the two goals | ||
288 | of preserving the free status of all derivatives of our free software and | ||
289 | of promoting the sharing and reuse of software generally. | ||
290 | |||
291 | @iftex | ||
292 | @heading NO WARRANTY | ||
293 | @end iftex | ||
294 | @ifinfo | ||
295 | @center NO WARRANTY | ||
296 | @end ifinfo | ||
297 | |||
298 | @item | ||
299 | BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY | ||
300 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN | ||
301 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES | ||
302 | PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED | ||
303 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF | ||
304 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS | ||
305 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE | ||
306 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, | ||
307 | REPAIR OR CORRECTION. | ||
308 | |||
309 | @item | ||
310 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING | ||
311 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR | ||
312 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, | ||
313 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING | ||
314 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED | ||
315 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY | ||
316 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER | ||
317 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE | ||
318 | POSSIBILITY OF SUCH DAMAGES. | ||
319 | |||
320 | @iftex | ||
321 | @heading ECOS EXTENSION | ||
322 | @end iftex | ||
323 | @ifinfo | ||
324 | @center ECOS EXTENSION | ||
325 | @end ifinfo | ||
326 | |||
327 | |||
328 | @item | ||
329 | As a special exception, if other files instantiate templates or use | ||
330 | macros or inline functions from this file, or you compile this file | ||
331 | and link it with other works to produce a work based on this file, | ||
332 | this file does not by itself cause the resulting work to be covered by | ||
333 | the GNU General Public License. However the source code for this file | ||
334 | must still be made available in accordance with section (3) of the GNU | ||
335 | General Public License v2. | ||
336 | |||
337 | This exception does not invalidate any other reasons why a work based | ||
338 | on this file might be covered by the GNU General Public License. | ||
339 | |||
340 | @end enumerate | ||
341 | |||
342 | |||
343 | @iftex | ||
344 | @heading END OF TERMS AND CONDITIONS | ||
345 | @end iftex | ||
346 | @ifinfo | ||
347 | @center END OF TERMS AND CONDITIONS | ||
348 | @end ifinfo | ||
349 | |||
350 | @page | ||
351 | @unnumberedsec How to Apply These Terms to Your New Programs | ||
352 | |||
353 | If you develop a new program, and you want it to be of the greatest | ||
354 | possible use to the public, the best way to achieve this is to make it | ||
355 | free software which everyone can redistribute and change under these terms. | ||
356 | |||
357 | To do so, attach the following notices to the program. It is safest | ||
358 | to attach them to the start of each source file to most effectively | ||
359 | convey the exclusion of warranty; and each file should have at least | ||
360 | the ``copyright'' line and a pointer to where the full notice is found. | ||
361 | |||
362 | @smallexample | ||
363 | @var{one line to give the program's name and an idea of what it does.} | ||
364 | Copyright (C) 19@var{yy} @var{name of author} | ||
365 | |||
366 | This program is free software; you can redistribute it and/or | ||
367 | modify it under the terms of the GNU General Public License | ||
368 | as published by the Free Software Foundation; either version 2 | ||
369 | of the License, or (at your option) any later version. | ||
370 | |||
371 | This program is distributed in the hope that it will be useful, | ||
372 | but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
373 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
374 | GNU General Public License for more details. | ||
375 | |||
376 | You should have received a copy of the GNU General Public License along | ||
377 | with this program; if not, write to the Free Software Foundation, Inc., | ||
378 | 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. | ||
379 | @end smallexample | ||
380 | |||
381 | Also add information on how to contact you by electronic and paper mail. | ||
382 | |||
383 | If the program is interactive, make it output a short notice like this | ||
384 | when it starts in an interactive mode: | ||
385 | |||
386 | @smallexample | ||
387 | Gnomovision version 69, Copyright (C) 19@var{yy} @var{name of author} | ||
388 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details | ||
389 | type `show w'. This is free software, and you are welcome | ||
390 | to redistribute it under certain conditions; type `show c' | ||
391 | for details. | ||
392 | @end smallexample | ||
393 | |||
394 | The hypothetical commands @samp{show w} and @samp{show c} should show | ||
395 | the appropriate parts of the General Public License. Of course, the | ||
396 | commands you use may be called something other than @samp{show w} and | ||
397 | @samp{show c}; they could even be mouse-clicks or menu items---whatever | ||
398 | suits your program. | ||
399 | |||
400 | You should also get your employer (if you work as a programmer) or your | ||
401 | school, if any, to sign a ``copyright disclaimer'' for the program, if | ||
402 | necessary. Here is a sample; alter the names: | ||
403 | |||
404 | @smallexample | ||
405 | @group | ||
406 | Yoyodyne, Inc., hereby disclaims all copyright | ||
407 | interest in the program `Gnomovision' | ||
408 | (which makes passes at compilers) written | ||
409 | by James Hacker. | ||
410 | |||
411 | @var{signature of Ty Coon}, 1 April 1989 | ||
412 | Ty Coon, President of Vice | ||
413 | @end group | ||
414 | @end smallexample | ||
415 | |||
416 | This General Public License does not permit incorporating your program into | ||
417 | proprietary programs. If your program is a subroutine library, you may | ||
418 | consider it more useful to permit linking proprietary applications with the | ||
419 | library. If this is what you want to do, use the GNU Library General | ||
420 | Public License instead of this License. | ||
diff --git a/doc/microhttpd.texi b/doc/microhttpd.texi index 8a3544d0..90a73080 100644 --- a/doc/microhttpd.texi +++ b/doc/microhttpd.texi | |||
@@ -127,8 +127,10 @@ GNU libmicrohttpd is a GNU package. | |||
127 | 127 | ||
128 | Appendices | 128 | Appendices |
129 | 129 | ||
130 | * Copying:: The GNU Lesser General Public License says how you | 130 | * GNU-LGPL:: The GNU Lesser General Public License says how you |
131 | can copy and share some parts of `libmicrohttpd'. | 131 | can copy and share almost all of `libmicrohttpd'. |
132 | * GNU GPL with eCos Extension:: The GNU General Public License with eCos extension says how you | ||
133 | can copy and share some parts of `libmicrohttpd'. | ||
132 | * GNU-FDL:: The GNU Free Documentation License says how you | 134 | * GNU-FDL:: The GNU Free Documentation License says how you |
133 | can copy and share the documentation of `libmicrohttpd'. | 135 | can copy and share the documentation of `libmicrohttpd'. |
134 | 136 | ||
@@ -214,6 +216,7 @@ Symbian. | |||
214 | No options selected. | 216 | No options selected. |
215 | 217 | ||
216 | @item MHD_USE_DEBUG | 218 | @item MHD_USE_DEBUG |
219 | @cindex debugging | ||
217 | Run in debug mode. If this flag is used, the library should print error | 220 | Run in debug mode. If this flag is used, the library should print error |
218 | messages and warnings to stderr. Note that @mhd{} also needs to be | 221 | messages and warnings to stderr. Note that @mhd{} also needs to be |
219 | compiled with the configure option @code{--enable-messages} for this | 222 | compiled with the configure option @code{--enable-messages} for this |
@@ -229,6 +232,7 @@ Run using one thread per connection. | |||
229 | Run using an internal thread doing @code{SELECT}. | 232 | Run using an internal thread doing @code{SELECT}. |
230 | 233 | ||
231 | @item MHD_USE_IPv6 | 234 | @item MHD_USE_IPv6 |
235 | @cindex IPv6 | ||
232 | Run using the IPv6 protocol (otherwise, @mhd{} will just support IPv4). | 236 | Run using the IPv6 protocol (otherwise, @mhd{} will just support IPv4). |
233 | 237 | ||
234 | 238 | ||
@@ -254,11 +258,13 @@ No more options / last option. This is used to terminate the VARARGs | |||
254 | list. | 258 | list. |
255 | 259 | ||
256 | @item MHD_OPTION_CONNECTION_MEMORY_LIMIT | 260 | @item MHD_OPTION_CONNECTION_MEMORY_LIMIT |
261 | @cindex memory, limiting memory utilization | ||
257 | Maximum memory size per connection (followed by a @code{size_t}). The | 262 | Maximum memory size per connection (followed by a @code{size_t}). The |
258 | default is 32 kB (32*1024 bytes) as defined by the internal constant | 263 | default is 32 kB (32*1024 bytes) as defined by the internal constant |
259 | @code{MHD_POOL_SIZE_DEFAULT}. | 264 | @code{MHD_POOL_SIZE_DEFAULT}. |
260 | 265 | ||
261 | @item MHD_OPTION_CONNECTION_LIMIT | 266 | @item MHD_OPTION_CONNECTION_LIMIT |
267 | @cindex connection, limiting number of connections | ||
262 | Maximum number of concurrenct connections to accept (followed by an | 268 | Maximum number of concurrenct connections to accept (followed by an |
263 | @code{unsigned int}). The default is @code{FD_SETSIZE - 4} (the | 269 | @code{unsigned int}). The default is @code{FD_SETSIZE - 4} (the |
264 | maximum number of file descriptors supported by @code{select} minus | 270 | maximum number of file descriptors supported by @code{select} minus |
@@ -266,6 +272,7 @@ four for @code{stdin}, @code{stdout}, @code{stderr} and the server | |||
266 | socket). In other words, the default is as large as possible. | 272 | socket). In other words, the default is as large as possible. |
267 | 273 | ||
268 | @item MHD_OPTION_CONNECTION_TIMEOUT | 274 | @item MHD_OPTION_CONNECTION_TIMEOUT |
275 | @cindex timeout | ||
269 | After how many seconds of inactivity should a connection automatically | 276 | After how many seconds of inactivity should a connection automatically |
270 | be timed out? (followed by an @code{unsigned int}; use zero for no | 277 | be timed out? (followed by an @code{unsigned int}; use zero for no |
271 | timeout). The default is zero (no timeout). | 278 | timeout). The default is zero (no timeout). |
@@ -294,6 +301,7 @@ zero, which means no limit on the number of connections | |||
294 | from the same IP address. | 301 | from the same IP address. |
295 | 302 | ||
296 | @item MHD_OPTION_SOCK_ADDR | 303 | @item MHD_OPTION_SOCK_ADDR |
304 | @cindex bind, restricting bind | ||
297 | Bind daemon to the supplied socket address. This option should be followed by a | 305 | Bind daemon to the supplied socket address. This option should be followed by a |
298 | @code{struct sockaddr *}. If @code{MHD_USE_IPv6} is specified, | 306 | @code{struct sockaddr *}. If @code{MHD_USE_IPv6} is specified, |
299 | the @code{struct sockaddr*} should point to a @code{struct sockaddr_in6}, | 307 | the @code{struct sockaddr*} should point to a @code{struct sockaddr_in6}, |
@@ -301,6 +309,9 @@ otherwise to a @code{struct sockaddr_in}. If this option is not specified, | |||
301 | the daemon will listen to incomming connections from anywhere. | 309 | the daemon will listen to incomming connections from anywhere. |
302 | 310 | ||
303 | @item MHD_OPTION_URI_LOG_CALLBACK | 311 | @item MHD_OPTION_URI_LOG_CALLBACK |
312 | @cindex debugging | ||
313 | @cindex logging | ||
314 | @cindex query string | ||
304 | Specify a function that should be called before parsing the URI from | 315 | Specify a function that should be called before parsing the URI from |
305 | the client. The specified callback function can be used for processing | 316 | the client. The specified callback function can be used for processing |
306 | the URI (including the options) before it is parsed. The URI after | 317 | the URI (including the options) before it is parsed. The URI after |
@@ -352,6 +363,7 @@ representing the cipher priority order to which the HTTPS | |||
352 | daemon should adhere. | 363 | daemon should adhere. |
353 | 364 | ||
354 | @item MHD_OPTION_EXTERNAL_LOGGER | 365 | @item MHD_OPTION_EXTERNAL_LOGGER |
366 | @cindex logging | ||
355 | Use the given function for logging error messages. | 367 | Use the given function for logging error messages. |
356 | This option must be followed by two arguments; the | 368 | This option must be followed by two arguments; the |
357 | first must be a pointer to a function | 369 | first must be a pointer to a function |
@@ -379,10 +391,12 @@ Response header. | |||
379 | @http{} header. | 391 | @http{} header. |
380 | 392 | ||
381 | @item MHD_COOKIE_KIND | 393 | @item MHD_COOKIE_KIND |
394 | @cindex cookie | ||
382 | Cookies. Note that the original @http{} header containing the cookie(s) | 395 | Cookies. Note that the original @http{} header containing the cookie(s) |
383 | will still be available and intact. | 396 | will still be available and intact. |
384 | 397 | ||
385 | @item MHD_POSTDATA_KIND | 398 | @item MHD_POSTDATA_KIND |
399 | @cindex POST method | ||
386 | @code{POST} data. This is available only if a content encoding | 400 | @code{POST} data. This is available only if a content encoding |
387 | supported by @mhd{} is used (currently only @acronym{URL} encoding), and | 401 | supported by @mhd{} is used (currently only @acronym{URL} encoding), and |
388 | only if the posted content fits within the available memory pool. Note | 402 | only if the posted content fits within the available memory pool. Note |
@@ -494,6 +508,7 @@ algorithm. The cipher algorithm should be passed as an extra argument | |||
494 | (of type 'enum MHD_GNUTLS_HashAlgorithm'). | 508 | (of type 'enum MHD_GNUTLS_HashAlgorithm'). |
495 | 509 | ||
496 | @item MHD_DAEMON_INFO_LISTEN_FD | 510 | @item MHD_DAEMON_INFO_LISTEN_FD |
511 | @cindex listen | ||
497 | Request the file-descriptor number that MHD is using to listen to the | 512 | Request the file-descriptor number that MHD is using to listen to the |
498 | server socket. This can be useful if no port | 513 | server socket. This can be useful if no port |
499 | was specified and a client needs to learn what port | 514 | was specified and a client needs to learn what port |
@@ -529,6 +544,7 @@ Handle for a response. | |||
529 | 544 | ||
530 | 545 | ||
531 | @deftp {C Struct} MHD_PostProcessor | 546 | @deftp {C Struct} MHD_PostProcessor |
547 | @cindex POST method | ||
532 | Handle for @code{POST} processing. | 548 | Handle for @code{POST} processing. |
533 | @end deftp | 549 | @end deftp |
534 | 550 | ||
@@ -595,6 +611,8 @@ the @http{} version string (i.e. @code{HTTP/1.1}); | |||
595 | 611 | ||
596 | @item upload_data | 612 | @item upload_data |
597 | the data being uploaded (excluding headers): | 613 | the data being uploaded (excluding headers): |
614 | @cindex POST method | ||
615 | @cindex PUT method | ||
598 | 616 | ||
599 | @itemize | 617 | @itemize |
600 | @item | 618 | @item |
@@ -829,13 +847,14 @@ the right options for this call. | |||
829 | 847 | ||
830 | 848 | ||
831 | @deftypefun int MHD_get_timeout (struct MHD_Daemon *daemon, unsigned long long *timeout) | 849 | @deftypefun int MHD_get_timeout (struct MHD_Daemon *daemon, unsigned long long *timeout) |
850 | @cindex timeout | ||
832 | Obtain timeout value for select for this daemon (only needed if | 851 | Obtain timeout value for select for this daemon (only needed if |
833 | connection timeout is used). The returned value is how long | 852 | connection timeout is used). The returned value is how long |
834 | @cfunction{select} should at most block, not the timeout value set for | 853 | @cfunction{select} should at most block, not the timeout value set for |
835 | connections. | 854 | connections. |
836 | 855 | ||
837 | @table @var | 856 | @table @var |
838 | @item timeout | 857 | @cindex timeout |
839 | set to the timeout (in milliseconds). | 858 | set to the timeout (in milliseconds). |
840 | @end table | 859 | @end table |
841 | 860 | ||
@@ -1150,7 +1169,7 @@ We should not modify the value, unless we know what we are doing. | |||
1150 | @c ------------------------------------------------------------ | 1169 | @c ------------------------------------------------------------ |
1151 | @node microhttpd-post | 1170 | @node microhttpd-post |
1152 | @chapter Adding a @code{POST} processor | 1171 | @chapter Adding a @code{POST} processor |
1153 | 1172 | @cindex POST method | |
1154 | 1173 | ||
1155 | @menu | 1174 | @menu |
1156 | * microhttpd-post api:: Programming interface for the | 1175 | * microhttpd-post api:: Programming interface for the |
@@ -1246,8 +1265,7 @@ always terminate normally. | |||
1246 | @c ------------------------------------------------------------ | 1265 | @c ------------------------------------------------------------ |
1247 | @node microhttpd-post api | 1266 | @node microhttpd-post api |
1248 | @section Programming interface for the @code{POST} processor | 1267 | @section Programming interface for the @code{POST} processor |
1249 | 1268 | @cindex POST method | |
1250 | |||
1251 | 1269 | ||
1252 | @deftypefun {struct MHD_PostProcessor *} MHD_create_post_processor (struct MHD_Connection *connection, size_t buffer_size, MHD_PostDataIterator iterator, void *iterator_cls) | 1270 | @deftypefun {struct MHD_PostProcessor *} MHD_create_post_processor (struct MHD_Connection *connection, size_t buffer_size, MHD_PostDataIterator iterator, void *iterator_cls) |
1253 | Create a PostProcessor. A PostProcessor can be used to (incrementally) | 1271 | Create a PostProcessor. A PostProcessor can be used to (incrementally) |
@@ -1388,12 +1406,19 @@ applicable. | |||
1388 | @c ******************* Appendices ************************* | 1406 | @c ******************* Appendices ************************* |
1389 | @c ********************************************************** | 1407 | @c ********************************************************** |
1390 | 1408 | ||
1391 | @node Copying | 1409 | @node GNU-LGPL |
1392 | @unnumbered Copying | 1410 | @unnumbered GNU-LGPL |
1411 | @cindex license | ||
1393 | @include lgpl.texi | 1412 | @include lgpl.texi |
1394 | 1413 | ||
1414 | @node GNU GPL with eCos Extension | ||
1415 | @unnumbered GNU GPL with eCos Extension | ||
1416 | @cindex license | ||
1417 | @include ecos.texi | ||
1418 | |||
1395 | @node GNU-FDL | 1419 | @node GNU-FDL |
1396 | @unnumbered GNU-FDL | 1420 | @unnumbered GNU-FDL |
1421 | @cindex license | ||
1397 | @include fdl-1.3.texi | 1422 | @include fdl-1.3.texi |
1398 | 1423 | ||
1399 | @node Concept Index | 1424 | @node Concept Index |