* 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 b368ae7e475a136686b4875233654e96c15d353b..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