From dad9e8d40adecf5a7d2a2e3b77aa2548996ddf7b Mon Sep 17 00:00:00 2001
From: Rich Bowen <rbowen@apache.org>
Date: Thu, 12 Apr 2012 14:23:33 +0000
Subject: [PATCH] Move split-logfile and log_server_status into their own doc
 file, rather than having "other". Update index accordingly.

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1325282 13f79535-47bb-0310-9956-ffa450edef68
---
 docs/manual/programs/index.html.en         |  4 +-
 docs/manual/programs/index.xml             |  5 +-
 docs/manual/programs/log_server_status.xml | 61 ++++++++++++++++++++++
 docs/manual/programs/split-logfile.xml     | 59 +++++++++++++++++++++
 4 files changed, 124 insertions(+), 5 deletions(-)
 create mode 100644 docs/manual/programs/log_server_status.xml
 create mode 100644 docs/manual/programs/split-logfile.xml

diff --git a/docs/manual/programs/index.html.en b/docs/manual/programs/index.html.en
index e9045ee1c1..5348a71df7 100644
--- a/docs/manual/programs/index.html.en
+++ b/docs/manual/programs/index.html.en
@@ -93,7 +93,7 @@
       <dd>Resolve hostnames for IP-addresses in Apache
       logfiles</dd>
 
-      <dt><a href="other.html#log_server_status">log_server_status</a></dt>
+      <dt><code class="program"><a href="../programs/log_server_status.html">log_server_status</a></code></dt>
 
       <dd>Periodically log the server's status</dd>
 
@@ -101,7 +101,7 @@
 
       <dd>Rotate Apache logs without having to kill the server</dd>
 
-      <dt><a href="other.html#split-logfile">split-logfile</a></dt>
+      <dt><code class="program"><a href="../programs/split-logfile.html">split-logfile</a></code></dt>
 
       <dd>Split a multi-vhost logfile into per-host logfiles</dd>
 
diff --git a/docs/manual/programs/index.xml b/docs/manual/programs/index.xml
index 1e518e51f6..14ba1526b1 100644
--- a/docs/manual/programs/index.xml
+++ b/docs/manual/programs/index.xml
@@ -93,8 +93,7 @@
       <dd>Resolve hostnames for IP-addresses in Apache
       logfiles</dd>
 
-      <dt><a
-      href="other.html#log_server_status">log_server_status</a></dt>
+      <dt><program>log_server_status</program></dt>
 
       <dd>Periodically log the server's status</dd>
 
@@ -102,7 +101,7 @@
 
       <dd>Rotate Apache logs without having to kill the server</dd>
 
-      <dt><a href="other.html#split-logfile">split-logfile</a></dt>
+      <dt><program>split-logfile</program></dt>
 
       <dd>Split a multi-vhost logfile into per-host logfiles</dd>
 
diff --git a/docs/manual/programs/log_server_status.xml b/docs/manual/programs/log_server_status.xml
new file mode 100644
index 0000000000..dd88089751
--- /dev/null
+++ b/docs/manual/programs/log_server_status.xml
@@ -0,0 +1,61 @@
+<?xml version='1.0' encoding='UTF-8' ?>
+<!DOCTYPE manualpage SYSTEM "../style/manualpage.dtd">
+<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
+<!-- $LastChangedRevision: 1174747 $ -->
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<manualpage metafile="other.xml.meta">
+<parentdocument href="./">Programs</parentdocument>
+
+<title>log_server_status - Log periodic status summaries</title>
+
+<summary>
+    <p>This perl script is designed to be run at a frequent interval by
+    something like cron. It connects to the server and downloads the status
+    information. It reformats the information to a single line and logs it to
+    a file. Adjust the variables at the top of the script to specify the
+    location of the resulting logfile. <module>mod_status</module> will
+    need to be loaded and configured in order for this script to do its
+    job.</p>
+</summary>
+
+<section id="configure"><title>Usage</title>
+
+<p>The script contains the following section.</p>
+
+<example>
+<pre>
+my $wherelog = "/usr/local/apache2/logs/";  # Logs will be like "/var/log/graph/19960312"
+my $server   = "localhost";        # Name of server, could be "www.foo.com"
+my $port     = "80";               # Port on server
+my $request = "/server-status/?auto";    # Request to send
+</pre>
+</example>
+
+<p>You'll need to ensure that these variables have the correct values,
+and you'll need to have the <code>/server-status</code> handler
+configured at the location specified, and the specified log location
+needs to be writable by the user which will run the script.</p>
+
+<p>Run the script periodically via cron to produce a daily log file,
+which can then be used for statistical analysis.</p>
+
+</section>
+
+</manualpage>
diff --git a/docs/manual/programs/split-logfile.xml b/docs/manual/programs/split-logfile.xml
new file mode 100644
index 0000000000..2f2317a00a
--- /dev/null
+++ b/docs/manual/programs/split-logfile.xml
@@ -0,0 +1,59 @@
+<?xml version='1.0' encoding='UTF-8' ?>
+<!DOCTYPE manualpage SYSTEM "../style/manualpage.dtd">
+<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
+<!-- $LastChangedRevision: 1174747 $ -->
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<manualpage metafile="other.xml.meta">
+<parentdocument href="./">Programs</parentdocument>
+
+<title>split-logfile - Split up multi-vhost logfiles</title>
+
+<summary>
+    <p>This perl script will take a combined Web server access log file and
+    break its contents into separate files. It assumes that the first field of
+    each line is the virtual host identity, put there using the "<code>%v</code>"
+    variable in <directive module="mod_log_config">LogFormat</directive>.
+    </p>
+</summary>
+
+<section id="split-logfile"><title>Usage</title>
+
+    <p>Create a log file with virtual host information in it:</p>
+
+    <example>
+        LogFormat "%v %h %l %u %t \"%r\" %&gt;s %b \"%{Referer}i\" \"%{User-agent}i\""
+             combined_plus_vhost<br />
+        CustomLog logs/access_log combined_plus_vhost
+    </example>
+
+    <p>Log files will be created, in the directory where you run the
+    script, for each virtual host name that appears in the combined log file.
+    These logfiles will named after the hostname, with a
+    <code>.log</code> file extension.</p>
+
+    <p>The combined log file is read from stdin. Records read will be appended
+    to any existing log files.</p>
+
+    <example>split-logfile &lt; access_log</example>
+
+
+</section>
+
+</manualpage>
-- 
2.40.0