diff -r 94c0a938b66c -r ee9e63c437c4 docs/src/getting-started.md --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/src/getting-started.md Sun Jul 09 20:15:14 2017 +0200 @@ -0,0 +1,44 @@ +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. Infact you can also write dav ls instead of dav list and there is also a -l option like ls has one. + +### Create a repository + +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. + +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 this example page and the config.xml spec. + +More informations about urls and path in dav here.