add documentation for secret store commands

Sat, 14 Dec 2019 09:45:39 +0100

author
Olaf Wintermann <olaf.wintermann@gmail.com>
date
Sat, 14 Dec 2019 09:45:39 +0100
changeset 697
32f439d70127
parent 696
ec1509240080
child 698
c07252cc7476

add documentation for secret store commands

docs/src/add-user.md file | annotate | diff | comparison | revisions
docs/src/edit-user.md file | annotate | diff | comparison | revisions
docs/src/header.html file | annotate | diff | comparison | revisions
docs/src/list-users.md file | annotate | diff | comparison | revisions
docs/src/remove-user.md file | annotate | diff | comparison | revisions
--- a/docs/src/add-user.md	Sat Dec 14 09:31:59 2019 +0100
+++ b/docs/src/add-user.md	Sat Dec 14 09:45:39 2019 +0100
@@ -0,0 +1,10 @@
+---
+title: 'dav add-user'
+---
+
+This command runs an interactive assistant that adds a user to the secret store. The secret store is an encrypted file, that stores user credentials.
+
+The assistant firstly asks for the secret store master password. After that, you must specify a unique credentials identifier, the user name and password. Optionally it is possible to specify one or more locations (URLs), where these credentials should be used.
+
+
+
--- a/docs/src/edit-user.md	Sat Dec 14 09:31:59 2019 +0100
+++ b/docs/src/edit-user.md	Sat Dec 14 09:45:39 2019 +0100
@@ -0,0 +1,6 @@
+---
+title: 'dav edit-user'
+---
+
+Interactive command for editing secret store credentials.
+
--- a/docs/src/header.html	Sat Dec 14 09:31:59 2019 +0100
+++ b/docs/src/header.html	Sat Dec 14 09:45:39 2019 +0100
@@ -37,7 +37,7 @@
 						<li><a href="add-user.html">add-user</a></li>
 						<li><a href="remove-user.html">remove-user</a></li>
 						<li><a href="edit-user.html">edit-user</a></li>
-						<li><a href="list-useres.html">list-users</a></li>
+						<li><a href="list-users.html">list-users</a></li>
 						<li><a href="check-config.html">check-config</a></li>
 					</ul>
 				<li><a href="configuration.html">Configuration</a></li>
--- a/docs/src/list-users.md	Sat Dec 14 09:31:59 2019 +0100
+++ b/docs/src/list-users.md	Sat Dec 14 09:45:39 2019 +0100
@@ -0,0 +1,5 @@
+---
+title: 'dav list-users'
+---
+
+The command lists all credentials that are saved in the secret store.
--- a/docs/src/remove-user.md	Sat Dec 14 09:31:59 2019 +0100
+++ b/docs/src/remove-user.md	Sat Dec 14 09:45:39 2019 +0100
@@ -0,0 +1,5 @@
+---
+title: 'dav remove-user'
+---
+
+Interactive command for removing secret store credentials.

mercurial