]> granicus.if.org Git - apache/commitdiff
Splits the docs for log_server_status and split-logfile into their own
authorRich Bowen <rbowen@apache.org>
Tue, 1 May 2012 14:59:02 +0000 (14:59 +0000)
committerRich Bowen <rbowen@apache.org>
Tue, 1 May 2012 14:59:02 +0000 (14:59 +0000)
separate docs. The "other" file has dwindled over the years, and having
"other" just list two things seems a little silly. Also, update
log_server_status doc to reflect current reality.

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/branches/2.4.x@1332679 13f79535-47bb-0310-9956-ffa450edef68

docs/manual/programs/log_server_status.html [new file with mode: 0644]
docs/manual/programs/log_server_status.html.en [new file with mode: 0644]
docs/manual/programs/log_server_status.xml [new file with mode: 0644]
docs/manual/programs/log_server_status.xml.meta [new file with mode: 0644]
docs/manual/programs/other.html.en
docs/manual/programs/other.xml
docs/manual/programs/split-logfile.html [new file with mode: 0644]
docs/manual/programs/split-logfile.html.en [new file with mode: 0644]
docs/manual/programs/split-logfile.xml [new file with mode: 0644]
docs/manual/programs/split-logfile.xml.meta [new file with mode: 0644]

diff --git a/docs/manual/programs/log_server_status.html b/docs/manual/programs/log_server_status.html
new file mode 100644 (file)
index 0000000..192b614
--- /dev/null
@@ -0,0 +1,5 @@
+# GENERATED FROM XML -- DO NOT EDIT
+
+URI: log_server_status.html.en
+Content-Language: en
+Content-type: text/html; charset=ISO-8859-1
diff --git a/docs/manual/programs/log_server_status.html.en b/docs/manual/programs/log_server_status.html.en
new file mode 100644 (file)
index 0000000..fe20f64
--- /dev/null
@@ -0,0 +1,71 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
+        XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+              This file is generated from xml source: DO NOT EDIT
+        XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+      -->
+<title>log_server_status - Log periodic status summaries - Apache HTTP Server</title>
+<link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
+<link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
+<link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
+<script src="../style/scripts/prettify.js" type="text/javascript">
+</script>
+
+<link href="../images/favicon.ico" rel="shortcut icon" /></head>
+<body id="manual-page" class="no-sidebar"><div id="page-header">
+<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
+<p class="apache">Apache HTTP Server Version 2.4</p>
+<img alt="" src="../images/feather.gif" /></div>
+<div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
+<div id="path">
+<a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.4</a> &gt; <a href="./">Programs</a></div><div id="page-content"><div id="preamble"><h1>log_server_status - Log periodic status summaries</h1>
+<div class="toplang">
+<p><span>Available Languages: </span><a href="../en/programs/other.html" title="English">&nbsp;en&nbsp;</a> |
+<a href="../ko/programs/other.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
+<a href="../tr/programs/other.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
+</div>
+
+    <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. <code class="module"><a href="../mod/mod_status.html">mod_status</a></code> will
+    need to be loaded and configured in order for this script to do its
+    job.</p>
+</div>
+<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="section">
+<h2><a name="configure" id="configure">Usage</a></h2>
+
+<p>The script contains the following section.</p>
+
+<pre class="prettyprint lang-perl">
+my $wherelog = "/usr/local/apache2/logs/";  # Logs will be like "/usr/local/apache2/logs/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>
+
+
+<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>
+
+</div></div>
+<div class="bottomlang">
+<p><span>Available Languages: </span><a href="../en/programs/other.html" title="English">&nbsp;en&nbsp;</a> |
+<a href="../ko/programs/other.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
+<a href="../tr/programs/other.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
+</div><div id="footer">
+<p class="apache">Copyright 2012 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
+<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
+if (typeof(prettyPrint) !== undefined) {
+    prettyPrint();
+}
+//--><!]]></script>
+</body></html>
\ No newline at end of file
diff --git a/docs/manual/programs/log_server_status.xml b/docs/manual/programs/log_server_status.xml
new file mode 100644 (file)
index 0000000..04f709b
--- /dev/null
@@ -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: 1331547 $ -->
+
+<!--
+ 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>
+
+<highlight language="perl">
+my $wherelog = "/usr/local/apache2/logs/";  # Logs will be like "/usr/local/apache2/logs/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
+</highlight>
+
+<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/log_server_status.xml.meta b/docs/manual/programs/log_server_status.xml.meta
new file mode 100644 (file)
index 0000000..4ad2755
--- /dev/null
@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!-- GENERATED FROM XML: DO NOT EDIT -->
+
+<metafile reference="log_server_status.xml">
+  <basename>log_server_status</basename>
+  <path>/programs/</path>
+  <relpath>..</relpath>
+
+  <variants>
+    <variant>en</variant>
+  </variants>
+</metafile>
index 9c8522a22b8a3a57aa82aac49101bda7c419a084..8fefe2117b3abe947b2d6b99c0dc0f0fa58c3a6c 100644 (file)
@@ -13,7 +13,7 @@
 </script>
 
 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
-<body id="manual-page"><div id="page-header">
+<body id="manual-page" class="no-sidebar"><div id="page-header">
 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
 <p class="apache">Apache HTTP Server Version 2.4</p>
 <img alt="" src="../images/feather.gif" /></div>
 <a href="../tr/programs/other.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
 </div>
 
