mirror of
https://github.com/apache/httpd.git
synced 2025-06-06 09:01:00 +03:00
adb3627f17
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@97865 13f79535-47bb-0310-9956-ffa450edef68
147 lines
7.3 KiB
XML
147 lines
7.3 KiB
XML
<?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><!--
|
||
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
|
||
This file is generated from xml source: DO NOT EDIT
|
||
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
|
||
-->
|
||
<title>mod_example - Apache HTTP Server</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="../images/favicon.ico" rel="shortcut icon" /></head>
|
||
<body>
|
||
<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.1</p>
|
||
<img alt="" src="../images/feather.gif" /></div>
|
||
<div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
|
||
<div id="path">
|
||
<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs-project/">Documentation</a> > <a href="../">Version 2.1</a> > <a href="./">Modules</a></div>
|
||
<div id="page-content">
|
||
<div id="preamble"><h1>Apache Module mod_example</h1>
|
||
<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>
|
||
|
||
<div class="warning">
|
||
This document has not been updated
|
||
to take into account changes made in the 2.0 version of the
|
||
Apache HTTP Server. Some of the information may still be
|
||
relevant, but please use it with care.
|
||
</div>
|
||
|
||
<p>The files in the <code>src/modules/example directory</code>
|
||
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>
|
||
<ul id="toc">
|
||
<li><img alt="" src="../images/down.gif" /> <a href="#example">Example</a></li>
|
||
</ul>
|
||
<h3>Topics</h3>
|
||
<ul id="topics">
|
||
<li><img alt="" src="../images/down.gif" /> Compiling the example module</li>
|
||
<li><img alt="" src="../images/down.gif" /> Using the <code>mod_example</code> Module</li>
|
||
</ul></div>
|
||
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
|
||
<div class="section">
|
||
<h2>Compiling the example module</h2>
|
||
|
||
<p>To include the example module in your server, follow the
|
||
steps below:</p>
|
||
|
||
<ol>
|
||
<li>
|
||
Uncomment the "AddModule modules/example/mod_example" line
|
||
near the bottom of the <code>src/Configuration</code> file.
|
||
If there isn't one, add it; it should look like this:
|
||
<div class="example"><p><code>
|
||
AddModule modules/example/mod_example.o
|
||
</code></p></div>
|
||
</li>
|
||
|
||
<li>Run the <code>src/Configure</code> script
|
||
("<code>cd src; ./Configure</code>"). This will
|
||
build the Makefile for the server itself, and update the
|
||
<code>src/modules/Makefile</code> for any additional modules
|
||
you have requested from beneath that subdirectory.</li>
|
||
|
||
<li>Make the server (run "<code>make</code>" in the
|
||
<code>src</code> directory).</li>
|
||
</ol>
|
||
|
||
<p>To add another module of your own:</p>
|
||
|
||
<ol class="up-A">
|
||
<li><code>mkdir src/modules/<em>mymodule</em></code></li>
|
||
|
||
<li><code>cp src/modules/example/*
|
||
src/modules/<em>mymodule</em></code></li>
|
||
|
||
<li>Modify the files in the new directory.</li>
|
||
|
||
<li>Follow steps [1] through [3] above, with appropriate
|
||
changes.</li>
|
||
</ol>
|
||
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
|
||
<div class="section">
|
||
<h2>Using the <code>mod_example</code> Module</h2>
|
||
|
||
<p>To activate the example module, include a block similar to
|
||
the following in your <code>srm.conf</code> file:</p>
|
||
<div class="example"><p><code>
|
||
<Location /example-info><br />
|
||
SetHandler example-handler<br />
|
||
</Location>
|
||
</code></p></div>
|
||
|
||
<p>As an alternative, you can put the following into a <a href="core.html#accessfilename"><code>.htaccess</code></a> file
|
||
and then request the file "test.example" from that location:</p>
|
||
<div class="example"><p><code>
|
||
AddHandler example-handler .example
|
||
</code></p></div>
|
||
|
||
<p>After reloading/restarting your server, you should be able
|
||
to browse to this location and see the brief display mentioned
|
||
earlier.</p>
|
||
</div>
|
||
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
|
||
<div class="directive-section"><h2><a name="Example" id="Example">Example</a> <a name="example" id="example">Directive</a></h2>
|
||
<table class="directive">
|
||
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Demonstration directive to illustrate the Apache module
|
||
API</td></tr>
|
||
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Example</code></td></tr>
|
||
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
|
||
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
|
||
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_example</td></tr>
|
||
</table>
|
||
<p>The <code class="directive">Example</code> directive just sets a demonstration
|
||
flag which the example module's content handler displays. It
|
||
takes no arguments. If you browse to an URL to which the
|
||
example content-handler applies, you will get a display of the
|
||
routines within the module and how and in what order they were
|
||
called to service the document request. The effect of this
|
||
directive one can observe under the point "<code>Example
|
||
directive declared here: YES/NO</code>".</p>
|
||
|
||
</div>
|
||
</div>
|
||
<div id="footer">
|
||
<p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</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>
|
||
</body></html> |