mirror of
https://github.com/civetweb/civetweb
synced 2025-03-28 21:13:27 +00:00
spelling: Fix docs/* issues.
Signed-off-by: Mario Trangoni <mjtrangoni@gmail.com>
This commit is contained in:
Mario Trangoni
parent
c6e4e33b78
commit
1070fc9ca6
@ -163,7 +163,7 @@ make build COPT="-DNDEBUG -DNO_CGI"
|
||||
| | |
|
||||
| `USE_ALPN` | enable Application-Level-Protocol-Negotiation, required for HTTP2 |
|
||||
| `USE_DUKTAPE` | enable server-side JavaScript (using Duktape library) |
|
||||
| `USE_HTTP2` | enable HTTP2 support (experimental, not reccomended for production) |
|
||||
| `USE_HTTP2` | enable HTTP2 support (experimental, not recommended for production) |
|
||||
| `USE_IPV6` | enable IPv6 support |
|
||||
| `USE_LUA` | enable Lua support |
|
||||
| `USE_SERVER_STATS` | enable server statistics support |
|
||||
|
||||
@ -7,7 +7,7 @@ Contributions to CivetWeb are welcome, provided all contributions carry the MIT
|
||||
- If you know how to fix the issue, please create a pull request on GitHub. Please take care your modifications pass the continuous integration checks. These checks are performed automatically when you create a pull request, but it may take some hours until all tests are completed. Please provide a description for every pull request (see below).
|
||||
- Alternatively, you can post a patch or describe the required modifications in a GitHub issue. However, a pull request would be preferred.
|
||||
|
||||
- Improvments to documentation, tests and examples are welcome as well.
|
||||
- Improvements to documentation, tests and examples are welcome as well.
|
||||
|
||||
- Contributor names are listed in [CREDITS.md](https://github.com/civetweb/civetweb/blob/master/CREDITS.md), unless you explicitly state you don't want your name to be listed there. This file is occasionally updated, adding new contributors, using author names from git commits and GitHub comments.
|
||||
|
||||
|
||||
@ -3,7 +3,7 @@ Embedding CivetWeb
|
||||
|
||||
CivetWeb is primarily designed so applications can easily add HTTP and HTTPS server as well as WebSocket (WS and WSS) server functionality.
|
||||
For example, a C/C++ application could use CivetWeb to enable a web service and configuration interface, to add a HTML5 data visualization interface, for automation or remote control, as a protocol gateway or as a HTTP/WebSocket client for firewall traversal.
|
||||
Often the easiest way to embedd CivetWeb is to add the civetweb.c file into your existing C project (see below).
|
||||
Often the easiest way to embed CivetWeb is to add the civetweb.c file into your existing C project (see below).
|
||||
|
||||
CivetWeb can also be used as a stand-alone executable. It can deliver static files and offers built-in server side Lua, JavaScript and CGI support. Some instructions how to build the stand-alone server can be found in [Building.md](https://github.com/civetweb/civetweb/blob/master/docs/Building.md).
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ The latest source code version is available at [https://github.com/civetweb/cive
|
||||
Windows
|
||||
---
|
||||
|
||||
This pre-built version comes pre-built wit Lua support. Libraries for SSL support are not included due to licensing restrictions;
|
||||
This pre-built version comes pre-built with Lua support. Libraries for SSL support are not included due to licensing restrictions;
|
||||
however, users may add an SSL library themselves.
|
||||
Instructions for adding SSL support can be found in [https://github.com/civetweb/civetweb/tree/master/docs](https://github.com/civetweb/civetweb/tree/master/docs)
|
||||
|
||||
|
||||
@ -102,7 +102,7 @@ All other characters in the pattern match themselves. Examples:
|
||||
**.cgi$ Any string that ends with .cgi
|
||||
/foo Any string that begins with /foo
|
||||
**a$|**b$ Any string that ends with a or b
|
||||
|
||||
|
||||
/data/????.css$ Matches css files with 4 letter names in "/data" folder.
|
||||
/data/*.js$ Matches all js file names in "/data" folder.
|
||||
/api/*/*.cgi$ Matches "/api/resourcetype/resourcename.cgi"
|
||||
@ -150,7 +150,7 @@ See the [Wikipedia page on CORS](http://en.wikipedia.org/wiki/Cross-origin_resou
|
||||
An Access Control List (ACL) allows restrictions to be put on the list of IP
|
||||
addresses which have access to the web server. In the case of the CivetWeb
|
||||
web server, the ACL is a comma separated list of IP subnets, where each
|
||||
subnet is pre-pended by either a `-` or a `+` sign. A plus sign means allow,
|
||||
subnet is prepended by either a `-` or a `+` sign. A plus sign means allow,
|
||||
where a minus sign means deny. If a subnet mask is omitted, such as `-1.2.3.4`,
|
||||
this means to deny only that single IP address.
|
||||
|
||||
@ -438,7 +438,7 @@ SSL port. For example, if `listening_ports` is `80r,443s`, then all
|
||||
HTTP traffic coming at port 80 will be redirected to HTTPS port 443.
|
||||
|
||||
It is possible to specify an IP address to bind to. In this case,
|
||||
an IP address and a colon must be pre-pended to the port number.
|
||||
an IP address and a colon must be prepended to the port number.
|
||||
For example, to bind to a loopback interface on port 80 and to
|
||||
all interfaces on HTTPS port 443, use `127.0.0.1:80,443s`.
|
||||
|
||||
@ -688,7 +688,7 @@ TLS1.1+TLS1.2+TLS1.3 | 3
|
||||
TLS1.2+TLS1.3 | 4
|
||||
TLS1.3 | 5
|
||||
|
||||
TLS version 1.3 is only available if you are using an up-to-date TLS libary.
|
||||
TLS version 1.3 is only available if you are using an up-to-date TLS library.
|
||||
The default setting has been changed from 0 to 4 in CivetWeb 1.14.
|
||||
|
||||
### ssl\_short\_trust `no`
|
||||
@ -977,8 +977,8 @@ mg (table):
|
||||
mg.get_mime_type(filename) -- get MIME type of a file
|
||||
mg.get_option(name) -- get configuration option value from name
|
||||
mg.get_response_code_text(n)-- get response code text for n, nil otherwise
|
||||
mg.get_var(str, varname, [occurance]) -- extract the first occurance of variable from (query) string
|
||||
-- otherwise the nth occurance if supplied, nil if not found
|
||||
mg.get_var(str, varname, [occurrence]) -- extract the first occurrence of variable from (query) string
|
||||
-- otherwise the nth occurrence if supplied, nil if not found
|
||||
mg.send_file(filename) -- send a file, including all required HTTP headers
|
||||
mg.send_file_body(filename) -- send a file, excluding HTTP headers
|
||||
mg.send_http_error(n,str) -- send http error code n with string body
|
||||
@ -1017,7 +1017,7 @@ mg (table):
|
||||
.https -- true if accessed by https://, false otherwise
|
||||
.remote_user -- user name if authenticated, nil otherwise
|
||||
.auth_type -- Digest
|
||||
.client_cert -- Table with ssl certificate infomation
|
||||
.client_cert -- Table with ssl certificate information
|
||||
.subject -- Certificate subject
|
||||
.issuer -- Certificate issuer
|
||||
.serial -- Certificate serial number
|
||||
@ -1125,7 +1125,7 @@ some features of the "mg" library are not available yet. Use the "start()" callb
|
||||
function instead.
|
||||
|
||||
A Lua background script may define the following functions:
|
||||
`start()` -- called wnen the server is started
|
||||
`start()` -- called when the server is started
|
||||
`stop()` -- called when the server is stopped
|
||||
`log(req, res)` -- called when an access log entry is created
|
||||
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|**`http_error`**|**`int (*http_error)( struct mg_connection *conn, int status, const char *msg );`**|
|
||||
| |The callback function `http_error()` is called by CivetWeb just before an HTTP error is to be sent to the client. The function allows the application to send a custom error page. The status code of the error is provided as a parameter. If the application sends their own error page, it must return 0 to signal CivetWeb that no further processing is needed. If the returned value is not 0, CivetWeb will send an error page to the client.|
|
||||
|**`init_context`**|**`void (*init_context)( const struct mg_context *ctx );`**|
|
||||
| |The callback function `init_context()` is called after the CivetWeb server has been started and initialized, but before any requests are served. This allowes the application to perform some initialization activities before the first requests are handled.|
|
||||
| |The callback function `init_context()` is called after the CivetWeb server has been started and initialized, but before any requests are served. This allows the application to perform some initialization activities before the first requests are handled.|
|
||||
|**`init_lua`**|**`void (*init_lua)( const struct mg_connection *conn, void *lua_context, unsigned context_flags );`**|
|
||||
| |The callback function `init_lua()` is called just before a Lua server page is to be served. Lua page serving must have been enabled at compile time for this callback function to be called. The parameter `lua_context` is a `lua_State *` pointer. The parameter `context_flags` indicate the type of Lua environment. |
|
||||
|**`exit_lua`**|**`void (*init_lua)( const struct mg_connection *conn, void *lua_context, unsigned context_flags );`**|
|
||||
|
||||
@ -31,7 +31,7 @@ The following parameter values can be used:
|
||||
| **64** | USE_DUKTAPE | *Support for server side JavaScript*. Server side JavaScript can be used for dynamic page generation if the proper options have been set at compile time. Please note that client side JavaScript execution is always available if it has been enabled in the connecting browser. |
|
||||
| **128** | NO_CACHING | *Support for caching*. The webserver will support caching, if it has not been disabled while compiling the library. |
|
||||
|
||||
Parameter values other than the values mentioned above will give undefined results. Therefore—although the parameter values for the `mg_check_feature()` function are effectively bitmasks, you should't assume that combining two of those values with an OR to a new value will give any meaningful results when the function returns.
|
||||
Parameter values other than the values mentioned above will give undefined results. Therefore—although the parameter values for the `mg_check_feature()` function are effectively bitmasks, you shouldn't assume that combining two of those values with an OR to a new value will give any meaningful results when the function returns.
|
||||
|
||||
### See Also
|
||||
|
||||
|
||||
@ -16,7 +16,7 @@
|
||||
|
||||
### Description
|
||||
|
||||
The function `mg_get_user_connection_data()` returns the user data associated with a connection. This user data is represented with a pointer which has been prevously registered with a call to [`mg_set_user_connection_data();`](mg_set_user_connection_data.md). With this function it is possible to pass state information between callback functions referring to a specific connection.
|
||||
The function `mg_get_user_connection_data()` returns the user data associated with a connection. This user data is represented with a pointer which has been previously registered with a call to [`mg_set_user_connection_data();`](mg_set_user_connection_data.md). With this function it is possible to pass state information between callback functions referring to a specific connection.
|
||||
|
||||
### See Also
|
||||
|
||||
|
||||
@ -17,7 +17,7 @@
|
||||
|
||||
### Description
|
||||
|
||||
The function `mg_md5()` caluclates the MD5 checksum of a NULL terminated list of NUL terminated ASCII strings. The MD5 checksum is returned in human readable format as an MD5 string in a caller supplied buffer.
|
||||
The function `mg_md5()` calculates the MD5 checksum of a NULL terminated list of NUL terminated ASCII strings. The MD5 checksum is returned in human readable format as an MD5 string in a caller supplied buffer.
|
||||
|
||||
The function returns a pointer to the supplied result buffer.
|
||||
|
||||
|
||||
@ -21,7 +21,7 @@
|
||||
|
||||
The function `mg_modify_passwords_file()` allows an application to manipulate .htpasswd files on the fly by adding, deleting and changing user records. This is one of the several ways to implement authentication on the server side.
|
||||
|
||||
If the password parameter is not `NULL` an entry is added to the password file. An existing records is modified in that case. If `NULL` is used as the password the enrty is removed from the file.
|
||||
If the password parameter is not `NULL` an entry is added to the password file. An existing records is modified in that case. If `NULL` is used as the password the entry is removed from the file.
|
||||
|
||||
The function returns 1 when successful and 0 if an error occurs.
|
||||
|
||||
|
||||
@ -15,7 +15,7 @@ Getting Started
|
||||
|
||||
- Download Cayssl at https://www.wolfssl.com (formerly http://www.yassl.com/)
|
||||
- Extract the zip file
|
||||
- To make this seemless, extract to a directory parallel to with Civetweb is
|
||||
- To make this seamless, extract to a directory parallel to with Civetweb is
|
||||
|
||||
### Example Project
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user