Document account names in manpage

[tpg/opendispense2.git] / docs / dispense.1

diff --git a/docs/dispense.1 b/docs/dispense.1
index dffff1c..18eead7 100644 (file)
--- a/docs/dispense.1
+++ b/docs/dispense.1
@@ -39,40 +39,49 @@ Use a non-interactive list instead of the ncurses interface.
 .SH SUB-COMMANDS
 .SS "All users"
 .TP
-.RI "give " "user ammount reason"
+.RI "give " "user amount reason"
 Give some money to another user (e.g. for pizza).
 
 .TP
 .RI "acct [" "user" "]"
-List users (including balances and flags)
+List users (including balances and flags).
+
+.TP
+.RI "donate " "amount reason"
+Give money to the club (for whatever reason)
 
 .SS "Door Members"
 .TP
 .RI "door"
-Open the UCC door
+Open the UCC door.
 
 .SS "Coke Controllers"
 
 .TP
-.RI "acct " "user" " [+-]" "ammount" " '" "reason" "'"
+.RI "acct " "user" " [+-]" "amount" " '" "reason" "'"
 Alter a user's balance by
-.I ammount
-cents, leaving a reason for the coke logs.
+.I amount
+cents, leaving a reason for the coke logs. Implemented as a transfer of
+.I amount
+cents from '>additions' to the user.
 
 .TP
 .RI "refund " "user item_id" " [" "price" "]"
-Refund a bad dispense for a user (the item_id can be found in the coke log usually)
-It is is of the form <type>:<slot>, for example coke:6 or snack:33
+Refund a bad dispense for a user (the item_id can be found in the coke log usually).
+It is is of the form <type>:<slot>, for example coke:6 or snack:33.
 
 .TP
 .RI "slot " "item_id price name"
-Update a slot's contents (name and price)
+Update a slot's contents (name and price).
 
 .SS "Administrators"
 
 .TP
-.RI "acct " "user" " =" "ammount" " '" reason "'"
-Set a user's balance to a number of cents
+.RI "acct " "user" " =" "amount" " '" reason "'"
+Set a user's balance to a number of cents.
+
+This function will use the '>countersum' account as the source/sink for money to make the users
+balance as requested
 
 .TP
 .RI "user add " "username"
@@ -81,7 +90,7 @@ Create a new account with the specified username.
 .TP
 .RI "user type " "username flags"
 Alter the flags on a user. Valid flags are user, coke, admin, internal and disabled.
-Flags can be removed by prepending the flag with a '-'
+Flags can be removed by prepending the flag with a '-'.
 
 .SH EXIT STATUS