diff options
Diffstat (limited to 'doc/microhttpd.texi')
-rw-r--r-- | doc/microhttpd.texi | 74 |
1 files changed, 73 insertions, 1 deletions
diff --git a/doc/microhttpd.texi b/doc/microhttpd.texi index 63aca697..bb5e03a5 100644 --- a/doc/microhttpd.texi +++ b/doc/microhttpd.texi | |||
@@ -190,6 +190,65 @@ Examples based on reports we've received from developers include: | |||
190 | @c If you have other interesting examples, please let us know | 190 | @c If you have other interesting examples, please let us know |
191 | @end itemize | 191 | @end itemize |
192 | 192 | ||
193 | |||
194 | @section Compiling GNU libmicrohttpd | ||
195 | @cindex compilation | ||
196 | @cindex embedded systems | ||
197 | @cindex portability | ||
198 | |||
199 | @mhd{} uses the standard GNU system where the usual build process | ||
200 | involves running | ||
201 | @verbatim | ||
202 | $ ./configure | ||
203 | $ make | ||
204 | $ make install | ||
205 | @end verbatim | ||
206 | |||
207 | @mhd{} supports various options to be given to configure to tailor the | ||
208 | binary to a specific situation. Note that some of these options will | ||
209 | remove portions of the @mhd{} code that are required for | ||
210 | binary-compatibility. They should only be used on embedded systems | ||
211 | with tight resource constraints and no concerns about library | ||
212 | versioning. Standard distributions including @mhd{} are expected to | ||
213 | always ship with all features enabled, otherwise unexpected | ||
214 | incompatibilities can arise! | ||
215 | |||
216 | Here is a list of @mhd{}-specific options that can be given to configure | ||
217 | (canonical configure options such as ``--prefix'' are also supported, for a | ||
218 | full list of options run ``./configure --help''): | ||
219 | |||
220 | @table | ||
221 | @item ``--disable-curl'' | ||
222 | disable running testcases using libcurl | ||
223 | |||
224 | @item ``--disable-largefile'' | ||
225 | disable support for 64-bit files | ||
226 | |||
227 | @item ``--disable-messages'' | ||
228 | disable logging of error messages (smaller binary size, not so much fun for debugging) | ||
229 | |||
230 | @item ``--disable-https'' | ||
231 | disable HTTPS support, even if GNUtls is found; this option must be used if eCOS license is desired as an option (in all cases the resulting binary falls under a GNU LGPL-only license) | ||
232 | |||
233 | @item ``--disable-postprocessor'' | ||
234 | do not include the post processor API (results in binary incompatibility) | ||
235 | |||
236 | @item ``--disable-dauth'' | ||
237 | do not include the authentication APIs (results in binary incompatibility) | ||
238 | |||
239 | @item ``--enable-coverage'' | ||
240 | set flags for analysis of code-coverage with gcc/gcov (results in slow, large binaries) | ||
241 | |||
242 | @item ``--with-gcrypt=PATH'' | ||
243 | specifies path to libgcrypt installation | ||
244 | |||
245 | @item ``--with-gnutls=PATH'' | ||
246 | specifies path to libgnutls installation | ||
247 | |||
248 | |||
249 | |||
250 | @end table | ||
251 | |||
193 | @section Including the microhttpd.h header | 252 | @section Including the microhttpd.h header |
194 | @cindex portability | 253 | @cindex portability |
195 | @cindex microhttpd.h | 254 | @cindex microhttpd.h |
@@ -256,6 +315,7 @@ ignore_sigpipe () | |||
256 | @cindex IAR | 315 | @cindex IAR |
257 | @cindex ARM | 316 | @cindex ARM |
258 | @cindex cortex m3 | 317 | @cindex cortex m3 |
318 | @cindex embedded systems | ||
259 | 319 | ||
260 | Some platforms do not support @code{long long}. Hence MHD defines | 320 | Some platforms do not support @code{long long}. Hence MHD defines |
261 | a macro @code{MHD_LONG_LONG} which will default to @code{long long}. | 321 | a macro @code{MHD_LONG_LONG} which will default to @code{long long}. |
@@ -329,6 +389,15 @@ Use poll instead of select. This allows sockets with descriptors | |||
329 | @code{>= FD_SETSIZE}. This option only works in conjunction with | 389 | @code{>= FD_SETSIZE}. This option only works in conjunction with |
330 | @code{MHD_USE_THREAD_PER_CONNECTION} (at this point). | 390 | @code{MHD_USE_THREAD_PER_CONNECTION} (at this point). |
331 | 391 | ||
392 | @item MHD_SUPPRESS_DATE_NO_CLOCK | ||
393 | @cindex date | ||
394 | @cindex clock | ||
395 | @cindex embedded systems | ||
396 | Suppress (automatically) adding the 'Date:' header to HTTP responses. | ||
397 | This option should ONLY be used on systems that do not have a clock | ||
398 | and that DO provide other mechanisms for cache control. See also | ||
399 | RFC 2616, section 14.18 (exception 3). | ||
400 | |||
332 | @end table | 401 | @end table |
333 | @end deftp | 402 | @end deftp |
334 | 403 | ||
@@ -598,7 +667,10 @@ MHD_OPTION_UNESCAPE_CALLBACK. | |||
598 | 667 | ||
599 | 668 | ||
600 | @item MHD_OPTION_THREAD_STACK_SIZE | 669 | @item MHD_OPTION_THREAD_STACK_SIZE |
601 | @cindex stack, thread, pthread | 670 | @cindex stack |
671 | @cindex thread | ||
672 | @cindex pthread | ||
673 | @cindex embedded systems | ||
602 | Maximum stack size for threads created by MHD. This option must be | 674 | Maximum stack size for threads created by MHD. This option must be |
603 | followed by a @code{size_t}). Not specifying this option or using | 675 | followed by a @code{size_t}). Not specifying this option or using |
604 | a value of zero means using the system default (which is likely to | 676 | a value of zero means using the system default (which is likely to |