docs/src/getting-started.md

Sat, 05 Aug 2017 10:19:53 +0200

author
Mike Becker <universe@uap-core.de>
date
Sat, 05 Aug 2017 10:19:53 +0200
changeset 278
c9096eb3554c
parent 273
c743721d566f
child 282
3070d72f54af
permissions
-rw-r--r--

refines commands.md

265
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
1 Getting started
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
2 ===============
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
3
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
4 ### Test
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
5
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
6 After successful installation you can test dav with your WebDAV server.
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
7
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
8 dav list http://example.com/webdav/
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
9
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
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.
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
11
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
12 ### Create a repository
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
13
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
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.
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
15
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
16 So when you have created a repository with the name myserv and the url http://example.com/webdav/, you can just type
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
17
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
18 dav list myserv
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
19
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
20 You can add a path to the repository name to access an other url
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
21
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
22 dav list myserv/mycollection/
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
23
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
24 This lists the content of http://example.com/webdav/mycollection/
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
25
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
26 The easiest way to create a repository is with the add-repository command. This is a simple configuration assistant.
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
27
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
28 $ dav add-repository
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
29 Each repository must have an unique name.
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
30 name: myserv
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
31
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
32 Specify the repository base url.
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
33 url: http://example.com/webdav/
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
34
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
35 User for HTTP authentication.
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
36 user (optional): myuser
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
37 password (optional):
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
38
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
39
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
40 Added repository: myserv (http://example.com/webdav/)
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
41
273
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 265
diff changeset
42 You can also configure the config.xml yourself, check out [the config.xml spec][1].
265
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
43
273
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 265
diff changeset
44 [1]: ./configuration.html
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 265
diff changeset
45

mercurial