diff options
| author | Jeff Trawick <trawick@apache.org> | 2010-11-08 13:15:17 +0000 |
|---|---|---|
| committer | Jeff Trawick <trawick@apache.org> | 2010-11-08 13:15:17 +0000 |
| commit | 66e4cc46767585749277c58684d5ddd3b1586af1 (patch) | |
| tree | 79896e3f7c989ba0badd63b0b077276e2d302b6f /docs | |
| parent | 3aecbb05432840ea4131a573040cd9661dc8578a (diff) | |
| download | httpd-66e4cc46767585749277c58684d5ddd3b1586af1.tar.gz | |
Add Error directive for aborting startup or htaccess processing
with a specified error message.
Be nice and strip off any quotes, which aren't necessary.
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1032565 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/manual/mod/core.xml | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/docs/manual/mod/core.xml b/docs/manual/mod/core.xml index 878ecea993..c2bbd8ab4c 100644 --- a/docs/manual/mod/core.xml +++ b/docs/manual/mod/core.xml @@ -890,6 +890,43 @@ version 2.3.9.</compatibility> </directivesynopsis> <directivesynopsis> +<name>Error</name> +<description>Abort configuration parsing with a custom error message</description> +<syntax>Error <var>message</var></syntax> +<contextlist><context>server config</context><context>virtual host</context> +<context>directory</context><context>.htaccess</context> +</contextlist> +<compatibility>2.3.9 and later</compatibility> + +<usage> + <p>If an error can be detected within the configuration, this + directive can be used to generate a custom error message, and halt + configuration parsing. The typical use is for reporting required + modules which are missing from the configuration.</p> + + <example><title>Example</title> + # ensure that mod_include is loaded<br /> + <IfModule !include_module><br /> + Error mod_include is required by mod_foo. Load it with LoadModule.<br /> + </IfModule><br /> + <br /> + # ensure that exactly one of SSL,NOSSL is defined<br /> + <IfDefine SSL><br /> + <IfDefine NOSSL><br /> + Error Both SSL and NOSSL are defined. Define only one of them.<br /> + </IfDefine><br /> + </IfDefine><br /> + <IfDefine !SSL><br /> + <IfDefine !NOSSL><br /> + Error Either SSL or NOSSL must be defined.<br /> + </IfDefine><br /> + </IfDefine><br /> + </example> + +</usage> +</directivesynopsis> + +<directivesynopsis> <name>ErrorDocument</name> <description>What the server will return to the client in case of an error</description> |