docs/src/getting-started.md

changeset 265
ee9e63c437c4
child 273
c743721d566f
equal deleted inserted replaced
264:94c0a938b66c 265:ee9e63c437c4
1 Getting started
2 ===============
3
4 ### Test
5
6 After successful installation you can test dav with your WebDAV server.
7
8 dav list http://example.com/webdav/
9
10 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.
11
12 ### Create a repository
13
14 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.
15
16 So when you have created a repository with the name myserv and the url http://example.com/webdav/, you can just type
17
18 dav list myserv
19
20 You can add a path to the repository name to access an other url
21
22 dav list myserv/mycollection/
23
24 This lists the content of http://example.com/webdav/mycollection/
25
26 The easiest way to create a repository is with the add-repository command. This is a simple configuration assistant.
27
28 $ dav add-repository
29 Each repository must have an unique name.
30 name: myserv
31
32 Specify the repository base url.
33 url: http://example.com/webdav/
34
35 User for HTTP authentication.
36 user (optional): myuser
37 password (optional):
38
39
40 Added repository: myserv (http://example.com/webdav/)
41
42 You can also configure the config.xml yourself, check out this example page and the config.xml spec.
43
44 More informations about urls and path in dav here.

mercurial