docs/src/getting-started.md

Thu, 21 Dec 2017 19:48:27 +0100

author
Mike Becker <universe@uap-core.de>
date
Thu, 21 Dec 2017 19:48:27 +0100
changeset 359
bacb54502b24
parent 283
0e36bb75a732
permissions
-rw-r--r--

davql: allow ANYWHERE keyword in SELECT statements

This may seem pointless, but users might want to be explicit about this and the grammar is more consistent.

This commit also adds some no-ops to the functions body of the SET parser, because some day the grammar might allow more clauses after the WHERE clause.

---
title: 'Getting started'
---

### Test

After successful installation you can test dav with your WebDAV server.

	dav list http://example.com/webdav/

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 `dav ls` instead of `dav list` and there is also an `-l` option similarly to the unix tool `ls`.

### Create a repository

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.

So when you have created a repository with the name myserv and the url http://example.com/webdav/, you can just type

	dav list myserv

You can add a path to the repository name to access an other url

	dav list myserv/mycollection/

This lists the content of http://example.com/webdav/mycollection/

The easiest way to create a repository is with the add-repository command. This is a simple configuration assistant.

	$ 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/)

You can also configure the config.xml yourself, check out [the config.xml spec][1].

[1]: ./configuration.html

mercurial