docs/src/get-property.md

Sat, 15 Jun 2019 11:01:37 +0200

author
Olaf Wintermann <olaf.wintermann@gmail.com>
date
Sat, 15 Jun 2019 11:01:37 +0200
changeset 605
bbc66c72661a
parent 408
f71eab18ed38
permissions
-rw-r--r--

add new api for encrypted properties

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 get-property'
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
408
f71eab18ed38 more dav documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 320
diff changeset
5 **`dav get-property [-pcx] [-n <uri>] <url> <property>`**
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: 265
diff changeset
7 Gets a specific resource property. Every WebDAV property has a name and an XML namespace. A namespace can be specified with the `-n` option or with a prefixed name. The prefix and property name are separated by a **:** as usual.
265
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
8
408
f71eab18ed38 more dav documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 320
diff changeset
9 If the **`-x`** option is specified, a valid xml document containing the value is printed on stdout.
f71eab18ed38 more dav documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 320
diff changeset
10
f71eab18ed38 more dav documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 320
diff changeset
11 If the property contains xml data and the **`-x`** option is not specified, the value is printed on stderr in an xml-like format.
f71eab18ed38 more dav documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 320
diff changeset
12
265
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
13 Example: `D:creationdate`
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 `D` is the prefix, `creationdate` is the name.
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
16
282
3070d72f54af more minor improvements to the documentation
Mike Becker <universe@uap-core.de>
parents: 265
diff changeset
17 There are only two available prefixes by default:
265
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 1. `D` for the `DAV:` namespace
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
20 2. `idav` for `http://davutils.org/`
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
21
320
12ed560c926c adds documentation for new features
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
22 To use another namespace, use the `-n` option or configure a namespace in the [config.xml][1] file.
265
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 If the property name has no prefix, and no namespace is specified, the default namespace `DAV:` is used.
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 **`-p`** disable file name and path decryption if enabled
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 **`-c`** enable file name and path decryption
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
29
408
f71eab18ed38 more dav documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 320
diff changeset
30 **`-x`** prints property as xml
f71eab18ed38 more dav documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 320
diff changeset
31
265
ee9e63c437c4 adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
32 **`-n <uri>`** specify property namespace
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 **Note:** Properties are never encrypted.
320
12ed560c926c adds documentation for new features
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
35
408
f71eab18ed38 more dav documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 320
diff changeset
36 ### Example: xml property
f71eab18ed38 more dav documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 320
diff changeset
37
f71eab18ed38 more dav documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 320
diff changeset
38 $ dav get-property -x myserv/collection/ resourcetype
f71eab18ed38 more dav documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 320
diff changeset
39 <?xml version="1.0"?>
f71eab18ed38 more dav documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 320
diff changeset
40 <x0:resourcetype xmlns:x0="DAV:"><x0:collection /></x0:resourcetype>
f71eab18ed38 more dav documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 320
diff changeset
41
320
12ed560c926c adds documentation for new features
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
42 [1]: ./configuration.html

mercurial