* 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 a186dfebcc762e66d2408bbf81a51eef4f349cd1..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
@@ -2257,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