~ubuntu-branches/ubuntu/feisty/apache2/feisty

<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.2</p>

<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>

<div id="preamble"><h1>Apache Module mod_example</h1>

<p><span>Available Languages: </span><a href="../en/mod/mod_example.html" title="English"> en </a> |

</div>

<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Illustrates the Apache module API</td></tr>

<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Experimental</td></tr>

<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>example_module</td></tr>

<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_example.c</td></tr></table>

<h3>Summary</h3>

<p>Some files in the <code>modules/experimental</code> directory

under the Apache distribution directory tree are provided as an

example to those that wish to write modules that use the Apache

API.</p>

<p>The main file is <code>mod_example.c</code>, which

illustrates all the different callback mechanisms and call

syntaxes. By no means does an add-on module need to include

routines for all of the callbacks - quite the contrary!</p>

<p>The example module is an actual working module. If you link

it into your server, enable the "example-handler" handler for a

location, and then browse to that location, you will see a

display of some of the tracing the example module did as the

various callbacks were made.</p>

</div>

<div id="quickview"><h3 class="directives">Directives</h3>

<li><img alt="" src="../images/down.gif" /> <a href="#example">Example</a></li>

</ul>

<h3>Topics</h3>

<li><img alt="" src="../images/down.gif" /> <a href="#compiling">Compiling the example module</a></li>

<li><img alt="" src="../images/down.gif" /> <a href="#using">Using the <code>mod_example</code> Module</a></li>

</ul></div>

<h2><a name="compiling" id="compiling">Compiling the example module</a></h2>

<p>To include the example module in your server, follow the

steps below:</p>

<ol>

<li>

Run <code class="program"><a href="../programs/configure.html">configure</a></code> with <code>--enable-example</code>

option.</li>

<li>Make the server (run "<code>make</code>").</li>

</ol>

<p>To add another module of your own:</p>

<li><code>cp modules/experimental/mod_example.c

modules/new_module/<em>mod_myexample.c</em></code></li>

<li>Modify the file.</li>

<li>Create <code>modules/new_module/config.m4</code>.

<ol>

<li>Add <code>APACHE_MODPATH_INIT(new_module)</code>.</li>

<li>Copy APACHE_MODULE line with "example" from

<code>modules/experimental/config.m4</code>.</li>

<li>Replace the first argument "example" with <em>myexample</em>.</li>

<li>Replace the second argument with brief description of your module.

It will be used in <code>configure --help</code>.</li>

<li>If your module needs additional C compiler flags, linker flags or

libraries, add them to CFLAGS, LDFLAGS and LIBS accordingly.

See other <code>config.m4</code> files in modules directory for

examples.</li>

<li>Add <code>APACHE_MODPATH_FINISH</code>.</li>

</ol>

</li>

<li>Create <code>module/new_module/Makefile.in</code>.

If your module doesn't need special build instructions,

all you need to have in that file is

100

<code>include $(top_srcdir)/build/special.mk</code>.</li>

101

102

<li>Run ./buildconf from the top-level directory.</li>

103

104

<li>Build the server with --enable-myexample</li>

105

106

</ol>

107

</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>

108

109

<h2><a name="using" id="using">Using the <code>mod_example</code> Module</a></h2>

110

111

<p>To activate the example module, include a block similar to

112

the following in your <code>httpd.conf</code> file:</p>

113

114

115

SetHandler example-handler<br />

116

</Location>

117

</code></p></div>

118

119

<p>As an alternative, you can put the following into a <a href="core.html#accessfilename"><code>.htaccess</code></a> file

120

and then request the file "test.example" from that location:</p>

121

122

AddHandler example-handler .example

123

</code></p></div>

124

125

<p>After reloading/restarting your server, you should be able

126

to browse to this location and see the brief display mentioned

127

earlier.</p>

128

</div>

129

130

<div class="directive-section"><h2><a name="Example" id="Example">Example</a> <a name="example" id="example">Directive</a></h2>

131

132

<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Demonstration directive to illustrate the Apache module

133

API</td></tr>

134

<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Example</code></td></tr>

135

<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>

136

<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>

137

<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_example</td></tr>

138

</table>

139

<p>The <code class="directive">Example</code> directive just sets a demonstration

140

flag which the example module's content handler displays. It

141

takes no arguments. If you browse to an URL to which the

142

example content-handler applies, you will get a display of the

143

routines within the module and how and in what order they were

144

called to service the document request. The effect of this

145

directive one can observe under the point "<code>Example

146

directive declared here: YES/NO</code>".</p>

147

148

</div>

149

</div>

150

151

<p><span>Available Languages: </span><a href="../en/mod/mod_example.html" title="English"> en </a> |

152

153

</div><div id="footer">

154

155

156

</body></html>

b'\\ No newline at end of file'

Older »