* New HALT command shuts down server but suspends instead of exiting.

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

diff --git a/citadel/techdoc/protocol.txt b/citadel/techdoc/protocol.txt
index 5ec92e49acf6a885c9f30d0e2b6c736a7f4348a1..712a887222d30ae048730cff2d750686e064bad5 100644 (file)
--- a/citadel/techdoc/protocol.txt
+++ b/citadel/techdoc/protocol.txt
@@ -1666,6 +1666,14 @@ otherwise, it returns OK followed by a number representing the current state
 of the flag.
 
 
+ HALT   (HALT the server without shutting it down)
+ 
+ Identical to the DOWN command, except instead of exiting, the server process
+cleans up and then suspends indefinitely.  This could potentially be useful for
+shutdown scripts that don't want init to automatically respawn another citserver
+process.
+
+
  EMSG   (Enter a system MeSsaGe)
 
  This is the opposite of the MESG command - it allows the creation and editing
@@ -2156,8 +2164,17 @@ may be issued:
   Output the contents of the entire calendar (assuming we are in a calendar
   room) as one big data stream.  All of the events (or tasks, etc.) in the room
   are combined into a single VCALENDAR object, which is then serialized and
-  transmitted to the client.  This is suitable for exporting a calendar into
-  third-party software.
+  transmitted to the client.  This is suitable for subscribing to a calendar
+  in third-party software.  This command will output LISTING_FOLLOWS followed
+  by the calendar data stream, or ERROR if the requested operation is not
+  permitted.
+ 
+ ICAL putics
+  Delete the entire contents of a calendar room and replace it with the calendar
+  supplied by a client-input data stream.  This is suitable for publishing a
+  calendar from third-party software.  This command will output SEND_LISTING and
+  then expect the client to transmit the calendar data stream.  Alternatively,
+  it will return ERROR if the requested operation is not permitted.
 
 
 
@@ -2248,6 +2265,7 @@ only in rooms to which the user does not have access.
 guaranteed to continue to exist in this form.
 
 
+
 EUID   (get message number using an EUID)}
 
  Returns the message number, if present, of the message in the current room