* Set up the framework for different "views" of a room

[citadel.git] / citadel / techdoc / session.txt

diff --git a/citadel/techdoc/session.txt b/citadel/techdoc/session.txt
index 9f92efa5e65150b8b6e7ff5a70dc027845d65ca3..2aed1cd18f0a7dae618e39252b233ad4cb5e7f0d 100644 (file)
--- a/citadel/techdoc/session.txt
+++ b/citadel/techdoc/session.txt
@@ -182,7 +182,7 @@ following parameters are returned:
  
  NEWU   (create NEW User account)
  
- This command creates a new user account and logs it in.  The argument to
+ This command creates a new user account AND LOGS IT IN.  The argument to
 this command will be the name of the account.  No case conversion is done
 on the name.  Note that the new account is installed with a default
 configuration, and no password, so the client should immediately prompt the
@@ -191,6 +191,9 @@ command completes.  This command returns OK if the account was created and
 logged in, or ERROR if another user already exists with this name.  If OK,
 it will also return the same parameters that PASS returns.
  
+ Please note that the NEWU command should only be used for self-service user account
+creation.  For administratively creating user accounts, please use the CREU command.
+ 
   
  SETP   (SET new Password)
  
@@ -200,6 +203,20 @@ returns OK, unless the client is not logged in, in which case it will return
 ERROR.
  
    
+ CREU   (CREate new User account)
+ 
+ This command creates a new user account AND DOES NOT LOG IT IN.  The argument to
+this command will be the name of the account.  No case conversion is done
+on the name.  Note that the new account is installed with a default
+configuration, and no password.  This command returns OK if the account was created,
+or ERROR if another user already exists with this name.  
+ 
+ Please note that CREU is intended to be used for activities in which a system
+administrator is creating user accounts.  For self-service user account creation,
+use the NEWU command.
+ 
+ 
+  
  LKRN   (List Known Rooms with New messages)
  
  List known rooms with new messages.  If the client is not logged in, ERROR
@@ -382,6 +399,7 @@ a regular Aide (this makes access checks easy).
    9. The number of new Mail messages the user has (useful for alerting the
 user to the arrival of new mail during a session)
   10. The floor number this room resides on
+  11. The current "view" for this room (see views.txt for more info)
   
   
  MSGS   (get pointers to MeSsaGeS in this room)
@@ -643,6 +661,7 @@ and the room aide associated with the current room, can access this command.
  3. Various flags (bits) associated with the room (see LKRN cmd above)
  4. The floor number on which the room resides
  5. The room listing order
+ 6. The default view for the room (see views.txt)
   
   
  SETR   (SET Room attributes)
@@ -657,6 +676,7 @@ should be passed the following arguments:
  4. "Bump" flag (see below)
  5. The floor number on which the room should reside
  6. The room listing order
+ 7. The default view for the room (see views.txt)
  
  *Important: You should always use GETR to retrieve the current attributes of
 the room, then change what you want to change, and then use SETR to write it
@@ -1862,23 +1882,6 @@ command may be run at any time.
  3 - Cipher strength bits actually in use, e.g. 128
 
 
- ETLS   (End Transport Layer Security)
-
- This command shuts down TLS and resumes an unencrypted communications
-channel.  This command returns OK and then negotiates TLS shutdown.  The
-client should read the response before negotiating TLS shutdown (e.g. with
-SSL_shutdown() in OpenSSL).  The connection is then unencrypted.  The
-server may return ERROR if it does not support SSL or if the connection was
-not encrypted to begin with.  If either end is unable to resume the connection
-unencrypted, the connection should be closed.
- 
- This command is primarily for debugging.  Clients may end TLS at any time
-without calling this command.  If a client needs to end TLS and resume
-unencrypted communications, it should do so through the SSL/TLS layer (e.g.
-with SSL_shutdown() in OpenSSL) rather than using this command.  This command
-may be removed from future versions of Citadel/UX.
- 
- 
  IGAB   (Initialize Global Address Book)
  
  This command creates, or re-creates, a database of Internet e-mail addresses
@@ -1897,6 +1900,13 @@ returns OK followed by a Citadel address if there is a match, otherwise it
 returns ERROR+NOT_LOGGED_IN.
  
  
+ VIEW   (set the VIEW for a room)
+ 
+ Set the preferred view for the current user in the current room.  Please see
+views.txt for more information on views.  The sole parameter for this command
+is the type of view requested.  VIEW returns OK on success or ERROR on failure.
+   
+    
  ASYN   (ASYNchronous message support)
  
  Negotiate the use of asynchronous, or unsolicited, protocol messages.  The