Man page for each module.
[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 ]>
5 <!-- $Id: http_file.xml,v 1.1 2006-03-27 13:41:40 adam Exp $ -->
6 <refentry>
7  <refmeta>
8   <refentrytitle>http_file</refentrytitle>
9   <manvolnum>3mp</manvolnum>
10    <refmiscinfo>Metaproxy Module</refmiscinfo>
11 </refmeta>
12  
13  <refnamediv>
14   <refname>http_file</refname>
15   <refpurpose>network server</refpurpose>
16  </refnamediv>
17  
18  <refsect1><title>DESCRIPTION</title>
19   <para>
20    This module enables file access via the HTTP protocol.
21    All URLs with a given prefix are directed to a specific
22    documentroot (on local file storage). The module only serves
23    static content.
24   </para>
25  </refsect1>
26  
27  <refsect1><title>EXAMPLES</title>
28   <para>
29    A typical configuration looks as likes:
30    <screen><![CDATA[
31    <filter type="http_file">
32     <mimetypes>/etc/mime.types</mimetypes>
33     <documentroot>/var/www/metaproxy/html</port>
34     <prefix>/etc</prefixs>
35    </filter>
36 ]]>
37    </screen>
38   </para>
39  </refsect1> 
40  
41  <refsect1><title>SEE ALSO</title>
42   <para>
43    <citerefentry>
44     <refentrytitle>metaproxy</refentrytitle>
45     <manvolnum>1</manvolnum>
46    </citerefentry>
47   </para>
48  </refsect1>
49  
50  &copyright;
51 </refentry>
52
53 <!-- Keep this comment at the end of the file
54 Local variables:
55 mode: sgml
56 sgml-omittag:t
57 sgml-shorttag:t
58 sgml-minimize-attributes:nil
59 sgml-always-quote-attributes:t
60 sgml-indent-step:1
61 sgml-indent-data:t
62 sgml-parent-document:nil
63 sgml-local-catalogs: nil
64 sgml-namecase-general:t
65 End:
66 -->