]> granicus.if.org Git - apache/blobdiff - docs/manual/custom-error.html.en
Documentation rebuild after recent commits
[apache] / docs / manual / custom-error.html.en
index 43d9ae196e7b897a451b472471546e4776350e0a..b0ae5956e14147937b48ca0fa310dc608b4d964b 100644 (file)
@@ -1,22 +1,27 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
+<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
+<!--
         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
               This file is generated from xml source: DO NOT EDIT
         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
       -->
-<title>Custom Error Responses - Apache HTTP Server</title>
+<title>Custom Error Responses - Apache HTTP Server Version 2.5</title>
 <link href="./style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
 <link href="./style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
-<link href="./style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
+<link href="./style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="./style/css/prettify.css" />
+<script src="./style/scripts/prettify.min.js" type="text/javascript">
+</script>
+
 <link href="./images/favicon.ico" rel="shortcut icon" /></head>
 <body id="manual-page"><div id="page-header">
-<p class="menu"><a href="./mod/">Modules</a> | <a href="./mod/directives.html">Directives</a> | <a href="./faq/">FAQ</a> | <a href="./glossary.html">Glossary</a> | <a href="./sitemap.html">Sitemap</a></p>
-<p class="apache">Apache HTTP Server Version 2.3</p>
-<img alt="" src="./images/feather.gif" /></div>
+<p class="menu"><a href="./mod/">Modules</a> | <a href="./mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="./glossary.html">Glossary</a> | <a href="./sitemap.html">Sitemap</a></p>
+<p class="apache">Apache HTTP Server Version 2.5</p>
+<img alt="" src="./images/feather.png" /></div>
 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="./images/left.gif" /></a></div>
 <div id="path">
-<a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="./">Version 2.3</a></div><div id="page-content"><div id="preamble"><h1>Custom Error Responses</h1>
+<a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="./">Version 2.5</a></div><div id="page-content"><div id="preamble"><h1>Custom Error Responses</h1>
 <div class="toplang">
 <p><span>Available Languages: </span><a href="./en/custom-error.html" title="English">&nbsp;en&nbsp;</a> |
 <a href="./es/custom-error.html" hreflang="es" rel="alternate" title="Español">&nbsp;es&nbsp;</a> |
@@ -30,7 +35,7 @@
     <p>Although the Apache HTTP Server provides generic error responses
     in the event of 4xx or 5xx HTTP status codes, these responses are
     rather stark, uninformative, and can be intimidating to site users.
-    You may wish to provide custom error responses which are either 
+    You may wish to provide custom error responses which are either
     friendlier, or in some language other than English, or perhaps which
     are styled more in line with your site layout.</p>
 
@@ -49,8 +54,8 @@
 <div id="quickview"><ul id="toc"><li><img alt="" src="./images/down.gif" /> <a href="#configuration">Configuration</a></li>
 <li><img alt="" src="./images/down.gif" /> <a href="#variables">Available Variables</a></li>
 <li><img alt="" src="./images/down.gif" /> <a href="#custom">Customizing Error Responses</a></li>
-<li><img alt="" src="./images/down.gif" /> <a href="#multi-lang">Multi Language Customer Error Documents</a></li>
-</ul></div>
+<li><img alt="" src="./images/down.gif" /> <a href="#multi-lang">Multi Language Custom Error Documents</a></li>
+</ul><h3>See also</h3><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
 <div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
 <div class="section">
 <h2><a name="configuration" id="configuration">Configuration</a></h2>
     <p>Custom error documents are configured using the <code class="directive"><a href="./mod/core.html#errordocument">ErrorDocument</a></code> directive,
     which may be used in global,
     virtualhost, or directory context. It may be used in .htaccess files
-    if <code class="directive"><a href="./mod/core.html#allowoverride">AllowOverride</a></code> is set to 
+    if <code class="directive"><a href="./mod/core.html#allowoverride">AllowOverride</a></code> is set to
     FileInfo.</p>
 
-    <div class="example"><p><code>
-      ErrorDocument 500 "Sorry, our script crashed. Oh dear"<br />
-      ErrorDocument 500 /cgi-bin/crash-recover<br />
-      ErrorDocument 500 http://error.example.com/server_error.html<br />
-      ErrorDocument 404 /errors/not_found.html <br />
-      ErrorDocument 401 /subscription/how_to_subscribe.html
-    </code></p></div>
+    <pre class="prettyprint lang-config">ErrorDocument 500 "Sorry, our script crashed. Oh dear"<br />
+ErrorDocument 500 /cgi-bin/crash-recover<br />
+ErrorDocument 500 http://error.example.com/server_error.html<br />
+ErrorDocument 404 /errors/not_found.html <br />
+ErrorDocument 401 /subscription/how_to_subscribe.html</pre>
+
 
     <p>The syntax of the <code>ErrorDocument</code> directive is:</p>
 
-    <div class="example"><p><code>
-      ErrorDocument &lt;3-digit-code&gt; &lt;action&gt;
-    </code></p></div>
+    <pre class="prettyprint lang-config">ErrorDocument &lt;3-digit-code&gt; &lt;action&gt;</pre>
 