-    <p>The following programs are simple support programs included with the
-    Apache HTTP Server which do not have their own manual pages. They are not
-    installed automatically. You can find them after the configuration process
-    in the <code>support/</code> directory.</p>
-</div>
-<div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#log_server_status">log_server_status</a></li>
-<li><img alt="" src="../images/down.gif" /> <a href="#split-logfile">split-logfile</a></li>
-</ul></div>
-<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
-<div class="section">
-<h2><a name="log_server_status" id="log_server_status">log_server_status</a></h2>
-    <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.</p>
-</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
-<div class="section">
-<h2><a name="split-logfile" id="split-logfile">split-logfile</a></h2>
-    <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 <code class="directive"><a href="../mod/mod_log_config.html#logformat">LogFormat</a></code>.
-    </p>
-
-    <div class="example"><p><code>
-        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
-    </code></p></div>
-
-    <p>Log files will be created, in the directory where are running 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>
+    <p>This page used to contain documentation for programs which now
+    have their own docs pages. Please update any links.</p>
 
-    <div class="example"><p><code>split-logfile &lt; access_log</code></p></div>
-
-
-</div></div>
+    <p><code class="program"><a href="../programs/log_server_status.html">log_server_status</a></code></p>
+    <p><code class="program"><a href="../programs/split-lofile.html">split-lofile</a></code></p>
+</div>
+</div>
 <div class="bottomlang">
 <p><span>Available Languages: </span><a href="../en/programs/other.html" title="English">&nbsp;en&nbsp;</a> |
 <a href="../ko/programs/other.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
index 334dfd3a32c4f46f0d774ef8d82c898c64f5f46b..8ce768c7f8e285b87a967991e37d8c317872c837 100644 (file)
 <title>Other Programs</title>
 
 <summary>
-    <p>The following programs are simple support programs included with the
-    Apache HTTP Server which do not have their own manual pages. They are not
-    installed automatically. You can find them after the configuration process
-    in the <code>support/</code> directory.</p>
-</summary>
-
-<section id="log_server_status"><title>log_server_status</title>
-    <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.</p>
-</section>
-
-<section id="split-logfile"><title>split-logfile</title>
-    <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>
-
-    <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 are running 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>This page used to contain documentation for programs which now
+    have their own docs pages. Please update any links.</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>
+    <p><program>log_server_status</program></p>
+    <p><program>split-lofile</program></p>
+</summary>
 
 </manualpage>
diff --git a/docs/manual/programs/split-logfile.html b/docs/manual/programs/split-logfile.html
new file mode 100644 (file)
index 0000000..80b4860
--- /dev/null
@@ -0,0 +1,5 @@
+# GENERATED FROM XML -- DO NOT EDIT
+
+URI: split-logfile.html.en
+Content-Language: en
+Content-type: text/html; charset=ISO-8859-1
diff --git a/docs/manual/programs/split-logfile.html.en b/docs/manual/programs/split-logfile.html.en
new file mode 100644 (file)
index 0000000..5ac8e4f
--- /dev/null
@@ -0,0 +1,70 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
+        XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+              This file is generated from xml source: DO NOT EDIT
+        XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+      -->
+<title>split-logfile - Split up multi-vhost logfiles - Apache HTTP Server</title>
+<link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
+<link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
+<link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
+<script src="../style/scripts/prettify.js" type="text/javascript">
+</script>
+
+<link href="../images/favicon.ico" rel="shortcut icon" /></head>
+<body id="manual-page" class="no-sidebar"><div id="page-header">
+<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
+<p class="apache">Apache HTTP Server Version 2.4</p>
+<img alt="" src="../images/feather.gif" /></div>
+<div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
+<div id="path">
+<a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.4</a> &gt; <a href="./">Programs</a></div><div id="page-content"><div id="preamble"><h1>split-logfile - Split up multi-vhost logfiles</h1>
+<div class="toplang">
+<p><span>Available Languages: </span><a href="../en/programs/other.html" title="English">&nbsp;en&nbsp;</a> |
+<a href="../ko/programs/other.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
+<a href="../tr/programs/other.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
+</div>
+
+    <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 <code class="directive"><a href="../mod/mod_log_config.html#logformat">LogFormat</a></code>.
+    </p>
+</div>
+<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="section">
+<h2><a name="split-logfile" id="split-logfile">Usage</a></h2>
+
+    <p>Create a log file with virtual host information in it:</p>
+
+    <div class="example"><p><code>
+        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
+    </code></p></div>
+
+    <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>
+
+    <div class="example"><p><code>split-logfile &lt; access_log</code></p></div>
+
+
+</div></div>
+<div class="bottomlang">
+<p><span>Available Languages: </span><a href="../en/programs/other.html" title="English">&nbsp;en&nbsp;</a> |
+<a href="../ko/programs/other.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
+<a href="../tr/programs/other.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
+</div><div id="footer">
+<p class="apache">Copyright 2012 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
+<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
+if (typeof(prettyPrint) !== undefined) {
+    prettyPrint();
+}
+//--><!]]></script>
+</body></html>
\ No newline at end of file
diff --git a/docs/manual/programs/split-logfile.xml b/docs/manual/programs/split-logfile.xml
new file mode 100644 (file)
index 0000000..20e7aba
--- /dev/null
@@ -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: 1331547 $ -->
+
+<!--
+ 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>
diff --git a/docs/manual/programs/split-logfile.xml.meta b/docs/manual/programs/split-logfile.xml.meta
new file mode 100644 (file)
index 0000000..2151406
--- /dev/null
@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!-- GENERATED FROM XML: DO NOT EDIT -->
+
+<metafile reference="split-logfile.xml">
+  <basename>split-logfile</basename>
+  <path>/programs/</path>
+  <relpath>..</relpath>
+
+  <variants>
+    <variant>en</variant>
+  </variants>
+</metafile>