doc: Fixed patplex configuration filename discrepancy.

[ashd.git] / doc / patplex.doc

diff --git a/doc/patplex.doc b/doc/patplex.doc
index 2d9acbd..dafe5e2 100644 (file)
--- a/doc/patplex.doc
+++ b/doc/patplex.doc
@@ -37,9 +37,9 @@ In addition to the 'CONFIGFILE' specified on the command-line,
 *patplex* also attempts to find and read a global configuration file
 called `patplex.rc`, unless the *-N* option is given. It looks in all
 directories named by the *PATH* environment variable, appended with
 *patplex* also attempts to find and read a global configuration file
 called `patplex.rc`, unless the *-N* option is given. It looks in all
 directories named by the *PATH* environment variable, appended with

-`../etc`. For example, then, if *PATH* is
-`/usr/local/bin:/bin:/usr/bin`, the directories `/usr/local/etc`,
-`/etc` and `/usr/etc` are searched for `patplex.rc`, in that
+`../etc/ashd`. For example, then, if *PATH* is
+`/usr/local/bin:/bin:/usr/bin`, the directories `/usr/local/etc/ashd`,
+`/etc/ashd` and `/usr/etc/ashd` are searched for `patplex.rc`, in that

 order. Only the first file found is used, should there exist several.
 
 Should the global and the given configuration files conflict, the
 order. Only the first file found is used, should there exist several.
 
 Should the global and the given configuration files conflict, the


@@ -93,7 +93,7 @@ rules are recognized:
        rule has matched.
 
 In addition to the rules, a *match* stanza must contain exactly one
        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'::
 only the *handler* action is recognized:
 
 *handler* 'HANDLER'::


@@ -101,14 +101,30 @@ only the *handler* action is recognized:
        'HANDLER' must be a named handler as declared by a *child* or
        *fchild* stanza, to which the request is passed.
 
        'HANDLER' must be a named handler as declared by a *child* or
        *fchild* stanza, to which the request is passed.
 

-Additionally, a *match* stanza may contain a *restpat* line:
+Additionally, a *match* stanza may contain any of the following,
+optional lines:
+
+*set* 'HEADER' 'VALUE'::
+
+       If the *match* stanza as a whole matches, the named HTTP
+       'HEADER' in the request is set to 'VALUE' before passing the
+       request on to the specified handler. A *match* stanza may
+       contain any number of *set* lines.
+
+*xset* 'HEADER' 'VALUE'::
+
+       *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.

 
 *restpat* 'TEMPLATE'::
 
        If the *match* stanza as a whole matches, 'TEMPLATE' is
        expanded and installed as the rest string of the request
        before it is passed to the specified handler. In 'TEMPLATE',
 
 *restpat* 'TEMPLATE'::
 
        If the *match* stanza as a whole matches, 'TEMPLATE' is
        expanded and installed as the rest string of the request
        before it is passed to the specified handler. In 'TEMPLATE',

-       the following parameters are recognized and expanded.
+       the following parameters are recognized and expanded. At most
+       one *restpat* line may be given per *match* stanza.

 
 *$0* ... *$9*::
 
 
 *$0* ... *$9*::