docs/src/commands.md

Sun, 17 Dec 2023 14:25:34 +0100

author
Mike Becker <universe@uap-core.de>
date
Sun, 17 Dec 2023 14:25:34 +0100
changeset 797
edbb20b1438d
parent 283
0e36bb75a732
permissions
-rw-r--r--

[Makefile] fix missing rules preventing dry-runs

We have to support dry-runs, because many IDEs are using
dry-runs to collect build information.

Some rules have dependencies that expect certain files or
directories to be just present. We added respective build
rules which invoke the test program. This way, the behavior
when running make normally is exactly the same, but dry-runs
are also not failing now.

283
0e36bb75a732 adds dav-sync introduction and sync.xml documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 279
diff changeset
1 ---
0e36bb75a732 adds dav-sync introduction and sync.xml documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 279
diff changeset
2 title: 'Commands'
0e36bb75a732 adds dav-sync introduction and sync.xml documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 279
diff changeset
3 ---
265
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
4
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
5 Overview
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
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
8 List resources:
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 dav list <url>
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 Download resource:
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 dav get <url>
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 Download all resources from a collection:
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 get -R <url>
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 Upload a file:
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 put <url> <file>
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 Upload all files from a directory:
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 dav put -R <url> <dir>
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 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
29
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
30 dav copy <src-url> <dst-url>
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 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
33
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
34 dav move <src-url> <dst-url>
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
35
278
c9096eb3554c refines commands.md
Mike Becker <universe@uap-core.de>
parents: 266
diff changeset
36 These are the most common commands.
c9096eb3554c refines commands.md
Mike Becker <universe@uap-core.de>
parents: 266
diff changeset
37 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
38 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
39
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
40 Common options
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
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
43 **`-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
44
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
45 **`-i`** disable TLS certificate verification
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
46
278
c9096eb3554c refines commands.md
Mike Becker <universe@uap-core.de>
parents: 266
diff changeset
47 **`-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
48
278
c9096eb3554c refines commands.md
Mike Becker <universe@uap-core.de>
parents: 266
diff changeset
49 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
50
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 265
diff changeset
51 [1]: ./encryption.html
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 265
diff changeset
52
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 265
diff changeset
53 Aliases
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 265
diff changeset
54 -------
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 265
diff changeset
55
279
f0f24da5f920 refines copy.md
Mike Becker <universe@uap-core.de>
parents: 278
diff changeset
56 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
57 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
58

mercurial