Code

git: remove $Id$ svn cruft
[fusedav.git] / doc / README.html.in
1 <?xml version="1.0" encoding="iso-8859-15"?> <!-- -*-nxml-*- -->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
5   <head>
6     <title>fusedav @PACKAGE_VERSION@</title>
7     <link rel="stylesheet" type="text/css" href="style.css" />
8   </head>
10   <body>
11     <h1><a name="top">fusedav @PACKAGE_VERSION@</a></h1>
13     <p><i>Copyright 2004,2006 Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;</i></p>
15     <ul class="toc">
16       <li><a href="#license">License</a></li>
17       <li><a href="#news">News</a></li>
18       <li><a href="#overview">Overview</a></li>
19       <li><a href="#status">Current Status</a></li>
20       <li><a href="#documentation">Documentation</a></li>
21       <li><a href="#requirements">Requirements</a></li>
22       <li><a href="#installation">Installation</a></li>
23       <li><a href="#acks">Acknowledgements</a></li>
24       <li><a href="#download">Download</a></li>
25     </ul>
27     <h2><a name="license">License</a></h2>
29     <p>Copyright (c) 2004-2006 Lennart Poettering</p>
31     <p>Permission is hereby granted, free of charge, to any person
32     obtaining a copy of this software and associated documentation
33     files (the "Software"), to deal in the Software without
34     restriction, including without limitation the rights to use, copy,
35     modify, merge, publish, distribute, sublicense, and/or sell copies
36     of the Software, and to permit persons to whom the Software is
37     furnished to do so, subject to the following conditions:</p>
39     <p>The above copyright notice and this permission notice shall be
40     included in all copies or substantial portions of the Software.</p>
42     <p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
43     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
44     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
45     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
46     HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
47     WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
48     OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
49     DEALINGS IN THE SOFTWARE.</p>
51     <h2><a name="news">News</a></h2>
53     <div class="news-date">Sun Apr 2 2006: </div> <p class="news-text"><a
54     href="@PACKAGE_URL@fusedav-0.2.tar.gz">Version 0.2</a> released, changes include: update for current NEON (0.26 required) and FUSE (2.5 required); locking support; proper redirection support; export WebDAV properties as Linux EAs</p>
56     <div class="news-date">Tue Mar 30 2004: </div> <p class="news-text"><a
57     href="@PACKAGE_URL@fusedav-0.1.tar.gz">Version 0.1</a> released, initial release</p>
59     <h2><a name="overview">Overview</a></h2>
61     <p><tt>fusedav</tt> is a Linux userspace file system driver for mounting
62     <a href="http://www.webdav.org/">WebDAV</a> shares. It makes use
63     of <a href="http://fuse.sourceforge.net/">FUSE</a> as userspace file system
64     API and <a href="http://www.webdav.org/neon/">neon</a> as WebDAV API.</p>
66     <h2><a name="status">Current Status</a></h2>
68     <p>Version @PACKAGE_VERSION@ works fine.</p>
70     <h2><a name="documentation">Documentation</a></h2>
72     <p>After installation just run <tt>fusedav</tt> with two arguments: the WevDAV URL and the local mount point:</p>
74     <pre>fusedav http://webdav.foo.bar/ /tmp/test</pre>
76     <p>You will be queried for a username and password if required. As long as the <tt>fusedav</tt> process is running, the file system is accessible under <tt>/tmp/test</tt>.</p>
78     <h2><a name="requirements">Requirements</a></h2>
80     <p><tt>fusedav</tt> was developed and tested on Debian GNU/Linux
81     "testing" from April 2006, it should work on most other Linux
82     distributions since it uses GNU autoconf for source code
83     configuration.</p>
85     <p><tt>fusedav</tt> requires the <a
86     href="http://www.webdav.org/neon/">neon</a> (0.26 minimum - 0.25
87     does not suffice!) built with thread-safe SSL and LFS support, and <a
88     href="http://fuse.sourceforge.net/">FUSE</a> (2.5 minimum)
89     development library files for compilation.</p>
91     <h2><a name="installation">Installation</a></h2>
93     <p>As this package is made with the GNU autotools you should run
94     <tt>./configure</tt> inside the distribution directory for configuring
95     the source tree. After that you should run <tt>make</tt> for
96     compilation and <tt>make install</tt> (as root) for installation of
97     <tt>fusedav</tt>.</p>
99     <h2><a name="acks">Acknowledgements</a></h2>
101     <p>Milos Szeredi for developing FUSE and some useful hints for its usage</p>
103     <p>Sebastien Estienne for some packaging work</p>
105     <h2><a name="download">Download</a></h2>
107     <p>The newest release is always available from <a href="@PACKAGE_URL@">@PACKAGE_URL@</a></p>
109     <p>The current release is <a href="@PACKAGE_URL@fusedav-@PACKAGE_VERSION@.tar.gz">@PACKAGE_VERSION@</a></p>
111     <p>Get <tt>fusedav</tt>'s development sources from the <a href="http://subversion.tigris.org/">Subversion</a> <a href="svn://svn.0pointer.net/fusedav/">repository</a> (<a href="http://0pointer.net/cgi-bin/viewcvs.cgi/?root=fusedav">viewcvs</a>): </p>
113     <pre>svn checkout svn://svn.0pointer.net/fusedav/trunk fusedav</pre>
115     <p>If you want to be notified whenever I release a new version of this software use the subscription feature of <a href="http://freshmeat.net/projects/fusedav/">Freshmeat</a>.</p>
117     <hr/>
118     <address class="grey">Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;, April 2006</address>
119     <div class="grey"><i>$Id$</i></div>
121   </body>
122 </html>