aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README48
1 files changed, 29 insertions, 19 deletions
diff --git a/README b/README
index be36aff..87da0e6 100644
--- a/README
+++ b/README
@@ -59,6 +59,23 @@ ignored. Empty lines are ignored as well.
There are three kinds of statements: option definition, domain
declaration, and redirection rule.
+** Domain declaration
+
+This statement declares a domain for which the redirection rules below
+apply. Syntactically, it is:
+
+ [DOMAIN]
+
+where DOMAIN is the domain name. No whitespace is allowed between the
+name and square brackets.
+
+Each domain declaration remains in effect until another domain
+declaration is encountered in the redirection table.
+
+Special name "*" means "any domain name".
+
+A redirection table file must declare at least one domain.
+
** Option definition
Option definition begins with the word 'option' followed by one or
@@ -99,34 +116,27 @@ Discard any query string attached to the incoming URI.
Creates a temporary redirect (HTTP response code 302). By default,
permanent redirects (301) are created.
+*** urlencode
+
+Encode special characters in path parts of both source and destination
+URLs as specified in RFC 3986 ("percent encoding"). By default,
+bulkencode assumes all URLs are already properly encoded.
+
Each of these option names can be prefixed with 'no' to revert its
meaning.
By default all options are unset.
-The options defined in this statement remain in effect until changed
-by another 'option' statement below. They also can be overridden for
-each redirect individually. See the discussion of redirection rules
-below.
-
Here is an example of the 'option' statement:
option www,stripquery
-** Domain declaration
-
-This statement declares a domain for which the redirection rules below
-apply. Syntactically, it is:
-
- [DOMAIN]
-
-where DOMAIN is the domain name. No whitespace is allowed between the
-name and square brackets.
-
-Each domain declaration remains in effect until another domain
-declaration is encountered in the redirection table.
-
-Special name "*" means "any domain name".
+The 'option' statement that appears before the first domain
+declaration sets the default options for each domain declared in the
+file. These defaults can be changed for each domain individually,
+by placing an 'option' statement after declaring that domain. Options
+set by such statement remain in effect for each redirect that appears
+after it, until overridden by another 'option' statement.
** Redirection rule

Return to:

Send suggestions and report system problems to the System administrator.