docs/src/list.md

Sun, 01 Jul 2018 16:45:03 +0200

author
Mike Becker <universe@uap-core.de>
date
Sun, 01 Jul 2018 16:45:03 +0200
changeset 439
e85c93b59d1c
parent 320
12ed560c926c
permissions
-rw-r--r--

command documentation for dav-sync man page

283
0e36bb75a732 adds dav-sync introduction and sync.xml documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 282
diff changeset
1 ---
0e36bb75a732 adds dav-sync introduction and sync.xml documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 282
diff changeset
2 title: 'dav list'
0e36bb75a732 adds dav-sync introduction and sync.xml documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 282
diff changeset
3 ---
265
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
4
320
12ed560c926c adds documentation for new features
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 283
diff changeset
5 **`dav list [-altdepcR] [-u <date>] <url>`**
265
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
6
282
3070d72f54af more minor improvements to the documentation
Mike Becker <universe@uap-core.de>
parents: 266
diff changeset
7 Lists child resources of the specified collection. Without any option it
265
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
8 shows only the direct children and hides files beginning with a dot.
282
3070d72f54af more minor improvements to the documentation
Mike Becker <universe@uap-core.de>
parents: 266
diff changeset
9 The behavior is quite similar to that of the unix tool `ls`.
265
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 Options
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
282
3070d72f54af more minor improvements to the documentation
Mike Becker <universe@uap-core.de>
parents: 266
diff changeset
14 **`-a`** don't hide files whose names begin with a dot `.`
265
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
15
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 265
diff changeset
16 **`-l`** show additional information for resources
265
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 Example:
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 -- 4.2 KiB Oct 11 2015 somefile
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 The first column contains to fields for flags.
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 1. Field: `d-` indicates a collection
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
25 2. Field: `-c` indicates an encrypted resource
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
26
282
3070d72f54af more minor improvements to the documentation
Mike Becker <universe@uap-core.de>
parents: 266
diff changeset
27 Encrypted collections are also possible, but only the collection name is encrypted, the content may be unencrypted.
265
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 The second column in the `list -l` output is the resource size. The number has always a suffix (bytes, KiB, MiB, GiB, TiB). To get the exact content-length in bytes you can use the [dav info][1] command.
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 [1]: ./info.html
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
32
282
3070d72f54af more minor improvements to the documentation
Mike Becker <universe@uap-core.de>
parents: 266
diff changeset
33 The third column is the date of the last modification. The `strftime` format is `%b %d %H:%M` if the year is the current year. Otherwise the format is `%b %d %Y`.
265
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 The last column is the resource name. If the `-R` option is specified, the resource path is shown.
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
36
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 265
diff changeset
37 **`-t`** this options only works in combination with `-l` and it adds the resource content type to the output (after the flags)
265
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
38
320
12ed560c926c adds documentation for new features
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 283
diff changeset
39 **`-d`** order resources by their lastmodified date
12ed560c926c adds documentation for new features
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 283
diff changeset
40
265
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
41 **`-e`** similar to `-l`, but with 6 flag fields. Currently only the first 4 fields are used. The last two are reserved for future use.
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
42
282
3070d72f54af more minor improvements to the documentation
Mike Becker <universe@uap-core.de>
parents: 266
diff changeset
43 1. Field: `d---` indicates a collection
3070d72f54af more minor improvements to the documentation
Mike Becker <universe@uap-core.de>
parents: 266
diff changeset
44 2. Field: `-c--` indicates an encrypted resource
3070d72f54af more minor improvements to the documentation
Mike Becker <universe@uap-core.de>
parents: 266
diff changeset
45 3. Field: `--l-` indicates a locked resource
3070d72f54af more minor improvements to the documentation
Mike Becker <universe@uap-core.de>
parents: 266
diff changeset
46 4. Field: `---x` indicates an executable resource (executable property with http://apache.org/dav/props/ namespace)
3070d72f54af more minor improvements to the documentation
Mike Becker <universe@uap-core.de>
parents: 266
diff changeset
47
3070d72f54af more minor improvements to the documentation
Mike Becker <universe@uap-core.de>
parents: 266
diff changeset
48 All combinations of these four flags are possible.
265
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
49
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 265
diff changeset
50 **`-p`** disable file name and path decryption if enabled
265
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
51
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 265
diff changeset
52 **`-c`** enable file name and path decryption
265
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
53
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 265
diff changeset
54 **`-R`** recursively show all resources in the collection and all child collections
265
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
55
282
3070d72f54af more minor improvements to the documentation
Mike Becker <universe@uap-core.de>
parents: 266
diff changeset
56 **`-u <date>`** show only resources with a `lastmodified` date after the specified
3070d72f54af more minor improvements to the documentation
Mike Becker <universe@uap-core.de>
parents: 266
diff changeset
57 date. Uses the HTTP date format.
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 265
diff changeset
58
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 265
diff changeset
59 **Command alias:** ls

mercurial