Debian Codegraph @

doc/html/index.html

raw
1 <?xml version="1.0" ?>
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 <head>
5 <title>PerlDAV</title>
6 <link rel="stylesheet" href="perldav.css" type="text/css" />
7 <meta http-equiv="content-type" content="text/html; charset=utf-8" />
8 <link rev="made" href="mailto:root@localhost" />
9 </head>
10
11 <body>
12
13
14
15
16 <div id="content">
17 <H1>PerlDAV -- A WebDAV client library for Perl5</H1>
18 </div><div id="content">
19
20 <p>PerlDAV is a Perl library for modifying content on webservers using the WebDAV protocol. Now you can LOCK, DELETE and PUT files and much more on a DAV-enabled webserver.</p>
21
22 <p>The PerlDAV library consists of:</p>
23
24 <ul>
25
26 <li><p><b>HTTP::DAV</b> - an object-oriented Web-DAV client API.</p>
27
28 </li>
29 <li><p><b>dave</b> - the DAV Explorer, an end-user Unix console program for interacting with WebDAV servers. dave looks and feels like a standard Unix ftp program.</p>
30
31 </li>
32 </ul>
33
34 <h1 id="LATEST-VERSION-AND-WHATS-NEW">LATEST VERSION AND WHAT&#39;S NEW</h1>
35
36 <p>See the included <code>Changes</code> file for the full changelog.</p>
37
38 <h1 id="INSTALLING-HTTP::DAV">INSTALLING HTTP::DAV</h1>
39
40 <p>The lazy way to install PerlDAV:</p>
41
42 <pre><code>$ cpan HTTP::DAV</code></pre>
43
44 <p>Or the normal way:</p>
45
46 <p>Retrieve the latest copy from CPAN: https://metacpan.org/module/HTTP-DAV/</p>
47
48 <pre><code>$ perl Makefile.PL # Creates the Makefile
49 $ make # Runs the makefile
50 $ make test # Optional (See Interopability below)
51 $ make install # Installs dave and HTTP::DAV</code></pre>
52
53 <p>With this method you will first have to install the pre-requisites: LWP and XML::DOM, see <a href="#what-are-the-prerequisites">&quot;what are the prerequisites?&quot;</a>.</p>
54
55 <p>When you install PerlDAV, the HTTP::DAV library will be installed to your Perl library location (usually /usr/local/lib/perl5)</p>
56
57 <p><code>dave</code> will be installed to /usr/local/bin. This suits most people but you can modify this by using the INSTALLBIN flag:</p>
58
59 <pre><code>$ perl Makefile.PL INSTALLBIN=&quot;/home/user/bin&quot;</code></pre>
60
61 <h2 id="What-Are-The-Prerequisites">What Are The Prerequisites?</h2>
62
63 <ul>
64
65 <li><p>Perl 5.6.0+</p>
66
67 </li>
68 <li><p>LWP (Have not tested lower than v5.48)</p>
69
70 </li>
71 <li><p>Scalar::Util (standard library from 5.8.0+)</p>
72
73 </li>
74 <li><p>XML::DOM (Have not tested lower than v1.26). Requires James Clark&#39;s expat library:</p>
75
76 </li>
77 <li><p>To access SSL urls you will need <a>Crypt::SSLeay</a> and/or <a>IO::Socket::SSL</a>.</p>
78
79 </li>
80 </ul>
81
82 <h2 id="Optional-Prerequisites">Optional Prerequisites.</h2>
83
84 <ul>
85
86 <li><p>Crypt::SSLeay if you&#39;d like to use https. Crypt::SSLeay requires the openssl library as well. See Crypt::SSLeay&#39;s excellent install instructions for how to get https support into LWP (and hence HTTP::DAV). I&#39;ve tested HTTP::DAV and Crypt::SSLeay against Apache/mod_dav with the mod_ssl plugin. Works seamlessly.</p>
87
88 </li>
89 <li><p>MD5 if you&#39;d like to use LWP&#39;s Digest authentication.</p>
90
91 </li>
92 </ul>
93
94 <p>To get the latest versions of these prerequisite modules you can simply type this at the command prompt:</p>
95
96 <pre><code> $ &lt;install expat&gt;
97 then:
98 $ perl -MCPAN -e shell
99 cpan&gt; install LWP
100 cpan&gt; install XML::DOM</code></pre>
101
102 <p>or if you just &#39;install HTTP::DAV&#39; the lovely CPAN module should just magically install all of the prerequisites for you (you&#39;ll still need to manually instal expat though).</p>
103
104 <h2 id="What-Systems-Does-It-Work-With">What Systems Does It Work With?</h2>
105
106 <p>HTTP::DAV and dave are pure perl so only needs Perl 5.6.0 (or later). PerlDAV is known to run under Windows (although I haven&#39;t tried it myself) and should run under all Unix systems.</p>
107
108 <h1 id="WHERE-ARE-THE-MANUALS">WHERE ARE THE MANUALS?</h1>
109
110 <p>Once you&#39;ve installed PerlDAV, you can type:</p>
111
112 <pre><code>$ perldoc HTTP::DAV
113 $ man dave</code></pre>
114
115
116 <P>Or you can view them here:
117 <A HREF="HTTP-DAV.html">HTTP::DAV</A>,
118 <A HREF="dave.html">dave</A>.</P>
119
120 <h1 id="GETTING-HELP">GETTING HELP</h1>
121
122 <h2 id="The-perldav-mailing-list">The perldav mailing list</h2>
123
124 <p>There is a mailing list for PerlDAV for use by Developers and Users. Please see http://mailman.webdav.org/mailman/listinfo/perldav</p>
125
126 <h1 id="THE-TEST-SUITE-INTEROPERABILITY">THE TEST SUITE &amp; INTEROPERABILITY</h1>
127
128 <p>You will notice that the standard <code>make test</code> command invokes a large set of test procedures, but most will be skipped. This standard test is sufficient to give you a good indication that PerlDAV has installed properly.</p>
129
130 <p>If you&#39;d like to see how well PerlDAV performs against a particular DAV server then you should set the URL (and username,password) in the test suite t/TestDetails.pm. Then you can run <code>make test</code> again and watch the test suite perform as many operations as the server supports. Please note that the test suite will perofrm well over 200 HTTP requests to your server.</p>
131
132 <p>I have tested PerlDAV against IIS5, mod_dav and the Xythos WFS.</p>
133
134 <p>Out of the box, the test suite should NOT fail on any tests.</p>
135
136 <p>The test suite is the best way to test interopability between PerlDAV and other servers. I&#39;d really like help with testing PerlDAV&#39;s interoperability. So if one or more tests fail against your server please follow the following steps:</p>
137
138 <ul>
139
140 <li><p>Determine which test is failing.</p>
141
142 </li>
143 <li><p>set DEBUG to on: edit the script and change HTTP::DAV::DebugLevel(0) to (3).</p>
144
145 </li>
146 <li><p>Delete previous server output: rm /tmp/perldav_debug.txt</p>
147
148 </li>
149 <li><p>Run that single test again:</p>
150
151 <p>$make test TEST_FILES=t/thetest.t TEST_VERBOSE=1 &gt; testoutput.log</p>
152
153 </li>
154 <li><p>Then gzip and mail me both testoutput.log and /tmp/perldav_debug.txt with details of the test environment. (My email is at the bottom)</p>
155
156 </li>
157 </ul>
158
159 <p>Alternatively, you could have a shot at solving the bug yourself :)</p>
160
161 <h1 id="BUGS-and-TODO">BUGS and TODO</h1>
162
163 <p>Need to convert XML::DOM to a DOM Level 2 compliant parser like XML::Gdome.</p>
164
165
166 <P>See <A HREF="TODO.html">TODO</A> for what is left to be done.</P>
167
168 <h1 id="AUTHOR-AND-COPYRIGHT">AUTHOR AND COPYRIGHT</h1>
169
170 <p>This module is Copyright (C) 2001 by</p>
171
172 <pre><code>Patrick Collins
173 G03 Gloucester Place, Kensington
174 Sydney, Australia
175
176 mailto:[email protected]
177 Phone: +61 2 9663 4916</code></pre>
178
179 <p>All rights reserved.</p>
180
181 <h1 id="MAINTAINER">MAINTAINER</h1>
182
183 <p>The current maintainer of HTTP-DAV is Cosimo Streppone for Kahoot!, and previously for Opera Software ASA. You can contact me at <code>[email protected]</code>.</p>
184
185 <h1 id="GITHUB-REPOSITORY">GITHUB REPOSITORY</h1>
186
187 <p>The official repository for HTTP-DAV is now on Github:</p>
188
189 <pre><code>https://github.com/cosimo/perl5-http-dav</code></pre>
190
191 <h1 id="LICENSE">LICENSE</h1>
192
193 <p>You may distribute this module under the terms of either the GNU General Public License or the Artistic License, as specified in the Perl README file.</p>
194
195 <p>$Id$</p>
196
197
198 </div>
199
200
201 </body>
202
203 </html>
204
205