add documentation for dav versioning commands

Sun, 15 Dec 2019 13:48:31 +0100

author
Olaf Wintermann <olaf.wintermann@gmail.com>
date
Sun, 15 Dec 2019 13:48:31 +0100
changeset 701
0a48f17c729d
parent 700
165811ea12ab
child 702
444aa8fe133f

add documentation for dav versioning commands

docs/src/checkin.md file | annotate | diff | comparison | revisions
docs/src/checkout.md file | annotate | diff | comparison | revisions
docs/src/get.md file | annotate | diff | comparison | revisions
docs/src/list-versions.md file | annotate | diff | comparison | revisions
docs/src/uncheckout.md file | annotate | diff | comparison | revisions
docs/src/versioncontrol.md file | annotate | diff | comparison | revisions
--- a/docs/src/checkin.md	Sun Dec 15 12:11:16 2019 +0100
+++ b/docs/src/checkin.md	Sun Dec 15 13:48:31 2019 +0100
@@ -0,0 +1,11 @@
+---
+title: 'dav checkin'
+---
+
+**`dav checkin [-pc] <url>`**
+
+Changes the state of a resource to *checked-in*. This will create a new version of the resource. In the *checked-in* state the resource cannot be modified.
+
+**`-p`** disable file name and path decryption if enabled
+
+**`-c`** enable file name and path decryption
--- a/docs/src/checkout.md	Sun Dec 15 12:11:16 2019 +0100
+++ b/docs/src/checkout.md	Sun Dec 15 13:48:31 2019 +0100
@@ -0,0 +1,11 @@
+---
+title: 'dav checkout'
+---
+
+**`dav checkout [-pc] <url>`**
+
+Changes the state of a resource to *checked-out* to allow modifications to the content and properties.
+
+**`-p`** disable file name and path decryption if enabled
+
+**`-c`** enable file name and path decryption
--- a/docs/src/get.md	Sun Dec 15 12:11:16 2019 +0100
+++ b/docs/src/get.md	Sun Dec 15 13:48:31 2019 +0100
@@ -2,7 +2,7 @@
 title: 'dav get'
 ---
 
-**`dav get [-pcRK] [-o <file>] [-u <date>] <url>`**
+**`dav get [-pcRK] [-o <file>] [-u <date>] [-V <version>] <url>`**
 
 Downloads a resource. This command also downloads collections and its child resources when the **`-R`** option is used.
 When downloading a single resource, the default local file name is the resource
@@ -23,4 +23,6 @@
 
 **`-u <date>`** download only files which are modified since the specified date. Uses the HTTP date format
 
+**`-V <version>`** downloads a specific version of the resource. Available versions can be listed with the *list-versions* command
 
+
--- a/docs/src/list-versions.md	Sun Dec 15 12:11:16 2019 +0100
+++ b/docs/src/list-versions.md	Sun Dec 15 13:48:31 2019 +0100
@@ -0,0 +1,11 @@
+---
+title: 'dav list-versions'
+---
+
+**`dav list-versions [-pc] <url>`**
+
+Lists all versions of a version-controlled resource.
+
+**`-p`** disable file name and path decryption if enabled
+
+**`-c`** enable file name and path decryption
--- a/docs/src/uncheckout.md	Sun Dec 15 12:11:16 2019 +0100
+++ b/docs/src/uncheckout.md	Sun Dec 15 13:48:31 2019 +0100
@@ -0,0 +1,11 @@
+---
+title: 'dav uncheckout'
+---
+
+**`dav uncheckout [-pc] <url>`**
+
+Cancels all modification of the resource and sets the state to *checked-in* without creating a new version.
+
+**`-p`** disable file name and path decryption if enabled
+
+**`-c`** enable file name and path decryption
--- a/docs/src/versioncontrol.md	Sun Dec 15 12:11:16 2019 +0100
+++ b/docs/src/versioncontrol.md	Sun Dec 15 13:48:31 2019 +0100
@@ -0,0 +1,13 @@
+---
+title: 'dav versioncontrol'
+---
+
+**`dav versioncontrol [-pc] <url>`**
+
+Puts the resource, specified by *url*, under version control. This is required in order to use other versioning commands with this resource.
+
+To use this command, the server must support *DeltaV*.
+
+**`-p`** disable file name and path decryption if enabled
+
+**`-c`** enable file name and path decryption

mercurial