summaryrefslogtreecommitdiffstats
path: root/docs/manual
diff options
context:
space:
mode:
authorJoshua Slive <slive@apache.org>2005-09-21 21:41:48 +0200
committerJoshua Slive <slive@apache.org>2005-09-21 21:41:48 +0200
commitc988b688c275e08270fa5bfeb1b456afa09e1bf6 (patch)
tree43c213c3dbcc3dad7016d8594dce68c557c25159 /docs/manual
parentFix dtd to match <glossary> change in xsl. (diff)
downloadapache2-c988b688c275e08270fa5bfeb1b456afa09e1bf6.tar.xz
apache2-c988b688c275e08270fa5bfeb1b456afa09e1bf6.zip
Add APR to the glossary and link it in where appropriate.
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@290801 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'docs/manual')
-rw-r--r--docs/manual/bind.xml7
-rw-r--r--docs/manual/glossary.xml10
-rw-r--r--docs/manual/mod/event.xml13
-rw-r--r--docs/manual/mod/mod_charset_lite.xml21
-rw-r--r--docs/manual/mod/mod_ldap.xml2
-rw-r--r--docs/manual/mod/mod_ssl.xml16
-rw-r--r--docs/manual/new_features_2_2.xml2
-rw-r--r--docs/manual/programs/configure.xml3
-rw-r--r--docs/manual/programs/httxt2dbm.xml2
9 files changed, 45 insertions, 31 deletions
diff --git a/docs/manual/bind.xml b/docs/manual/bind.xml
index c939818e46..981d2fa287 100644
--- a/docs/manual/bind.xml
+++ b/docs/manual/bind.xml
@@ -95,9 +95,10 @@
<section id="ipv6">
<title>Special IPv6 Considerations</title>
- <p>A growing number of platforms implement IPv6, and APR supports
- IPv6 on most of these platforms, allowing Apache to allocate IPv6
- sockets and handle requests which were sent over IPv6.</p>
+ <p>A growing number of platforms implement IPv6, and
+ <glossary>APR</glossary> supports IPv6 on most of these platforms,
+ allowing Apache to allocate IPv6 sockets and handle requests which
+ were sent over IPv6.</p>
<p>One complicating factor for Apache administrators is whether or
not an IPv6 socket can handle both IPv4 connections and IPv6
diff --git a/docs/manual/glossary.xml b/docs/manual/glossary.xml
index dca77df92e..c25623114b 100644
--- a/docs/manual/glossary.xml
+++ b/docs/manual/glossary.xml
@@ -56,6 +56,16 @@
See: Manual Page: <program>apxs</program>
</dd>
+ <dt><a name="apacheportableruntime"
+ id="apacheportableruntime">Apache Portable Runtime</a> <a
+ name="apr" id="apr">(APR)</a></dt>
+ <dd>A set of libraries providing many of the basic interfaces
+ between the server and the operating system. APR is developed
+ parallel to the Apache HTTP Server as an independent project.<br />
+ See: <a href="http://apr.apache.org/">Apache Portable Runtime
+ Project
+ </dd>
+
<dt><a name="authentication" id="authentication">Authentication</a></dt>
<dd>The positive identification of a network entity such as a server, a
client, or a user.<br />
diff --git a/docs/manual/mod/event.xml b/docs/manual/mod/event.xml
index 20dc8158ed..715e77d9e4 100644
--- a/docs/manual/mod/event.xml
+++ b/docs/manual/mod/event.xml
@@ -38,14 +38,15 @@ MPM</description>
<code>--with-mpm=event</code> to the <program>configure</program>
script's arguments when building the <program>httpd</program>.</p>
- <p>This MPM depends on APR's atomic compare-and-swap operations for
- thread synchronization. If you are compiling for an x86 target
- and you don't need to support 386s, or you are compiling for a
- SPARC and you don't need to run on pre-UltraSPARC chips, add
+ <p>This MPM depends on <glossary>APR</glossary>'s atomic
+ compare-and-swap operations for thread synchronization. If you are
+ compiling for an x86 target and you don't need to support 386s, or
+ you are compiling for a SPARC and you don't need to run on
+ pre-UltraSPARC chips, add
<code>--enable-nonportable-atomics=yes</code> to the
<program>configure</program> script's arguments. This will cause
- APR to implement atomic operations
- using efficient opcodes not available in older CPUs.</p>
+ APR to implement atomic operations using efficient opcodes not
+ available in older CPUs.</p>
</summary>
<directivesynopsis location="mpm_common"><name>AcceptMutex</name>
diff --git a/docs/manual/mod/mod_charset_lite.xml b/docs/manual/mod/mod_charset_lite.xml
index db8c7eec27..fe7cc7b3b7 100644
--- a/docs/manual/mod/mod_charset_lite.xml
+++ b/docs/manual/mod/mod_charset_lite.xml
@@ -60,12 +60,13 @@
<p>The character set name parameters of <directive
module="mod_charset_lite">CharsetSourceEnc</directive> and
<directive module="mod_charset_lite">CharsetDefault</directive>
- must be acceptable to the translation mechanism used by APR on the
- system where <module>mod_charset_lite</module> is deployed. These
- character set names are not standardized and are usually not the
- same as the corresponding values used in http headers. Currently,
- APR can only use iconv(3), so you can easily test your character
- set names using the iconv(1) program, as follows:</p>
+ must be acceptable to the translation mechanism used by
+ <glossary>APR</glossary> on the system where
+ <module>mod_charset_lite</module> is deployed. These character
+ set names are not standardized and are usually not the same as
+ the corresponding values used in http headers. Currently, APR
+ can only use iconv(3), so you can easily test your character set
+ names using the iconv(1) program, as follows:</p>
<example>
iconv -f charsetsourceenc-value -t charsetdefault-value
@@ -105,8 +106,8 @@
<p>The value of the <var>charset</var> argument must be accepted
as a valid character set name by the character set support in
- APR. Generally, this means that it must be supported by
- iconv.</p>
+ <glossary>APR</glossary>. Generally, this means that it must be
+ supported by iconv.</p>
<example><title>Example</title>
&lt;Directory /export/home/trawick/apacheinst/htdocs/convert&gt;<br />
@@ -139,8 +140,8 @@
<p>The value of the <var>charset</var> argument must be accepted
as a valid character set name by the character set support in
- APR. Generally, this means that it must be supported by
- iconv.</p>
+ <glossary>APR</glossary>. Generally, this means that it must be
+ supported by iconv.</p>
<example><title>Example</title>
&lt;Directory /export/home/trawick/apacheinst/htdocs/convert&gt;<br />
diff --git a/docs/manual/mod/mod_ldap.xml b/docs/manual/mod/mod_ldap.xml
index f0d3fde797..a432341de1 100644
--- a/docs/manual/mod/mod_ldap.xml
+++ b/docs/manual/mod/mod_ldap.xml
@@ -43,7 +43,7 @@ by other LDAP modules</description>
Apache.</p>
<p>SSL/TLS support is dependant on which LDAP toolkit has been
- linked to APR. As of this writing, APR-util supports:
+ linked to <glossary>APR</glossary>. As of this writing, APR-util supports:
<a href="http://www.openldap.org/">OpenLDAP SDK</a> (2.x or later),
<a href="http://developer.novell.com/ndk/cldap.htm">Novell LDAP
SDK</a>, <a href="http://www.mozilla.org/directory/csdk.html">
diff --git a/docs/manual/mod/mod_ssl.xml b/docs/manual/mod/mod_ssl.xml
index f97a5584dc..011510455d 100644
--- a/docs/manual/mod/mod_ssl.xml
+++ b/docs/manual/mod/mod_ssl.xml
@@ -238,29 +238,29 @@ The following Mutex <em>types</em> are available:</p>
<p>
This is an elegant Mutex variant where a Posix Semaphore is used when possible.
It is only available when the underlying platform
- and APR supports it.</p></li>
+ and <glossary>APR</glossary> supports it.</p></li>
<li><code>sysvsem</code>
<p>
This is a somewhat elegant Mutex variant where a SystemV IPC Semaphore is used when
possible. It is possible to "leak" SysV semaphores if processes crash before
the semaphore is removed. It is only available when the underlying platform
- and APR supports it.</p></li>
+ and <glossary>APR</glossary> supports it.</p></li>
<li><code>sem</code>
<p>
This directive tells the SSL Module to pick the "best" semaphore implementation
available to it, choosing between Posix and SystemV IPC, in that order. It is only
- available when the underlying platform and APR supports at least one of the 2.</p></li>
+ available when the underlying platform and <glossary>APR</glossary> supports at least one of the 2.</p></li>
<li><code>pthread</code>
<p>
This directive tells the SSL Module to use Posix thread mutexes. It is only available
- if the underlying platform and APR supports it.</p></li>
+ if the underlying platform and <glossary>APR</glossary> supports it.</p></li>
<li><code>fcntl:/path/to/mutex</code>
<p>
This is a portable Mutex variant where a physical (lock-)file and the <code>fcntl()</code>
fucntion are used as the Mutex.
Always use a local disk filesystem for <code>/path/to/mutex</code> and never a file
residing on a NFS- or AFS-filesystem. It is only available when the underlying platform
- and APR supports it. Note: Internally, the Process ID (PID) of the
+ and <glossary>APR</glossary> supports it. Note: Internally, the Process ID (PID) of the
Apache parent process is automatically appended to
<code>/path/to/mutex</code> to make it unique, so you don't have to worry
about conflicts yourself. Notice that this type of mutex is not available
@@ -271,17 +271,17 @@ The following Mutex <em>types</em> are available:</p>
This is similar to the <code>fcntl:/path/to/mutex</code> method with the
exception that the <code>flock()</code> function is used to provide file
locking. It is only available when the underlying platform
- and APR supports it.</p></li>
+ and <glossary>APR</glossary> supports it.</p></li>
<li><code>file:/path/to/mutex</code>
<p>
This directive tells the SSL Module to pick the "best" file locking implementation
available to it, choosing between <code>fcntl</code> and <code>flock</code>,
- in that order. It is only available when the underlying platform and APR supports
+ in that order. It is only available when the underlying platform and <glossary>APR</glossary> supports
at least one of the 2.</p></li>
<li><code>default | yes</code>
<p>
This directive tells the SSL Module to pick the default locking implementation
- as determined by the platform and APR.</p></li>
+ as determined by the platform and <glossary>APR</glossary>.</p></li>
</ul>
<example><title>Example</title>
SSLMutex file:/usr/local/apache/logs/ssl_mutex
diff --git a/docs/manual/new_features_2_2.xml b/docs/manual/new_features_2_2.xml
index 510e66b2de..9e15165956 100644
--- a/docs/manual/new_features_2_2.xml
+++ b/docs/manual/new_features_2_2.xml
@@ -138,7 +138,7 @@
<section id="developer">
<title>Module Developer Changes</title>
<dl>
- <dt>APR 1.0 API</dt>
+ <dt><glossary>APR</glossary> 1.0 API</dt>
<dd>Apache 2.2 uses the APR 1.0 API. All deprecated functions and
symbols have been removed from <code>APR</code> and
diff --git a/docs/manual/programs/configure.xml b/docs/manual/programs/configure.xml
index 08d62791fb..cf59786a7a 100644
--- a/docs/manual/programs/configure.xml
+++ b/docs/manual/programs/configure.xml
@@ -743,7 +743,8 @@
<section id="packageopt"><title>Specific packages</title>
<dl>
<dt><code>--with-apr=<var>DIR</var>|<var>FILE</var></code></dt>
- <dd>The Apache Portable Runtime (APR) is part of the httpd
+ <dd>The <glossary ref="apr">Apache Portable Runtime</glossary> (APR)
+ is part of the httpd
source distribution and will automatically be build together with the
HTTP server. If you want to use an already installed APR instead you
have to tell <code>configure</code> the path to the
diff --git a/docs/manual/programs/httxt2dbm.xml b/docs/manual/programs/httxt2dbm.xml
index 582957d041..08d8a8bdab 100644
--- a/docs/manual/programs/httxt2dbm.xml
+++ b/docs/manual/programs/httxt2dbm.xml
@@ -49,7 +49,7 @@
<dt><code>-f</code></dt>
<dd>Specify the DBM type to be used for the output. If not specified, will
- use the APR Default. Available types are:<br />
+ use the <glossary>APR</glossary> Default. Available types are:<br />
<code>GDBM</code> for GDBM files<br />
<code>SDBM</code> for SDBM files<br />
<code>DB</code> for berkeley DB files<br />