Use entity idcommon rather than common
[metaproxy-moved-to-github.git] / doc / http_file.xml
1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" 
2     "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" [
3  <!ENTITY copyright SYSTEM "copyright.xml">
4  <!ENTITY % idcommon SYSTEM "common/common.ent">
5      %idcommon;
6 ]>
7 <!-- $Id: http_file.xml,v 1.8 2007-05-22 11:05:45 adam Exp $ -->
8 <refentry id="ref-http_file">
9  <refmeta>
10   <refentrytitle>http_file</refentrytitle>
11   <manvolnum>3mp</manvolnum>
12    <refmiscinfo>Metaproxy Module</refmiscinfo>
13 </refmeta>
14  
15  <refnamediv>
16   <refname>http_file</refname>
17   <refpurpose>Metaproxy HTTP File Server Module</refpurpose>
18  </refnamediv>
19  
20  <refsect1><title>DESCRIPTION</title>
21   <para>
22    This module enables file access via the HTTP protocol.
23    All URLs with a given prefix are directed to a specific
24    document root (on local file storage). The module only serves
25    static content.
26   </para>
27  </refsect1>
28  
29  <refsect1><title>EXAMPLES</title>
30   <para>
31    A typical configuration looks like this:
32    <screen><![CDATA[
33    <filter type="http_file">
34     <mimetypes>/etc/mime.types</mimetypes>
35     <area>
36      <documentroot>/var/www/metaproxy/html</port>
37      <prefix>/etc</prefixs>
38     </area>
39    </filter>
40 ]]>
41    </screen>
42   </para>
43  </refsect1> 
44  
45  <refsect1><title>SEE ALSO</title>
46   <para>
47    <citerefentry>
48     <refentrytitle>metaproxy</refentrytitle>
49     <manvolnum>1</manvolnum>
50    </citerefentry>
51   </para>
52  </refsect1>
53  
54  &copyright;
55 </refentry>
56
57 <!-- Keep this comment at the end of the file
58 Local variables:
59 mode: sgml
60 sgml-omittag:t
61 sgml-shorttag:t
62 sgml-minimize-attributes:nil
63 sgml-always-quote-attributes:t
64 sgml-indent-step:1
65 sgml-indent-data:t
66 sgml-parent-document:nil
67 sgml-local-catalogs: nil
68 sgml-namecase-general:t
69 End:
70 -->