granicus.if.org Git - apache/blob - docs/manual/mod/mod_dav_fs.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
   3 <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
   4 <!-- $LastChangedRevision$ -->
   5
   6 <!--
   7  Licensed to the Apache Software Foundation (ASF) under one or more
   8  contributor license agreements.  See the NOTICE file distributed with
   9  this work for additional information regarding copyright ownership.
  10  The ASF licenses this file to You under the Apache License, Version 2.0
  11  (the "License"); you may not use this file except in compliance with
  12  the License.  You may obtain a copy of the License at
  13
  14      http://www.apache.org/licenses/LICENSE-2.0
  15
  16  Unless required by applicable law or agreed to in writing, software
  17  distributed under the License is distributed on an "AS IS" BASIS,
  18  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  19  See the License for the specific language governing permissions and
  20  limitations under the License.
  21 -->
  22
  23 <modulesynopsis metafile="mod_dav_fs.xml.meta">
  24
  25 <name>mod_dav_fs</name>
  26 <description>filesystem provider for <module>mod_dav</module></description>
  27 <status>Extension</status>
  28 <sourcefile>mod_dav_fs.c</sourcefile>
  29 <identifier>dav_fs_module</identifier>
  30
  31 <summary>
  32     <p>This module <em>requires</em> the service of <module
  33     >mod_dav</module>. It acts as a support module for <module
  34     >mod_dav</module> and provides access to resources located in the
  35     server's file system. The formal name of this provider is
  36     <code>filesystem</code>. <module>mod_dav</module> backend providers
  37     will be invoked by using the <directive module="mod_dav">Dav</directive>
  38     directive:</p>
  39
  40     <example><title>Example</title>
  41       Dav filesystem
  42     </example>
  43
  44     <p>Since <code>filesystem</code> is the default provider for
  45     <module>mod_dav</module>, you may simply use the value
  46     <code>On</code> instead.</p>
  47 </summary>
  48 <seealso><module>mod_dav</module></seealso>
  49
  50 <directivesynopsis>
  51 <name>DavLockDB</name>
  52 <description>Location of the DAV lock database</description>
  53 <syntax>DavLockDB <var>file-path</var></syntax>
  54 <contextlist><context>server config</context><context>virtual host</context>
  55 </contextlist>
  56
  57 <usage>
  58     <p>Use the <directive>DavLockDB</directive> directive to specify
  59     the full path to the lock database, excluding an extension. If
  60     the path is not absolute, it will be taken relative to <directive
  61     module="core">ServerRoot</directive>. The implementation of
  62     <module>mod_dav_fs</module> uses a SDBM database to track user
  63     locks.</p>
  64
  65     <!-- XXX: someone should add that tool to the support directory...
  66     The utility <code>modules/dav/util/lockview</code> can be used from
  67     the server to display all locks in a lock database.</p> -->
  68
  69     <example><title>Example</title>
  70       DavLockDB var/DavLock
  71     </example>
  72
  73     <p>The directory containing the lock database file must be
  74     writable by the <directive module="mod_unixd">User</directive>
  75     and <directive module="mod_unixd" >Group</directive> under which
  76     Apache is running.  For security reasons, you should create a
  77     directory for this purpose rather than changing the permissions on
  78     an existing directory.  In the above example, Apache will create
  79     files in the <code>var/</code> directory under the <directive
  80     module="core">ServerRoot</directive> with the base filename
  81     <code>DavLock</code> and extension name chosen by the server.</p>
  82
  83 </usage>
  84 </directivesynopsis>
  85
  86 </modulesynopsis>
  87