From: Ken Coar Date: Fri, 11 Apr 1997 22:23:26 +0000 (+0000) Subject: Update documentation to include stuff for mod_example. X-Git-Tag: APACHE_1_2b9~62 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=e11fd1f0c06f7f42d4620e8f6afb970d61d5773c;p=apache Update documentation to include stuff for mod_example. git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@77852 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/docs/manual/mod/directives.html b/docs/manual/mod/directives.html index cdcbd95e89..cf18af1a58 100644 --- a/docs/manual/mod/directives.html +++ b/docs/manual/mod/directives.html @@ -67,6 +67,7 @@
  • DocumentRoot
  • ErrorDocument
  • ErrorLog +
  • Example
  • ExpiresActive
  • ExpiresByType
  • ExpiresDefault diff --git a/docs/manual/mod/index.html b/docs/manual/mod/index.html index 86f0619ca6..b2185ab18a 100644 --- a/docs/manual/mod/index.html +++ b/docs/manual/mod/index.html @@ -46,6 +46,8 @@ mod_usertrack
    Start-time linking with the GNU libdld.
    mod_env
    Passing of environments to CGI scripts +
    mod_example Apache 1.2 and up +
    Demonstrates Apache API
    mod_expires Apache 1.2 and up
    Apply Expires: headers to resources
    mod_headers Apache 1.2 and up diff --git a/docs/manual/mod/mod_example.html b/docs/manual/mod/mod_example.html new file mode 100644 index 0000000000..05fb8ef721 --- /dev/null +++ b/docs/manual/mod/mod_example.html @@ -0,0 +1,133 @@ + + + + Apache module mod_example + + + +

    Module mod_example

    +

    + This module is contained in the modules/mod_example.c file, and + is not compiled in by default. It illustrates many of + the aspects of the + Apache 1.2 API + and, when used, demonstrates the manner in which module callbacks are + triggered by the server. +

    +

    Summary

    +

    + The files in the src/modules/example directory under the + Apache distribution directory tree are provided as an example to those + that wish to write modules that use the Apache API. +

    +

    + The main file is mod_example.c, which illustrates all + the different callback mechanisms and call syntaces. By no means does + an add-on module need to include routines for all of the callbacks - + quite the contrary! +

    +

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

    +

    + To include the example module in your server, follow the steps below: +

    +
      +
    1. Uncomment the "Module example_module" line near the bottom of + the src/Configuration file. If there isn't one, add + it; it should look like this: + 
      +     Module example_module        modules/example/mod_example.o
+
      +
      2. +
    2. Run the src/Configure script + ("cd src; ./Configure"). This will + build the Makefile for the server itself, and update the + src/modules/Makefile for any additional modules you + have requested from beneath that subdirectory. +
      3. +
    3. Make the server (run "make" in the src + directory). +
      4. +
    +

    + To add another module of your own: +

    +
      +
    1. mkdir src/modules/mymodule +
      2. +
    2. cp src/modules/example/* src/modules/mymodule +
      3. +
    3. Modify the files in the new directory. +
      4. +
    4. Follow steps [1] through [3] above, with appropriate changes. +
      5. +
    +

    + Using the mod_example Module +

    +

    + To activate the example module, include a block similar to the + following in your srm.conf file: +

    + 
    +   <Location /example-info>
+       SetHandler example-handler
+   </Location>
+
    +

    + As an alternative, you can put the following into a + .htaccess + file and then request the file "test.example" from that + location: +

    + 
    +   AddHandler example-handler .example
+
    +

    + After reloading/restarting your server, you should be able to browse + to this location and see the brief display mentioned earlier. +

    +

    Directives

    +

    +

    +

    +
    + +

    Example

    +     +

    + Syntax: Example +
    + Default: None +
    + Context: server config, virtual host, directory, .htaccess +
    + Override: Options +
    + Status: Extension +
    + Module: mod_example +

    +

    + The Example directive activates the example module's content handler + for a particular location or file type. 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. +

    + + +