-    <p>where the action can be one of:</p>
+
+    <p>where the action will be treated as:</p>
 
     <ol>
-      <li>Text to be displayed. Wrap the text with quotes (").</li>
-      <li>A local URL to redirect to.</li>
-      <li>An external URL to redirect to.</li>
+      <li>A local URL to redirect to (if the action begins with a "/").</li>
+      <li>An external URL to redirect to (if the action is a valid URL).</li>
+      <li>Text to be displayed (if none of the above). The text must be
+          wrapped in quotes (") if it consists of more than one word.</li>
     </ol>
 
     <p>When redirecting to a local URL, additional environment variables
       'REDIRECT_' onto the original header name. This provides the error
       document the context of the original request.</p>
 
-      <p>For example, you might recieve, in addition to more usual
+      <p>For example, you might receive, in addition to more usual
       environment variables, the following.</p>
 
       <div class="example"><p><code>
       <p>If you point your <code>ErrorDocument</code> to some variety of
       dynamic handler such as a server-side include document, CGI
       script, or some variety of other handler, you may wish to use the
-      available custom environent variables to customize this
+      available custom environment variables to customize this
       response.</p>
 
       <p>If the ErrorDocument specifies a local redirect to a CGI
       caused it to be invoked. For instance, a Perl ErrorDocument
       script might include the following:</p>
 
-      <div class="example"><p><code>
-        ... <br />
-        print  "Content-type: text/html\n"; <br />
-        printf "Status: %s Condition Intercepted\n", $ENV{"REDIRECT_STATUS"}; <br />
-        ...
-      </code></p></div>
+       <pre class="prettyprint lang-perl">...
+print  "Content-type: text/html\n"; <br />
+printf "Status: %s Condition Intercepted\n", $ENV{"REDIRECT_STATUS"}; <br />
+...</pre>
+
 
       <p>If the script is dedicated to handling a particular error
       condition, such as <code>404&nbsp;Not&nbsp;Found</code>, it can
 
       <p>Note that if the response contains <code>Location:</code>
       header (in order to issue a client-side redirect), the script
-      <em>must</em> emit an appropriate <code>Status:</code> header 
-      (such as <code>302&nbsp;Found</code>). Otherwise the 
+      <em>must</em> emit an appropriate <code>Status:</code> header
+      (such as <code>302&nbsp;Found</code>). Otherwise the
       <code>Location:</code> header may have no effect.</p>
 
   </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
 <div class="section">
-<h2><a name="multi-lang" id="multi-lang">Multi Language Customer Error Documents</a></h2>
+<h2><a name="multi-lang" id="multi-lang">Multi Language Custom Error Documents</a></h2>
 
     <p>Provided with your installation of the Apache HTTP Server is a
     directory of custom error documents translated into 16 different
 
     <p>In your server configuration file, you'll see a line such as:</p>
 
-    <div class="example"><p><code>
-    # Multi-language error messages<br />
-    #Include conf/extra/httpd-multilang-errordoc.conf
-    </code></p></div>
+    <pre class="prettyprint lang-config">    # Multi-language error messages<br />
+    #Include conf/extra/httpd-multilang-errordoc.conf</pre>
+
 
     <p>Uncommenting this <code>Include</code> line will enable this
     feature, and provide language-negotiated error messages, based on
     provide more useful information to users about your site, and what
     they can expect to find there.</p>
 
-    <p><code class="module"><a href="./mod/mod_include.html">mod_include</a></code> and <code class="module"><a href="./mod/mod_negotiation.html">mod_negotiation</a></code> 
+    <p><code class="module"><a href="./mod/mod_include.html">mod_include</a></code> and <code class="module"><a href="./mod/mod_negotiation.html">mod_negotiation</a></code>
     must be enabled to use this feature.</p>
 
  </div></div>
 <a href="./ja/custom-error.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
 <a href="./ko/custom-error.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
 <a href="./tr/custom-error.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
-</div><div id="footer">
-<p class="apache">Copyright 2010 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
-<p class="menu"><a href="./mod/">Modules</a> | <a href="./mod/directives.html">Directives</a> | <a href="./faq/">FAQ</a> | <a href="./glossary.html">Glossary</a> | <a href="./sitemap.html">Sitemap</a></p></div>
+</div><div class="top"><a href="#page-header"><img src="./images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&amp;A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
+<script type="text/javascript"><!--//--><![CDATA[//><!--
+var comments_shortname = 'httpd';
+var comments_identifier = 'http://httpd.apache.org/docs/trunk/custom-error.html';
+(function(w, d) {
+    if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
+        d.write('<div id="comments_thread"><\/div>');
+        var s = d.createElement('script');
+        s.type = 'text/javascript';
+        s.async = true;
+        s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
+        (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
+    }
+    else {
+        d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
+    }
+})(window, document);
+//--><!]]></script></div><div id="footer">
+<p class="apache">Copyright 2016 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
+<p class="menu"><a href="./mod/">Modules</a> | <a href="./mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="./glossary.html">Glossary</a> | <a href="./sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
+if (typeof(prettyPrint) !== 'undefined') {
+    prettyPrint();
+}
+//--><!]]></script>
 </body></html>
\ No newline at end of file