summaryrefslogtreecommitdiff
path: root/docs/manual/mod
diff options
context:
space:
mode:
authorAndré Malo <nd@apache.org>2004-11-28 13:25:21 +0000
committerAndré Malo <nd@apache.org>2004-11-28 13:25:21 +0000
commitfd5a98d46475e095bd3f10051d90acaaaee50109 (patch)
tree3cfcb3170e53b98fd9234aebc384f3d1d6329344 /docs/manual/mod
parent12585b43ab806d173911d0fb6897a37e81e186bb (diff)
downloadhttpd-fd5a98d46475e095bd3f10051d90acaaaee50109.tar.gz
use <program> for programs
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@106803 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'docs/manual/mod')
-rw-r--r--docs/manual/mod/core.xml28
-rw-r--r--docs/manual/mod/leader.xml9
-rw-r--r--docs/manual/mod/mod_auth_digest.xml2
-rw-r--r--docs/manual/mod/mod_authn_dbm.xml2
-rw-r--r--docs/manual/mod/mod_authn_file.xml12
-rw-r--r--docs/manual/mod/mod_authnz_ldap.xml2
-rw-r--r--docs/manual/mod/mod_cgi.xml3
-rw-r--r--docs/manual/mod/mod_cgid.xml3
-rw-r--r--docs/manual/mod/mod_env.xml6
-rw-r--r--docs/manual/mod/mod_example.xml2
-rw-r--r--docs/manual/mod/mod_ldap.xml6
-rw-r--r--docs/manual/mod/mod_log_config.xml4
-rw-r--r--docs/manual/mod/mod_log_forensic.xml6
-rw-r--r--docs/manual/mod/mod_rewrite.xml2
-rw-r--r--docs/manual/mod/mod_suexec.xml4
-rw-r--r--docs/manual/mod/mod_unique_id.xml2
-rw-r--r--docs/manual/mod/mod_version.xml3
-rw-r--r--docs/manual/mod/mpm_common.xml9
-rw-r--r--docs/manual/mod/perchild.xml6
-rw-r--r--docs/manual/mod/worker.xml2
20 files changed, 58 insertions, 55 deletions
diff --git a/docs/manual/mod/core.xml b/docs/manual/mod/core.xml
index 481c96de45..b06ec964ef 100644
--- a/docs/manual/mod/core.xml
+++ b/docs/manual/mod/core.xml
@@ -722,7 +722,7 @@ from the web</description>
</contextlist>
<usage>
- <p>This directive sets the directory from which <code>httpd</code>
+ <p>This directive sets the directory from which <program>httpd</program>
will serve files. Unless matched by a directive like <directive
module="mod_alias">Alias</directive>, the server appends the
path from the requested URL to the document root to make the
@@ -756,7 +756,7 @@ Location</a></seealso>
<override>FileInfo</override>
<usage>
- <p>This directive controls whether the <code>httpd</code> may use
+ <p>This directive controls whether the <program>httpd</program> may use
memory-mapping if it needs to read the contents of a file during
delivery. By default, when the handling of a request requires
access to the data within a file -- for example, when delivering a
@@ -769,10 +769,10 @@ Location</a></seealso>
<ul>
<li>On some multiprocessor systems, memory-mapping can reduce the
- performance of the <code>httpd</code>.</li>
+ performance of the <program>httpd</program>.</li>
<li>With an NFS-mounted <directive module="core">DocumentRoot</directive>,
- the <code>httpd</code> may crash due to a segmentation fault if a file
- is deleted or truncated while the <code>httpd</code> has it
+ the <program>httpd</program> may crash due to a segmentation fault if a file
+ is deleted or truncated while the <program>httpd</program> has it
memory-mapped.</li>
</ul>
@@ -808,8 +808,8 @@ Location</a></seealso>
<compatibility>Available in version 2.0.44 and later</compatibility>
<usage>
- <p>This directive controls whether <code>httpd</code> may use the sendfile
- support from the kernel to transmit file contents to the client.
+ <p>This directive controls whether <program>httpd</program> may use the
+ sendfile support from the kernel to transmit file contents to the client.
By default, when the handling of a request requires no access
to the data within a file -- for example, when delivering a
static file -- Apache uses sendfile to deliver the file contents
@@ -1222,10 +1222,10 @@ MIME content-type</description>
don't have to suffer the extra latency that a lookup entails.
Heavily loaded sites should leave this directive
<code>Off</code>, since DNS lookups can take considerable
- amounts of time. The utility <a
- href="../programs/logresolve.html">logresolve</a>, compiled by default
- to the <code>bin</code> subdirectory of your installation directory, can
- be used to look up host names from logged IP addresses offline.</p>
+ amounts of time. The utility <program>logresolve</program>, compiled by
+ default to the <code>bin</code> subdirectory of your installation
+ directory, can be used to look up host names from logged IP addresses
+ offline.</p>
</usage>
</directivesynopsis>
@@ -1264,7 +1264,7 @@ if a test is true at startup</description>
<var>parameter-name</var> is <strong>not</strong> defined.</p>
<p>The <var>parameter-name</var> argument is a define as given on
- the <code>httpd</code> command line via <code>-D<var>parameter-</var>
+ the <program>httpd</program> command line via <code>-D<var>parameter-</var>
</code>, at the time the server was started.</p>
<p><directive type="section">IfDefine</directive> sections are
@@ -1362,7 +1362,7 @@ the server configuration files</description>
rather than a file, Apache will read all files in that directory
and any subdirectory. But including entire directories is not
recommended, because it is easy to accidentally leave temporary
- files in a directory that can cause <code>httpd</code> to
+ files in a directory that can cause <program>httpd</program> to
fail.</p>
<p>The file path specified may be an absolute path, or may be relative
@@ -1396,7 +1396,7 @@ the server configuration files</description>
</example>
</usage>
-<seealso><a href="../programs/apachectl.html">apachectl</a></seealso>
+<seealso><program>apachectl</program></seealso>
</directivesynopsis>
<directivesynopsis>
diff --git a/docs/manual/mod/leader.xml b/docs/manual/mod/leader.xml
index 8f209ec8f5..49881a51c9 100644
--- a/docs/manual/mod/leader.xml
+++ b/docs/manual/mod/leader.xml
@@ -40,15 +40,16 @@ MPM</description>
>http://deuce.doc.wustl.edu/doc/pspdfs/lf.pdf</a>.</p>
<p>To use the <module>leader</module> MPM, add
- <code>--with-mpm=leader</code> to the <code>configure</code> script's
- arguments when building the <code>httpd</code>.</p>
+ <code>--with-mpm=leader</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
- <code>--enable-nonportable-atomics=yes</code> to the <code>configure</code>
- script's arguments. This will cause APR to implement atomic operations
+ <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>
</summary>
diff --git a/docs/manual/mod/mod_auth_digest.xml b/docs/manual/mod/mod_auth_digest.xml
index 91bbbc37c7..f9cdedb1c3 100644
--- a/docs/manual/mod/mod_auth_digest.xml
+++ b/docs/manual/mod/mod_auth_digest.xml
@@ -51,7 +51,7 @@
URI(s) for this protection space.</p>
<p>Appropriate user (text) files can be created using the
- <a href="../programs/htdigest.html">htdigest</a> tool.</p>
+ <program>htdigest</program> tool.</p>
<example><title>Example:</title>
&lt;Location /private/&gt;<br />
diff --git a/docs/manual/mod/mod_authn_dbm.xml b/docs/manual/mod/mod_authn_dbm.xml
index c1d1a038da..1283a426d4 100644
--- a/docs/manual/mod/mod_authn_dbm.xml
+++ b/docs/manual/mod/mod_authn_dbm.xml
@@ -88,7 +88,7 @@ passwords for authentication</description>
problem.</p>
<p>A perl script called
- <a href="../programs/dbmmanage.html">dbmmanage</a> is included with
+ <program>dbmmanage</program> is included with
Apache. This program can be used to create and update DBM
format password files for use with this module.</p>
</usage>
diff --git a/docs/manual/mod/mod_authn_file.xml b/docs/manual/mod/mod_authn_file.xml
index dc7a8f470d..b4e7937274 100644
--- a/docs/manual/mod/mod_authn_file.xml
+++ b/docs/manual/mod/mod_authn_file.xml
@@ -46,8 +46,8 @@
<seealso>
<directive module="mod_auth_digest">AuthDigestProvider</directive>
</seealso>
-<seealso><a href="../programs/htpasswd.html">htpasswd</a></seealso>
-<seealso><a href="../programs/htdigest.html">htdigest</a></seealso>
+<seealso><program>htpasswd</program></seealso>
+<seealso><program>htdigest</program></seealso>
<directivesynopsis>
<name>AuthUserFile</name>
@@ -70,7 +70,7 @@ passwords for authentication</description>
ID is defined multiple times, <module>mod_authn_file</module> will
use the first occurrence to verify the password.</p>
- <p>The utility <a href="../programs/htpasswd.html">htpasswd</a>
+ <p>The utility <program>htpasswd</program>
which is installed as part of the binary distribution, or which
can be found in <code>src/support</code>, is used to maintain
the password file for <em>HTTP Basic Authentication</em>. See the
@@ -97,9 +97,9 @@ passwords for authentication</description>
module="mod_authn_dbm">AuthDBMUserFile</directive> should be used
instead.</p>
- <p>If you are using <em>HTTP Digest Authentication</em>, the <a
- href="../programs/htpasswd.html">htpasswd</a> tool is not sufficient.
- You have to use <a href="../programs/htdigest.html">htdigest</a>
+ <p>If you are using <em>HTTP Digest Authentication</em>, the <program>
+ htpasswd</program> tool is not sufficient.
+ You have to use <program>htdigest</program>
instead. Note that you cannot mix user data for Digest Authentication
and Basic Authentication within the same file.</p>
diff --git a/docs/manual/mod/mod_authnz_ldap.xml b/docs/manual/mod/mod_authnz_ldap.xml
index 52ff5e368f..304a7ed863 100644
--- a/docs/manual/mod/mod_authnz_ldap.xml
+++ b/docs/manual/mod/mod_authnz_ldap.xml
@@ -850,7 +850,7 @@ environment variable</description>
<p>Once a connection has been made to a server, that
connection remains active for the life of the
- <code>httpd</code> process, or until the LDAP server goes
+ <program>httpd</program> process, or until the LDAP server goes
down.</p>
<p>If the LDAP server goes down and breaks an existing
diff --git a/docs/manual/mod/mod_cgi.xml b/docs/manual/mod/mod_cgi.xml
index 9f8f232e2d..c30b7edb37 100644
--- a/docs/manual/mod/mod_cgi.xml
+++ b/docs/manual/mod/mod_cgi.xml
@@ -62,7 +62,8 @@
<seealso><directive module="core">Options</directive></seealso>
<seealso><directive module="mod_alias">ScriptAlias</directive></seealso>
<seealso><directive module="mod_mime">AddHandler</directive></seealso>
-<seealso><a href="../suexec.html">Running CGI programs under different user IDs</a></seealso>
+<seealso><a href="../suexec.html">Running CGI programs under different
+ user IDs</a></seealso>
<seealso><a href="http://hoohoo.ncsa.uiuc.edu/cgi/">CGI Specification</a></seealso>
<section id="env"><title>CGI Environment variables</title>
diff --git a/docs/manual/mod/mod_cgid.xml b/docs/manual/mod/mod_cgid.xml
index 9860ac9f35..530230cd17 100644
--- a/docs/manual/mod/mod_cgid.xml
+++ b/docs/manual/mod/mod_cgid.xml
@@ -56,7 +56,8 @@
</summary>
<seealso><module>mod_cgi</module></seealso>
-<seealso><a href="../suexec.html">Running CGI programs under different user IDs</a></seealso>
+<seealso><a href="../suexec.html">Running CGI programs under different
+ user IDs</a></seealso>
<directivesynopsis location="mod_cgi">
<name>ScriptLog</name>
diff --git a/docs/manual/mod/mod_env.xml b/docs/manual/mod/mod_env.xml
index 503a5c0649..25e60297ae 100644
--- a/docs/manual/mod/mod_env.xml
+++ b/docs/manual/mod/mod_env.xml
@@ -30,8 +30,8 @@ SSI pages</description>
<summary>
<p>This module allows for control of the environment that will
be provided to CGI scripts and SSI pages. Environment variables
- may be passed from the shell which invoked the httpd process.
- Alternatively, environment variables may be set or unset within
+ may be passed from the shell which invoked the <program>httpd</program>
+ process. Alternatively, environment variables may be set or unset within
the configuration process.</p>
</summary>
<seealso><a href="../env.html">Environment Variables</a></seealso>
@@ -48,7 +48,7 @@ SSI pages</description>
<usage>
<p>Specifies one or more environment variables to pass to CGI
scripts and SSI pages from the environment of the shell which
- invoked the httpd process.</p>
+ invoked the <program>httpd</program> process.</p>
<example><title>Example</title>
PassEnv LD_LIBRARY_PATH
diff --git a/docs/manual/mod/mod_example.xml b/docs/manual/mod/mod_example.xml
index 3e1e0113ef..e21d47fc32 100644
--- a/docs/manual/mod/mod_example.xml
+++ b/docs/manual/mod/mod_example.xml
@@ -52,7 +52,7 @@
<ol>
<li>
- Run <code>configure</code> with <code>--enable-example</code>
+ Run <program>configure</program> with <code>--enable-example</code>
option.</li>
<li>Make the server (run "<code>make</code>").</li>
diff --git a/docs/manual/mod/mod_ldap.xml b/docs/manual/mod/mod_ldap.xml
index 50e5bf951f..ed86cfe28f 100644
--- a/docs/manual/mod/mod_ldap.xml
+++ b/docs/manual/mod/mod_ldap.xml
@@ -38,7 +38,7 @@ by other LDAP modules</description>
<p>To enable this module, LDAP support must be compiled into
apr-util. This is achieved by adding the <code>--with-ldap</code>
- flag to the <code>./configure</code> script when building
+ flag to the <program>configure</program> script when building
Apache.</p>
<p>SSL support requires that <module>mod_ldap</module> be linked
@@ -174,9 +174,9 @@ by other LDAP modules</description>
<p>By fetching the URL <code>http://servername/cache-info</code>,
the administrator can get a status report of every cache that is used
by <module>mod_ldap</module> cache. Note that if Apache does not
- support shared memory, then each <code>httpd</code> instance has its
+ support shared memory, then each <program>httpd</program> instance has its
own cache, so reloading the URL will result in different
- information each time, depending on which <code>httpd</code>
+ information each time, depending on which <program>httpd</program>
instance processes the request.</p>
</section>
</section>
diff --git a/docs/manual/mod/mod_log_config.xml b/docs/manual/mod/mod_log_config.xml
index 6d86b72195..f693737ae1 100644
--- a/docs/manual/mod/mod_log_config.xml
+++ b/docs/manual/mod/mod_log_config.xml
@@ -323,8 +323,8 @@
<note type="warning"><title>Security:</title>
<p>If a program is used, then it will be run as the user who
- started httpd. This will be root if the server was started by root;
- be sure that the program is secure.</p>
+ started <program>httpd</program>. This will be root if the server was
+ started by root; be sure that the program is secure.</p>
</note>
<note type="warning"><title>Note</title>
<p>When entering a file path on non-Unix platforms, care should be taken
diff --git a/docs/manual/mod/mod_log_forensic.xml b/docs/manual/mod/mod_log_forensic.xml
index 3a10ec08d5..8133b343c6 100644
--- a/docs/manual/mod/mod_log_forensic.xml
+++ b/docs/manual/mod/mod_log_forensic.xml
@@ -127,9 +127,9 @@ version 2.1</compatibility>
<note type="warning"><title>Security:</title>
<p>If a program is used, then it will be run as the user who
- started httpd. This will be root if the server was started by root;
- be sure that the program is secure or switches to a less privileged
- user.</p>
+ started <program>httpd</program>. This will be root if the server was
+ started by root; be sure that the program is secure or switches to a
+ less privileged user.</p>
</note>
<note><title>Note</title>
diff --git a/docs/manual/mod/mod_rewrite.xml b/docs/manual/mod/mod_rewrite.xml
index 5ef341a50c..9cf2ec9159 100644
--- a/docs/manual/mod/mod_rewrite.xml
+++ b/docs/manual/mod/mod_rewrite.xml
@@ -1467,7 +1467,7 @@ When using the NOT character
<code>mod_proxy.c</code> is part of the ``<code>httpd
-l</code>'' output. If yes, this functionality is
available to mod_rewrite. If not, then you first have to
- rebuild the ``<code>httpd</code>'' program with mod_proxy
+ rebuild the <program>httpd</program> program with mod_proxy
enabled.</p>
</li>
diff --git a/docs/manual/mod/mod_suexec.xml b/docs/manual/mod/mod_suexec.xml
index c426e4569e..fc6ba4b87a 100644
--- a/docs/manual/mod/mod_suexec.xml
+++ b/docs/manual/mod/mod_suexec.xml
@@ -31,8 +31,8 @@ and Group</description>
<summary>
- <p>This module, in combination with the <a
- href="../programs/suexec.html">suexec support program</a> allows
+ <p>This module, in combination with the <program>
+ suexec</program> support program allows
CGI scripts to run as a specified user and Group.</p>
</summary>
diff --git a/docs/manual/mod/mod_unique_id.xml b/docs/manual/mod/mod_unique_id.xml
index 9c21d03879..7231364721 100644
--- a/docs/manual/mod/mod_unique_id.xml
+++ b/docs/manual/mod/mod_unique_id.xml
@@ -49,7 +49,7 @@ identifier for each request</description>
process requests one at a time. Each child can serve multiple
requests in its lifetime. For the purpose of this discussion,
the children don't share any data with each other. We'll refer
- to the children as httpd processes.</p>
+ to the children as <dfn>httpd processes</dfn>.</p>
<p>Your website has one or more machines under your
administrative control, together we'll call them a cluster of
diff --git a/docs/manual/mod/mod_version.xml b/docs/manual/mod/mod_version.xml
index ad2aa1aedf..d64e6e2ce7 100644
--- a/docs/manual/mod/mod_version.xml
+++ b/docs/manual/mod/mod_version.xml
@@ -63,7 +63,8 @@
<usage>
<p>The <directive type="section">IfVersion</directive> section encloses
- configuration directives which are executed only if the httpd version
+ configuration directives which are executed only if the
+ <program>httpd</program> version
matches the desired criteria. For normal (numeric) comparisons the
<var>version</var> argument has the format
<code><var>major</var>[.<var>minor</var>[.<var>patch</var>]]</code>, e.g.
diff --git a/docs/manual/mod/mpm_common.xml b/docs/manual/mod/mpm_common.xml
index a70970fcc8..9189a576be 100644
--- a/docs/manual/mod/mpm_common.xml
+++ b/docs/manual/mod/mpm_common.xml
@@ -200,7 +200,7 @@ requests</description>
<p>Special note: Use of this directive in <directive module="core"
type="section">VirtualHost</directive> is no longer supported. To
- configure your server for <a href="mod_suexec.html">suexec</a> use
+ configure your server for <program>suexec</program> use
<directive module="mod_suexec">SuexecUserGroup</directive>.</p>
<note><title>Note</title>
@@ -247,9 +247,8 @@ of the daemon</description>
href="../misc/security_tips.html#serverroot">security</a>.</p>
<note><title>Note</title>
- <p>As of Apache 2 it is recommended to use only the <a
- href="../programs/apachectl.html">apachectl</a> script for
- (re-)starting or stopping the server.</p>
+ <p>As of Apache 2 it is recommended to use only the <program>
+ apachectl</program> script for (re-)starting or stopping the server.</p>
</note>
</usage>
</directivesynopsis>
@@ -934,7 +933,7 @@ requests</description>
<p>Special note: Use of this directive in <directive module="core"
type="section">VirtualHost</directive> is no longer supported. To
- configure your server for <a href="../suexec.html">suexec</a> use
+ configure your server for <program>suexec</program> use
<directive module="mod_suexec">SuexecUserGroup</directive>.</p>
<note><title>Note</title>
diff --git a/docs/manual/mod/perchild.xml b/docs/manual/mod/perchild.xml
index 26b156a5c7..85ba386921 100644
--- a/docs/manual/mod/perchild.xml
+++ b/docs/manual/mod/perchild.xml
@@ -78,9 +78,9 @@ uses</a></seealso>
set the privileges of the Apache child processes. The child
processes must be able to read all the content that will be
served, but should have as few privileges beyond that as
- possible. In addition, unless <a
- href="../suexec.html">suexec</a> is used, these directives also
- set the privileges which will be inherited by CGI scripts.</p>
+ possible. In addition, unless <program>suexec</program> is used,
+ these directives also set the privileges which will be inherited
+ by CGI scripts.</p>
<p><directive module="mpm_common">MaxRequestsPerChild</directive>
controls how frequently the
diff --git a/docs/manual/mod/worker.xml b/docs/manual/mod/worker.xml
index 80e2fbb080..d210c626cf 100644
--- a/docs/manual/mod/worker.xml
+++ b/docs/manual/mod/worker.xml
@@ -129,7 +129,7 @@ uses</a></seealso>
the privileges of the Apache child processes. The child processes
must be able to read all the content that will be served, but
should have as few privileges beyond that as possible. In
- addition, unless <a href="../suexec.html">suexec</a> is used,
+ addition, unless <program>suexec</program> is used,
these directives also set the privileges which will be inherited
by CGI scripts.</p>