From: pcs Date: Sat, 21 Mar 1998 17:03:49 +0000 (+0000) Subject: Update docs to reflect the fact that mod_dll has been replaced by mod_so. X-Git-Tag: APACHE_BIG_SYMBOL_RENAME_POST~15 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=68bde2e09cd59421249904ce661bf6fc3279d4da;p=thirdparty%2Fapache%2Fhttpd.git Update docs to reflect the fact that mod_dll has been replaced by mod_so. In particular, mark mod_dll as obselete, add Windows information and examples to mod_so documentation, copy info about creating DLLs from mod_dll.html to mod_so.html (although this needs more work to add info for Unix users, since most of the description applies to all systems). git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@80623 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/docs/manual/mod/directives.html b/docs/manual/mod/directives.html index 3681bfd9c89..45fcf01e59d 100644 --- a/docs/manual/mod/directives.html +++ b/docs/manual/mod/directives.html @@ -120,10 +120,8 @@ of the terms used in their descriptions available.
  • <Limit>
  • Listen
  • ListenBacklog -
  • LoadFile (Unix) -
  • LoadFile (Windows) -
  • LoadModule (Unix) -
  • LoadModule (Windows) +
  • LoadFile +
  • LoadModule
  • <Location>
  • <LocationMatch>
  • LockFile diff --git a/docs/manual/mod/index.html b/docs/manual/mod/index.html index 123d6620357..612454414e4 100644 --- a/docs/manual/mod/index.html +++ b/docs/manual/mod/index.html @@ -60,8 +60,8 @@ mod_usertrack
    Basic directory handling.
    mod_dld Apache 1.2.* and earlier
    Start-time linking with the GNU libdld. Replaced in Apache 1.3 by mod_so -
    mod_dll -
    Start-time module linking with Win32 DLLs. +
    mod_dll Apache 1.3b1 to 1.3b5 only +
    Replaced in 1.3b6 by mod_so
    mod_env
    Passing of environments to CGI scripts
    mod_example Apache 1.2 and up @@ -100,7 +100,7 @@ mod_log_config module in Apache 1.2 and up
    mod_setenvif Apache 1.3 and up
    Set environment variables based on client information
    mod_so Apache 1.3 and up -
    Experimental support for loading modules at runtime on Unix +
    Experimental support for loading modules (DLLs on Windows) at runtime
    mod_speling Apache 1.3 and up
    Automatically correct minor typos in URLs
    mod_status diff --git a/docs/manual/mod/mod_so.html b/docs/manual/mod/mod_so.html index 5c9e6336f62..e3ad3e144f1 100644 --- a/docs/manual/mod/mod_so.html +++ b/docs/manual/mod/mod_so.html @@ -15,11 +15,20 @@

    Module mod_so

    -This module is contained in the mod_so.c file, and is not -compiled in by default. It provides for loading of executable code and -modules into the server at start-up time, on Unix systems. Win32 -systems use mod_dll instead. This module is -only available in Apache 1.3 and up. +This module is contained in the mod_so.c file. It is +compiled in by default on Windows and is not compiled in by default on +Unix. It provides for loading of executable code and modules into the +server at start-up or restart time. On Unix, the loaded code typically +comes from shared object files (usually with .so +extension), whilst on Windows this module loads DLL +files. This module is only available in Apache 1.3 and up. + +

    + +In previous releases, the functionality of this module was provided +for Unix by mod_dld, and for Windows by mod_dll. On Windows, mod_dll +was used in beta release 1.3b1 through 1.3b5. mod_so combines these +two modules into a single module for all operating systems.

    Summary

    @@ -55,10 +64,11 @@ a recompilation. REL="Help" >Module: mod_so

    -The LoadFile directive links in the named object files or libraries when -the server is started; this is used to load additional code which -may be required for some module to work. Filename is relative -to ServerRoot.


    +The LoadFile directive links in the named object files or libraries +when the server is started or restarted; this is used to load +additional code which may be required for some module to +work. Filename is either and absolute path or relative to ServerRoot.


    LoadModule

    @@ -82,11 +92,71 @@ to ServerRoot.


    The LoadModule directive links in the object file or library filename and adds the module structure named module to the list of active modules. Module is the name of the external variable of type -module in the file. Example: +module in the file. Example (Unix):
    LoadModule status_module modules/mod_status.so
    -loads the module in the modules subdirectory of the ServerRoot.

    + +

    + +Example (Windows): +

    +LoadModule status_module modules/ApacheModuleStatus.dll
    +
    + +loads the named module from the modules subdirectory of the +ServerRoot.

    + +


    + +

    Creating DLL Modules for Windows

    + +

    The Apache module API is unchanged between the Unix and Windows + versions. Many modules will run on Windows with no or little change + from Unix, although others rely on aspects of the Unix architecture + which are not present in Windows, and will not work.

    + +

    When a module does work, it can be added to the server in one of two + ways. As with Unix, it can be compiled into the server. Because Apache + for Windows does not have the Configure program of Apache + for Unix, the module's source file must be added to the ApacheCore + project file, and its symbols must be added to the + os\win32\modules.c file.

    + +

    The second way is to compile the module as a DLL, a shared library + that can be loaded into the server at runtime, using the + LoadModule + directive. These module DLLs can be distributed and run on any Apache + for Windows installation, without recompilation of the server.

    + +

    To create a module DLL, a small change is necessary to the module's + source file: The module record must be exported from the DLL (which + will be created later; see below). To do this, add the + MODULE_VAR_EXPORT (defined in the Apache header files) to + your module's module record definition. For example, if your module + has:

    +
    +    module foo_module;
    +
    +

    Replace the above with:

    +
    +    module MODULE_VAR_EXPORT foo_module;
    +
    +

    Note that this will only be activated on Windows, so the module can + continue to be used, unchanged, with Unix if needed. Also, if you are + familiar with .DEF files, you can export the module + record with that method instead.

    + +

    Now, create a DLL containing your module. You will need to link this + against the ApacheCore.lib export library that is created when the + ApacheCore.dll shared library is compiled. You may also have to change + the compiler settings to ensure that the Apache header files are + correctly located.

    + +

    This should create a DLL version of your module. Now simply place it + in the modules directory of your server root, and use + the LoadModule directive to + load it.