update man pages

Sun, 15 Dec 2019 16:54:05 +0100

author
Olaf Wintermann <olaf.wintermann@gmail.com>
date
Sun, 15 Dec 2019 16:54:05 +0100
changeset 703
2e3a24b9896a
parent 702
444aa8fe133f
child 704
8b88efcbf56f

update man pages

dav/main.c file | annotate | diff | comparison | revisions
docs/src/Makefile file | annotate | diff | comparison | revisions
docs/src/dav-sync.1.md file | annotate | diff | comparison | revisions
docs/src/dav.1.md file | annotate | diff | comparison | revisions
docs/src/header.html file | annotate | diff | comparison | revisions
docs/src/restore.md file | annotate | diff | comparison | revisions
--- a/dav/main.c	Sun Dec 15 16:22:08 2019 +0100
+++ b/dav/main.c	Sun Dec 15 16:54:05 2019 +0100
@@ -292,31 +292,32 @@
     }
     fprintf(stderr, "Options:\n");
     fprintf(stderr,
-            "        -k <key>   Key to use for encryption\n");
-    fprintf(stderr, "        -p         Don't encrypt or decrypt files\n");
-    fprintf(stderr, "        -c         Enable full encryption\n");
+            "        -k <key>    Key to use for encryption\n");
+    fprintf(stderr, "        -p           Don't encrypt or decrypt files\n");
+    fprintf(stderr, "        -c           Enable full encryption\n");
     fprintf(stderr,
-            "        -R         "
+            "        -R           "
             "Recursively do the operation for all children\n");
-    fprintf(stderr, "        -K         Keep already present files\n");
-    fprintf(stderr, "        -o <file>  Write output to file (use '-' for stdout)\n");
+    fprintf(stderr, "        -K           Keep already present files\n");
+    fprintf(stderr, "        -o <file>    Write output to file (use '-' for stdout)\n");
     fprintf(
             stderr,
-            "        -u <date>  "
+            "        -u <date>    "
             "Get resources which are modified since the specified date\n");
-    fprintf(stderr, "        -a         show all files\n");
-    fprintf(stderr, "        -l         print resources in long list format\n");
-    fprintf(stderr, "        -t         print content type\n");
-    fprintf(stderr, "        -d         order by last modified date\n");
-    fprintf(stderr, "        -e         show extended flags\n");
-    fprintf(stderr, "        -O         override resources\n");
-    fprintf(stderr, "        -L <lock>  specificy lock token\n");
-    fprintf(stderr, "        -T <sec>   timeout in seconds\n");
-    fprintf(stderr, "        -n <uri>   specify namespace uri\n");
-    fprintf(stderr, "        -x         xml property content\n");
-    fprintf(stderr, "        -N         disable authentication prompt (all commands)\n");
-    fprintf(stderr, "        -i         disable cert verification (all commands)\n");
-    fprintf(stderr, "        -v         verbose output (all commands)\n");
+    fprintf(stderr, "        -V <version> Download a specific version of a resource\n");
+    fprintf(stderr, "        -a           show all files\n");
+    fprintf(stderr, "        -l           print resources in long list format\n");
+    fprintf(stderr, "        -t           print content type\n");
+    fprintf(stderr, "        -d           order by last modified date\n");
+    fprintf(stderr, "        -e           show extended flags\n");
+    fprintf(stderr, "        -O           override resources\n");
+    fprintf(stderr, "        -L <lock>    specificy lock token\n");
+    fprintf(stderr, "        -T <sec>     timeout in seconds\n");
+    fprintf(stderr, "        -n <uri>     specify namespace uri\n");
+    fprintf(stderr, "        -x           xml property content\n");
+    fprintf(stderr, "        -N           disable authentication prompt (all commands)\n");
+    fprintf(stderr, "        -i           disable cert verification (all commands)\n");
+    fprintf(stderr, "        -v           verbose output (all commands)\n");
     fprintf(stderr, "\n");
     fprintf(stderr, "Advanced commands:\n");
     fprintf(stderr, "        versioncontrol list-versions checkout checkin uncheckout\n\n");
--- a/docs/src/Makefile	Sun Dec 15 16:22:08 2019 +0100
+++ b/docs/src/Makefile	Sun Dec 15 16:54:05 2019 +0100
@@ -86,6 +86,7 @@
 SRC += sync-check-config.md
 SRC += check-repositories.md
 SRC += sync-configuration.md
+SRC += sync-list-versions.md
 
 SRCMAN  = dav.1.md
 SRCMAN += dav-sync.1.md
--- a/docs/src/dav-sync.1.md	Sun Dec 15 16:22:08 2019 +0100
+++ b/docs/src/dav-sync.1.md	Sun Dec 15 16:54:05 2019 +0100
@@ -1,6 +1,6 @@
-% DAV-SYNC(1) Version 1.2 | DavUtils User Manuals
+% DAV-SYNC(1) Version 1.3 | DavUtils User Manuals
 % Olaf Wintermann
-% July 1, 2018
+% December 15, 2019
 
 # NAME
 
@@ -22,17 +22,21 @@
     locally modified and conflict detection is not disabled, the local file is
     renamed and an entry in the conflict database is added.
 
