comparison: docs/html/getting-started.html
docs/html/getting-started.html
- changeset 266
- 8c44c5919691
- child 273
- c743721d566f
equal
deleted
inserted
replaced
| 265:ee9e63c437c4 | 266:8c44c5919691 |
|---|---|
| 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | |
| 2 <html xmlns="http://www.w3.org/1999/xhtml"> | |
| 3 <head> | |
| 4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | |
| 5 <meta http-equiv="Content-Style-Type" content="text/css" /> | |
| 6 <meta name="generator" content="pandoc" /> | |
| 7 <title></title> | |
| 8 <style type="text/css">code{white-space: pre;}</style> | |
| 9 <link rel="stylesheet" href="davdoc.css" type="text/css" /> | |
| 10 </head> | |
| 11 <body> | |
| 12 <div class="header"> | |
| 13 <span>davutils documentation</span> | |
| 14 </div> | |
| 15 <div class="sidebar"> | |
| 16 <div class="nav"> | |
| 17 <h3>dav</h3> | |
| 18 <ul> | |
| 19 <li><a href="getting-started.html">Getting started</a></li> | |
| 20 <li><a href="commands.html">Commands</a></li> | |
| 21 <ul> | |
| 22 <li><a href="list.html">list</a></li> | |
| 23 <li><a href="get.html">get</a></li> | |
| 24 <li><a href="put.html">put</a></li> | |
| 25 <li><a href="mkdir.html">mkdir</a></li> | |
| 26 <li><a href="remove.html">remove</a></li> | |
| 27 <li><a href="copy.html">copy</a></li> | |
| 28 <li><a href="move.html">move</a></li> | |
| 29 <li><a href="get-property.html">get-property</a></li> | |
| 30 <li><a href="set-property.html">set-property</a></li> | |
| 31 <li><a href="lock.html">lock</a></li> | |
| 32 <li><a href="unlock.html">unlock</a></li> | |
| 33 <li><a href="info.html">info</a></li> | |
| 34 <li><a href="date.html">date</a></li> | |
| 35 <li><a href="add-repository.html">add-repository</a></li> | |
| 36 <li><a href="list-repositories.html">list-repositories</a></li> | |
| 37 <li><a href="check-config.html">check-config</a></li> | |
| 38 </ul> | |
| 39 <li><a href="configuration.html">Configuration</a></li> | |
| 40 <li><a href="encryption.html">Encryption</a></li> | |
| 41 </ul> | |
| 42 </div> | |
| 43 <div class="nav"> | |
| 44 <h3>dav-sync</h3> | |
| 45 <ul> | |
| 46 <li><a href=".">.</a></li> | |
| 47 </ul> | |
| 48 </div> | |
| 49 </div> | |
| 50 | |
| 51 <!-- begin content --> | |
| 52 <div class="content"> | |
| 53 <h1 id="getting-started">Getting started</h1> | |
| 54 <h3 id="test">Test</h3> | |
| 55 <p>After successful installation you can test dav with your WebDAV server.</p> | |
| 56 <pre><code>dav list http://example.com/webdav/</code></pre> | |
| 57 <p>This lists all child resources of the specified collection. If you are unfamiliar to WebDAV terminology this means basically listing all files in a directory, similar to the ls unix tool. Infact you can also write dav ls instead of dav list and there is also a -l option like ls has one.</p> | |
| 58 <h3 id="create-a-repository">Create a repository</h3> | |
| 59 <p>All dav commands are expecting a url argument, but it may be a bit cumbersome to type a full url every time. But you can configure a repository in the dav configuration file ($HOME/.dav/config.xml) with the servers url, optional authentication information and other options. After that you can access a webdav server just with the repository name and an optional path.</p> | |
| 60 <p>So when you have created a repository with the name myserv and the url http://example.com/webdav/, you can just type</p> | |
| 61 <pre><code>dav list myserv</code></pre> | |
| 62 <p>You can add a path to the repository name to access an other url</p> | |
| 63 <pre><code>dav list myserv/mycollection/</code></pre> | |
| 64 <p>This lists the content of http://example.com/webdav/mycollection/</p> | |
| 65 <p>The easiest way to create a repository is with the add-repository command. This is a simple configuration assistant.</p> | |
| 66 <pre><code>$ dav add-repository | |
| 67 Each repository must have an unique name. | |
| 68 name: myserv | |
| 69 | |
| 70 Specify the repository base url. | |
| 71 url: http://example.com/webdav/ | |
| 72 | |
| 73 User for HTTP authentication. | |
| 74 user (optional): myuser | |
| 75 password (optional): | |
| 76 | |
| 77 | |
| 78 Added repository: myserv (http://example.com/webdav/)</code></pre> | |
| 79 <p>You can also configure the config.xml yourself, check out this example page and the config.xml spec.</p> | |
| 80 <p>More informations about urls and path in dav here.</p> | |
| 81 </div> | |
| 82 <!-- end content --> | |
| 83 </body> | |
| 84 </html> |
