Browse Source

Merge pull request #668 from ijm7/ijm7-patch-1

Fix some typos and change some grammar in the user manual
bel2125 6 years ago
parent
commit
898acd9a8e
1 changed files with 22 additions and 22 deletions
  1. 22 22
      docs/UserManual.md

+ 22 - 22
docs/UserManual.md

@@ -2,7 +2,7 @@
 Overview
 Overview
 =====
 =====
 
 
-CivetWeb is small and easy to use web server.
+CivetWeb is a small and easy to use web server.
 It may be embedded into C/C++ host applications or used as a stand-alone
 It may be embedded into C/C++ host applications or used as a stand-alone
 server. See `Embedding.md` for information on embedding CivetWeb into
 server. See `Embedding.md` for information on embedding CivetWeb into
 host applications.
 host applications.
@@ -24,26 +24,26 @@ For UNIX and Mac, CivetWeb does not detach from the terminal.
 Pressing `Ctrl-C` keys will stop the server.
 Pressing `Ctrl-C` keys will stop the server.
 
 
 On Windows, CivetWeb iconifies itself to the system tray icon when started.
 On Windows, CivetWeb iconifies itself to the system tray icon when started.
-Right-click on the icon pops up a menu, where it is possible to stop
-CivetWeb, or configure it, or install it as Windows service.
+Right-clicking on the icon pops up a menu, where it is possible to stop
+CivetWeb, configure it, or install it as Windows service.
 
 
 When started without options, the server exposes the local directory at
 When started without options, the server exposes the local directory at
 [http](http://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol) port 8080.
 [http](http://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol) port 8080.
 Thus, the easiest way to share a folder on Windows is to copy `CivetWeb.exe`
 Thus, the easiest way to share a folder on Windows is to copy `CivetWeb.exe`
 to this folder, double-click the exe, and launch a browser at
 to this folder, double-click the exe, and launch a browser at
 [http://localhost:8080](http://localhost:8080). Note that 'localhost' should
 [http://localhost:8080](http://localhost:8080). Note that 'localhost' should
-be changed to a machine's name if a folder is accessed from other computer.
+be changed to a machine's name if a folder is accessed from another computer.
 
 
 When started, CivetWeb first searches for the configuration file.
 When started, CivetWeb first searches for the configuration file.
-If configuration file is specified explicitly in the command line, i.e.
-`CivetWeb path_to_config_file`, then specified configuration file is used.
-Otherwise, CivetWeb would search for file `CivetWeb.conf` in the same directory
+If a configuration file is specified explicitly in the command line, i.e.
+`CivetWeb path_to_config_file`, then the specified configuration file is used.
+Otherwise, CivetWeb will search for the file `CivetWeb.conf` in the same directory that
 the executable is located, and use it. This configuration file is optional.
 the executable is located, and use it. This configuration file is optional.
 
 
 The configuration file is a sequence of lines, each line containing one
 The configuration file is a sequence of lines, each line containing one
 command line argument name and the corresponding value.
 command line argument name and the corresponding value.
 Empty lines, and lines beginning with `#`, are ignored.
 Empty lines, and lines beginning with `#`, are ignored.
-Here is the example of `CivetWeb.conf` file:
+Here is the example of a `CivetWeb.conf` file:
 
 
     document_root c:\www
     document_root c:\www
     listening_ports 80,443s
     listening_ports 80,443s
@@ -57,7 +57,7 @@ For example: The above `CivetWeb.conf` file is used, and CivetWeb started as
 `CivetWeb -document_root D:\web`. Then the `D:\web` directory will be served
 `CivetWeb -document_root D:\web`. Then the `D:\web` directory will be served
 as document root, because command line options take priority over the
 as document root, because command line options take priority over the
 configuration file. The configuration options section below provides a good
 configuration file. The configuration options section below provides a good
-overview of the CivetWeb features.
+overview of CivetWeb features.
 
 
 Note that configuration options on the command line must start with `-`,
 Note that configuration options on the command line must start with `-`,
 but their names are the same as in the config file. All option names are
 but their names are the same as in the config file. All option names are
@@ -109,9 +109,9 @@ The following options are supported in `civetweb.c`. They can be used for
 the stand-alone executable as well as for applications embedding CivetWeb.
 the stand-alone executable as well as for applications embedding CivetWeb.
 
 
 ### cgi\_pattern `**.cgi$|**.pl$|**.php$`
 ### cgi\_pattern `**.cgi$|**.pl$|**.php$`
-All files that match `cgi_pattern` are treated as CGI files. Default pattern
+All files that match `cgi_pattern` are treated as CGI files. The default pattern
 allows CGI files be anywhere. To restrict CGIs to a certain directory,
 allows CGI files be anywhere. To restrict CGIs to a certain directory,
-use `/path/to/cgi-bin/**.cgi` as pattern. Note that the full file path is
+use `/path/to/cgi-bin/**.cgi` as the pattern. Note that the full file path is
 matched against the pattern, not the URI.
 matched against the pattern, not the URI.
 
 
 ### cgi\_environment
 ### cgi\_environment
@@ -120,8 +120,8 @@ addition to standard ones. The list must be comma-separated list
 of name=value pairs, like this: `VARIABLE1=VALUE1,VARIABLE2=VALUE2`.
 of name=value pairs, like this: `VARIABLE1=VALUE1,VARIABLE2=VALUE2`.
 
 
 ### put\_delete\_auth\_file
 ### put\_delete\_auth\_file
-Passwords file for PUT and DELETE requests. Without password file, it will not
-be possible to, PUT new files to the server or DELETE existing ones. PUT and
+Passwords file for PUT and DELETE requests. Without a password file, it will not
+be possible to PUT new files to the server or DELETE existing ones. PUT and
 DELETE requests might still be handled by Lua scripts and CGI paged.
 DELETE requests might still be handled by Lua scripts and CGI paged.
 
 
 ### cgi\_interpreter
 ### cgi\_interpreter
@@ -140,7 +140,7 @@ working directory is the directory where the CivetWeb executable is located.
 
 
 If all CGIs use the same interpreter, for example they are all PHP, it is
 If all CGIs use the same interpreter, for example they are all PHP, it is
 more efficient to set `cgi_interpreter` to the path to `php-cgi.exe`.
 more efficient to set `cgi_interpreter` to the path to `php-cgi.exe`.
-The  shebang line in the CGI scripts can be omitted in this case.
+The shebang line in the CGI scripts can be omitted in this case.
 Note that PHP scripts must use `php-cgi.exe` as executable, not `php.exe`.
 Note that PHP scripts must use `php-cgi.exe` as executable, not `php.exe`.
 
 
 ### protect\_uri
 ### protect\_uri
@@ -162,7 +162,7 @@ will be accepted.
 All files that match `ssi_pattern` are treated as Server Side Includes (SSI).
 All files that match `ssi_pattern` are treated as Server Side Includes (SSI).
 
 
 SSI is a simple interpreted server-side scripting language which is most
 SSI is a simple interpreted server-side scripting language which is most
-commonly used to include the contents of another file into a web page.
+commonly used to include the contents of another file in a web page.
 It can be useful when it is desirable to include a common piece
 It can be useful when it is desirable to include a common piece
 of code throughout a website, for example, headers and footers.
 of code throughout a website, for example, headers and footers.
 
 
@@ -279,7 +279,7 @@ To learn more about subnet masks, see the
 [Wikipedia page on Subnetwork](http://en.wikipedia.org/wiki/Subnetwork).
 [Wikipedia page on Subnetwork](http://en.wikipedia.org/wiki/Subnetwork).
 
 
 ### extra\_mime\_types
 ### extra\_mime\_types
-Extra mime types, in tha form `extension1=type1,exten-sion2=type2,...`.
+Extra mime types, in the form `extension1=type1,exten-sion2=type2,...`.
 See the [Wikipedia page on Internet media types](http://en.wikipedia.org/wiki/Internet_media_type).
 See the [Wikipedia page on Internet media types](http://en.wikipedia.org/wiki/Internet_media_type).
 Extension must include a leading dot. Example:
 Extension must include a leading dot. Example:
 `.cpp=plain/text,.java=plain/text`
 `.cpp=plain/text,.java=plain/text`
@@ -307,7 +307,7 @@ e.g. `[::1]:8080` for the IPv6 loopback interface.
 all interfaces, both IPv4 and IPv6, use either the configuration
 all interfaces, both IPv4 and IPv6, use either the configuration
 `80,[::]:80` (create one socket for IPv4 and one for IPv6 only),
 `80,[::]:80` (create one socket for IPv4 and one for IPv6 only),
 or `+80` (create one socket for both, IPv4 and IPv6). 
 or `+80` (create one socket for both, IPv4 and IPv6). 
-The `+`-notation to use IPv4 and IPv6 will only work in no network
+The `+` notation to use IPv4 and IPv6 will only work if no network
 interface is specified. Depending on your operating system version
 interface is specified. Depending on your operating system version
 and IPv6 network environment, some configurations might not work
 and IPv6 network environment, some configurations might not work
 as expected, so you have to test to find the configuration most 
 as expected, so you have to test to find the configuration most 
@@ -484,7 +484,7 @@ script on changes of the server state. See example lua script :
 [background.lua](https://github.com/civetweb/civetweb/blob/master/test/background.lua).
 [background.lua](https://github.com/civetweb/civetweb/blob/master/test/background.lua).
 
 
 Additional functions available in background script :
 Additional functions available in background script :
-sleep, root path, script name, isterminated
+sleep, root path, script name, is terminated
 
 
 ### lua\_background\_script\_params `param1=1,param2=2`
 ### lua\_background\_script\_params `param1=1,param2=2`
 Can add dynamic parameters to background script.
 Can add dynamic parameters to background script.
@@ -553,12 +553,12 @@ Set the maximum time (in seconds) a cache may store a static files.
 
 
 This option will set the `Cache-Control: max-age` value for static files.
 This option will set the `Cache-Control: max-age` value for static files.
 Dynamically generated content, i.e., content created by a script or callback,
 Dynamically generated content, i.e., content created by a script or callback,
-must send cache control headers by themselfes.
+must send cache control headers by themselves.
 
 
 A value >0 corresponds to a maximum allowed caching time in seconds.
 A value >0 corresponds to a maximum allowed caching time in seconds.
 This value should not exceed one year (RFC 2616, Section 14.21).
 This value should not exceed one year (RFC 2616, Section 14.21).
 A value of 0 will send "do not cache" headers for all static files.
 A value of 0 will send "do not cache" headers for all static files.
-For values <0 and values >31622400, the behavior is undefined.
+For values <0 and values >31622400, the behaviour is undefined.
 
 
 ### strict\_transport\_security\_max\_age
 ### strict\_transport\_security\_max\_age
 
 
@@ -570,7 +570,7 @@ send HTTP headers on their own.
 
 
 The time is specified in seconds. If this configuration is not set, 
 The time is specified in seconds. If this configuration is not set, 
 or set to -1, no `Strict-Transport-Security` header will be sent.
 or set to -1, no `Strict-Transport-Security` header will be sent.
-For values <-1 and values >31622400, the behavior is undefined.
+For values <-1 and values >31622400, the behaviour is undefined.
 
 
 ### decode\_url `yes`
 ### decode\_url `yes`
 URL encoded request strings are decoded in the server, unless it is disabled
 URL encoded request strings are decoded in the server, unless it is disabled
@@ -887,7 +887,7 @@ All function are called with one argument of type table with at least one field
 "client" to identify the client. When "open" is called, the argument table additionally
 "client" to identify the client. When "open" is called, the argument table additionally
 contains the "request_info" table as defined above. For the "data" handler, an
 contains the "request_info" table as defined above. For the "data" handler, an
 additional field "data" is available. The functions "open", "ready" and "data"
 additional field "data" is available. The functions "open", "ready" and "data"
-must return true in order to keep the connetion open.
+must return true in order to keep the connection open.
 
 
 Lua websocket pages do support single shot (timeout) and interval timers.
 Lua websocket pages do support single shot (timeout) and interval timers.