docs/src/commands.md

Sat, 05 Aug 2017 11:33:17 +0200

author
Mike Becker <universe@uap-core.de>
date
Sat, 05 Aug 2017 11:33:17 +0200
changeset 281
ddb5e8f2a43d
parent 279
f0f24da5f920
child 283
0e36bb75a732
permissions
-rw-r--r--

some more minor doc improvements

265
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
1 Commands
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 Overview
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
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
7 List resources:
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
8
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
9 dav list <url>
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
10
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
11 Download resource:
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
12
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
13 dav get <url>
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
14
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
15 Download all resources from a collection:
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
16
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
17 dav get -R <url>
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
18
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
19 Upload a file:
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
20
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
21 dav put <url> <file>
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
22
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
23 Upload all files from a directory:
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
24
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
25 dav put -R <url> <dir>
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
26
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
27 Duplicate a resource or a collection on a server:
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
28
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
29 dav copy <src-url> <dst-url>
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
30
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
31 There is also a move operation similar to copy:
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
32
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
33 dav move <src-url> <dst-url>
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
34
278
c9096eb3554c refines commands.md
Mike Becker <universe@uap-core.de>
parents: 266
diff changeset
35 These are the most common commands.
c9096eb3554c refines commands.md
Mike Becker <universe@uap-core.de>
parents: 266
diff changeset
36 There are also more commands, e.g. for webdav locking or manipulating webdav properties.
c9096eb3554c refines commands.md
Mike Becker <universe@uap-core.de>
parents: 266
diff changeset
37 See the left menu for a complete list.
265
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 Common options
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
40 --------------
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
41
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
42 **`-N`** disable any authentication prompt. If authentication is required, dav will abort.
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
43
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
44 **`-i`** disable TLS certificate verification
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
45
278
c9096eb3554c refines commands.md
Mike Becker <universe@uap-core.de>
parents: 266
diff changeset
46 **`-v`** enable verbose output. Internally `CURLOPT_VERBOSE` is set to 1 and verbose output is printed to stderr.
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 265
diff changeset
47
278
c9096eb3554c refines commands.md
Mike Becker <universe@uap-core.de>
parents: 266
diff changeset
48 Most commands have the **`-c`** and **`-p`** options for enabling or disabling encryption. If encryption is not configured for a repository, but the **`-c`** option is specified, encryption/decryption is enabled. When enabled, all commands handle encrypted resource names. The **`-p`** options disables any encryption/decryption. See [encryption][1] for details.
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 265
diff changeset
49
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 265
diff changeset
50 [1]: ./encryption.html
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 265
diff changeset
51
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 265
diff changeset
52 Aliases
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 265
diff changeset
53 -------
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 265
diff changeset
54
279
f0f24da5f920 refines copy.md
Mike Becker <universe@uap-core.de>
parents: 278
diff changeset
55 Some commands have alternate names. For example `dav ls` is an alias for `dav list`.
278
c9096eb3554c refines commands.md
Mike Becker <universe@uap-core.de>
parents: 266
diff changeset
56 The available aliases can be found in the documentation for the respective commands.
c9096eb3554c refines commands.md
Mike Becker <universe@uap-core.de>
parents: 266
diff changeset
57

mercurial