docs/html/getting-started.html

changeset 266
8c44c5919691
child 273
c743721d566f
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/html/getting-started.html	Tue Jul 11 20:45:32 2017 +0200
@@ -0,0 +1,84 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <meta http-equiv="Content-Style-Type" content="text/css" />
+  <meta name="generator" content="pandoc" />
+  <title></title>
+  <style type="text/css">code{white-space: pre;}</style>
+  <link rel="stylesheet" href="davdoc.css" type="text/css" />
+</head>
+<body>
+<div class="header">
+	<span>davutils documentation</span>
+</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="get-property.html">get-property</a></li>
+						<li><a href="set-property.html">set-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="add-repository.html">add-repository</a></li>
+						<li><a href="list-repositories.html">list-repositories</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=".">.</a></li>
+			</ul>
+	</div>
+</div>
+
+<!-- begin content -->
+<div class="content">
+<h1 id="getting-started">Getting started</h1>
+<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. Infact you can also write dav ls instead of dav list and there is also a -l option like ls has one.</p>
+<h3 id="create-a-repository">Create a repository</h3>
+<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>
+<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 this example page and the config.xml spec.</p>
+<p>More informations about urls and path in dav here.</p>
+</div>
+<!-- end content -->
+</body>
+</html>

mercurial