docs: Add FILES section to program man pages per man-pages(7) convention. Paths are...

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1933945 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/docs/manual/programs/apachectl.xml b/docs/manual/programs/apachectl.xml
index da09e01de8a503ae0853650efbf602cc10f2965d..658e937c0e0f5a834e3292019261276583b6c7d6 100644 (file)
--- a/docs/manual/programs/apachectl.xml
+++ b/docs/manual/programs/apachectl.xml
@@ -155,4 +155,19 @@ use the normal <code>apachectl start</code>.</dd>
 
 </section>
 
+<section id="files"><title>Files</title>
+
+<note>The default paths listed below may be changed at compile time.
+Consult your local installation for the actual locations.</note>
+
+<dl>
+<dt><code>/usr/local/apache2/bin/envvars</code></dt>
+<dd>Environment variable settings sourced at startup.</dd>
+
+<dt><code>/usr/local/apache2/bin/httpd</code></dt>
+<dd>The httpd binary invoked by apachectl.</dd>
+</dl>
+
+</section>
+
 </manualpage>

diff --git a/docs/manual/programs/htcacheclean.xml b/docs/manual/programs/htcacheclean.xml
index 295ef2fa4b5b80fc3ff7da3190a4ada45673a2ab..c76cae86003ee06212c869bc5eadca53554dce4f 100644 (file)
--- a/docs/manual/programs/htcacheclean.xml
+++ b/docs/manual/programs/htcacheclean.xml
@@ -209,4 +209,17 @@
     occurred during URL removal, <code>1</code> is returned.</p>
 </section>
 
+<section id="files"><title>Files</title>
+
+<note>The cache root directory is specified as an argument on the command line
+and should match the <code>CacheRoot</code> directive in the server
+configuration.</note>
+
+<dl>
+<dt><var>path</var></dt>
+<dd>The root directory of the disk cache to be cleaned.</dd>
+</dl>
+
+</section>
+
 </manualpage>

diff --git a/docs/manual/programs/htdbm.xml b/docs/manual/programs/htdbm.xml
index 4a679fcbd64f99bb0aa09ce1fd779b5b9c1363e8..f5f288306a2ea769657ca94111f51b0bfc0840ef 100644 (file)
--- a/docs/manual/programs/htdbm.xml
+++ b/docs/manual/programs/htdbm.xml
@@ -323,4 +323,16 @@
     character <code>:</code>.</p>
 </section>
 
+<section id="files"><title>Files</title>
+
+<note>The DBM password file path is specified as an argument on the command
+line and may be located anywhere on the filesystem.</note>
+
+<dl>
+<dt><var>filename</var></dt>
+<dd>The DBM format file containing usernames and passwords.</dd>
+</dl>
+
+</section>
+
 </manualpage>

diff --git a/docs/manual/programs/htdigest.xml b/docs/manual/programs/htdigest.xml
index 8b189e41f2cabc5245c5012806705662ef62cfbd..dc44e859ee56232e30e9b3a8a4ad7a38c1a1af87 100644 (file)
--- a/docs/manual/programs/htdigest.xml
+++ b/docs/manual/programs/htdigest.xml
@@ -73,4 +73,16 @@
     setuid.</p>
 </section>
 
+<section id="files"><title>Files</title>
+
+<note>The digest authentication file path is specified as an argument on the
+command line and may be located anywhere on the filesystem.</note>
+
+<dl>
+<dt><var>passwdfile</var></dt>
+<dd>The flat-file containing usernames, realms, and password hashes.</dd>
+</dl>
+
+</section>
+
 </manualpage>

diff --git a/docs/manual/programs/htpasswd.xml b/docs/manual/programs/htpasswd.xml
index 09a39da17fd70c378aefaebed68b78fc323298fa..f2ab5c0af373b491e5564b278a0e7dec4bb1e730 100644 (file)
--- a/docs/manual/programs/htpasswd.xml
+++ b/docs/manual/programs/htpasswd.xml
@@ -301,4 +301,18 @@ distribution.</seealso>
     rounds of 17 in version <code>1.6.0</code> and later.</p>
 </section>
 
+<section id="files"><title>Files</title>
+
+<note>The password file path is specified as an argument on the command line
+and may be located anywhere on the filesystem.</note>
+
+<dl>
+<dt><var>passwdfile</var></dt>
+<dd>The flat-file containing usernames and passwords.
+May contain empty lines and comment lines beginning with the hash
+character (<code>#</code>).</dd>
+</dl>
+
+</section>
+
 </manualpage>

diff --git a/docs/manual/programs/httpd.xml b/docs/manual/programs/httpd.xml
index 77d93c013433f9e6e25daaf74e617cea48858114..5115e7b4e1c213598302bc31333bb8250f732939 100644 (file)
--- a/docs/manual/programs/httpd.xml
+++ b/docs/manual/programs/httpd.xml
@@ -219,4 +219,29 @@ information about the configuration:</p>
 </dl>
 </section>
 
+<section id="files"><title>Files</title>
+
+<note>The default paths listed below may be changed at compile time or with
+various command-line and configuration directives. Consult your local
+installation for the actual locations.</note>
+
+<dl>
+<dt><code>/usr/local/apache2/conf/httpd.conf</code></dt>
+<dd>Main server configuration file.</dd>
+
+<dt><code>/usr/local/apache2/conf/mime.types</code></dt>
+<dd>Default MIME type mappings.</dd>
+
+<dt><code>/usr/local/apache2/logs/error_log</code></dt>
+<dd>Error log file.</dd>
+
+<dt><code>/usr/local/apache2/logs/access_log</code></dt>
+<dd>Access log file.</dd>
+
+<dt><code>/usr/local/apache2/logs/httpd.pid</code></dt>
+<dd>File containing the process ID of the running daemon.</dd>
+</dl>
+
+</section>
+
 </manualpage>