Documentation cleanups
[tpg/opendispense2.git] / proto.txt
index 3adcaf2..18a5416 100644 (file)
--- a/proto.txt
+++ b/proto.txt
@@ -35,6 +35,9 @@ If the client is connecting from a trusted machine on a root port then
 automatic authentication is allowed
 c      AUTOAUTH <username>\n
 s      200 Auth OK\n or 404 Bad Username\n or 401 Untrusted\n
+--- Set effective user (User in `dispense -u`) ---
+c      SETEUSER <username>\n
+s      200 User set\n or 403 Not in coke\n or 404 User not found\n
 
 === Commands ===
 --- Dispense an item ---
@@ -75,5 +78,7 @@ s     202 User <username> <balance> <flags>\n
 c      USER_ADD <username>\n
 s      200 User Added\n or 403 Not Wheel\n or 404 User Exists\n
 --- Set user flags ---
+ <flags> is a comma-separated list of flag values (optionally preceded by
+ - to remove the flag) Valid values are: user,coke,wheel,meta,disabled,door
 c      USER_FLAGS <username> <flags>\n
 s      200 User Updated\n or 403 Not Wheel\n or 404 Bad User\n or 407 Unknown Flags\n

UCC git Repository :: git.ucc.asn.au