From c0a46ef37bc3a68be0932a4e5a747c0d67db07d2 Mon Sep 17 00:00:00 2001 From: Joshua Slive Date: Thu, 28 Sep 2000 16:55:53 +0000 Subject: [PATCH] Style update. git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@86349 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/mod/mod_so.html | 157 +++++++++++++++------------ docs/manual/mod/mod_speling.html | 41 ++++--- docs/manual/mod/mod_status.html | 114 ++++++++++++------- docs/manual/mod/mod_unique_id.html | 41 +++++-- docs/manual/mod/mod_userdir.html | 24 +++- docs/manual/mod/mod_vhost_alias.html | 53 +++++++-- 6 files changed, 286 insertions(+), 144 deletions(-) diff --git a/docs/manual/mod/mod_so.html b/docs/manual/mod/mod_so.html index 6edd1a4fb3..78347d799e 100644 --- a/docs/manual/mod/mod_so.html +++ b/docs/manual/mod/mod_so.html @@ -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

-

LoadFile

+

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.

+ +
+ +

LoadFile directive

Filename is either and absolute path or relative to ServerRoot.

-

LoadModule

+

LoadModule directive

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.

- diff --git a/docs/manual/mod/mod_speling.html b/docs/manual/mod/mod_speling.html index 3be9f8000b..574b31b683 100644 --- a/docs/manual/mod/mod_speling.html +++ b/docs/manual/mod/mod_speling.html @@ -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: