improve documentation

1 files changed, 51 insertions, 34 deletions

diff --git a/commands.txt b/commands.txt
index 731f5f6..0e543a3 100644
--- a/commands.txt
+++ b/commands.txt
@@ -1,44 +1,71 @@
-commands:
+Commands (via command-line):
 
   run-quasselcore
     runs quasselcore via sudo
 
-  create-quasselcore-user <username> [<<< <password>]
-    creates the user in the quasselcore database
-    reads optional initial password
-    if no password read then generate random password
+  quasselcore-sqlite
+    run sqlite3 on the quasselcore database
 
-  reset-quasselcore-user-password <username> <password>
-    sets the quasselcore user password
+  quassluser database table interface is provided by eight functions:
 
-  quasseluser-get-userid <username>
-    if user exists, show userid and return true; otherwise return false
+    quasseluser-create <username> [<<< <password>]
+      creates the user in the quasselcore database
+      reads optional initial password
+      if no password read then generate random password
 
+    quasseluser-set-password <username> <password>
+      sets the quasselcore user password
 
+    quasseluser-reset-password <username>
+      sets the quasselcore user password to a random string
 
-  create-invitation <username> <address> [<<< message]
-    reads optional message
+    quasseluser-check-password <username> <<< <password>
+      check the name/password pair against the database
+
+    quasseluser-get-userid <username>
+      if user exists, show userid and return true; otherwise return false
+
+    quasseluser-get-password <username>
+      show salt:password field for username
+
+    quasseluser-get <field name> <username>
+      query quasseluser table for named field
+
+    quasseluser-users
+      list all usernames
+
+Server-Side Commands (e.g., endpoints)
+
+  (These are implemented in the video-responder repository.)
+
+  create-invitation <address>
     creates entry in invitations/
     outputs the invitation code
 
-  create-user <invitation code> <new-username> [<<< password]
-    reads optional initial password
-    fails if existing entry in users/ OR in quasselcore database
-    creates entry in users/
-    adds corresponding user to quasselcore database
-    outputs the address associated with the username
 
-  request-password-reset <username> <address> [new]
-    boolean "new" indicates setting initial password
-    creates entry in password-resets/ with shared secret
-    outputs pw-reset code
 
-  show-secret <pw-reset code>
-    outputs shared secret
+  create-preinvitation <username>
+    creates entry in preinvitations/.
+    outputs the preinvitation code.
+    input username is _inviting_ user.  invited user has no username.
+
+  request-invitation <preinvitation code> <address>
+    calls create-invitation with the inviting user set to that of the
+    preinvitation.  This should track up to the preinvitation source.
 
-  execute-password-reset <pw-reset code>
+  request-password-reset <username> <address>
+    stores and generates pw-reset code and shared secret.
+    triggers out-of-band transmission of shared secret.
+    outputs pw-reset code (or pw-reset url embedding code).
 
+  reset-password <pw-reset code> <shared secret> <(<<< passwd)>
+    validate the provided pw-reset code and shared secret.
+    set the password on the quassel account to the password provided.
+    it is accessible under an url that contains the pw-reset code.
 
+  send-invitation-email <invitation code>
+    send email with link
+    invitation code is embedded in link URL
 
   create-pdf-invitation [message]
     creates entry in pre-invitations/
@@ -50,18 +77,8 @@ commands:
     link is to an HTML page equivalent to the PDF
     returns index as e.g. 0 for database/invitation-sheet/0
 
-  send-invitation-email <invitation code>
-    send email with link
-    invitation code is embedded in link URL
-
   send-password-reset-email <pw-reset code> [new]
     constructed link will contain shared secret
     linked page will contain html form accepting shared secret via user input
     linked page gets pw-reset code from browser via cookie
 
-  reset-password <pw-reset code> <shared secret> <(<<< passwd)>
-    validate the provided pw-reset code and shared secret
-    set the password on the quassel account to the password provided
-    this has to be an HTML form served on a web server
-    it is accessible under an url that contains the pw-reset code.
-