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. Filter rontend_net
  27    + http_client in combo - acts as a normal, non-transparent, proxy.
  28   </para>
  29   <para>
  30    The element default-host of configuration specifies the default host
  31    in remote URL. If this is set, frontend_net + http_client acts as a
  32    transparent HTTP proxy as well.
  33   </para>
  34   <para>
  35    The configuration element, proxy, is optional and enables a remote
  36    HTTP proxy to be in use.
  37   </para>
  38  </refsect1>
  39
  40  <refsect1><title>SCHEMA</title>
  41    <literallayout><xi:include
  42                      xi:href="../xml/schema/filter_http_client.rnc"
  43                      xi:parse="text"
  44                      xmlns:xi="http://www.w3.org/2001/XInclude" />
  45    </literallayout>
  46  </refsect1>
  47
  48  <refsect1><title>EXAMPLES</title>
  49   <para>
  50    A typical configuration looks like this:
  51    <screen><![CDATA[
  52    <filter type="http_client">
  53     <proxy>localhost:3128</proxy>
  54    </filter>
  55 ]]>
  56    </screen>
  57   </para>
  58  </refsect1>
  59
  60  <refsect1><title>SEE ALSO</title>
  61   <para>
  62    <citerefentry>
  63     <refentrytitle>metaproxy</refentrytitle>
  64     <manvolnum>1</manvolnum>
  65    </citerefentry>
  66   </para>
  67  </refsect1>
  68
  69  &copyright;
  70 </refentry>
  71
  72 <!-- Keep this comment at the end of the file
  73 Local variables:
  74 mode: nxml
  75 nxml-child-indent: 1
  76 End:
  77 -->