getting-started.html - UNIXwork Code

1 <!DOCTYPE html> 2 <html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang=""> 3 <head> 4 <meta charset="utf-8" /> 5 <meta name="generator" content="pandoc" /> 6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" /> 7 <title>Getting started</title> 8 <style type="text/css"> 9 code{white-space: pre-wrap;} 10 span.smallcaps{font-variant: small-caps;} 11 span.underline{text-decoration: underline;} 12 div.column{display: inline-block; vertical-align: top; width: 50%;} 13 </style> 14 <link rel="stylesheet" href="davdoc.css" /> 15  18 </head> 19 <body> 20 <div class="header"> 21 <a href="./index.html"><span>DavUtils documentation</span></a> 22 </div> 23 <div class="sidebar"> 24 <div class="nav"> 25 <h3>dav</h3> 26 <ul> 27 <li><a href="getting-started.html">Getting started</a></li> 28 <li><a href="commands.html">Commands</a></li> 29 <ul> 30 <li><a href="list.html">list</a></li> 31 <li><a href="get.html">get</a></li> 32 <li><a href="put.html">put</a></li> 33 <li><a href="mkdir.html">mkdir</a></li> 34 <li><a href="remove.html">remove</a></li> 35 <li><a href="copy.html">copy</a></li> 36 <li><a href="move.html">move</a></li> 37 <li><a href="rename.html">rename</a></li> 38 <li><a href="export.html">export</a></li> 39 <li><a href="import.html">import</a></li> 40 <li><a href="get-property.html">get-property</a></li> 41 <li><a href="set-property.html">set-property</a></li> 42 <li><a href="remove-property.html">remove-property</a></li> 43 <li><a href="lock.html">lock</a></li> 44 <li><a href="unlock.html">unlock</a></li> 45 <li><a href="info.html">info</a></li> 46 <li><a href="date.html">date</a></li> 47 <li><a href="versioncontrol.html">versioncontrol</a></li> 48 <li><a href="list-versions.html">list-versions</a></li> 49 <li><a href="checkout.html">checkout</a></li> 50 <li><a href="checkin.html">checkin</a></li> 51 <li><a href="uncheckout.html">uncheckout</a></li> 52 <li><a href="add-repository.html">add-repository</a></li> 53 <li><a href="remove-repository.html">remove-repository</a></li> 54 <li><a href="list-repositories.html">list-repositories</a></li> 55 <li><a href="repository-url.html">repository-url</a></li> 56 <li><a href="add-user.html">add-user</a></li> 57 <li><a href="remove-user.html">remove-user</a></li> 58 <li><a href="edit-user.html">edit-user</a></li> 59 <li><a href="list-users.html">list-users</a></li> 60 <li><a href="check-config.html">check-config</a></li> 61 </ul> 62 <li><a href="configuration.html">Configuration</a></li> 63 <li><a href="encryption.html">Encryption</a></li> 64 </ul> 65 </div> 66 <div class="nav"> 67 <h3>dav-sync</h3> 68 <ul> 69 <li><a href="introduction.html">Introduction</a></li> 70 <li><a href="sync-commands.html">Commands</a></li> 71 <ul> 72 <li><a href="pull.html">pull</a></li> 73 <li><a href="push.html">push</a></li> 74 <li><a href="archive.html">archive</a></li> 75 <li><a href="restore.html">restore</a></li> 76 <li><a href="list-conflicts.html">list-conflicts</a></li> 77 <li><a href="resolve-conflicts.html">resolve-conflicts</a></li> 78 <li><a href="delete-conflicts.html">delete-conflicts</a></li> 79 <li><a href="trash-info.html">trash-info</a></li> 80 <li><a href="empty-trash.html">empty-trash</a></li> 81 <li><a href="list-versions.html">list-versions</a></li> 82 <li><a href="add-tag.html">add-tag</a></li> 83 <li><a href="remove-tag.html">remove-tag</a></li> 84 <li><a href="set-tags.html">set-tags</a></li> 85 <li><a href="list-tags.html">list-tags</a></li> 86 <li><a href="add-directory.html">add-directory</a></li> 87 <li><a href="list-directories.html">list-directories</a></li> 88 <li><a href="sync-check-config.html">check-config</a></li> 89 <li><a href="check-repositories.html">check-repositories</a></li> 90 </ul> 91 <li><a href="sync-configuration.html">Configuration</a></li> 92 </ul> 93 </div> 94 </div> 95 96  97 <div class="content"> 98 <header> 99 <h1 class="title">Getting started</h1> 100 </header> 101 <h3 id="test">Test</h3> 102 <p>After successful installation you can test dav with your WebDAV server.</p> 103 <pre><code>dav list http://example.com/webdav/</code></pre> 104 <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. Actually you can also write <code>dav ls</code> instead of <code>dav list</code> and there is also an <code>-l</code> option similarly to the unix tool <code>ls</code>.</p> 105 <h3 id="create-a-repository">Create a repository</h3> 106 <p>All dav commands are expecting an 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. Afterwards you can access a webdav server just with the repository name and an optional path.</p> 107 <p>So when you have created a repository with the name myserv and the url http://example.com/webdav/, you can just type</p> 108 <pre><code>dav list myserv</code></pre> 109 <p>You can add a path to the repository name to access an other url</p> 110 <pre><code>dav list myserv/mycollection/</code></pre> 111 <p>This lists the content of http://example.com/webdav/mycollection/</p> 112 <p>The easiest way to create a repository is with the add-repository command. This is a simple configuration assistant.</p> 113 <pre><code>$ dav add-repository 114 Each repository must have an unique name. 115 name: myserv 116 117 Specify the repository base url. 118 url: http://example.com/webdav/ 119 120 User for HTTP authentication. 121 user (optional): myuser 122 password (optional): 123 124 125 Added repository: myserv (http://example.com/webdav/)</code></pre> 126 <p>You can also configure the config.xml yourself, check out <a href="./configuration.html">the config.xml spec</a>.</p> 127 </div> 128  129 </body> 130 </html> 131

UNIXworkcode

UNIXwork`code`