]> git.ipfire.org Git - thirdparty/apache/httpd.git/commitdiff
new XML
authorAndré Malo <nd@apache.org>
Sat, 5 Apr 2003 02:55:41 +0000 (02:55 +0000)
committerAndré Malo <nd@apache.org>
Sat, 5 Apr 2003 02:55:41 +0000 (02:55 +0000)
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@99227 13f79535-47bb-0310-9956-ffa450edef68

docs/manual/developer/hooks.html [deleted file]
docs/manual/developer/hooks.html.en [new file with mode: 0644]
docs/manual/developer/hooks.xml [new file with mode: 0644]

diff --git a/docs/manual/developer/hooks.html b/docs/manual/developer/hooks.html
deleted file mode 100644 (file)
index f7a5575..0000000
+++ /dev/null
@@ -1,199 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml">
-  <head>
-    <meta name="generator" content="HTML Tidy, see www.w3.org" />
-
-    <title>Apache 2.0 Hook Functions</title>
-  </head>
-  <!-- Background white, links blue (unvisited), navy (visited), red (active) -->
-
-  <body bgcolor="#FFFFFF" text="#000000" link="#0000FF"
-  vlink="#000080" alink="#FF0000">
-    <!--#include virtual="header.html" -->
-
-    <h1 align="center">Apache Hook Functions</h1>
-
-    <p>In general, a hook function is one that Apache will call at
-    some point during the processing of a request. Modules can
-    provide functions that are called, and specify when they get
-    called in comparison to other modules.</p>
-
-    <h2>Creating a hook function</h2>
-
-    <p>In order to create a new hook, four things need to be
-    done:</p>
-
-    <h3>Declare the hook function</h3>
-
-    <p>Use the AP_DECLARE_HOOK macro, which needs to be given the
-    return type of the hook function, the name of the hook, and the
-    arguments. For example, if the hook returns an <tt>int</tt> and
-    takes a <tt>request_rec *</tt> and an <tt>int</tt> and is
-    called "do_something", then declare it like this:</p>
-    <tt>AP_DECLARE_HOOK(int,do_something,(request_rec *r,int
-    n))</tt> 
-
-    <p>This should go in a header which modules will include if
-    they want to use the hook.</p>
-
-    <h3>Create the hook structure</h3>
-
-    <p>Each source file that exports a hook has a private structure
-    which is used to record the module functions that use the hook.
-    This is declared as follows:</p>
-<pre>
-APR_HOOK_STRUCT(
-            APR_HOOK_LINK(do_something)
-            ...
-           )
-</pre>
-
-    <h3>Implement the hook caller</h3>
-
-    <p>The source file that exports the hook has to implement a
-    function that will call the hook. There are currently three
-    possible ways to do this. In all cases, the calling function is
-    called <tt>ap_run_<i>hookname</i>()</tt>.</p>
-
-    <h4>Void hooks</h4>
-
-    <p>If the return value of a hook is <tt>void</tt>, then all the
-    hooks are called, and the caller is implemented like this:</p>
-    <tt>AP_IMPLEMENT_HOOK_VOID(do_something,(request_rec *r,int
-    n),(r,n))</tt> 
-
-    <p>The second and third arguments are the dummy argument
-    declaration and the dummy arguments as they will be used when
-    calling the hook. In other words, this macro expands to
-    something like this:</p>
-<pre>
-void ap_run_do_something(request_rec *r,int n)
-{
-    ...
-    do_something(r,n);
-}
-</pre>
-
-    <h4>Hooks that return a value</h4>
-
-    <p>If the hook returns a value, then it can either be run until
-    the first hook that does something interesting, like so:</p>
-    <tt>AP_IMPLEMENT_HOOK_RUN_FIRST(int,do_something,(request_rec
-    *r,int n),(r,n),DECLINED)</tt> 
-
-    <p>The first hook that <i>doesn't</i> return <tt>DECLINED</tt>
-    stops the loop and its return value is returned from the hook
-    caller. Note that <tt>DECLINED</tt> is the tradition Apache
-    hook return meaning "I didn't do anything", but it can be
-    whatever suits you.</p>
-
-    <p>Alternatively, all hooks can be run until an error occurs.
-    This boils down to permitting <i>two</i> return values, one of
-    which means "I did something, and it was OK" and the other
-    meaning "I did nothing". The first function that returns a
-    value other than one of those two stops the loop, and its
-    return is the return value. Declare these like so:</p>
-    <tt>AP_IMPLEMENT_HOOK_RUN_ALL(int,do_something,(request_rec
-    *r,int n),(r,n),OK,DECLINED)</tt> 
-
-    <p>Again, <tt>OK</tt> and <tt>DECLINED</tt> are the traditional
-    values. You can use what you want.</p>
-
-    <h3>Call the hook callers</h3>
-
-    <p>At appropriate moments in the code, call the hook caller,
-    like so:</p>
-<pre>
-    int n,ret;
-    request_rec *r;
-
-    ret=ap_run_do_something(r,n);
-</pre>
-
-    <h2>Hooking the hook</h2>
-
-    <p>A module that wants a hook to be called needs to do two
-    things.</p>
-
-    <h3>Implement the hook function</h3>
-
-    <p>Include the appropriate header, and define a static function
-    of the correct type:</p>
-<pre>
-static int my_something_doer(request_rec *r,int n)
-{
-    ...
-    return OK;
-}
-</pre>
-
-    <h3>Add a hook registering function</h3>
-
-    <p>During initialisation, Apache will call each modules hook
-    registering function, which is included in the module
-    structure:</p>
-<pre>
-static void my_register_hooks()
-{
-    ap_hook_do_something(my_something_doer,NULL,NULL,HOOK_MIDDLE);
-}
-
-mode MODULE_VAR_EXPORT my_module =
-{
-    ...
-    my_register_hooks       /* register hooks */
-};
-</pre>
-
-    <h3>Controlling hook calling order</h3>
-
-    <p>In the example above, we didn't use the three arguments in
-    the hook registration function that control calling order.
-    There are two mechanisms for doing this. The first, rather
-    crude, method, allows us to specify roughly where the hook is
-    run relative to other modules. The final argument control this.
-    There are three possible values:</p>
-<pre>
-HOOK_FIRST
-HOOK_MIDDLE
-HOOK_LAST
-</pre>
-
-    <p>All modules using any particular value may be run in any
-    order relative to each other, but, of course, all modules using
-    <tt>HOOK_FIRST</tt> will be run before <tt>HOOK_MIDDLE</tt>
-    which are before <tt>HOOK_LAST</tt>. Modules that don't care
-    when they are run should use <tt>HOOK_MIDDLE</tt>. <i>(I spaced
-    these out so people could do stuff like <tt>HOOK_FIRST-2</tt>
-    to get in slightly earlier, but is this wise? - Ben)</i></p>
-
-    <p>Note that there are two more values,
-    <tt>HOOK_REALLY_FIRST</tt> and <tt>HOOK_REALLY_LAST</tt>. These
-    should only be used by the hook exporter.</p>
-
-    <p>The other method allows finer control. When a module knows
-    that it must be run before (or after) some other modules, it
-    can specify them by name. The second (third) argument is a
-    NULL-terminated array of strings consisting of the names of
-    modules that must be run before (after) the current module. For
-    example, suppose we want "mod_xyz.c" and "mod_abc.c" to run
-    before we do, then we'd hook as follows:</p>
-<pre>
-static void register_hooks()
-{
-    static const char * const aszPre[]={ "mod_xyz.c", "mod_abc.c", NULL };
-
-    ap_hook_do_something(my_something_doer,aszPre,NULL,HOOK_MIDDLE);
-}
-</pre>
-
-    <p>Note that the sort used to achieve this is stable, so
-    ordering set by <tt>HOOK_<i>ORDER</i></tt> is preserved, as far
-    as is possible.</p>
-    <i>Ben Laurie, 15th August 1999</i> 
-    <!--#include virtual="footer.html" -->
-  </body>
-</html>
-
diff --git a/docs/manual/developer/hooks.html.en b/docs/manual/developer/hooks.html.en
new file mode 100644 (file)
index 0000000..120d908
--- /dev/null
@@ -0,0 +1,233 @@
+<?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>Apache 2.0 Hook Functions - 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 id="manual-page"><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="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
+<div id="path">
+<a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs-project/">Documentation</a> &gt; <a href="../">Version 2.1</a></div><div id="page-content"><div id="preamble"><h1>Apache 2.0 Hook Functions</h1>
+    <div class="warning"><h3>Warning</h3>
+      <p>This document is still in development and may be partially out of
+      date.</p>
+    </div>
+
+    <p>In general, a hook function is one that Apache will call at
+    some point during the processing of a request. Modules can
+    provide functions that are called, and specify when they get
+    called in comparison to other modules.</p>
+</div>
+<div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#create">Creating a hook function</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#hooking">Hooking the hook</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="create" id="create">Creating a hook function</a></h2>
+    <p>In order to create a new hook, four things need to be
+    done:</p>
+
+    <h3><a name="create-declare" id="create-declare">Declare the hook function</a></h3>
+      <p>Use the <code>AP_DECLARE_HOOK</code> macro, which needs to be given
+      the return type of the hook function, the name of the hook, and the
+      arguments. For example, if the hook returns an <code>int</code> and
+      takes a <code>request_rec *</code> and an <code>int</code> and is
+      called <code>do_something</code>, then declare it like this:</p>
+      <div class="example"><p><code>
+        AP_DECLARE_HOOK(int, do_something, (request_rec *r, int n))
+      </code></p></div>
+
+      <p>This should go in a header which modules will include if
+      they want to use the hook.</p>
+    
+
+    <h3><a name="create-create" id="create-create">Create the hook structure</a></h3>
+      <p>Each source file that exports a hook has a private structure
+      which is used to record the module functions that use the hook.
+      This is declared as follows:</p>
+
+      <div class="example"><p><code>
+        APR_HOOK_STRUCT(<br />
+        <span class="indent">
+          APR_HOOK_LINK(do_something)<br />
+          ...<br />
+        </span>
+        )
+      </code></p></div>
+    
+
+    <h3><a name="create-implement" id="create-implement">Implement the hook caller</a></h3>
+      <p>The source file that exports the hook has to implement a
+      function that will call the hook. There are currently three
+      possible ways to do this. In all cases, the calling function is
+      called <code>ap_run_<var>hookname</var>()</code>.</p>
+
+      <h4>Void hooks</h4>
+        <p>If the return value of a hook is <code>void</code>, then all the
+        hooks are called, and the caller is implemented like this:</p>
+
+        <div class="example"><p><code>
+          AP_IMPLEMENT_HOOK_VOID(do_something, (request_rec *r, int n), (r, n))
+        </code></p></div>
+
+        <p>The second and third arguments are the dummy argument
+        declaration and the dummy arguments as they will be used when
+        calling the hook. In other words, this macro expands to
+        something like this:</p>
+
+        <div class="example"><p><code>
+          void ap_run_do_something(request_rec *r, int n)<br />
+          {<br />
+          <span class="indent">
+            ...<br />
+            do_something(r, n);<br />
+          </span>
+          }
+        </code></p></div>
+      
+
+      <h4>Hooks that return a value</h4>
+        <p>If the hook returns a value, then it can either be run until
+        the first hook that does something interesting, like so:</p>
+
+        <div class="example"><p><code>
+          AP_IMPLEMENT_HOOK_RUN_FIRST(int, do_something, (request_rec *r, int n), (r, n), DECLINED)
+        </code></p></div>
+
+        <p>The first hook that does <em>not</em> return <code>DECLINED</code>
+        stops the loop and its return value is returned from the hook
+        caller. Note that <code>DECLINED</code> is the tradition Apache
+        hook return meaning "I didn't do anything", but it can be
+        whatever suits you.</p>
+
+        <p>Alternatively, all hooks can be run until an error occurs.
+        This boils down to permitting <em>two</em> return values, one of
+        which means "I did something, and it was OK" and the other
+        meaning "I did nothing". The first function that returns a
+        value other than one of those two stops the loop, and its
+        return is the return value. Declare these like so:</p>
+
+        <div class="example"><p><code>
+          AP_IMPLEMENT_HOOK_RUN_ALL(int, do_something, (request_rec *r, int n), (r, n), OK, DECLINED)
+        </code></p></div>
+
+        <p>Again, <code>OK</code> and <code>DECLINED</code> are the traditional
+        values. You can use what you want.</p>
+      
+    
+
+    <h3><a name="create-call" id="create-call">Call the hook callers</a></h3>
+      <p>At appropriate moments in the code, call the hook caller,
+      like so:</p>
+
+      <div class="example"><p><code>
+        int n, ret;<br />
+        request_rec *r;<br />
+        <br />
+        ret=ap_run_do_something(r, n);
+      </code></p></div>
+    
+</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="section">
+<h2><a name="hooking" id="hooking">Hooking the hook</a></h2>
+    <p>A module that wants a hook to be called needs to do two
+    things.</p>
+
+    <h3><a name="hooking-implement" id="hooking-implement">Implement the hook function</a></h3>
+      <p>Include the appropriate header, and define a static function
+      of the correct type:</p>
+
+      <div class="example"><p><code>
+        static int my_something_doer(request_rec *r, int n)<br />
+        {<br />
+        <span class="indent">
+          ...<br />
+          return OK;<br />
+        </span>
+        }
+      </code></p></div>
+    
+
+    <h3><a name="hooking-add" id="hooking-add">Add a hook registering function</a></h3>
+      <p>During initialisation, Apache will call each modules hook
+      registering function, which is included in the module
+      structure:</p>
+
+      <div class="example"><p><code>
+        static void my_register_hooks()<br />
+        {<br />
+        <span class="indent">
+          ap_hook_do_something(my_something_doer, NULL, NULL, HOOK_MIDDLE);<br />
+        </span>
+        }<br />
+        <br />
+        mode MODULE_VAR_EXPORT my_module =<br />
+        {<br />
+        <span class="indent">
+          ...<br />
+          my_register_hooks       /* register hooks */<br />
+        </span>
+        };
+      </code></p></div>
+    
+
+    <h3><a name="hooking-order" id="hooking-order">Controlling hook calling order</a></h3>
+      <p>In the example above, we didn't use the three arguments in
+      the hook registration function that control calling order.
+      There are two mechanisms for doing this. The first, rather
+      crude, method, allows us to specify roughly where the hook is
+      run relative to other modules. The final argument control this.
+      There are three possible values: <code>HOOK_FIRST</code>,
+      <code>HOOK_MIDDLE</code> and <code>HOOK_LAST</code>.</p>
+
+      <p>All modules using any particular value may be run in any
+      order relative to each other, but, of course, all modules using
+      <code>HOOK_FIRST</code> will be run before <code>HOOK_MIDDLE</code>
+      which are before <code>HOOK_LAST</code>. Modules that don't care
+      when they are run should use <code>HOOK_MIDDLE</code>. <em>(I spaced
+      these out so people could do stuff like <code>HOOK_FIRST-2</code>
+      to get in slightly earlier, but is this wise? - Ben)</em></p>
+
+      <p>Note that there are two more values,
+      <code>HOOK_REALLY_FIRST</code> and <code>HOOK_REALLY_LAST</code>. These
+      should only be used by the hook exporter.</p>
+
+      <p>The other method allows finer control. When a module knows
+      that it must be run before (or after) some other modules, it
+      can specify them by name. The second (third) argument is a
+      NULL-terminated array of strings consisting of the names of
+      modules that must be run before (after) the current module. For
+      example, suppose we want "mod_xyz.c" and "mod_abc.c" to run
+      before we do, then we'd hook as follows:</p>
+
+      <div class="example"><p><code>
+        static void register_hooks()<br />
+        {<br />
+        <span class="indent">
+          static const char * const aszPre[] = { "mod_xyz.c", "mod_abc.c", NULL };<br />
+          <br />
+          ap_hook_do_something(my_something_doer, aszPre, NULL, HOOK_MIDDLE);<br />
+        </span>
+        }
+      </code></p></div>
+
+      <p>Note that the sort used to achieve this is stable, so
+      ordering set by <code>HOOK_<var>ORDER</var></code> is preserved, as far
+      as is possible.</p>
+
+      <p class="cite"><cite>Ben Laurie</cite>, 15th August 1999</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>
\ No newline at end of file
diff --git a/docs/manual/developer/hooks.xml b/docs/manual/developer/hooks.xml
new file mode 100644 (file)
index 0000000..ce94207
--- /dev/null
@@ -0,0 +1,218 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!DOCTYPE manualpage SYSTEM "../style/manualpage.dtd">
+<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
+
+<manualpage>
+<relativepath href=".."/>
+
+<title>Apache 2.0 Hook Functions</title>
+
+<summary>
+    <note type="warning"><title>Warning</title>
+      <p>This document is still in development and may be partially out of
+      date.</p>
+    </note>
+
+    <p>In general, a hook function is one that Apache will call at
+    some point during the processing of a request. Modules can
+    provide functions that are called, and specify when they get
+    called in comparison to other modules.</p>
+</summary>
+
+<section id="create"><title>Creating a hook function</title>
+    <p>In order to create a new hook, four things need to be
+    done:</p>
+
+    <section id="create-declare"><title>Declare the hook function</title>
+      <p>Use the <code>AP_DECLARE_HOOK</code> macro, which needs to be given
+      the return type of the hook function, the name of the hook, and the
+      arguments. For example, if the hook returns an <code>int</code> and
+      takes a <code>request_rec *</code> and an <code>int</code> and is
+      called <code>do_something</code>, then declare it like this:</p>
+      <example>
+        AP_DECLARE_HOOK(int, do_something, (request_rec *r, int n))
+      </example>
+
+      <p>This should go in a header which modules will include if
+      they want to use the hook.</p>
+    </section>
+
+    <section id="create-create"><title>Create the hook structure</title>
+      <p>Each source file that exports a hook has a private structure
+      which is used to record the module functions that use the hook.
+      This is declared as follows:</p>
+
+      <example>
+        APR_HOOK_STRUCT(<br />
+        <indent>
+          APR_HOOK_LINK(do_something)<br />
+          ...<br />
+        </indent>
+        )
+      </example>
+    </section>
+
+    <section id="create-implement"><title>Implement the hook caller</title>
+      <p>The source file that exports the hook has to implement a
+      function that will call the hook. There are currently three
+      possible ways to do this. In all cases, the calling function is
+      called <code>ap_run_<var>hookname</var>()</code>.</p>
+
+      <section><title>Void hooks</title>
+        <p>If the return value of a hook is <code>void</code>, then all the
+        hooks are called, and the caller is implemented like this:</p>
+
+        <example>
+          AP_IMPLEMENT_HOOK_VOID(do_something, (request_rec *r, int n), (r, n))
+        </example>
+
+        <p>The second and third arguments are the dummy argument
+        declaration and the dummy arguments as they will be used when
+        calling the hook. In other words, this macro expands to
+        something like this:</p>
+
+        <example>
+          void ap_run_do_something(request_rec *r, int n)<br />
+          {<br />
+          <indent>
+            ...<br />
+            do_something(r, n);<br />
+          </indent>
+          }
+        </example>
+      </section>
+
+      <section><title>Hooks that return a value</title>
+        <p>If the hook returns a value, then it can either be run until
+        the first hook that does something interesting, like so:</p>
+
+        <example>
+          AP_IMPLEMENT_HOOK_RUN_FIRST(int, do_something, (request_rec *r, int n), (r, n), DECLINED)
+        </example>
+
+        <p>The first hook that does <em>not</em> return <code>DECLINED</code>
+        stops the loop and its return value is returned from the hook
+        caller. Note that <code>DECLINED</code> is the tradition Apache
+        hook return meaning "I didn't do anything", but it can be
+        whatever suits you.</p>
+
+        <p>Alternatively, all hooks can be run until an error occurs.
+        This boils down to permitting <em>two</em> return values, one of
+        which means "I did something, and it was OK" and the other
+        meaning "I did nothing". The first function that returns a
+        value other than one of those two stops the loop, and its
+        return is the return value. Declare these like so:</p>
+
+        <example>
+          AP_IMPLEMENT_HOOK_RUN_ALL(int, do_something, (request_rec *r, int n), (r, n), OK, DECLINED)
+        </example>
+
+        <p>Again, <code>OK</code> and <code>DECLINED</code> are the traditional
+        values. You can use what you want.</p>
+      </section>
+    </section>
+
+    <section id="create-call"><title>Call the hook callers</title>
+      <p>At appropriate moments in the code, call the hook caller,
+      like so:</p>
+
+      <example>
+        int n, ret;<br />
+        request_rec *r;<br />
+        <br />
+        ret=ap_run_do_something(r, n);
+      </example>
+    </section>
+</section>
+
+<section id="hooking"><title>Hooking the hook</title>
+    <p>A module that wants a hook to be called needs to do two
+    things.</p>
+
+    <section id="hooking-implement"><title>Implement the hook function</title>
+      <p>Include the appropriate header, and define a static function
+      of the correct type:</p>
+
+      <example>
+        static int my_something_doer(request_rec *r, int n)<br />
+        {<br />
+        <indent>
+          ...<br />
+          return OK;<br />
+        </indent>
+        }
+      </example>
+    </section>
+
+    <section id="hooking-add"><title>Add a hook registering function</title>
+      <p>During initialisation, Apache will call each modules hook
+      registering function, which is included in the module
+      structure:</p>
+
+      <example>
+        static void my_register_hooks()<br />
+        {<br />
+        <indent>
+          ap_hook_do_something(my_something_doer, NULL, NULL, HOOK_MIDDLE);<br />
+        </indent>
+        }<br />
+        <br />
+        mode MODULE_VAR_EXPORT my_module =<br />
+        {<br />
+        <indent>
+          ...<br />
+          my_register_hooks       /* register hooks */<br />
+        </indent>
+        };
+      </example>
+    </section>
+
+    <section id="hooking-order"><title>Controlling hook calling order</title>
+      <p>In the example above, we didn't use the three arguments in
+      the hook registration function that control calling order.
+      There are two mechanisms for doing this. The first, rather
+      crude, method, allows us to specify roughly where the hook is
+      run relative to other modules. The final argument control this.
+      There are three possible values: <code>HOOK_FIRST</code>,
+      <code>HOOK_MIDDLE</code> and <code>HOOK_LAST</code>.</p>
+
+      <p>All modules using any particular value may be run in any
+      order relative to each other, but, of course, all modules using
+      <code>HOOK_FIRST</code> will be run before <code>HOOK_MIDDLE</code>
+      which are before <code>HOOK_LAST</code>. Modules that don't care
+      when they are run should use <code>HOOK_MIDDLE</code>. <em>(I spaced
+      these out so people could do stuff like <code>HOOK_FIRST-2</code>
+      to get in slightly earlier, but is this wise? - Ben)</em></p>
+
+      <p>Note that there are two more values,
+      <code>HOOK_REALLY_FIRST</code> and <code>HOOK_REALLY_LAST</code>. These
+      should only be used by the hook exporter.</p>
+
+      <p>The other method allows finer control. When a module knows
+      that it must be run before (or after) some other modules, it
+      can specify them by name. The second (third) argument is a
+      NULL-terminated array of strings consisting of the names of
+      modules that must be run before (after) the current module. For
+      example, suppose we want "mod_xyz.c" and "mod_abc.c" to run
+      before we do, then we'd hook as follows:</p>
+
+      <example>
+        static void register_hooks()<br />
+        {<br />
+        <indent>
+          static const char * const aszPre[] = { "mod_xyz.c", "mod_abc.c", NULL };<br />
+          <br />
+          ap_hook_do_something(my_something_doer, aszPre, NULL, HOOK_MIDDLE);<br />
+        </indent>
+        }
+      </example>
+
+      <p>Note that the sort used to achieve this is stable, so
+      ordering set by <code>HOOK_<var>ORDER</var></code> is preserved, as far
+      as is possible.</p>
+
+      <p class="cite"><cite>Ben Laurie</cite>, 15th August 1999</p>
+    </section>
+</section>
+</manualpage>
+