From: Fredrik Tolf Date: Sun, 13 May 2012 07:09:12 +0000 (+0200) Subject: doc: Typo fixes and other documentation improvements. X-Git-Tag: 0.11~22 X-Git-Url: http://www.dolda2000.com/gitweb/?p=ashd.git;a=commitdiff_plain;h=fda48525a7bab9e487e69264619ebdbabcd83ff2 doc: Typo fixes and other documentation improvements. --- diff --git a/INSTALL b/INSTALL index efed246..e64824f 100644 --- a/INSTALL +++ b/INSTALL @@ -26,8 +26,9 @@ automake and asciidoc. When Ashd is compiled and installed, you will most likely want to install its default configuration. To do so, simply copy the -`etc/ashd' directory into either `/etc' or `/usr/local/etc'. It does -not matter which you choose. +`etc/ashd' directory into either `/etc' or `/usr/local/etc'. As long +as your system is fairly normal, it should not matter which you +choose. Testing diff --git a/doc/accesslog.doc b/doc/accesslog.doc index 109aa09..c33c6d6 100644 --- a/doc/accesslog.doc +++ b/doc/accesslog.doc @@ -55,9 +55,9 @@ OPTIONS *-p* 'PIDFILE':: - Write the PID of the *accesslog* to 'PIDFILE'. 'PIDFILE' may - be `-`, in which case the string "`.pid`" is appended to the - log file name and used instead. + Write the PID of the *accesslog* process to + 'PIDFILE'. 'PIDFILE' may be `-`, in which case the string + "`.pid`" is appended to the log file name and used instead. *-a*:: diff --git a/doc/dirplex.doc b/doc/dirplex.doc index fce3565..9d2240d 100644 --- a/doc/dirplex.doc +++ b/doc/dirplex.doc @@ -126,7 +126,7 @@ as part of the word. Empty lines are ignored, and lines whose first character after leading whitespace is a hash character (`#`) are treated as comments and ignored. -The follow configuration directives are recognized: +The following configuration directives are recognized: *include* ['FILENAME'...]:: @@ -189,7 +189,7 @@ The follow configuration directives are recognized: above is aborted as soon as the directory containing the `.htrc` file is encountered. The request is passed, with any remaining rest string, to the specified 'HANDLER', which must - by a named request handler specified either in the same + be a named request handler specified either in the same `.htrc` file or elsewhere. The *capture* directive accepts no follow-up lines. Note that the `X-Ash-File` header is not added to requests passed via *capture* directives. @@ -274,7 +274,7 @@ optional directives: *xset* 'HEADER' 'VALUE':: - *xset* does exactly the same thing as *set*, except the + *xset* does exactly the same thing as *set*, except that 'HEADER' is automatically prepended with the `X-Ash-` prefix. The intention is only to make configuration files look nicer in this very common case. @@ -288,7 +288,7 @@ A HTTP 404 response is sent to the client if * A path element is encountered during mapping which, after URL unescaping, either begins with a dot or contains slashes; * The mapping procedure finds a file which is neither a directory nor - a regular file; + a regular file (or a symbolic link to any of the same); * An empty, non-final path element is encountered during mapping; or * The mapping procedure results in a file which is not matched by any *match* stanza. @@ -313,7 +313,7 @@ fchild send exec sendfile match - filename *.html + filename *.html *.htm xset content-type text/html handler send -------- @@ -350,9 +350,9 @@ match directory The following configuration can be placed in a `.htrc` file in order to dedicate the directory containing that file to some external SCGI script engine. Note that *callscgi*, and therefore the script engine -itself, is started in the directory itself, so that arbitrary code -modules or data files can be put directly in that directory and easily -found. +itself, is started in the same directory, so that arbitrary code +modules or data files can be put directly in that directory and be +easily found. -------- child foo diff --git a/doc/htls.doc b/doc/htls.doc index 9e7786a..730eb41 100644 --- a/doc/htls.doc +++ b/doc/htls.doc @@ -32,17 +32,17 @@ OPTIONS *-m*:: - Include the time the listed files and directories were last - modified in the listing. + Include the time of last modification for the listed files and + directories in the listing. *-s*:: - Include the size for files listed in the listing. + Include the size of the listed files in the listing. *-c* 'STYLESHEET':: Instead of including an inline stylesheet, insert 'STYLESHEET' - as stylesheet link in the generated index. + as a stylesheet link in the generated index. AUTHOR ------ diff --git a/doc/patplex.doc b/doc/patplex.doc index f567d56..f405262 100644 --- a/doc/patplex.doc +++ b/doc/patplex.doc @@ -93,7 +93,7 @@ rules are recognized: rule has matched. In addition to the rules, a *match* stanza must contain exactly one -follow-up line specifying the action to take if it mathces. Currently, +follow-up line specifying the action to take if it matches. Currently, only the *handler* action is recognized: *handler* 'HANDLER':: diff --git a/examples/README b/examples/README index 3f7c9d6..e20543b 100644 --- a/examples/README +++ b/examples/README @@ -2,10 +2,11 @@ This directory contains some examples of more or less simple ashd configurations. Each sub-directory contains a self-contained example with a shell script called `run'. Simply run that script to start the example, and examine it to see how it was made. All of them will start -an non-SSL HTTP server on port 8080. +a non-SSL HTTP server on port 8080. Note that ashd, including the default configuration files, must be -installed on the system to be able to run the examples. +installed on the system to be able to run the examples. See the +INSTALL file for details thereof. The `python' sub-directory contains examples for using the Python module. To run them, the Python module has to be installed and