diff options
| author | Stefan Fritsch <sf@sfritsch.de> | 2011-12-27 19:42:03 +0100 |
|---|---|---|
| committer | Stefan Fritsch <sf@sfritsch.de> | 2011-12-27 19:42:03 +0100 |
| commit | 80db94fff6a9620fb469ee911347ed973e3f7735 (patch) | |
| tree | 35ccde4018b7e6b84103e5e85dc1085ef9e7d6c2 /docs/manual/mod/mod_example.html.en | |
| download | apache2-upstream/2.2.3.tar.gz | |
Upstream tarball 2.2.3upstream/2.2.3
Diffstat (limited to 'docs/manual/mod/mod_example.html.en')
| -rw-r--r-- | docs/manual/mod/mod_example.html.en | 156 |
1 files changed, 156 insertions, 0 deletions
diff --git a/docs/manual/mod/mod_example.html.en b/docs/manual/mod/mod_example.html.en new file mode 100644 index 00000000..ce42e380 --- /dev/null +++ b/docs/manual/mod/mod_example.html.en @@ -0,0 +1,156 @@ +<?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.2</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/">Documentation</a> > <a href="../">Version 2.2</a> > <a href="./">Modules</a></div> +<div id="page-content"> +<div id="preamble"><h1>Apache Module mod_example</h1> +<div class="toplang"> +<p><span>Available Languages: </span><a href="../en/mod/mod_example.html" title="English"> en </a> | +<a href="../ko/mod/mod_example.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p> +</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> +<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" /> <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> +<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<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> + + <ol class="up-A"> + <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 + <code>include $(top_srcdir)/build/special.mk</code>.</li> + + <li>Run ./buildconf from the top-level directory.</li> + + <li>Build the server with --enable-myexample</li> + + </ol> +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="using" id="using">Using the <code>mod_example</code> Module</a></h2> + + <p>To activate the example module, include a block similar to + the following in your <code>httpd.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 class="bottomlang"> +<p><span>Available Languages: </span><a href="../en/mod/mod_example.html" title="English"> en </a> | +<a href="../ko/mod/mod_example.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p> +</div><div id="footer"> +<p class="apache">Copyright 2006 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> +</body></html>
\ No newline at end of file |