home *** CD-ROM | disk | FTP | other *** search
/ GameStar 2004 May / Gamestar_62_2004-05_dvd.iso / Programy / apache_2.0.48-win32-x86-no_ssl.msi / Data.Cab / F252520_mod_example.html.en < prev    next >
Extensible Markup Language  |  2003-05-29  |  8KB  |  152 lines
  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" />
  12. <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13. <body>
  14. <div id="page-header">
  15. <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>
  16. <p class="apache">Apache HTTP Server Version 2.0</p>
  17. <img alt="" src="../images/feather.gif" /></div>
  18. <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
  19. <div id="path">
  20. <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.0</a> > <a href="./">Modules</a></div>
  21. <div id="page-content">
  22. <div id="preamble"><h1>Apache Module mod_example</h1>
  23. <div class="toplang">
  24. <p><span>Available Languages: </span><a href="../en/mod/mod_example.html" title="English"> en </a></p>
  25. </div>
  26. <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Illustrates the Apache module API</td></tr>
  27. <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
  28. <tr><th><a href="module-dict.html#ModuleIdentifier">ModuleáIdentifier:</a></th><td>example_module</td></tr>
  29. <tr><th><a href="module-dict.html#SourceFile">SourceáFile:</a></th><td>mod_example.c</td></tr></table>
  30. <h3>Summary</h3>
  31.  
  32. <div class="warning">
  33.       This document has not been updated
  34.       to take into account changes made in the 2.0 version of the
  35.       Apache HTTP Server. Some of the information may still be
  36.       relevant, but please use it with care.
  37. </div>
  38.  
  39.     <p>The files in the <code>src/modules/example directory</code>
  40.     under the Apache distribution directory tree are provided as an
  41.     example to those that wish to write modules that use the Apache
  42.     API.</p>
  43.  
  44.     <p>The main file is <code>mod_example.c</code>, which
  45.     illustrates all the different callback mechanisms and call
  46.     syntaxes. By no means does an add-on module need to include
  47.     routines for all of the callbacks - quite the contrary!</p>
  48.  
  49.     <p>The example module is an actual working module. If you link
  50.     it into your server, enable the "example-handler" handler for a
  51.     location, and then browse to that location, you will see a
  52.     display of some of the tracing the example module did as the
  53.     various callbacks were made.</p>
  54. </div>
  55. <div id="quickview"><h3 class="directives">Directives</h3>
  56. <ul id="toc">
  57. <li><img alt="" src="../images/down.gif" /> <a href="#example">Example</a></li>
  58. </ul>
  59. <h3>Topics</h3>
  60. <ul id="topics">
  61. <li><img alt="" src="../images/down.gif" /> <a href="#compiling">Compiling the example module</a></li>
  62. <li><img alt="" src="../images/down.gif" /> <a href="#using">Using the <code>mod_example</code> Module</a></li>
  63. </ul></div>
  64. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  65. <div class="section">
  66. <h2><a name="compiling" id="compiling">Compiling the example module</a></h2>
  67.  
  68.     <p>To include the example module in your server, follow the
  69.     steps below:</p>
  70.  
  71.     <ol>
  72.       <li>
  73.         Uncomment the "AddModule modules/example/mod_example" line
  74.         near the bottom of the <code>src/Configuration</code> file.
  75.         If there isn't one, add it; it should look like this: 
  76. <div class="example"><p><code>
  77.      AddModule modules/example/mod_example.o
  78. </code></p></div>
  79.       </li>
  80.  
  81.       <li>Run the <code>src/Configure</code> script
  82.       ("<code>cd src; ./Configure</code>"). This will
  83.       build the Makefile for the server itself, and update the
  84.       <code>src/modules/Makefile</code> for any additional modules
  85.       you have requested from beneath that subdirectory.</li>
  86.  
  87.       <li>Make the server (run "<code>make</code>" in the
  88.       <code>src</code> directory).</li>
  89.     </ol>
  90.  
  91.     <p>To add another module of your own:</p>
  92.  
  93.     <ol class="up-A">
  94.       <li><code>mkdir src/modules/<em>mymodule</em></code></li>
  95.  
  96.       <li><code>cp src/modules/example/*
  97.       src/modules/<em>mymodule</em></code></li>
  98.  
  99.       <li>Modify the files in the new directory.</li>
  100.  
  101.       <li>Follow steps [1] through [3] above, with appropriate
  102.       changes.</li>
  103.     </ol>
  104. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  105. <div class="section">
  106. <h2><a name="using" id="using">Using the <code>mod_example</code> Module</a></h2>
  107.  
  108.     <p>To activate the example module, include a block similar to
  109.     the following in your <code>srm.conf</code> file:</p>
  110. <div class="example"><p><code>
  111.    <Location /example-info><br />
  112.        SetHandler example-handler<br />
  113.    </Location>
  114. </code></p></div>
  115.  
  116.     <p>As an alternative, you can put the following into a <a href="core.html#accessfilename"><code>.htaccess</code></a> file
  117.     and then request the file "test.example" from that location:</p>
  118. <div class="example"><p><code>
  119.    AddHandler example-handler .example
  120. </code></p></div>
  121.  
  122.     <p>After reloading/restarting your server, you should be able
  123.     to browse to this location and see the brief display mentioned
  124.     earlier.</p>
  125. </div>
  126. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  127. <div class="directive-section"><h2><a name="Example" id="Example">Example</a> <a name="example" id="example">Directive</a></h2>
  128. <table class="directive">
  129. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Demonstration directive to illustrate the Apache module
  130. API</td></tr>
  131. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Example</code></td></tr>
  132. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
  133. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
  134. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_example</td></tr>
  135. </table>
  136.     <p>The <code class="directive">Example</code> directive just sets a demonstration
  137.     flag which the example module's content handler displays. It
  138.     takes no arguments. If you browse to an URL to which the
  139.     example content-handler applies, you will get a display of the
  140.     routines within the module and how and in what order they were
  141.     called to service the document request. The effect of this
  142.     directive one can observe under the point "<code>Example
  143.     directive declared here: YES/NO</code>".</p>
  144.  
  145. </div>
  146. </div>
  147. <div class="bottomlang">
  148. <p><span>Available Languages: </span><a href="../en/mod/mod_example.html" title="English"> en </a></p>
  149. </div><div id="footer">
  150. <p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</a></p>
  151. <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>
  152. </body></html>