# HG changeset patch
# User Mike Becker <universe@uap-core.de>
# Date 1585411630 -3600
# Node ID 10a5d6ce0906fe5a7e9b0063eff74b288ffd3297
# Parent  a1c36a6410f60bea891300b0ef27607f9b3bd1d5
adds documentation for the edit command

diff -r a1c36a6410f6 -r 10a5d6ce0906 docs/src/Makefile
--- a/docs/src/Makefile	Sat Mar 28 16:37:40 2020 +0100
+++ b/docs/src/Makefile	Sat Mar 28 17:07:10 2020 +0100
@@ -36,6 +36,7 @@
 SRC += list.md
 SRC += get.md
 SRC += put.md
+SRC += edit.md
 SRC += mkdir.md
 SRC += remove.md
 SRC += copy.md
diff -r a1c36a6410f6 -r 10a5d6ce0906 docs/src/dav.1.md
--- a/docs/src/dav.1.md	Sat Mar 28 16:37:40 2020 +0100
+++ b/docs/src/dav.1.md	Sat Mar 28 17:07:10 2020 +0100
@@ -25,6 +25,12 @@
 put [**-pcR**] [**-k** *key*] [**-L** *lock*] *url* *file*
 :   Uploads a resource to *url*.
 
+edit [**-pc**] [**-k** *key*] [**-V** *version*] *url*
+:   Downloads or creates a resource and opens the editor.
+
+    The editor can be specified via the EDITOR environment variable.
+    Default editor is vi.
+
 mkdir [**-pc**] [**-k** *key*] [**-L** *lock*] *url*
 :   Creates a new collection at *url*.
 
diff -r a1c36a6410f6 -r 10a5d6ce0906 docs/src/edit.md
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/src/edit.md	Sat Mar 28 17:07:10 2020 +0100
@@ -0,0 +1,28 @@
+---
+title: 'dav edit'
+---
+
+**`dav edit [-pc] [-k <key>] [-V <version>] <url>`**
+
+Downloads a resources and opens an editor. If there is no resource at the
+specified location, it is attempted to create a fresh resource.
+The resource is downloaded to a temporary file and re-uploaded only if you save
+any changes to that file.
+
+The default editor `vi` can be changed with the `EDITOR` environment variable.
+
+This command transparently handles decryption and encryption. If you download
+and open a plain text file and request content encryption (either by config or
+by command line option) the file will be re-uploaded with content encryption.
+However, a present file will keep its (plain text) file name in any case.
+
+**`-p`** disable file name encryption and decryption
+
+**`-c`** enable file name and content encryption
+
+**`-k <key>`** use the specified key for encryption. The key must be configured in
+  the config.xml file
+
+**`-V <version>`** downloads a specific version of the resource. Available versions can be listed with the *list-versions* command
+
+
diff -r a1c36a6410f6 -r 10a5d6ce0906 docs/src/header.html
--- a/docs/src/header.html	Sat Mar 28 16:37:40 2020 +0100
+++ b/docs/src/header.html	Sat Mar 28 17:07:10 2020 +0100
@@ -11,6 +11,7 @@
 						<li><a href="list.html">list</a></li>
 						<li><a href="get.html">get</a></li>
 						<li><a href="put.html">put</a></li>
+						<li><a href="edit.html">edit</a></li>
 						<li><a href="mkdir.html">mkdir</a></li>
 						<li><a href="remove.html">remove</a></li>
 						<li><a href="copy.html">copy</a></li>
diff -r a1c36a6410f6 -r 10a5d6ce0906 docs/src/index.html
--- a/docs/src/index.html	Sat Mar 28 16:37:40 2020 +0100
+++ b/docs/src/index.html	Sat Mar 28 17:07:10 2020 +0100
@@ -22,6 +22,7 @@
 						<li><a href="list.html">list</a></li>
 						<li><a href="get.html">get</a></li>
 						<li><a href="put.html">put</a></li>
+						<li><a href="edit.html">edit</a></li>
 						<li><a href="mkdir.html">mkdir</a></li>
 						<li><a href="remove.html">remove</a></li>
 						<li><a href="copy.html">copy</a></li>