Return-Path: Mailing-List: contact apache-docs-help@apache.org; run by ezmlm Delivered-To: mailing list apache-docs@apache.org Received: (qmail 877 invoked by uid 500); 28 Sep 2000 16:54:56 -0000 Delivered-To: apmail-httpd-docs-1.3-cvs@apache.org Received: (qmail 855 invoked by uid 1173); 28 Sep 2000 16:54:52 -0000 Date: 28 Sep 2000 16:54:52 -0000 Message-ID: <20000928165452.851.qmail@locus.apache.org> From: slive@locus.apache.org To: httpd-docs-1.3-cvs@apache.org Subject: cvs commit: httpd-docs-1.3/htdocs/manual/mod mod_so.html mod_speling.html mod_status.html mod_unique_id.html mod_userdir.html mod_vhost_alias.html slive 00/09/28 09:54:48 Modified: htdocs/manual/mod mod_so.html mod_speling.html mod_status.html mod_unique_id.html mod_userdir.html mod_vhost_alias.html Log: Style updates. Revision Changes Path 1.7 +89 -68 httpd-docs-1.3/htdocs/manual/mod/mod_so.html Index: mod_so.html =================================================================== RCS file: /home/cvs/httpd-docs-1.3/htdocs/manual/mod/mod_so.html,v retrieving revision 1.6 retrieving revision 1.7 diff -u -r1.6 -r1.7 --- mod_so.html 1999/02/26 17:07:03 1.6 +++ mod_so.html 2000/09/28 16:54:35 1.7 @@ -15,36 +15,108 @@

Module mod_so

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

This module provides for loading of executable code and modules into the +server at start-up or restart time.

+

Status: Base (Windows); Experimental (Unix) +
+Source File: mod_so.c +
+Module Identifier: so_module +
+Compatibility: Available in Apache 1.3 and later. +

+ + +

Summary

+ +

This is an experimental module. On selected operating systems it +can be used to load modules into Apache at runtime via the Dynamic Shared Object (DSO) mechanism, rather +than requiring a recompilation. +

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

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

- -This is an experimental module. On selected operating systems it can be used -to load modules into Apache at runtime via the Dynamic -Shared Object (DSO) mechanism, rather than requiring a recompilation. -

Directives

-
+

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.

-

LoadFile

+

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.

+ +
+ +

LoadFile directive

Filename is either and absolute path or relative to ServerRoot.

-

LoadModule

+

LoadModule directive

- -
- -

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.

1.10 +28 -13 httpd-docs-1.3/htdocs/manual/mod/mod_speling.html Index: mod_speling.html =================================================================== RCS file: /home/cvs/httpd-docs-1.3/htdocs/manual/mod/mod_speling.html,v retrieving revision 1.9 retrieving revision 1.10 diff -u -r1.9 -r1.10 --- mod_speling.html 1998/08/06 23:31:55 1.9 +++ mod_speling.html 2000/09/28 16:54:38 1.10 @@ -14,16 +14,31 @@

Module mod_speling

- This module is contained in the mod_speling.c file, - and is not compiled in by default. - It attempts to correct misspellings of - URLs that users might have entered, by ignoring capitalization - and by allowing up to one misspelling.
- This catches the majority of misspelled requests. An automatic - "spelling corrected" redirection is returned if only one matching - document was found, and a list of matches is returned if more than - one document with a sufficiently similar name is found. -

+ This module attempts to correct misspellings of URLs that users + might have entered, by ignoring capitalization and by allowing up to + one misspelling.

+ +

Status: Extension +
+Source File: mod_speling.c +
+Module Identifier: speling_module +
+Compatibility: Available in Apache 1.3 and later. Available as an External module in Apache 1.1 and later. +

+

Summary

@@ -52,12 +67,12 @@

Directives

- + +
-

CheckSpelling

+

CheckSpelling directive

Module mod_status

-The Status Module is only available in Apache 1.1 and later.

+

This module provides information on server activity and +performance.

-

Function

+

Status: Base +
+Source File: mod_status.c +
+Module Identifier: status_module +
+Compatibility: Available in Apache 1.1 and later. +

+ + +

Summary

-The Status module allows a server administrator to find out how well +

The Status module allows a server administrator to find out how well their server is performing. A HTML page is presented that gives the current server statistics in an easily readable form. If required this page can be made to automatically refresh (given a compatible browser). Another page gives a simple machine-readable list of the current -server state. +server state.

+

The details given are: