doc/http_client.xml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
   2     "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
   3  <!ENTITY copyright SYSTEM "copyright.xml">
   4  <!ENTITY % idcommon SYSTEM "common/common.ent">
   5      %idcommon;
   6 ]>
   7 <refentry id="ref-http_client">
   8  <refentryinfo>
   9   <productname>Metaproxy</productname>
  10   <info><orgname>Index Data</orgname></info>
  11  </refentryinfo>
  12
  13  <refmeta>
  14   <refentrytitle>http_client</refentrytitle>
  15   <manvolnum>3mp</manvolnum>
  16   <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
  17  </refmeta>
  18
  19  <refnamediv>
  20   <refname>http_client</refname>
  21   <refpurpose>Metaproxy HTTP File Server Module</refpurpose>
  22  </refnamediv>
  23
  24  <refsect1><title>DESCRIPTION</title>
  25   <para>
  26    This module implements HTTP client functionality. By default,
  27    if proxy element is not given, it should be used as an explicit
  28    proxy (non-transparent mode). If proxy element is set, requests
  29    will be relayed to the proxy given (transparent mode for HTTP clients
  30    accessing this module).
  31   </para>
  32  </refsect1>
  33
  34  <refsect1><title>SCHEMA</title>
  35    <literallayout><xi:include
  36                      xi:href="../xml/schema/filter_http_client.rnc"
  37                      xi:parse="text"
  38                      xmlns:xi="http://www.w3.org/2001/XInclude" />
  39    </literallayout>
  40  </refsect1>
  41
  42  <refsect1><title>EXAMPLES</title>
  43   <para>
  44    A typical configuration looks like this:
  45    <screen><![CDATA[
  46    <filter type="http_client">
  47     <proxy>localhost:9999</proxy>
  48    </filter>
  49 ]]>
  50    </screen>
  51   </para>
  52  </refsect1>
  53
  54  <refsect1><title>SEE ALSO</title>
  55   <para>
  56    <citerefentry>
  57     <refentrytitle>metaproxy</refentrytitle>
  58     <manvolnum>1</manvolnum>
  59    </citerefentry>
  60   </para>
  61  </refsect1>
  62
  63  &copyright;
  64 </refentry>
  65
  66 <!-- Keep this comment at the end of the file
  67 Local variables:
  68 mode: nxml
  69 nxml-child-indent: 1
  70 End:
  71 -->