* added server command line option "-f" to defrag databases on startup

[citadel.git] / citadel / install.txt

diff --git a/citadel/install.txt b/citadel/install.txt
index e289d19f0c522b81885a92b0abaf16a4c38690e0..9c5e32e83458b2b03e8433477eb68358554cfc2f 100644 (file)
--- a/citadel/install.txt
+++ b/citadel/install.txt
@@ -207,7 +207,7 @@ port for each one.
 program is the main Citadel server.  Before we cover the recommended method of
 starting the server, let's examine its usage options:
  
- citserver [-hHomeDir] [-xDebugLevel] [-tTraceFile] [-d]
+ citserver [-hHomeDir] [-xDebugLevel] [-tTraceFile] [-d] [-f]
  
  The options are as follows:
  
@@ -234,6 +234,10 @@ starting the Citadel server, for example, from an rc.local script (which is
 not recommended, because this won't allow the server to automatically restart
 when it is shut down).
  
+ -f            - Defragment all the databases upon startup.  This isn't
+normally necessary due to the nature of the data stored in Citadel, but the
+option is provided in case you need it.
+ 
  
    The preferred method of starting the Citadel server is to place an entry in
 your /etc/inittab file.  This will conveniently bring the server up when your