From: Adam Dickmeiss <adam@indexdata.dk>
Date: Thu, 18 Apr 2013 09:37:27 +0000 (+0200)
Subject: http_client documentation
X-Git-Tag: v1.3.56~34
X-Git-Url: http://git.indexdata.com/?a=commitdiff_plain;h=66ccbf941e10d3c2c07ef3187e855e58e541c93d;p=metaproxy-moved-to-github.git

http_client documentation
---

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 64d850f..5cf88df 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -16,6 +16,7 @@ XMLMAN = metaproxy.xml \
 	cgi.xml \
         cql_rpn.xml \
 	frontend_net.xml \
+	http_client.xml \
 	http_file.xml \
 	limit.xml \
 	load_balance.xml \
@@ -40,6 +41,7 @@ MANFILES = metaproxy.1 \
 	cgi.3mp \
         cql_rpn.3mp \
         frontend_net.3mp \
+	http_client.3mp \
 	http_file.3mp \
 	limit.3mp \
 	load_balance.3mp \
diff --git a/doc/http_client.xml b/doc/http_client.xml
new file mode 100644
index 0000000..17d2355
--- /dev/null
+++ b/doc/http_client.xml
@@ -0,0 +1,71 @@
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
+    "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
+ <!ENTITY copyright SYSTEM "copyright.xml">
+ <!ENTITY % idcommon SYSTEM "common/common.ent">
+     %idcommon;
+]>
+<refentry id="ref-http_client">
+ <refentryinfo>
+  <productname>Metaproxy</productname>
+  <info><orgname>Index Data</orgname></info>
+ </refentryinfo>
+
+ <refmeta>
+  <refentrytitle>http_client</refentrytitle>
+  <manvolnum>3mp</manvolnum>
+  <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+  <refname>http_client</refname>
+  <refpurpose>Metaproxy HTTP File Server Module</refpurpose>
+ </refnamediv>
+
+ <refsect1><title>DESCRIPTION</title>
+  <para>
+   This module implements HTTP client functionality. By default,
+   if proxy element is not given, it should be used as an explicit
+   proxy (non-transparent mode). If proxy element is set, requests
+   will be relayed to the proxy given (transparent mode for HTTP clients
+   accessing this module).
+  </para>
+ </refsect1>
+
+ <refsect1><title>SCHEMA</title>
+   <literallayout><xi:include
+		     xi:href="../xml/schema/filter_http_client.rnc"
+		     xi:parse="text"
+		     xmlns:xi="http://www.w3.org/2001/XInclude" />
+   </literallayout>
+ </refsect1>
+
+ <refsect1><title>EXAMPLES</title>
+  <para>
+   A typical configuration looks like this:
+   <screen><![CDATA[
+   <filter type="http_client">
+    <proxy>localhost:9999</proxy>
+   </filter>
+]]>
+   </screen>
+  </para>
+ </refsect1>
+
+ <refsect1><title>SEE ALSO</title>
+  <para>
+   <citerefentry>
+    <refentrytitle>metaproxy</refentrytitle>
+    <manvolnum>1</manvolnum>
+   </citerefentry>
+  </para>
+ </refsect1>
+
+ &copyright;
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: nxml
+nxml-child-indent: 1
+End:
+-->