Code

update docs for release 0.2
[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">
4   
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>This program is free software; you can redistribute it and/or
30     modify it under the terms of the GNU General Public License as
31     published by the Free Software Foundation; either version 2 of the
32     License, or (at your option) any later version.</p>
34     <p>This program is distributed in the hope that it will be useful, but
35     WITHOUT ANY WARRANTY; without even the implied warranty of
36     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
37     General Public License for more details.</p>
39     <p>You should have received a copy of the GNU General Public License
40     along with this program; if not, write to the Free Software
41     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</p>
43     <h2><a name="news">News</a></h2>
45     <div class="news-date">Sun Apr 2 2006: </div> <p class="news-text"><a
46     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>
48     <div class="news-date">Tue Mar 30 2004: </div> <p class="news-text"><a
49     href="@PACKAGE_URL@fusedav-0.1.tar.gz">Version 0.1</a> released, initial release</p>
51     <h2><a name="overview">Overview</a></h2>
53     <p><tt>fusedav</tt> is a Linux userspace file system driver for mounting
54     <a href="http://www.webdav.org/">WebDAV</a> shares. It makes use
55     of <a href="http://fuse.sourceforge.net/">FUSE</a> as userspace file system
56     API and <a href="http://www.webdav.org/neon/">neon</a> as WebDAV API.</p>
58     <h2><a name="status">Current Status</a></h2>
60     <p>Version @PACKAGE_VERSION@ works fine.</p>
61     
62     <h2><a name="documentation">Documentation</a></h2>
64     <p>After installation just run <tt>fusedav</tt> with two arguments: the WevDAV URL and the local mount point:</p>
66     <pre>fusedav http://webdav.foo.bar/ /tmp/test</pre>
68     <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>
70     <h2><a name="requirements">Requirements</a></h2>
72     <p><tt>fusedav</tt> was developed and tested on Debian GNU/Linux
73     "testing" from April 2006, it should work on most other Linux
74     distributions since it uses GNU autoconf for source code
75     configuration.</p>
77     <p><tt>fusedav</tt> requires the <a
78     href="http://www.webdav.org/neon/">neon</a> (0.26 minimum - 0.25
79     does not suffice!) and <a
80     href="http://fuse.sourceforge.net/">FUSE</a> (2.5 minimum)
81     development library files for compilation.</p>
83     <h2><a name="installation">Installation</a></h2>
85     <p>As this package is made with the GNU autotools you should run
86     <tt>./configure</tt> inside the distribution directory for configuring
87     the source tree. After that you should run <tt>make</tt> for
88     compilation and <tt>make install</tt> (as root) for installation of
89     <tt>fusedav</tt>.</p>
91     <h2><a name="acks">Acknowledgements</a></h2>
93     <p>Milos Szeredi for developing FUSE and some useful hints for its usage</p>
95     <p>Sebastien Estienne for some packaging work</p>
97     <h2><a name="download">Download</a></h2>
99     <p>The newest release is always available from <a href="@PACKAGE_URL@">@PACKAGE_URL@</a></p>
101     <p>The current release is <a href="@PACKAGE_URL@fusedav-@PACKAGE_VERSION@.tar.gz">@PACKAGE_VERSION@</a></p>
103     <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>
105     <pre>svn checkout svn://svn.0pointer.net/fusedav/trunk fusedav</pre>
107     <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>
109     <hr/>
110     <address class="grey">Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;, April 2006</address>
111     <div class="grey"><i>$Id$</i></div>
113   </body>
114 </html>