documentation
[citadel.git] / citadel / docs / citadel.html
index 89c40b77fbcba47031ead984b0529661394cefd9..8a8cd28145eb14fb2ed258ebfff79bf392896746 100644 (file)
 <div align="center">
 <h1>C I T A D E L</h1>
 <h2>an open source messaging and collaboration platform</h2>
-Copyright &copy;1987-2008 by the Citadel development team:<br>
-<br>
-<table align="center" border="0" cellpadding="2" cellspacing="2">
-  <tbody>
-    <tr>
-      <td valign="top">Clint Adams<br>
-      </td>
-      <td valign="top"><i>portability enhancements<br>
-      </i></td>
-    </tr>
-    <tr>
-      <td valign="top">Steven M. Bellovin<br>
-      </td>
-      <td valign="top"><i>author of public domain 'parsedate' function<br>
-      </i></td>
-    </tr>
-    <tr>
-      <td valign="top">Nathan Bryant<br>
-      </td>
-      <td valign="top"><i>build system, security, database access, and
-others<br>
-      </i></td>
-    </tr>
-    <tr>
-      <td valign="top">Art Cancro<br>
-      </td>
-      <td valign="top"><i>overall system design and lead developer<br>
-      </i></td>
-    </tr>
-    <tr>
-      <td valign="top">Brian Costello<br>
-      </td>
-      <td valign="top"><i>cosmetics, additional commands<br>
-      </i></td>
-    </tr>
-    <tr>
-      <td valign="top">Nick Georbit<br>
-      </td>
-      <td valign="top"><i>additional client features<br>
-      </i></td>
-    </tr>
-    <tr>
-      <td valign="top">David Given<br>
-      </td>
-      <td valign="top"><i>IMAP and build patches<br>
-      </i></td>
-    </tr>
-    <tr>
-      <td valign="top">Dave West<br>
-      </td>
-      <td valign="top"><i>server features<br>
-      </i></td>
-    </tr>
-    <tr>
-      <td valign="top">Wilfried Goesgens<br>
-      </td>
-      <td valign="top"><i>build system patches<br>
-      </i></td>
-    </tr>
-    <tr>
-      <td valign="top">Michael Hampton<br>
-      </td>
-      <td valign="top"><i>client software development<br>
-      </i></td>
-    </tr>
-    <tr>
-      <td valign="top">Andru Luvisi<br>
-      </td>
-      <td valign="top"><i>troubleshooting and development assistance<br>
-      </i></td>
-    </tr>
-    <tr>
-      <td valign="top">Daniel Malament<br>
-      </td>
-      <td valign="top"><i>string compare function for IMAP server<br>
-      </i></td>
-    </tr>
-    <tr>
-      <td valign="top">Stu Mark<br>
-      </td>
-      <td valign="top"><i>additional client features, IGnet protocol design<br>
-      </i></td>
-    </tr>
-    <tr>
-      <td valign="top">Edward S. Marshall<br>
-      </td>
-      <td valign="top"><i>RBL checking function design<br>
-      </i></td>
-    </tr>
-    <tr>
-      <td valign="top">Ben Mehlman<br>
-      </td>
-      <td valign="top"><i>additional client features<br>
-      </i></td>
-    </tr>
-    <tr>
-      <td valign="top">Matt Pfleger<br>
-      </td>
-      <td valign="top"><i>additional client features<br>
-      </i></td>
-    </tr>
-    <tr>
-      <td valign="top">Ari Samson<br>
-      </td>
-      <td valign="top"><i>assistance with project management<br>
-      </i></td>
-    </tr>
-    <tr>
-      <td valign="top">Trey Van Riper<br>
-      </td>
-      <td valign="top"><i>QA and portability enhancements<br>
-      </i></td>
-    </tr>
-    <tr>
-      <td valign="top">John Walker<br>
-      </td>
-      <td valign="top"><i>author of public domain base64 encoder/decoder<br>
-      </i></td>
-    </tr>
-    <tr>
-      <td valign="top">Steve Williams<br>
-      </td>
-      <td valign="top"><i>documentation<br>
-      </i></td>
-    </tr>
-    <tr>
-      <td valign="top">Ethan Young<br>
-      </td>
-      <td valign="top"><i>IGnet protocol design<br>
-      </i></td>
-    </tr>
-  </tbody>
-</table>
+Copyright &copy;1987-2011 by the Citadel development team.  Contributors include:
+<ul>
+      <li>Clint Adams
+      <li>Steven M. Bellovin
+      <li>Nathan Bryant
+      <li>Art Cancro
+      <li>Brian Costello
+      <li>Edward Flick
+      <li>Nick Georbit
+      <li>David Given
+      <li>Dave West
+      <li>Wilfried Goesgens
+      <li>Michael Hampton
+      <li>Andru Luvisi
+      <li>Daniel Malament
+      <li>Stu Mark
+      <li>Edward S. Marshall
+      <li>Ben Mehlman
+      <li>Matt Pfleger
+      <li>Ari Samson
+      <li>Trey Van Riper
+      <li>John Walker
+      <li>Steve Williams
+      <li>Ethan Young
+</ul>
 </div>
 <br>
 <div align="justify">The entire package is open source software.  You may
@@ -1235,7 +1127,7 @@ program against to set up some data files. If a directory is not
 specified, the directory
 name which was specified in the <tt>Makefile</tt> will be used.</p>
 <p><tt>-xDebugLevel</tt> - Set the verbosity of trace messages printed.
-When -x is used, it will suppress messages sent to syslog (see below).
+When -x is used, it will suppress messages sent to syslog(see below).
 In
 other words, syslog will never see certain messages if -x is used.
 Normally
@@ -2688,15 +2580,12 @@ backups will be usable!</span><br>
 <h3><a name="Database_repair"></a>Database repair</h3>
 Although Citadel's data store is quite reliable, database corruption
 can occur in rare instances. &nbsp;External factors such as an
-operating
-system crash or an unexpected loss of power might leave the database in
-an unknown state. &nbsp;A utility is provided which may be able to
-repair
-your database if this occurs. &nbsp;If you find that your Citadel
-server
-is not running, and reading the logs shows that it is crashing because
-of
-an inability to validate a database, follow these steps:<br>
+operating system crash or an unexpected loss of power might leave the
+database in an unknown state. &nbsp;A utility is provided which may
+be able to repair your database if this occurs. &nbsp;If you find
+that your Citadel server is not running, and reading the logs shows
+that it is crashing because of an inability to validate a database,
+follow these steps:<br>
 <ol>
   <li>Edit <tt>/etc/inittab</tt> and switch the Citadel service from
 "respawn" to "off." &nbsp;Type <tt>init q</tt> to make this setting
@@ -2714,6 +2603,11 @@ changes.</li>
 </ol>
 If this procedure does not work, you must restore from your most recent
 backup.<br>
+<b>Please note: this utility should <i>only</i> be used for recovering
+a database that is causing the Citadel server to crash upon startup.  If
+you have some other type of problem, but the citserver process is not
+aborting with "Berkeley DB Panic" errors, this is <i>not</i> the way to
+fix it.</b><br>
 <br>
 <h3><a name="ImportingExporting_your_Citadel"></a>Importing/Exporting
 your Citadel database<br>