-push [**-cldr**] [**-t** *tags*] *directory*
+push [**-cldrSRM**] [**-t** *tags*] *directory*
 :   Pushes all local changes to the server. This uploads all locally modified
     files and deletes all locally deleted files on the server. If conflict
     detection is not disabled, all files that are also modified on the server
     will be skipped.
 
-archive [**-cld**] [**-t** *tags*] *directory*
+archive [**-cldSRM**] [**-t** *tags*] *directory*
 :   Uploads all new and modified files to the server. The command is similar to
     the push command (with the same conflict behavior), however it does not
     delete files on the server.
 
+restore [**-ldRM**] [**-V** *version] [**-s** *directory*] [*file...*]
+:   Restores local files by downloading them from the server. The *file* argument
+    can be a local absolute or relative file path.
+
 list-conflicts [**-v**] *directory*
 :   Lists all conflicting files. If verbose output is enabled, the output also
     shows the number of entries for the same conflicting file.
@@ -52,6 +56,9 @@
 :   Shows the trash directory path for a *directory*, the number of files
     currently in the trash and the space they consume.
 
+list-versions [**-s** *syncdir*] *file*
+:   Lists all available file versions.
+
 empty-trash *directory*
 :   Removes all files from the trash of the given *directory*.
 
--- a/docs/src/dav.1.md	Sun Dec 15 16:22:08 2019 +0100
+++ b/docs/src/dav.1.md	Sun Dec 15 16:54:05 2019 +0100
@@ -1,6 +1,6 @@
-% DAV(1) Version 1.2 | DavUtils User Manuals
+% DAV(1) Version 1.3 | DavUtils User Manuals
 % Olaf Wintermann
-% July 1, 2018
+% December 15, 2019
 
 # NAME
 
@@ -19,7 +19,7 @@
 list [**-altdepcR**] [**-u** *date*] *url*
 :   Lists the files at *url*.
 
-get [**-pcRK**] [**-o** *file*] [**-u** *date*] *url*
+get [**-pcRK**] [**-o** *file*] [**-u** *date*] [**-V** *version*] *url*
 :   Downloads a resource from *url*.
 
 put [**-pcR**] [**-k** *key*] [**-L** *lock*] *url* *file*
@@ -37,6 +37,9 @@
 move [**-pcO**] [**-L** *lock*] *srcurl* *desturl*
 :   Moves a resource or collection from *srcurl* to *desturl*.
 
+rename [**-pcO**] [**-L** *lock*] *srcurl* *name*
+:   Changes the name of a resource or collection at *srcurl* to *name*.
+
 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**
@@ -83,6 +86,26 @@
     This command is useful, if the server clock and the local clock are not
     in sync.
 
+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.
+
+list-versions [**-pc**] *url*
+:   Lists all versions of a version-controlled resource.
+
+checkout [**-pc**] *url*
+:   Changes the state of a resource to checked-out to allow modifications
+    to the content and properties.
+
+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.
+
+uncheckout [**-pc**] *url*
+:   Cancels all modification of the resource and sets the state to checked-in
+    without creating a new version.
+
 # CONFIGURATION COMMANDS
 
 add-repository
@@ -98,6 +121,21 @@
 check-config
 :   Validates the **$HOME/.dav/config.xml** configuration file.
 
+repository-url [**-p**] *repository*
+:   Prints the repository url.
+
+add-user
+:   Adds a user to the secret store.
+
+remove-user
+:   Removes a user from the secret store.
+
+edit-user
+:   Interactive command for modifying users stored in the secret store.
+
+list-users
+:   Lists all users stored in the secret store.
+
 # GENERAL OPTIONS
 
 The following options can be used with all commands.
@@ -165,6 +203,10 @@
 -u *date*
 :   Get resources which are modified since the specified *date*.
 
+-V *version*
+:   downloads a specific version of the resource. Available versions can be
+    listed with the list-versions command
+
 -x
 :   XML property content.
 
--- a/docs/src/header.html	Sun Dec 15 16:22:08 2019 +0100
+++ b/docs/src/header.html	Sun Dec 15 16:54:05 2019 +0100
@@ -59,6 +59,7 @@
 						<li><a href="delete-conflicts.html">delete-conflicts</a></li>
 						<li><a href="trash-info.html">trash-info</a></li>
 						<li><a href="empty-trash.html">empty-trash</a></li>
+						<li><a href="list-versions.html">list-versions</a></li>
 						<li><a href="add-tag.html">add-tag</a></li>
 						<li><a href="remove-tag.html">remove-tag</a></li>
 						<li><a href="set-tags.html">set-tags</a></li>
--- a/docs/src/restore.md	Sun Dec 15 16:22:08 2019 +0100
+++ b/docs/src/restore.md	Sun Dec 15 16:54:05 2019 +0100
@@ -18,6 +18,6 @@
 
 **`-V <version>`** Restore a specific file version. *version* must be the version name listed by [dav-sync list-versions][1]
 
-[1]: ./list-versions.html
+[1]: ./sync-list-versions.html
 
 

mercurial