From: Takashi Sato <takashi@apache.org>
Date: Thu, 19 Jun 2008 16:33:36 +0000 (+0000)
Subject: Add documents of mod_proxy_fcgi and fcgistarter.
X-Git-Tag: 2.3.0~472
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=fb7a8b17964a6fa825433c80859d25a24ebd5e01;p=thirdparty%2Fapache%2Fhttpd.git

Add documents of mod_proxy_fcgi and fcgistarter.
These are incomplete.

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

diff --git a/docs/manual/mod/mod_proxy_fcgi.xml b/docs/manual/mod/mod_proxy_fcgi.xml
new file mode 100644
index 00000000000..b9a3f90996a
--- /dev/null
+++ b/docs/manual/mod/mod_proxy_fcgi.xml
@@ -0,0 +1,52 @@
+<?xml version="1.0"?>
+<!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
+<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
+<!-- $LastChangedRevision$ -->
+
+<!--
+ 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.
+-->
+
+<modulesynopsis metafile="mod_proxy_fcgi.xml.meta">
+
+<name>mod_proxy_fcg</name>
+<description>FastCGI support module for
+<module>mod_proxy</module></description>
+<status>Extension</status>
+<sourcefile>mod_proxy_fcgi.c</sourcefile>
+<identifier>proxy_fcgi_module</identifier>
+<compatibility>Available in version 2.3 and later</compatibility>
+
+<summary>
+    <p>This module <em>requires</em> the service of <module
+    >mod_proxy</module>. It provides support for the 
+    <a href="http://www.fastcgi.com/">FastCGI</a>.</p>
+
+    <p>Thus, in order to get the ability of handling <code>FastCGI</code>
+    protocol, <module>mod_proxy</module> and
+    <module>mod_proxy_fcgi</module> have to be present in the server.</p>
+
+    <note type="warning"><title>Warning</title>
+      <p>Do not enable proxying until you have <a
+      href="mod_proxy.html#access">secured your server</a>. Open proxy
+      servers are dangerous both to your network and to the Internet at
+      large.</p>
+    </note>
+</summary>
+
+<seealso><program>fcgistarter</program></seealso>
+<seealso><module>mod_proxy</module></seealso>
+</modulesynopsis>
diff --git a/docs/manual/programs/fcgistarter.xml b/docs/manual/programs/fcgistarter.xml
new file mode 100644
index 00000000000..06cf4c716ad
--- /dev/null
+++ b/docs/manual/programs/fcgistarter.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: 650172 $ -->
+
+<!--
+ 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="fcgistarter.xml.meta">
+<parentdocument href="./">Programs</parentdocument>
+
+<title>fcgistarter - Start a FastCGI program</title>
+
+<summary>
+    <p></p>
+    <note><title>Note</title>
+      <p>Currently only works on Unix systems.</p>
+    </note>
+</summary>
+<seealso><module>mod_proxy_fcgi</module></seealso>
+
+<section id="synopsis"><title>Synopsis</title>
+    <p><code><strong>fcgistarter</strong>
+    -<strong>c</strong> <var>command</var>
+    -<strong>p</strong> <var>port</var>
+    [ -<strong>i</strong> <var>interface</var> ]
+    -<strong>N</strong> <var>num</var>
+    </code></p>
+</section>
+
+<section id="options"><title>Options</title>
+    <dl>
+    <dt><code>-c <var>command</var></code></dt>
+    <dd>FastCGI program</dd>
+
+    <dt><code>-p <var>port</var></code></dt>
+    <dd>Port which the program will listens on</dd>
+
+    <dt><code>-i <var>interface</var></code></dt>
+    <dd>Interface which the program will listens on</dd>
+
+    <dt><code>-N <var>num</var></code></dt>
+    <dd>Number of instances of the program</dd>
+
+    </dl>
+</section>
+</manualpage>