From 80db94fff6a9620fb469ee911347ed973e3f7735 Mon Sep 17 00:00:00 2001 From: Stefan Fritsch Date: Tue, 27 Dec 2011 19:42:03 +0100 Subject: Upstream tarball 2.2.3 --- docs/manual/mod/mod_example.html.en | 156 ++++++++++++++++++++++++++++++++++++ 1 file changed, 156 insertions(+) create mode 100644 docs/manual/mod/mod_example.html.en (limited to 'docs/manual/mod/mod_example.html.en') 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 @@ + + + +mod_example - Apache HTTP Server + + + + + +
+

Modules | Directives | FAQ | Glossary | Sitemap

+

Apache HTTP Server Version 2.2

+
+
<-
+
+Apache > HTTP Server > Documentation > Version 2.2 > Modules
+
+

Apache Module mod_example

+
+

Available Languages:  en  | + ko 

+
+ + + +
Description:Illustrates the Apache module API
Status:Experimental
Module Identifier:example_module
Source File:mod_example.c
+

Summary

+ +

Some files in the modules/experimental 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 + syntaxes. 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.

+
+ +
top
+
+

Compiling the example module

+ +

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

+ +
    +
  1. + Run configure with --enable-example + option.
    2. + +
  2. Make the server (run "make").
    3. +
+ +

To add another module of your own:

+ +
    +
  1. cp modules/experimental/mod_example.c + modules/new_module/mod_myexample.c
    2. + +
  2. Modify the file.
    3. + +
  3. Create modules/new_module/config.m4. +
      +
    1. Add APACHE_MODPATH_INIT(new_module).
      2. +
    2. Copy APACHE_MODULE line with "example" from + modules/experimental/config.m4.
      3. +
    3. Replace the first argument "example" with myexample.
      4. +
    4. Replace the second argument with brief description of your module. + It will be used in configure --help.
      5. +
    5. If your module needs additional C compiler flags, linker flags or + libraries, add them to CFLAGS, LDFLAGS and LIBS accordingly. + See other config.m4 files in modules directory for + examples.
      6. +
    6. Add APACHE_MODPATH_FINISH.
      7. +
    +
    4. + +
  4. Create module/new_module/Makefile.in. + If your module doesn't need special build instructions, + all you need to have in that file is + include $(top_srcdir)/build/special.mk.
    5. + +
  5. Run ./buildconf from the top-level directory.
    6. + +
  6. Build the server with --enable-myexample
    7. + +
+
top
+
+

Using the mod_example Module

+ +

To activate the example module, include a block similar to + the following in your httpd.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.

+
+
top
+

Example Directive

+ + + + + + +
Description:Demonstration directive to illustrate the Apache module +API
Syntax:Example
Context:server config, virtual host, directory, .htaccess
Status:Experimental
Module:mod_example
+

The Example 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 "Example + directive declared here: YES/NO".

+ +
+
+
+

Available Languages:  en  | + ko 

+
+ \ No newline at end of file -- cgit v1.2.3