X-Git-Url: http://www.dolda2000.com/gitweb/?a=blobdiff_plain;f=doc%2Fdirplex.doc;h=10b76091637620cb80298f41cbf5145c22d61c68;hb=6dcead3f0b94024225b517fcabb10c2c3a5c15a4;hp=fe21c7e8426a2217043eb22a145fff56fca2d3b0;hpb=8cc893f5a55ad27a6971524b41e99589576eade5;p=ashd.git diff --git a/doc/dirplex.doc b/doc/dirplex.doc index fe21c7e..10b7609 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'...]:: @@ -182,17 +182,19 @@ The follow configuration directives are recognized: pattern-matching procedure and the follow-up lines accepted by this stanza are described below, under MATCHING. -*capture* 'HANDLER':: +*capture* 'HANDLER' ['FLAGS']:: Only meaningful in `.htrc` files. If a *capture* directive is specified, then the URL-to-file mapping procedure as described 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. + added to requests passed via *capture* directives. If 'FLAGS' + contain the character `R`, this *capture* directive will be + ignored if it is in the root directory that *dirplex* serves. MATCHING -------- @@ -224,11 +226,13 @@ The following rules are recognized: *pathname* 'PATTERN'...:: - Matches if the entire path (relative as considered from the - root directory being served) of the file under consideration + Matches if the entire path of the file under consideration matches any of the 'PATTERNs'. A 'PATTERN' is an ordinary glob pattern, except that slashes are not matched by wildcards. See - *fnmatch*(3) for more information. + *fnmatch*(3) for more information. If a *pathname* rule is + specified in a `.htrc` file, the path will be examined as + relative to the directory containing the `.htrc` file, rather + than to the root directory being served. *default*:: @@ -272,7 +276,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. @@ -286,7 +290,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. @@ -307,9 +311,13 @@ EXAMPLES The *sendfile*(1) program can be used to serve HTML files as follows. -------- +fchild send + exec sendfile + match - filename *.html - fork sendfile -c text/html + filename *.html *.htm + xset content-type text/html + handler send -------- Assuming the PHP CGI interpreter is installed on the system, PHP @@ -344,9 +352,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