You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by wr...@locus.apache.org on 2000/12/21 03:26:57 UTC
cvs commit: httpd-2.0/docs/manual/mod index-bytype.html index.html mod_so.html
wrowe 00/12/20 18:26:56
Modified: docs/manual/mod index-bytype.html index.html mod_so.html
Log:
Document the Win32 .so change. Time to rest the brain.
Revision Changes Path
1.12 +1 -1 httpd-2.0/docs/manual/mod/index-bytype.html
Index: index-bytype.html
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/index-bytype.html,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- index-bytype.html 2000/12/11 00:45:41 1.11
+++ index-bytype.html 2000/12/21 02:26:56 1.12
@@ -165,7 +165,7 @@
<DT><A HREF="mod_proxy.html">mod_proxy</A>
<DD>Caching proxy abilities
<DT><A HREF="mod_so.html">mod_so</A>
-<DD>Experimental support for loading modules (DLLs on Windows) at runtime
+<DD>Support for loading modules at runtime
<DT><A HREF="mod_file_cache.html">mod_file_cache</A>
<DD>Caching files in memory for faster serving.
<DT><A HREF="mod_dav.html">mod_dav</A>
1.47 +2 -2 httpd-2.0/docs/manual/mod/index.html
Index: index.html
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/index.html,v
retrieving revision 1.46
retrieving revision 1.47
diff -u -r1.46 -r1.47
--- index.html 2000/12/11 00:45:41 1.46
+++ index.html 2000/12/21 02:26:56 1.47
@@ -66,7 +66,7 @@
<DT><A HREF="mod_auth_dbm.html">mod_auth_dbm</A>
<DD>User authentication using DBM files.
<DT><A HREF="mod_auth_digest.html">mod_auth_digest</A>
-<DD>MD5 authentication (experimental)
+<DD>MD5 authentication
<DT><A HREF="mod_autoindex.html">mod_autoindex</A>
<DD>Automatic directory listings.
<DT><A HREF="mod_cern_meta.html">mod_cern_meta</A>
@@ -114,7 +114,7 @@
<DT><A HREF="mod_setenvif.html">mod_setenvif</A>
<DD>Set environment variables based on client information
<DT><A HREF="mod_so.html">mod_so</A>
-<DD>Experimental support for loading modules (DLLs on Windows) at runtime
+<DD>Support for loading modules at runtime
<DT><A HREF="mod_speling.html">mod_speling</A>
<DD>Automatically correct minor typos in URLs
<DT><A HREF="mod_status.html">mod_status</A>
1.9 +31 -27 httpd-2.0/docs/manual/mod/mod_so.html
Index: mod_so.html
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_so.html,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- mod_so.html 2000/12/09 19:50:04 1.8
+++ mod_so.html 2000/12/21 02:26:56 1.9
@@ -21,7 +21,7 @@
<P><A
HREF="module-dict.html#Status"
REL="Help"
-><STRONG>Status:</STRONG></A> Base (Windows); Experimental (Unix)
+><STRONG>Status:</STRONG></A> Base (Windows); Optional (Unix)
<BR>
<A
HREF="module-dict.html#SourceFile"
@@ -42,31 +42,39 @@
<H2>Summary</H2>
-<p>This is an experimental module. On selected operating systems it
-can be used to load modules into Apache at runtime via the <A
-HREF="../dso.html">Dynamic Shared Object</A> (DSO) mechanism, rather
-than requiring a recompilation.
+<P>On selected operating systems this module can be used to load modules
+into Apache at runtime via the <A HREF="../dso.html">Dynamic Shared
+Object</A> (DSO) mechanism, rather than requiring a recompilation.
<P>
On Unix, the loaded code typically comes from shared object files
-(usually with <SAMP>.so</SAMP> extension), whilst on Windows this
-module loads <SAMP>DLL</SAMP> files. This module is only available in
-Apache 1.3 and up.
+(usually with <SAMP>.so</SAMP> extension), on Windows this may either
+the <SAMP>.so</SAMP> or <SAMP>.dll</SAMP> extension. This module is
+only available in Apache 1.3 and up.
-
<p>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.
+<P><STRONG> Warning: Apache 1.3 modules cannot be directly used with
+ Apache 2.0 - the module must be modified to dynamically load or
+ compile into Apache 2.0</STRONG>.</P>
+
<H2>Directives</H2>
<UL>
<LI><A HREF="#loadfile">LoadFile</A>
<LI><A HREF="#loadmodule">LoadModule</A>
</UL>
-<H2><A NAME="creating">Creating DLL Modules for Windows</A></H2>
+<H2><A NAME="creating">Creating Loadable Modules for Windows</A></H2>
+<P><STRONG>Note: the module name format changed for Windows with Apache
+ 1.3.15 and 2.0 - the modules are now named as mod_foo.so</STRONG>.
+ While mod_so still loads modules with ApacheModuleFoo.dll names, the
+ new naming convention is preferred; if you are converting your loadable
+ module for 2.0, please fix the name to this 2.0 convention.</P>
+
<P>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
@@ -87,16 +95,16 @@
<P>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
- <CODE>MODULE_VAR_EXPORT</CODE> (defined in the Apache header files) to
- your module's module record definition. For example, if your module
+ will be created later; see below). To do this, add the <CODE
+ >AP_MODULE_DECLARE_DATA</CODE> (defined in the Apache header files)
+ to your module's module record definition. For example, if your module
has:</P>
<PRE>
module foo_module;
</PRE>
<P>Replace the above with:</P>
<PRE>
- module MODULE_VAR_EXPORT foo_module;
+ module AP_MODULE_DECLARE_DATA foo_module;
</PRE>
<P>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
@@ -104,10 +112,13 @@
record with that method instead.</P>
<P>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
+ against the libhttpd.lib export library that is created when the
+ libhttpd.dll shared library is compiled. You may also have to change
the compiler settings to ensure that the Apache header files are
- correctly located.</P>
+ correctly located. You can find this library in your server root's
+ libexec directory. It is best to grab an existing module .dsp file
+ from the tree to assure the build environment is configured correctly,
+ or alternately compare the compiler and link options to your .dsp.</P>
<P>This should create a DLL version of your module. Now simply place it
in the <SAMP>modules</SAMP> directory of your server root, and use
@@ -166,20 +177,13 @@
to the list of active modules. <EM>Module</EM> is the name of the
external variable of type <CODE>module</CODE> in the file, and is
listed as the <a href="module-dict.html#ModuleIdentifier">Module
-Identifier</a> in the module documentation. Example (Unix):
+Identifier</a> in the module documentation. Example:
<BLOCKQUOTE><CODE>
LoadModule status_module modules/mod_status.so
</CODE></BLOCKQUOTE>
-
-<P>
-
-Example (Windows):
-<BLOCKQUOTE><CODE>
-LoadModule status_module modules/ApacheModuleStatus.dll<BR>
-</CODE></BLOCKQUOTE>
-loads the named module from the modules subdirectory of the
-ServerRoot.<P>
+<P>loads the named module from the modules subdirectory of the
+ ServerRoot.<P>
<!--#include virtual="footer.html" -->