Mercurial > hg > dav / file diff

--- a/docs/src/dav.1.md	Sun Jul 01 16:45:03 2018 +0200
+++ b/docs/src/dav.1.md	Sun Jul 01 17:14:17 2018 +0200
@@ -17,101 +17,155 @@
 # COMMANDS
 
 list [**-altdepcR**] [**-u** *date*] *url*
+:   Lists the files at *url*.
 
 get [**-pcRK**] [**-o** *file*] [**-u** *date*] *url*
+:   Downloads a resource from *url*.
 
 put [**-pcR**] [**-k** *key*] [**-L** *lock*] *url* *file*
+:   Uploads a resource to *url*.
 
 mkdir [**-pc**] [**-k** *key*] [**-L** *lock*] *url*
+:   Creates a new collection at *url*.
 
 remove [**-pc**] [**-L** *lock*] *url*
+:   Deletes a resource or collection at *url*
 
 copy [**-pcO**] [**-L** *lock*] *srcurl* *desturl*
+:   Copies a resource or collection from *srcurl* to *desturl*.
 
 move [**-pcO**] [**-L** *lock*] *srcurl* *desturl*
+:   Moves a resource or collection from *srcurl* to *desturl*.
 
 export [**-pc**] [**-o** *file*] [**-u** *date*] *url*
+:   Exports a resource or collection to a **tar(5)** archive. By default the
+    data is written to *stdout*, but you may specify a *file* with the **-o**
+    option.
 
 import [**-pc**] [**-k** *key*] [**-L** *lock*] *url* *file*
+:   Uploads and extracts the contents of the **tar(5)** archive *file* to *url*.
 
 get-property [**-pcx**] [**-n** *uri*] *url* *property*
+:   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 colon
+    *:* as usual.
+    
+    If the **-x** option is specified, a valid XML document containing the
+    value is printed on *stdout*.
+    
+    If the property contains XML data and the **-x** option is not specified, 
+    the value is printed on *stderr* in an XML-like format.
 
 set-property [**-pcx**] [**-L** *lock*] [**-n** *uri*] *url* *property* [*value*]
+:   Sets a resource property to the specified value. See **get-property** for
+    details. If no *value* is specified, it is read from *stdin*.
 
 remove-property [**-pc**] [**-n** *uri*] *url* *property*
+:   Removes a resource property.
 
 lock [**-pc**] [**-T** *timeout*] *url*
+:   Creates a lock on the resource at *url*. The lock is an exclusive write
+    lock with infinite depth. If the resource is sucessfully locked, a lock
+    token for this resource is printed to *stdout*. This lock token should be
+    saved to unlock the resource eventually.
 
 unlock [**-pc**] [**-L** *lock*] *url*
+:   Unlocks the resource at *url* with a lock token. If *lock* is not
+    specified, the token is read from *stdin*.
 
 info [**-pc**] *url*
+:   Prints some information and lists al properties for the resource at *url*.
 
 date [*url*]
+:   Gets the time from the server providing the resource denoted by *url*.
+    If *url* is not specified, this command prints the local time.
+    This command is useful, if the server clock and the local clock are not
+    in sync.
+
+# CONFIGURATION COMMANDS
+
+add-repository
+:   This command runs an interactive assistant that creates a repository
+    configuration.
+
+remove-repository *name*
+:   Removes the repository with the specified *name* from the configuration.
+
+list-repositories
+:   Lists all currently configured repositories.
+
+check-config
+:   Validates the **$HOME/.dav/config.xml** configuration file.
 
 # GENERAL OPTIONS
 
 The following options can be used with all commands.
 
-**-i**
+-i
 :   Disable cert verification.
 
-**-N**
+-N
 :   Disable authentication prompt.
 
-**-v**
+-v
 :   Verbose output.
 
 # COMMAND OPTIONS
 
-**-a**
+-a
 :   Show all files.
 
-**-c**
+-c
 :   Enable full encryption.
 
-**-d**
+-d
 :   Order by last modified date.
 
-**-e**
+-e
 :   Show extended flags.
 
-**-K**
+-K
 :   Keep already present files.
 
-**-k** *key*
+-k *key*
 :   Key to use for encryption.
 
-**-l**
+-l
 :   Print resources in long list format.
 
-**-L** *lock*
+-L *lock*
 :   Specificy lock token.
 
-**-n** *uri* 
-:   Specify namespace *uri*.
+-n *uri* 
+:   Specify namespace *uri*. There are two namespaces configured by default.
 
-**-o** *file*
+    1. *D* for the *DAV:* namespace
+
+    2. *idav* for the *http://davutils.org/* namespace
+
+-o *file*
 :   Write output to *file*. Use '-' for stdout.
 
-**-O**
+-O
 :   Override resources.
 
-**-p**
+-p
 :   Don't encrypt or decrypt files.
 
-**-R**
+-R
 :   Recursively do the operation for all children.
 
-**-t**
+-t
 :   Print content type.
 
-**-T** *sec*
+-T *sec*
 :   Timeout in seconds.
 
-**-u** *date*
+-u *date*
 :   Get resources which are modified since the specified *date*.
 
-**-x**
+-x
 :   XML property content.