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