summaryrefslogtreecommitdiffstats
path: root/docs/manual/programs
diff options
context:
space:
mode:
authorAndré Malo <nd@apache.org>2004-11-28 14:25:21 +0100
committerAndré Malo <nd@apache.org>2004-11-28 14:25:21 +0100
commitfd5a98d46475e095bd3f10051d90acaaaee50109 (patch)
tree3cfcb3170e53b98fd9234aebc384f3d1d6329344 /docs/manual/programs
parentallow <program> in man pages (diff)
downloadapache2-fd5a98d46475e095bd3f10051d90acaaaee50109.tar.xz
apache2-fd5a98d46475e095bd3f10051d90acaaaee50109.zip
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/programs')
-rw-r--r--docs/manual/programs/ab.xml2
-rw-r--r--docs/manual/programs/apachectl.xml26
-rw-r--r--docs/manual/programs/apxs.xml6
-rw-r--r--docs/manual/programs/configure.xml89
-rw-r--r--docs/manual/programs/dbmmanage.xml6
-rw-r--r--docs/manual/programs/htdigest.xml4
-rw-r--r--docs/manual/programs/htpasswd.xml11
-rw-r--r--docs/manual/programs/httpd.xml6
-rw-r--r--docs/manual/programs/index.xml24
9 files changed, 87 insertions, 87 deletions
diff --git a/docs/manual/programs/ab.xml b/docs/manual/programs/ab.xml
index f6101d2443..f738cf2aee 100644
--- a/docs/manual/programs/ab.xml
+++ b/docs/manual/programs/ab.xml
@@ -31,7 +31,7 @@
you how many requests per second your Apache installation is capable of
serving.</p>
</summary>
-<seealso><a href="httpd.html">httpd</a></seealso>
+<seealso><program>httpd</program></seealso>
<section id="synopsis"><title>Synopsis</title>
<p><code><strong>ab</strong>
diff --git a/docs/manual/programs/apachectl.xml b/docs/manual/programs/apachectl.xml
index f9889ad680..3a77ce65ee 100644
--- a/docs/manual/programs/apachectl.xml
+++ b/docs/manual/programs/apachectl.xml
@@ -28,21 +28,21 @@
<p><code>apachectl</code> is a front end to the Apache HyperText
Transfer Protocol (HTTP) server. It is designed to help the
administrator control the functioning of the Apache
- <a href="httpd.html">httpd</a> daemon.</p>
+ <program>httpd</program> daemon.</p>
<p>The <code>apachectl</code> script can operate in two modes.
- First, it can act as a simple front-end to the <code>httpd</code>
+ First, it can act as a simple front-end to the <program>httpd</program>
command that simply sets any necessary environment variables and
- then invokes <code>httpd</code>, passing through any command line
+ then invokes <program>httpd</program>, passing through any command line
arguments. Second, <code>apachectl</code> can act as a SysV init
script, taking simple one-word arguments like <code>start</code>,
<code>restart</code>, and <code>stop</code>, and translating them
- into appropriate signals to <code>httpd</code>.</p>
+ into appropriate signals to <program>httpd</program>.</p>
<p>If your Apache installation uses non-standard paths, you will
need to edit the <code>apachectl</code> script to set the
- appropriate paths to the <code>httpd</code> binary. You can also
- specify any necessary <code>httpd</code> command line arguments.
+ appropriate paths to the <program>httpd</program> binary. You can also
+ specify any necessary <program>httpd</program> command line arguments.
See the comments in the script for details.</p>
<p>The <code>apachectl</code> script returns a 0 exit value on
@@ -53,12 +53,12 @@
<seealso><a href="../stopping.html">Stopping Apache</a></seealso>
<seealso><a href="../configuring.html">Configuration Files</a></seealso>
<seealso><a href="../platform/">Platform Docs</a></seealso>
-<seealso><a href="httpd.html">httpd</a></seealso>
+<seealso><program>httpd</program></seealso>
<section id="synopsis"><title>Synopsis</title>
<p>When acting in pass-through mode, <code>apachectl</code> can take
-all the arguments available for the <a href="httpd.html">httpd</a>
+all the arguments available for the <program>httpd</program>
binary.</p>
<p><code><strong>apachectl</strong> [ <var>httpd-argument</var> ]</code></p>
@@ -73,24 +73,24 @@ one-word commands, defined below.</p>
<section id="options"><title>Options</title>
<p>Only the SysV init-style options are defined here. Other arguments
-are defined on the <a href="httpd.html">httpd</a> manual page.</p>
+are defined on the <program>httpd</program> manual page.</p>
<dl>
<dt><code>start</code></dt>
-<dd>Start the Apache <code>httpd</code> daemon. Gives an error if it
+<dd>Start the Apache <program>httpd</program> daemon. Gives an error if it
is already running. This is equivalent to <code>apachectl -k
start</code>.</dd>
<dt><code>stop</code></dt>
-<dd>Stops the Apache <code>httpd</code> daemon. This is equivalent to
+<dd>Stops the Apache <program>httpd</program> daemon. This is equivalent to
<code>apachectl -k stop</code>.</dd>
<dt><code>restart</code></dt>
-<dd>Restarts the Apache <code>httpd</code> daemon. If the daemon is
+<dd>Restarts the Apache <program>httpd</program> daemon. If the daemon is
not running, it is started. This command automatically checks the
configuration files as in <code>configtest</code> before initiating
the restart to make sure the daemon doesn't die. This is equivalent
@@ -113,7 +113,7 @@ currently being served is omitted.</dd>
<dt><code>graceful</code></dt>
-<dd>Gracefully restarts the Apache <code>httpd</code> daemon. If the
+<dd>Gracefully restarts the Apache <program>httpd</program> daemon. If the
daemon is not running, it is started. This differs from a normal
restart in that currently open connections are not aborted. A side
effect is that old log files will not be closed immediately. This
diff --git a/docs/manual/programs/apxs.xml b/docs/manual/programs/apxs.xml
index fd8cdccb2e..cdb0cfd3a2 100644
--- a/docs/manual/programs/apxs.xml
+++ b/docs/manual/programs/apxs.xml
@@ -33,7 +33,7 @@
directive from <module>mod_so</module>.</p>
<p>So to use this extension mechanism your platform has to support the DSO
- feature and your Apache <code>httpd</code> binary has to be built with the
+ feature and your Apache <program>httpd</program> binary has to be built with the
<module>mod_so</module> module. The <code>apxs</code> tool automatically
complains if this is not the case. You can check this yourself by manually
running the command</p>
@@ -76,8 +76,8 @@
<module>mod_so</module> or perhaps even read the
<code>src/modules/standard/mod_so.c</code> source file.</p>
</summary>
-<seealso><a href="apachectl.html">apachectl</a></seealso>
-<seealso><a href="httpd.html">httpd</a></seealso>
+<seealso><program>apachectl</program></seealso>
+<seealso><program>httpd</program></seealso>
<section id="synopsis"><title>Synopsis</title>
<p><code><strong>apxs</strong> -<strong>g</strong>
diff --git a/docs/manual/programs/configure.xml b/docs/manual/programs/configure.xml
index eb4b58661a..9f0acfedb3 100644
--- a/docs/manual/programs/configure.xml
+++ b/docs/manual/programs/configure.xml
@@ -158,8 +158,8 @@
everything else is stored at sbindir. ==> clarify/change this -->
<dt><code>--bindir=<var>DIR</var></code></dt>
<dd>Install user executables in <var>DIR</var>. The user executables
- are supporting programs like <code>htpasswd</code>,
- <code>dbmmanage</code>, etc. which are useful for site
+ are supporting programs like <program>htpasswd</program>,
+ <program>dbmmanage</program>, etc. which are useful for site
administrators. By default <var>DIR</var> is set to
<code><var>EPREFIX</var>/bin</code>.</dd>
@@ -209,10 +209,11 @@
<dt><code>--sbindir=<var>DIR</var></code></dt>
<dd>Install the system administrator executables in <var>DIR</var>.
- Those are server programs like <code>httpd</code>,
- <code>apachectl</code>, <code>suexec</code>, etc. which are neccessary
- to run the Apache HTTP Server. By default <code>sbindir</code> is
- set to <code><var>EPREFIX</var>/sbin</code>.</dd>
+ Those are server programs like <program>httpd</program>,
+ <program>apachectl</program>, <program>suexec</program>, etc. which
+ are neccessary to run the Apache HTTP Server. By default
+ <code>sbindir</code> is set to
+ <code><var>EPREFIX</var>/sbin</code>.</dd>
<dt><code>--sharedstatedir=<var>DIR</var></code></dt>
<dd>Install modifiable architecture-independent data in <var>DIR</var>.
@@ -634,7 +635,7 @@
vendor's documentation.</p>
<note><title>Note</title>
If you want to build a DSO module instead of a statically linked
- use <a href="apxs.html">apxs</a>.</note>
+ use <program>apxs</program>.</note>
</dd>
<dt><code>--with-mpm=MPM</code></dt>
@@ -679,7 +680,7 @@
<dt><code>--enable-modules=<var>MODULE-LIST</var></code></dt>
<dd>This option behaves similar to <code>--enable-mods-shared</code>,
but will link the given modules statically. This mean, these modules
- will always be present while running <code>httpd</code>. They need
+ will always be present while running <program>httpd</program>. They need
not be loaded with <directive
module="mod_so">LoadModule</directive>.</dd>
@@ -687,8 +688,8 @@
<dd>Allow IPv6 sockets to handle IPv4 connections.</dd>
<dt><code>--with-port=<var>PORT</var></code></dt>
- <dd>This defines the port on which <code>httpd</code> will listen. This
- port number is used when generating the configuration file
+ <dd>This defines the port on which <program>httpd</program> will listen.
+ This port number is used when generating the configuration file
<code>httpd.conf</code>. The default is 80.</dd>
<dt><code>--with-program-name</code></dt>
@@ -724,7 +725,7 @@
<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 <code>httpd</code>
+ <dd>The Apache Portable Runtime (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
@@ -735,7 +736,7 @@
<dt><code>--with-apr-util=<var>DIR</var>|<var>FILE</var></code></dt>
<dd>The Apache Portable Runtime Utilities (APU) are part of the
- <code>httpd</code> source distribution and will automatically be build
+ httpd source distribution and will automatically be build
together with the HTTP server. If you want to use an already installed
APU instead you have to tell <code>configure</code> the path to the
<code>apu-config</code> script. You may set the absolute path and name
@@ -803,12 +804,12 @@
dynamically by default.</dd>
<dt><code>--enable-suexec</code></dt>
- <dd>Use this option to enable <code><a
- href="suexec.html">suexec</a></code>, which allows you to set
+ <dd>Use this option to enable <program>
+ suexec</program>, which allows you to set
uid and gid for spawned processes. <strong>Do not use this
option unless you understand all the security implications of
running a suid binary on your server.</strong> Further options
- to configure <code>suexec</code> are described <a
+ to configure <program>suexec</program> are described <a
href="#suexec">below</a>.</dd> </dl>
<p>It is possible to create a statically linked binary of a single
@@ -816,8 +817,8 @@
<dl>
<dt><code>--enable-static-ab</code></dt>
- <dd>Build a statically linked version of <code><a
- href="ab.html">ab</a></code>.</dd>
+ <dd>Build a statically linked version of <program>
+ ab</program>.</dd>
<!-- missing documentation for chechgid -->
<dt><code>--enable-static-checkgid</code></dt>
@@ -828,25 +829,25 @@
<dd>Build a statically linked version of <code>htdbm</code>.</dd>
<dt><code>--enable-static-htdigest</code></dt>
- <dd>Build a statically linked version of <code><a
- href="htdigest.html">htdigest</a></code>.</dd>
+ <dd>Build a statically linked version of <program>
+ htdigest</program>.</dd>
<dt><code>--enable-static-htpasswd</code></dt>
- <dd>Build a statically linked version of <code><a
- href="htpasswd.html">htpasswd</a></code>.</dd>
+ <dd>Build a statically linked version of <program>
+ htpasswd</program>.</dd>
<dt><code>--enable-static-logresolve</code></dt>
- <dd>Build a statically linked version of <code><a
- href="logresolve.html">logresolve</a></code>.</dd>
+ <dd>Build a statically linked version of <program>
+ logresolve</program>.</dd>
<dt><code>--enable-static-rotatelogs</code></dt>
- <dd>Build a statically linked version of <code><a
- href="rotatelogs.html">rotatelogs</a></code>.</dd>
+ <dd>Build a statically linked version of <program>
+ rotatelogs</program>.</dd>
</dl>
<section id="suexec"><title>suexec configuration options</title>
- <p>The following options are used to fine tune the behavior of <code><a
- href="suexec.html">suexec</a></code>. See <a
+ <p>The following options are used to fine tune the behavior of <program>
+ suexec</program>. See <a
href="suexec.html#install">Configuring and installing suEXEC</a>
for further information.</p>
@@ -854,47 +855,47 @@
<dt><code>--with-suexec-bin</code></dt>
<dd>This defines the path to suexec binary. Default is
<code>--sbindir</code> (see <a href="directoryfinetuning">Fine
- tuning of installation directories</a>).</dd>
+ tuning of installation directories</a>).</dd>
<dt><code>--with-suexec-caller</code></dt>
- <dd>This defines the user allowed to call <code>suexec</code>. It should
- be the same as the user under which <code>httpd</code> normally
- runs.</dd>
+ <dd>This defines the user allowed to call <program>suexec</program>.
+ It should be the same as the user under which <program>httpd</program>
+ normally runs.</dd>
<dt><code>--with-suexec-docroot</code></dt>
- <dd>This defines the directory tree under which <code>suexec</code>
- access is allowed for executables. Default value is
+ <dd>This defines the directory tree under which <program>
+ suexec</program> access is allowed for executables. Default value is
<code>--datadir/htdocs</code>.</dd>
<dt><code>--with-suexec-gidmin</code></dt>
<dd>Define this as the lowest GID allowed to be a target user for
- <code>suexec</code>. The default value is 100.</dd>
+ <program>suexec</program>. The default value is 100.</dd>
<dt><code>--with-suexec-logfile</code></dt>
- <dd>This defines the filename of the <code>suexec</code> logfile. By
- default the logfile is named <code>suexec_log</code> and located in
+ <dd>This defines the filename of the <program>suexec</program> logfile.
+ By default the logfile is named <code>suexec_log</code> and located in
<code>--logfiledir</code>.</dd>
<dt><code>--with-suexec-safepath</code></dt>
<dd>Define the value of the environment variable <code>PATH</code> to
- be set for processes started by <code>suexec</code>. Default value is
- <code>/usr/local/bin:/usr/bin:/bin</code>.</dd>
+ be set for processes started by <program>suexec</program>. Default
+ value is <code>/usr/local/bin:/usr/bin:/bin</code>.</dd>
<dt><code>--with-suexec-userdir</code></dt>
<dd>This defines the subdirectory under the user's directory that
- contains all executables for which <code>suexec</code> access is
- allowed. This setting is necessary when you want to use
- <code>suexec</code> together with user-specific directories (as
+ contains all executables for which <program>suexec</program> access
+ is allowed. This setting is necessary when you want to use
+ <program>suexec</program> together with user-specific directories (as
provided by <module>mod_userdir</module>). The default is
<code>public_html</code>.</dd>
<dt><code>--with-suexec-uidmin</code></dt>
<dd>Define this as the lowest UID allowed to be a target user for
- <code>suexec</code>. The default value is 100.</dd>
+ <program>suexec</program>. The default value is 100.</dd>
<dt><code>--with-suexec-umask</code></dt>
- <dd>Set <code>umask</code> for processes started by <code>suexec</code>.
- It defaults to your system settings.</dd>
+ <dd>Set <code>umask</code> for processes started by
+ <program>suexec</program>. It defaults to your system settings.</dd>
</dl>
</section>
</section>
diff --git a/docs/manual/programs/dbmmanage.xml b/docs/manual/programs/dbmmanage.xml
index af7d6edac2..5d87500dd7 100644
--- a/docs/manual/programs/dbmmanage.xml
+++ b/docs/manual/programs/dbmmanage.xml
@@ -31,15 +31,15 @@
Resources available from the Apache HTTP server can be restricted to just
the users listed in the files created by <code>dbmmanage</code>. This
program can only be used when the usernames are stored in a DBM file. To
- use a flat-file database see <a href="htpasswd.html">htpasswd</a>.</p>
+ use a flat-file database see <program>htpasswd</program>.</p>
<p>This manual page only lists the command line arguments. For details of
the directives necessary to configure user authentication in
- <a href="httpd.html">httpd</a> see the httpd manual, which is part of
+ <program>httpd</program> see the httpd manual, which is part of
the Apache distribution or can be found at <a
href="http://httpd.apache.org/">http://httpd.apache.org/</a>.</p>
</summary>
-<seealso><a href="httpd.html">httpd</a></seealso>
+<seealso><program>httpd</program></seealso>
<seealso><module>mod_authn_dbm</module></seealso>
<seealso><module>mod_authz_dbm</module></seealso>
diff --git a/docs/manual/programs/htdigest.xml b/docs/manual/programs/htdigest.xml
index 2823a86812..de8befc38d 100644
--- a/docs/manual/programs/htdigest.xml
+++ b/docs/manual/programs/htdigest.xml
@@ -32,11 +32,11 @@
<p>This manual page only lists the command line arguments. For details of
the directives necessary to configure digest authentication in
- <a href="httpd.html">httpd</a> see the Apache manual, which is part
+ <program>httpd</program> see the Apache manual, which is part
of the Apache distribution or can be found at
<a href="http://httpd.apache.org/">http://httpd.apache.org/</a>.</p>
</summary>
-<seealso><a href="httpd.html">httpd</a></seealso>
+<seealso><program>httpd</program></seealso>
<seealso><module>mod_auth_digest</module></seealso>
<section id="synopsis"><title>Synopsis</title>
diff --git a/docs/manual/programs/htpasswd.xml b/docs/manual/programs/htpasswd.xml
index 89993b1ef9..4808ad2dd9 100644
--- a/docs/manual/programs/htpasswd.xml
+++ b/docs/manual/programs/htpasswd.xml
@@ -35,8 +35,7 @@
just the users listed in the files created by <code>htpasswd</code>. This
program can only manage usernames and passwords stored in a flat-file. It
can encrypt and display password information for use in other types of data
- stores, though. To use a DBM database see <a
- href="dbmmanage.html">dbmmanage</a>.</p>
+ stores, though. To use a DBM database see <program>dbmmanage</program>.</p>
<p><code>htpasswd</code> encrypts passwords using either a version of MD5
modified for Apache, or the system's <code>crypt()</code> routine. Files
@@ -46,11 +45,11 @@
<p>This manual page only lists the command line arguments. For details of
the directives necessary to configure user authentication in
- <a href="httpd.html">httpd</a> see the Apache manual, which is part of the
+ <program>httpd</program> see the Apache manual, which is part of the
Apache distribution or can be found at <a href="http://httpd.apache.org"
>http://httpd.apache.org/</a>.</p>
</summary>
-<seealso><a href="httpd.html">httpd</a></seealso>
+<seealso><program>httpd</program></seealso>
<seealso>The scripts in support/SHA1 which come with the
distribution.</seealso>
@@ -110,7 +109,7 @@ distribution.</seealso>
<dd>Use <code>crypt()</code> encryption for passwords. The default on all
platforms but Windows, Netware and TPF. Though possibly supported by
<code>htpasswd</code> on all platforms, it is not supported by the
- <a href="httpd.html">httpd</a> server on Windows, Netware and TPF.</dd>
+ <program>httpd</program> server on Windows, Netware and TPF.</dd>
<dt><code>-s</code></dt>
<dd>Use SHA encryption for passwords. Facilitates migration from/to Netscape
@@ -118,7 +117,7 @@ distribution.</seealso>
<dt><code>-p</code></dt>
<dd>Use plaintext passwords. Though <code>htpasswd</code> will support
- creation on all platforms, the <a href="httpd.html">httpd</a> daemon will
+ creation on all platforms, the <program>httpd</program> daemon will
only accept plain text passwords on Windows, Netware and TPF.</dd>
<dt><code>-D</code></dt>
diff --git a/docs/manual/programs/httpd.xml b/docs/manual/programs/httpd.xml
index 2d37fe102b..0997af7963 100644
--- a/docs/manual/programs/httpd.xml
+++ b/docs/manual/programs/httpd.xml
@@ -31,8 +31,8 @@
child processes or threads to handle requests.</p>
<p>In general, <code>httpd</code> should not be invoked directly,
- but rather should be invoked via <a
- href="apachectl.html">apachectl</a> on Unix-based systems or <a
+ but rather should be invoked via <program>
+ apachectl</program> on Unix-based systems or <a
href="../platform/windows.html#winsvc">as a service on Windows NT,
2000 and XP</a> and <a href="../platform/windows.html#wincons">as
a console application on Windows 9x and ME</a>.</p>
@@ -42,7 +42,7 @@
<seealso><a href="../stopping.html">Stopping Apache</a></seealso>
<seealso><a href="../configuring.html">Configuration Files</a></seealso>
<seealso><a href="../platform/">Platform-specific Documentation</a></seealso>
-<seealso><a href="apachectl.html">apachectl</a></seealso>
+<seealso><program>apachectl</program></seealso>
<section id="synopsis"><title>Synopsis</title>
<p><code><strong>httpd</strong> [ -<strong>d</strong>
diff --git a/docs/manual/programs/index.xml b/docs/manual/programs/index.xml
index c4b98b0a34..e3c7eb96d2 100644
--- a/docs/manual/programs/index.xml
+++ b/docs/manual/programs/index.xml
@@ -32,54 +32,54 @@
<section id="index"><title>Index</title>
<dl>
- <dt><a href="httpd.html">httpd</a></dt>
+ <dt><program>httpd</program></dt>
<dd>Apache hypertext transfer protocol server</dd>
- <dt><a href="apachectl.html">apachectl</a></dt>
+ <dt><program>apachectl</program></dt>
<dd>Apache HTTP server control interface</dd>
- <dt><a href="ab.html">ab</a></dt>
+ <dt><program>ab</program></dt>
<dd>Apache HTTP server benchmarking tool</dd>
- <dt><a href="apxs.html">apxs</a></dt>
+ <dt><program>apxs</program></dt>
<dd>APache eXtenSion tool</dd>
- <dt><a href="configure.html">configure</a></dt>
+ <dt><program>configure</program></dt>
<dd>Configure the source tree</dd>
- <dt><a href="dbmmanage.html">dbmmanage</a></dt>
+ <dt><program>dbmmanage</program></dt>
<dd>Create and update user authentication files in DBM format
for basic authentication</dd>
- <dt><a href="htcacheclean.html">htcacheclean</a></dt>
+ <dt><program>htcacheclean</program></dt>
<dd>Clean up the disk cache</dd>
- <dt><a href="htdigest.html">htdigest</a></dt>
+ <dt><program>htdigest</program></dt>
<dd>Create and update user authentication files for digest
authentication</dd>
- <dt><a href="htpasswd.html">htpasswd</a></dt>
+ <dt><program>htpasswd</program></dt>
<dd>Create and update user authentication files for basic
authentication</dd>
- <dt><a href="logresolve.html">logresolve</a></dt>
+ <dt><program>logresolve</program></dt>
<dd>Resolve hostnames for IP-addresses in Apache
logfiles</dd>
- <dt><a href="rotatelogs.html">rotatelogs</a></dt>
+ <dt><program>rotatelogs</program></dt>
<dd>Rotate Apache logs without having to kill the server</dd>
- <dt><a href="suexec.html">suexec</a></dt>
+ <dt><program>suexec</program></dt>
<dd>Switch User For Exec</dd>