docs/src/list.md

Sat, 05 Aug 2017 13:35:27 +0200

author
Mike Becker <universe@uap-core.de>
date
Sat, 05 Aug 2017 13:35:27 +0200
changeset 282
3070d72f54af
parent 266
8c44c5919691
child 283
0e36bb75a732
permissions
-rw-r--r--

more minor improvements to the documentation

265
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
1 dav list
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 **`dav list [-altepcR] [-u <date>] <url>`**
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
5
282
3070d72f54af more minor improvements to the documentation
Mike Becker <universe@uap-core.de>
parents: 266
diff changeset
6 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
7 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
8 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
9
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
10 Options
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
282
3070d72f54af more minor improvements to the documentation
Mike Becker <universe@uap-core.de>
parents: 266
diff changeset
13 **`-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
14
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 265
diff changeset
15 **`-l`** show additional information for resources
265
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 Example:
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 -- 4.2 KiB Oct 11 2015 somefile
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 The first column contains to fields for flags.
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 1. Field: `d-` indicates a collection
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
24 2. Field: `-c` indicates an encrypted resource
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
25
282
3070d72f54af more minor improvements to the documentation
Mike Becker <universe@uap-core.de>
parents: 266
diff changeset
26 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
27
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
28 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
29
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
30 [1]: ./info.html
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
31
282
3070d72f54af more minor improvements to the documentation
Mike Becker <universe@uap-core.de>
parents: 266
diff changeset
32 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
33
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
34 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
35
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 265
diff changeset
36 **`-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
37
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
38 **`-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
39
282
3070d72f54af more minor improvements to the documentation
Mike Becker <universe@uap-core.de>
parents: 266
diff changeset
40 1. Field: `d---` indicates a collection
3070d72f54af more minor improvements to the documentation
Mike Becker <universe@uap-core.de>
parents: 266
diff changeset
41 2. Field: `-c--` indicates an encrypted resource
3070d72f54af more minor improvements to the documentation
Mike Becker <universe@uap-core.de>
parents: 266
diff changeset
42 3. Field: `--l-` indicates a locked resource
3070d72f54af more minor improvements to the documentation
Mike Becker <universe@uap-core.de>
parents: 266
diff changeset
43 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
44
3070d72f54af more minor improvements to the documentation
Mike Becker <universe@uap-core.de>
parents: 266
diff changeset
45 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
46
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 265
diff changeset
47 **`-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
48
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 265
diff changeset
49 **`-c`** enable file name and path decryption
265
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
50
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 265
diff changeset
51 **`-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
52
282
3070d72f54af more minor improvements to the documentation
Mike Becker <universe@uap-core.de>
parents: 266
diff changeset
53 **`-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
54 date. Uses the HTTP date format.
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 265
diff changeset
55
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 265
diff changeset
56 **Command alias:** ls

mercurial