docs/html/getting-started.html

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
<head>
  <meta charset="utf-8" />
  <meta name="generator" content="pandoc" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
  <title>Getting started</title>
  <style type="text/css">
      code{white-space: pre-wrap;}
      span.smallcaps{font-variant: small-caps;}
      span.underline{text-decoration: underline;}
      div.column{display: inline-block; vertical-align: top; width: 50%;}
  </style>
  <link rel="stylesheet" href="davdoc.css" />
  <!--[if lt IE 9]>
    <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
  <![endif]-->
</head>
<body>
<div class="header">
	<a href="./index.html"><span>DavUtils documentation</span></a>
</div>
<div class="sidebar">
	<div class="nav">
		<h3>dav</h3>
			<ul>
				<li><a href="getting-started.html">Getting started</a></li>
				<li><a href="commands.html">Commands</a></li>
					<ul>
						<li><a href="list.html">list</a></li>
						<li><a href="get.html">get</a></li>
						<li><a href="put.html">put</a></li>
						<li><a href="mkdir.html">mkdir</a></li>
						<li><a href="remove.html">remove</a></li>
						<li><a href="copy.html">copy</a></li>
						<li><a href="move.html">move</a></li>
						<li><a href="rename.html">rename</a></li>
						<li><a href="export.html">export</a></li>
						<li><a href="import.html">import</a></li>
						<li><a href="get-property.html">get-property</a></li>
						<li><a href="set-property.html">set-property</a></li>
						<li><a href="remove-property.html">remove-property</a></li>
						<li><a href="lock.html">lock</a></li>
						<li><a href="unlock.html">unlock</a></li>
						<li><a href="info.html">info</a></li>
						<li><a href="date.html">date</a></li>
						<li><a href="versioncontrol.html">versioncontrol</a></li>
						<li><a href="list-versions.html">list-versions</a></li>
						<li><a href="checkout.html">checkout</a></li>
						<li><a href="checkin.html">checkin</a></li>
						<li><a href="uncheckout.html">uncheckout</a></li>
						<li><a href="add-repository.html">add-repository</a></li>
						<li><a href="remove-repository.html">remove-repository</a></li>
						<li><a href="list-repositories.html">list-repositories</a></li>
						<li><a href="repository-url.html">repository-url</a></li>
						<li><a href="add-user.html">add-user</a></li>
						<li><a href="remove-user.html">remove-user</a></li>
						<li><a href="edit-user.html">edit-user</a></li>
						<li><a href="list-users.html">list-users</a></li>
						<li><a href="check-config.html">check-config</a></li>
					</ul>
				<li><a href="configuration.html">Configuration</a></li>
				<li><a href="encryption.html">Encryption</a></li>
			</ul>
	</div>
	<div class="nav">
		<h3>dav-sync</h3>
			<ul>
				<li><a href="introduction.html">Introduction</a></li>
				<li><a href="sync-commands.html">Commands</a></li>
					<ul>
						<li><a href="pull.html">pull</a></li>
						<li><a href="push.html">push</a></li>
						<li><a href="archive.html">archive</a></li>
						<li><a href="restore.html">restore</a></li>
						<li><a href="list-conflicts.html">list-conflicts</a></li>
						<li><a href="resolve-conflicts.html">resolve-conflicts</a></li>
						<li><a href="delete-conflicts.html">delete-conflicts</a></li>
						<li><a href="trash-info.html">trash-info</a></li>
						<li><a href="empty-trash.html">empty-trash</a></li>
						<li><a href="list-versions.html">list-versions</a></li>
						<li><a href="add-tag.html">add-tag</a></li>
						<li><a href="remove-tag.html">remove-tag</a></li>
						<li><a href="set-tags.html">set-tags</a></li>
						<li><a href="list-tags.html">list-tags</a></li>
						<li><a href="add-directory.html">add-directory</a></li>
						<li><a href="list-directories.html">list-directories</a></li>
						<li><a href="sync-check-config.html">check-config</a></li>
						<li><a href="check-repositories.html">check-repositories</a></li>
					</ul>
				<li><a href="sync-configuration.html">Configuration</a></li>
			</ul>
	</div>
</div>

<!-- begin content -->
<div class="content">
<header>
<h1 class="title">Getting started</h1>
</header>
<h3 id="test">Test</h3>
<p>After successful installation you can test dav with your WebDAV server.</p>
<pre><code>dav list http://example.com/webdav/</code></pre>
<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>
<h3 id="create-a-repository">Create a repository</h3>
<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>
<p>So when you have created a repository with the name myserv and the url http://example.com/webdav/, you can just type</p>
<pre><code>dav list myserv</code></pre>
<p>You can add a path to the repository name to access an other url</p>
<pre><code>dav list myserv/mycollection/</code></pre>
<p>This lists the content of http://example.com/webdav/mycollection/</p>
<p>The easiest way to create a repository is with the add-repository command. This is a simple configuration assistant.</p>
<pre><code>$ dav add-repository
Each repository must have an unique name.
name: myserv

Specify the repository base url.
url: http://example.com/webdav/

User for HTTP authentication.
user (optional): myuser
password (optional): 


Added repository: myserv (http://example.com/webdav/)</code></pre>
<p>You can also configure the config.xml yourself, check out <a href="./configuration.html">the config.xml spec</a>.</p>
</div>
<!-- end content -->
</body>
</html>