github.com/krum110487/go-htaccess@v0.0.0-20240316004156-60641c8e7598/tests/data/apache_2_2_34/manual/mod/mod_example.html.en (about) 1 <?xml version="1.0" encoding="ISO-8859-1"?> 2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> 3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head> 4 <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" /> 5 <!-- 6 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX 7 This file is generated from xml source: DO NOT EDIT 8 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX 9 --> 10 <title>mod_example - Apache HTTP Server Version 2.2</title> 11 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" /> 12 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" /> 13 <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" /> 14 <script src="../style/scripts/prettify.min.js" type="text/javascript"> 15 </script> 16 17 <link href="../images/favicon.ico" rel="shortcut icon" /><link href="http://httpd.apache.org/docs/current/mod/mod_example.html" rel="canonical" /></head> 18 <body> 19 <div id="page-header"> 20 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.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> 21 <p class="apache">Apache HTTP Server Version 2.2</p> 22 <img alt="" src="../images/feather.gif" /></div> 23 <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div> 24 <div id="path"> 25 <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.2</a> > <a href="./">Modules</a></div> 26 <div id="page-content"> 27 <div class="retired"><h4>Please note</h4> 28 <p> This document refers to a legacy release (<strong>2.2</strong>) of Apache httpd. The active release (<strong>2.4</strong>) is documented <a href="http://httpd.apache.org/docs/current">here</a>. If you have not already upgraded, please follow <a href="http://httpd.apache.org/docs/current/upgrading.html">this link</a> for more information.</p> 29 <p>You may follow <a href="http://httpd.apache.org/docs/current/mod/mod_example.html">this link</a> to go to the current version of this document.</p></div><div id="preamble"><h1>Apache Module mod_example</h1> 30 <div class="toplang"> 31 <p><span>Available Languages: </span><a href="../en/mod/mod_example.html" title="English"> en </a> | 32 <a href="../ko/mod/mod_example.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p> 33 </div> 34 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Illustrates the Apache module API</td></tr> 35 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Experimental</td></tr> 36 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>example_module</td></tr> 37 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_example.c</td></tr></table> 38 <h3>Summary</h3> 39 40 <p>Some files in the <code>modules/experimental</code> directory 41 under the Apache distribution directory tree are provided as an 42 example to those that wish to write modules that use the Apache 43 API.</p> 44 45 <p>The main file is <code>mod_example.c</code>, which 46 illustrates all the different callback mechanisms and call 47 syntaxes. By no means does an add-on module need to include 48 routines for all of the callbacks - quite the contrary!</p> 49 50 <p>The example module is an actual working module. If you link 51 it into your server, enable the "example-handler" handler for a 52 location, and then browse to that location, you will see a 53 display of some of the tracing the example module did as the 54 various callbacks were made.</p> 55 </div> 56 <div id="quickview"><h3>Topics</h3> 57 <ul id="topics"> 58 <li><img alt="" src="../images/down.gif" /> <a href="#compiling">Compiling the example module</a></li> 59 <li><img alt="" src="../images/down.gif" /> <a href="#using">Using the <code>mod_example</code> Module</a></li> 60 </ul><h3 class="directives">Directives</h3> 61 <ul id="toc"> 62 <li><img alt="" src="../images/down.gif" /> <a href="#example">Example</a></li> 63 </ul> 64 <ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> 65 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> 66 <div class="section"> 67 <h2><a name="compiling" id="compiling">Compiling the example module</a></h2> 68 69 <p>To include the example module in your server, follow the 70 steps below:</p> 71 72 <ol> 73 <li> 74 Run <code class="program"><a href="../programs/configure.html">configure</a></code> with <code>--enable-example</code> 75 option.</li> 76 77 <li>Make the server (run "<code>make</code>").</li> 78 </ol> 79 80 <p>To add another module of your own:</p> 81 82 <ol class="up-A"> 83 <li><code>cp modules/experimental/mod_example.c 84 modules/new_module/<em>mod_myexample.c</em></code></li> 85 86 <li>Modify the file.</li> 87 88 <li>Create <code>modules/new_module/config.m4</code>. 89 <ol> 90 <li>Add <code>APACHE_MODPATH_INIT(new_module)</code>.</li> 91 <li>Copy APACHE_MODULE line with "example" from 92 <code>modules/experimental/config.m4</code>.</li> 93 <li>Replace the first argument "example" with <em>myexample</em>.</li> 94 <li>Replace the second argument with brief description of your module. 95 It will be used in <code>configure --help</code>.</li> 96 <li>If your module needs additional C compiler flags, linker flags or 97 libraries, add them to CFLAGS, LDFLAGS and LIBS accordingly. 98 See other <code>config.m4</code> files in modules directory for 99 examples.</li> 100 <li>Add <code>APACHE_MODPATH_FINISH</code>.</li> 101 </ol> 102 </li> 103 104 <li>Create <code>module/new_module/Makefile.in</code>. 105 If your module doesn't need special build instructions, 106 all you need to have in that file is 107 <code>include $(top_srcdir)/build/special.mk</code>.</li> 108 109 <li>Run ./buildconf from the top-level directory.</li> 110 111 <li>Build the server with --enable-myexample</li> 112 113 </ol> 114 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> 115 <div class="section"> 116 <h2><a name="using" id="using">Using the <code>mod_example</code> Module</a></h2> 117 118 <p>To activate the example module, include a block similar to 119 the following in your <code>httpd.conf</code> file:</p> 120 <div class="example"><p><code> 121 <Location /example-info><br /> 122 SetHandler example-handler<br /> 123 </Location> 124 </code></p></div> 125 126 <p>As an alternative, you can put the following into a <a href="core.html#accessfilename"><code>.htaccess</code></a> file 127 and then request the file "test.example" from that location:</p> 128 <div class="example"><p><code> 129 AddHandler example-handler .example 130 </code></p></div> 131 132 <p>After reloading/restarting your server, you should be able 133 to browse to this location and see the brief display mentioned 134 earlier.</p> 135 </div> 136 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> 137 <div class="directive-section"><h2><a name="Example" id="Example">Example</a> <a name="example" id="example">Directive</a></h2> 138 <table class="directive"> 139 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Demonstration directive to illustrate the Apache module 140 API</td></tr> 141 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Example</code></td></tr> 142 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr> 143 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr> 144 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_example</td></tr> 145 </table> 146 <p>The <code class="directive">Example</code> directive just sets a demonstration 147 flag which the example module's content handler displays. It 148 takes no arguments. If you browse to an URL to which the 149 example content-handler applies, you will get a display of the 150 routines within the module and how and in what order they were 151 called to service the document request. The effect of this 152 directive one can observe under the point "<code>Example 153 directive declared here: YES/NO</code>".</p> 154 155 </div> 156 </div> 157 <div class="bottomlang"> 158 <p><span>Available Languages: </span><a href="../en/mod/mod_example.html" title="English"> en </a> | 159 <a href="../ko/mod/mod_example.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p> 160 </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&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> 161 <script type="text/javascript"><!--//--><![CDATA[//><!-- 162 var comments_shortname = 'httpd'; 163 var comments_identifier = 'http://httpd.apache.org/docs/2.2/mod/mod_example.html'; 164 (function(w, d) { 165 if (w.location.hostname.toLowerCase() == "httpd.apache.org") { 166 d.write('<div id="comments_thread"><\/div>'); 167 var s = d.createElement('script'); 168 s.type = 'text/javascript'; 169 s.async = true; 170 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier; 171 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s); 172 } 173 else { 174 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>'); 175 } 176 })(window, document); 177 //--><!]]></script></div><div id="footer"> 178 <p class="apache">Copyright 2017 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> 179 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.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[//><!-- 180 if (typeof(prettyPrint) !== 'undefined') { 181 prettyPrint(); 182 } 183 //--><!]]></script> 184 </body></html>