patplex: Search for the configuration file if it contains no slashes.

[ashd.git] / doc / patplex.doc

diff --git a/doc/patplex.doc b/doc/patplex.doc
index d2ee009..dff248b 100644 (file)
--- a/doc/patplex.doc
+++ b/doc/patplex.doc
@@ -37,10 +37,13 @@ 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
-order. Only the first file found is used, should there exist several.
+`../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. If the given 'CONFIGFILE' contains any slashes, it is opened
+by that exact name. Otherwise, it is searched for in the same manner
+as the global configuration file.

 
 Should the global and the given configuration files conflict, the
 directives from the given file take precedence.
 
 Should the global and the given configuration files conflict, the
 directives from the given file take precedence.


@@ -93,7 +96,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'::


@@ -111,6 +114,13 @@ optional lines:
        request on to the specified handler. A *match* stanza may
        contain any number of *set* lines.
 
        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
 *restpat* 'TEMPLATE'::
 
        If the *match* stanza as a whole matches, 'TEMPLATE' is