Expanding TXT support
[hcoop/domtool2.git] / lib / mod_rewrite.dtl
CommitLineData
f8dfbbcc
AC
1{{Support for Apache's mod_rewrite, which allows fancy mappings from URLs to
2 resources}}
3
4extern type redirect_code;
5{{An HTTP code to return as part of a redirection}}
6extern val temp : redirect_code;
7extern val permanent : redirect_code;
8extern val seeother : redirect_code;
9extern val redir300 : redirect_code;
10extern val redir301 : redirect_code;
11extern val redir302 : redirect_code;
12extern val redir303 : redirect_code;
13extern val redir304 : redirect_code;
14extern val redir305 : redirect_code;
15extern val redir307 : redirect_code;
16
17extern type rewrite_arg;
18{{Some mod_rewrite flags take arguments.
19 This type stands for values that may validly be given for one of those
20 arguments, which excludes commas and some other characters.}}
21
22extern type mod_rewrite_flag;
23{{See <a href="http://httpd.apache.org/docs/2.0/mod/mod_rewrite.html#rewriterule">the
24 Apache documentation</a> for information on what these flags mean.}}
25
26extern val redirect : mod_rewrite_flag;
27extern val forbidden : mod_rewrite_flag;
28extern val gone : mod_rewrite_flag;
29extern val last : mod_rewrite_flag;
30extern val chain : mod_rewrite_flag;
31extern val nosubreq : mod_rewrite_flag;
32extern val nocase : mod_rewrite_flag;
33extern val qsappend : mod_rewrite_flag;
34extern val noescape : mod_rewrite_flag;
35extern val passthrough : mod_rewrite_flag;
36
37extern val mimeType : rewrite_arg -> mod_rewrite_flag;
38extern val redirectWith : redirect_code -> mod_rewrite_flag;
39extern val skip : int -> mod_rewrite_flag;
40extern val env : rewrite_arg -> rewrite_arg -> mod_rewrite_flag;
41
e95a129e
AC
42extern type mod_rewrite_cond_flag;
43{{See <a href="http://httpd.apache.org/docs/2.0/mod/mod_rewrite.html#rewritecond">the
44 Apache documentation</a> for information on what these flags mean.}}
45
46extern val cond_nocase : mod_rewrite_cond_flag;
47extern val ornext : mod_rewrite_cond_flag;
48
690a19c3
AC
49extern type regexp;
50{{PCRE regular expression}}
51
52extern val rewriteRule : regexp -> no_spaces -> [mod_rewrite_flag] -> [^Vhost];
f8dfbbcc
AC
53{{See <a href="http://httpd.apache.org/docs/2.0/mod/mod_rewrite.html#rewriterule">Apache
54 documentation for <tt>RewriteRule</tt></a>.}}
55
690a19c3 56extern val rewriteCond : no_spaces -> regexp -> [mod_rewrite_cond_flag] -> [^Vhost];
e95a129e
AC
57{{See <a href="http://httpd.apache.org/docs/2.0/mod/mod_rewrite.html#rewritecond">Apache
58 documentation for <tt>RewriteCond</tt></a>.}}
59
fdf9a42d 60extern val rewriteBase : no_spaces -> [Location];
94b7b11a
AC
61{{See <a href="http://httpd.apache.org/docs/2.0/mod/mod_rewrite.html#rewritebase">Apache
62 documentation for <tt>RewriteBase</tt></a>.}}
63
e95a129e
AC
64extern type proxy_port;
65{{A port number above 1024}}
66
2882ee37 67extern val localProxyRewrite : no_spaces -> no_spaces -> proxy_port -> [^Vhost];
f8dfbbcc
AC
68{{All requests matching the regular expression in the first argument are
69 redirected to another HTTPD running on localhost at the given port, generating
70 the new URI by substituting variables in the second argument as per Apache
71 mod_rewrite.}}
72
c98b57cf
AC
73extern val rewriteLogLevel : int -> [Vhost];
74{{See <a href="http://httpd.apache.org/docs/2.0/mod/mod_rewrite.html#rewriteloglevel">Apache
75 documentation for <tt>RewriteLogLevel</tt></a>.}}