citadel/docs/citadel.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4   <title>Citadel/UX Documentation</title>
   5
   6   <meta http-equiv="content-type"
   7  content="text/html; charset=ISO-8859-1">
   8 </head>
   9 <body>
  10
  11 <div align="center">
  12 <h1>Citadel/UX</h1>
  13
  14 <h2>a messaging and collaboration platform for BBS and groupware applications</h2>
  15       Copyright &copy;1987-2003 by the Citadel development team:<br>
  16       <br>
  17
  18 <table cellpadding="2" cellspacing="2" border="0" align="center">
  19         <tbody>
  20           <tr>
  21             <td valign="top">Steven M. Bellovin<br>
  22             </td>
  23             <td valign="top"><i>author of public domain 'parsedate' function<br>
  24             </i></td>
  25           </tr>
  26           <tr>
  27             <td valign="top">Nathan Bryant<br>
  28             </td>
  29             <td valign="top"><i>build system, security, database access,
  30 and   others<br>
  31             </i></td>
  32           </tr>
  33           <tr>
  34             <td valign="top">Art Cancro<br>
  35             </td>
  36             <td valign="top"><i>overall system design and lead developer<br>
  37             </i></td>
  38           </tr>
  39           <tr>
  40             <td valign="top">Brian Costello<br>
  41             </td>
  42             <td valign="top"><i>cosmetics, additional commands<br>
  43             </i></td>
  44           </tr>
  45           <tr>
  46             <td valign="top">Michael Hampton<br>
  47             </td>
  48             <td valign="top"><i>client software development<br>
  49             </i></td>
  50           </tr>
  51           <tr>
  52             <td valign="top">Andru Luvisi<br>
  53             </td>
  54             <td valign="top"><i>troubleshooting and development assistance<br>
  55             </i></td>
  56           </tr>
  57           <tr>
  58             <td valign="top">Daniel Malament<br>
  59             </td>
  60             <td valign="top"><i>string compare function for IMAP server<br>
  61             </i></td>
  62           </tr>
  63           <tr>
  64             <td valign="top">Stu Mark<br>
  65             </td>
  66             <td valign="top"><i>additional client features, IGnet protocol
  67  design<br>
  68             </i></td>
  69           </tr>
  70           <tr>
  71             <td valign="top">Ben Mehlman<br>
  72             </td>
  73             <td valign="top"><i>additional client features<br>
  74             </i></td>
  75           </tr>
  76           <tr>
  77             <td valign="top">Ari Samson<br>
  78             </td>
  79             <td valign="top"><i>assistance with project management<br>
  80             </i></td>
  81           </tr>
  82           <tr>
  83             <td valign="top">John Walker<br>
  84             </td>
  85             <td valign="top"><i>author of public domain base64 encoder/decoder<br>
  86             </i></td>
  87           </tr>
  88           <tr>
  89             <td valign="top">Steve Williams<br>
  90             </td>
  91             <td valign="top"><i>documentation<br>
  92             </i></td>
  93           </tr>
  94           <tr>
  95             <td valign="top">Ethan Young<br>
  96             </td>
  97             <td valign="top"><i>IGnet protocol design<br>
  98             </i></td>
  99           </tr>
 100
 101   </tbody>
 102 </table>
 103       <br>
 104
 105 <div align="justify">The entire package is open source; you can redistribute
 106    and/or modify it under the terms of the GNU General Public License as
 107 published    by the Free Software Foundation; either version 2 of the License,
 108 or (at   your option) any later version.<br>
 109       <br>
 110       This program is distributed in the hope that it will be useful, but
 111 WITHOUT   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 112 or FITNESS   FOR A PARTICULAR PURPOSE.&nbsp; See the GNU General Public License
 113 for more   details.<br>
 114       </div>
 115       <br>
 116
 117 <div align="justify">You should have received a copy of the GNU General Public
 118    License along with this program; if not, write to the Free Software Foundation,
 119    Inc., 675 Mass Ave, Cambridge, MA 02139, USA.<br>
 120       <br>
 121       For more information, visit either of these locations on the web:<br>
 122
 123 <ul>
 124         <li>The Citadel home page: <a href="http://www.citadel.org">http://www.citadel.org</a></li>
 125         <li>UNCENSORED! BBS, the home of Citadel: <a
 126  href="http://uncensored.citadel.org">http://uncensored.citadel.org</a></li>
 127
 128 </ul>
 129
 130 <hr width="100%" size="2">
 131 <h2 align="center">Table of Contents</h2>
 132
 133 <ol>
 134        <li><a href="#GPL">Warranty</a></li>
 135        <li><a href="#Installation_Guide">Installation Guide</a></li>
 136        <li> Baz</li>
 137        <li> Eek</li>
 138
 139 </ol>
 140       <br>
 141
 142 <hr width="100%" size="2"><br>
 143
 144 <h2 align="center"><a name="GPL"></a>GNU General Public License<br>
 145      </h2>
 146      </div>
 147
 148 <p>  Version 2, June 1991  </p>
 149
 150 <pre>Copyright (C) 1989, 1991 Free Software Foundation, Inc.  <br>59 Temple Place - Suite 330, Boston, MA  02111-1307, USA<br><br>Everyone is permitted to copy and distribute verbatim copies<br>of this license document, but changing it is not allowed.<br></pre>
 151
 152 <h3 align="justify">Preamble</h3>
 153
 154 <div align="justify">  </div>
 155
 156 <p align="justify">   The licenses for most software are designed to take
 157   away your freedom to share and change it.  By contrast, the GNU General
 158 Public  License is intended to guarantee your freedom to share and change
 159 free software--to  make sure the software is free for all its users.  This
 160 General Public License  applies to most of the Free Software Foundation's
 161 software and to any other  program whose authors commit to using it.  (Some
 162 other Free Software Foundation  software is covered by the GNU Library General
 163 Public License instead.)  You can apply it to your programs, too.  </p>
 164
 165 <div align="justify"> </div>
 166
 167 <p align="justify">    When we speak of free software, we are referring to
 168   freedom, not price.  Our General Public Licenses are designed to make sure
 169   that you have the freedom to distribute copies of free software (and charge
 170   for this service if you wish), that you receive source code or can get it
 171   if you want it, that you can change the software or use pieces of it in
 172 new free programs; and that you know you can do these things.  </p>
 173
 174 <div align="justify"> </div>
 175
 176 <p align="justify">   To protect your rights, we need to make restrictions
 177   that forbid anyone to deny you these rights or to ask you to surrender the
 178   rights. These restrictions translate to certain responsibilities for you
 179  if you distribute copies of the software, or if you modify it.  </p>
 180
 181 <div align="justify"> </div>
 182
 183 <p align="justify">   For example, if you distribute copies of such a program,
 184   whether gratis or for a fee, you must give the recipients all the rights
 185  that you have.  You must make sure that they, too, receive or can get the
 186   source code.  And you must show them these terms so they know their rights.
 187    </p>
 188
 189 <div align="justify"> </div>
 190
 191 <p align="justify">   We protect your rights with two steps: (1) copyright
 192   the software, and (2) offer you this license which gives you legal permission
 193   to copy, distribute and/or modify the software.  </p>
 194
 195 <div align="justify"> </div>
 196
 197 <p align="justify">   Also, for each author's protection and ours, we want
 198   to make certain that everyone understands that there is no warranty for
 199 this  free software.  If the software is modified by someone else and passed
 200 on,  we want its recipients to know that what they have is not the original,
 201 so  that any problems introduced by others will not reflect on the original
 202   authors' reputations.   </p>
 203
 204 <div align="justify"> </div>
 205
 206 <p align="justify">   Finally, any free program is threatened constantly by
 207 software patents.  We wish to avoid the danger that redistributors of a free
 208 program will individually obtain patent licenses, in effect making the program
 209 proprietary.  To prevent this, we have made it clear that any  patent must
 210 be licensed for everyone's free use or not licensed at all.  </p>
 211
 212 <div align="justify"> </div>
 213
 214 <p align="justify">   The precise terms and conditions for copying, distribution
 215   and modification follow.  </p>
 216
 217 <div align="justify">   </div>
 218
 219 <h3>TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION</h3>
 220
 221 <div align="justify">   </div>
 222
 223 <p align="justify">  <strong>0.</strong>  This License applies to any program
 224   or other work which contains a notice placed by the copyright holder saying
 225   it may be distributed under the terms of this General Public License.  The
 226   "Program", below, refers to any such program or work, and a "work based
 227 on  the Program" means either the Program or any derivative work under copyright
 228   law: that is to say, a work containing the Program or a portion of it, either
 229   verbatim or with modifications and/or translated into another language.
 230  (Hereinafter, translation is included without limitation in the term "modification".)
 231   Each licensee is addressed as "you". </p>
 232
 233 <p align="justify">  Activities other than copying, distribution and modification
 234   are not covered by this License; they are outside its scope.  The act of
 235   running the Program is not restricted, and the output from the Program
 236 is   covered only if its contents constitute a work based on the Program
 237 (independent   of having been made by running the Program). Whether that
 238 is true depends   on what the Program does.  </p>
 239
 240 <p align="justify">  <strong>1.</strong>  You may copy and distribute verbatim
 241   copies of the Program's source code as you receive it, in any medium, provided
 242   that you conspicuously and appropriately publish on each copy an appropriate
 243    copyright notice and disclaimer of warranty; keep intact all the notices
 244   that refer to this License and to the absence of any warranty; and give
 245 any  other recipients of the Program a copy of this License along with the
 246 Program.  </p>
 247
 248 <p align="justify">  You may charge a fee for the physical act of transferring
 249   a copy, and you may at your option offer warranty protection in exchange
 250  for a fee. </p>
 251
 252 <p align="justify">  <strong>2.</strong>  You may modify your copy or copies
 253   of the Program or any portion of it, thus forming a work based on the Program,
 254   and copy and distribute such modifications or work under the terms of Section
 255   1 above, provided that you also meet all of these conditions: </p>
 256
 257 <p align="justify">  </p>
 258
 259 <div align="justify">
 260 <ul>
 261        <li><strong>a)</strong>      You must cause the modified files to
 262 carry   prominent notices      stating that you changed the files and the
 263 date of   any change.
 264     <p> </p>
 265        </li>
 266        <li><strong>b)</strong>      You must cause any work that you distribute
 267   or publish, that in      whole or in part contains or is derived from the
 268   Program or any      part thereof, to be licensed as a whole at no charge
 269  to all third      parties under the terms of this License.
 270
 271     <p> </p>
 272        </li>
 273        <li><strong>c)</strong>      If the modified program normally reads
 274  commands  interactively      when run, you must cause it, when started running
 275  for such      interactive use in the most ordinary way, to print or display
 276  an       announcement including an appropriate copyright notice and a
 277    notice  that there is no warranty (or else, saying that you provide
 278    a warranty)  and that users may redistribute the program under      these
 279  conditions, and telling the user how to view a copy of this      License.
 280   (Exception: if the Program itself is interactive but      does not normally
 281  print such an announcement, your work based on      the Program is not required
 282  to print  an announcement.) </li>
 283
 284 </ul>
 285        These requirements apply to the modified work as a whole.  If identifiable
 286   sections of that work are not derived from the Program, and can be reasonably
 287   considered independent and separate works in themselves, then this License,
 288   and its terms, do not apply to those sections when you distribute them as
 289   separate works.  But when you distribute the same sections as part of a
 290 whole  which is a work based on the Program, the distribution of the whole
 291 must be on the terms of this License, whose permissions for other licensees
 292 extend  to the entire whole, and thus to each and every part regardless of
 293 who wrote  it. </div>
 294
 295 <p align="justify">  Thus, it is not the intent of this section to claim rights
 296 or contest your rights to work written entirely by you; rather, the intent
 297 is to exercise the right to control the distribution of derivative or collective
 298 works based on the Program. </p>
 299
 300 <p align="justify">  In addition, mere aggregation of another work not based
 301   on the Program with the Program (or with a work based on the Program) on
 302  a volume of a storage or distribution medium does not bring the other work
 303  under the scope of this License.  </p>
 304
 305 <p align="justify">  <strong>3.</strong>   You may copy and distribute the
 306   Program (or a work based on it, under Section 2) in object code or executable
 307   form under the terms of Sections 1 and 2 above provided that you also do
 308  one of the following:   <!-- we use this doubled UL to get the sub-sections indented, -->
 309    <!-- while making the bullets as unobvious as possible. --> </p>
 310
 311 <div align="justify">
 312 <ul>
 313        <li><strong>a)</strong>      Accompany it with the complete corresponding
 314   machine-readable      source code, which must be distributed under the terms
 315   of Sections      1 and 2 above on a medium customarily used for software
 316  interchange; or,
 317     <p> </p>
 318        </li>
 319        <li><strong>b)</strong>      Accompany it with a written offer, valid
 320   for at least three      years, to give any third party, for a charge no
 321 more  than your      cost of physically performing source distribution, a
 322 complete        machine-readable copy of the corresponding source code, to
 323 be      distributed under the terms of Sections 1 and 2 above on a medium
 324      customarily used for software interchange; or,
 325
 326     <p> </p>
 327        </li>
 328        <li><strong>c)</strong>       Accompany it with the information you
 329  received  as to the offer      to distribute corresponding source code.
 330  (This alternative  is      allowed only for noncommercial distribution and
 331 only if you      received the program in object code or executable form with
 332 such      an offer, in accord with Subsection b above.) </li>
 333
 334 </ul>
 335        The source code for a work means the preferred form of the work for
 336  making  modifications to it.  For an executable work, complete source code
 337  means all the source code for all modules it contains, plus any associated
 338  interface  definition files, plus the scripts used to control compilation
 339  and installation  of the executable.  However, as a special exception, the
 340  source code distributed  need not include anything that is normally distributed
 341  (in either source or binary form) with the major components (compiler, kernel,
 342  and so on) of the operating system on which the executable runs, unless
 343 that  component itself  accompanies the executable. </div>
 344
 345 <p align="justify">  If distribution of executable or object code is made
 346   by offering access to copy from a designated place, then offering equivalent
 347    access to copy the source code from the same place counts as distribution
 348   of the source code, even though third parties are not compelled to copy
 349 the  source along with the object code. </p>
 350
 351 <p align="justify">  <strong>4.</strong>  You may not copy, modify, sublicense,
 352   or distribute the Program except as expressly provided under this License.
 353    Any attempt otherwise to copy, modify, sublicense or distribute the Program
 354   is void, and will automatically terminate your rights under this License.
 355    However, parties who have received copies, or rights, from you under this
 356   License will not have their licenses terminated so long as such parties
 357 remain  in full compliance.  </p>
 358
 359 <p align="justify">  <strong>5.</strong>   You are not required to accept
 360   this License, since you have not signed it.  However, nothing else grants
 361   you permission to modify or distribute the Program or its derivative works.
 362    These actions are prohibited by law if you do not accept this License.
 363  Therefore, by modifying or distributing the Program (or any work based on
 364  the Program), you indicate your acceptance of this License to do so, and
 365 all its terms and conditions for copying, distributing or modifying the Program
 366  or works based on it.  </p>
 367
 368 <p align="justify">  <strong>6.</strong>  Each time you redistribute the Program
 369 (or any work based on the Program), the recipient automatically receives a
 370 license from the original licensor to copy, distribute or modify the Program
 371   subject to these terms and conditions.  You may not impose any further restrictions
 372   on the recipients' exercise of the rights granted herein. You are not responsible
 373   for enforcing compliance by third parties to this License.  </p>
 374
 375 <p align="justify">  <strong>7.</strong>  If, as a consequence of a court
 376   judgment or allegation of patent infringement or for any other reason (not
 377   limited to patent issues), conditions are imposed on you (whether by court
 378   order, agreement or otherwise) that contradict the conditions of this License,
 379   they do not excuse you from the conditions of this License.  If you cannot
 380    distribute so as to satisfy simultaneously your obligations under this
 381 License  and any other pertinent obligations, then as a consequence you may
 382 not distribute  the Program at all.  For example, if a patent license would
 383 not permit royalty-free  redistribution of the Program by all those who receive
 384 copies directly or  indirectly through you, then the only way you could satisfy
 385 both it and this  License would be to refrain entirely from distribution
 386 of the Program. </p>
 387
 388 <p align="justify">  If any portion of this section is held invalid or unenforceable
 389   under any particular circumstance, the balance of the section is intended
 390   to apply and the section as a whole is intended to apply in other circumstances.
 391     </p>
 392
 393 <p align="justify">  It is not the purpose of this section to induce you to
 394 infringe any patents or other property right claims or to contest validity
 395   of any such claims; this section has the sole purpose of protecting the
 396 integrity  of the free software distribution system, which is implemented
 397 by public license practices.  Many people have made generous contributions
 398 to the wide range of software distributed through that system in reliance
 399 on consistent application of that system; it is up to the author/donor to
 400 decide if he or she is willing to distribute software through any other system
 401 and a licensee cannot impose that choice. </p>
 402
 403 <p align="justify">  This section is intended to make thoroughly clear what
 404   is believed to be a consequence of the rest of this License.  </p>
 405
 406 <p align="justify">  <strong>8.</strong>  If the distribution and/or use of
 407 the Program is restricted in certain countries either by patents or by copyrighted
 408 interfaces, the original copyright holder who places the Program under this
 409 License may add an explicit geographical distribution limitation excluding
 410 those countries, so that distribution is permitted only in or among  countries
 411 not thus excluded.  In such case, this License incorporates the limitation
 412 as if written in the body of this License.  </p>
 413
 414 <p align="justify">  <strong>9.</strong>  The Free Software Foundation may
 415   publish revised and/or new versions of the General Public License from time
 416   to time.  Such new versions will be similar in spirit to the present version,
 417   but may differ in detail to address new problems or concerns.  </p>
 418
 419 <p align="justify">  Each version is given a distinguishing version number.
 420    If the Program specifies a version number of this License which applies
 421  to it and "any later version", you have the option of following the terms
 422  and conditions either of that version or of any later version published by
 423  the Free Software Foundation.  If the Program does not specify a version
 424 number of this License, you may choose any version ever published by the Free
 425 Software Foundation.  </p>
 426
 427 <p align="justify">   <strong>10.</strong>  If you wish to incorporate parts
 428   of the Program into other free programs whose distribution conditions are
 429   different, write to the author to ask for permission.  For software which
 430   is copyrighted by the Free Software Foundation, write to the Free Software
 431   Foundation; we sometimes make exceptions for this.  Our decision will be
 432  guided by the two goals of preserving the free status of all derivatives
 433 of our free software and of promoting the sharing and reuse of software generally.
 434       </p>
 435
 436 <p align="justify"><strong>NO WARRANTY</strong></p>
 437
 438 <div align="justify">  </div>
 439
 440 <p align="justify">  <strong>11.</strong>   BECAUSE THE PROGRAM IS LICENSED
 441   FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED
 442   BY APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
 443   HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
 444   OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
 445  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 446    THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH
 447   YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY
 448   SERVICING, REPAIR OR CORRECTION.  </p>
 449
 450 <p align="justify">  <strong>12.</strong>  IN NO EVENT UNLESS REQUIRED BY
 451   APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY
 452  OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE,
 453  BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL
 454 OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM
 455   (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE
 456   OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
 457 TO  OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS
 458 BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.  </p>
 459
 460 <p align="justify">   </p>
 461
 462 <h3>END OF TERMS AND CONDITIONS</h3>
 463       <br>
 464
 465 <hr width="100%" size="2"><br>
 466
 467 <h2><a name="Installation_Guide"></a>Installation Guide</h2>
 468
 469 <div align="justify">
 470 <h3>Overview</h3>
 471
 472 <p>Citadel/UX is an advanced, multiuser, client/server, room-based BBS program.
 473   It is designed to handle the needs of both small dialup systems and large-scale
 474  Internet-connected systems.  It was originally developed on an Altos system
 475  running Xenix, and has been installed and tested on various Unix and Unix-like
 476  platforms.  The author's current development environment (and BBS) is an
 477 ordinary Linux system.  The current distribution includes: </p>
 478
 479 <ul>
 480     <li>The Citadel/UX server (this is the back end that does all processing)
 481     </li>
 482      <li>A text-based client program designed with the traditional Citadel
 483  "look  and feel" (room prompts, dot commands, and the like) </li>
 484      <li>Setup programs </li>
 485      <li>A set of utilities for system administration and maintenance </li>
 486      <li>Documentation </li>
 487
 488 </ul>
 489
 490 <p>Some knowledge of the Unix system is necessary to install and manage the
 491   system. It is mandatory that the sysop have "root" access to the operating
 492   system. The following are required to install Citadel/UX: </p>
 493
 494 <ul>
 495     <li>A Unix operating system (Linux, BSD, Solaris, Tru64, HP/UX) </li>
 496      <li>C compiler (such as gcc or egcs) and "make" </li>
 497      <li>POSIX threads (the "pthreads" library) </li>
 498      <li>TCP/IP </li>
 499      <li><a href="http://www.sleepycat.com">Berkeley DB</a> v4.1 or newer
 500 (GDBM  also works, but its use is officially depracated.  If you are building
 501 a new system, do <i>not</i> use GDBM.  If you have an existing system which
 502 uses GDBM, you should migrate it to Berkeley DB as soon as possible.) </li>
 503      <li>Enough disk space to hold all of the programs and data </li>
 504
 505 </ul>
 506
 507 <p>If you are running Citadel/UX on a Linux system, it is STRONGLY recommended
 508   that you run it on a recent distribution (such as  <a
 509  href="http://www.redhat.com">Red Hat</a> 7.3 or newer).  A new-ish distribution
 510  will have most or all of the prerequisite tools and libraries already integrated
 511  for you.</p>
 512
 513 <h3>Now available:</h3>
 514
 515 <ul>
 516     <li>"WebCit", a gateway program to allow full access to Citadel via the
 517  World Wide Web.  Interactive access through any Web browser. </li>
 518      <li>Access to Citadel via *any* standards-compliant e-mail program,
 519 thanks  to Citadel's built-in SMTP, POP, and IMAP services. </li>
 520
 521 </ul>
 522
 523 <h3>Coming soon:</h3>
 524
 525 <ul>
 526     <li>Newer and better GUI-based clients. </li>
 527
 528 </ul>
 529
 530 <h3>Everything in its place...</h3>
 531
 532 <p>Hopefully you've unpacked the distribution archive into its own directory.
 533  This is the directory in which all Citadel files are located and in which
 534  all activity will take place.  Several subdirectories have already been
 535 created  during the unpacking process, and others may be created by the software
 536 if  needed.  Make sure you have Berkeley DB installed on your system, and
 537 that  you have all the development libraries and headers in place so that
 538 you can  compile against them.  If you don't, you can get the latest Berkeley
 539 DB at  <a href="http://www.sleepycat.com">http://www.sleepycat.com</a>.
 540 If your  operating system uses a separate library to support POSIX threads
 541 (pthreads),  make sure that library is installed as well.  This is almost
 542 never the case  with Linux, but some commercial Unix flavors might need it.</p>
 543
 544 <h3>The BBS Login</h3>
 545
 546 <p>As with many Unix programs, Citadel wants to run under its own user ID.
 547 Unlike other programs, however, this user ID will do double-duty as a public
 548 login for your system if you are running a BBS.  This account is typically
 549 called "bbs" or "citadel" or something to that effect. You will tell Citadel
 550 what the user-id of that account is, and when someone logs in under that
 551 account, Citadel will prompt for a user name.</p>
 552
 553 <p>The Citadel user should have a unique uid. The home directory should be
 554 the one your Citadel installation resides in (in this example we will use
 555 /usr/local/citadel) and the shell should be either "citadel" in that directory,
 556 or a script that will start up citadel (you may wish to set up an external
 557 text editor; see below). Example:</p>
 558
 559 <pre>bbs::100:1:BBS Login:/usr/local/citadel:/usr/local/citadel/citadel<br></pre>
 560
 561 <p>When you run setup later, you will be required to tell it what the Citadel
 562 user's numeric user ID is, so it knows what user to run as.  If you create
 563 an account called <tt>bbs</tt>, <tt>guest</tt>, or <tt>citadel</tt>, the
 564 setup program will automatically pick up the user ID by default.</p>
 565
 566 <p>For all other users in /etc/passwd, Citadel will automatically set up
 567 an account using the full name (or 'gecos' in Unixspeak) of the user.  It'll
 568 also ignore any password you supply, because it uses the user's password
 569 on the host system.  This allows a 'single sign on' type of environment. Note
 570 that this does have to be enabled at compile time -- it's the configure option
 571 called <tt>--enable-autologin</tt>.  Keep in mind that these users can use
 572 *either* their Citadel login name or their login name on the host computer,
 573 and their password on the host computer.</p>
 574
 575 <h3>Bypassing the <tt>login:</tt> prompt</h3>
 576
 577 <p>If you normally log in to your host system using some method other than
 578 telnet (such as ssh), you might want the telnet service to go straight to
 579 the Citadel BBS, instead of displaying the <tt>login:</tt> prompt first.
 580  You can do this by having telnetd start citadel directly instead of <tt>/bin/login</tt>.
 581 This is actually very simple to implement; all you need to do is make a simple
 582 change to your <tt>inetd</tt> or <tt>xinetd</tt> configuration.  Here are
 583 some configuration examples.</p>
 584
 585 <p>An example for <tt>inetd</tt> (put the following line in <tt>/etc/inetd.conf<tt>,
 586 replacing any existing telnet configuration line already there):</p>
 587
 588 <pre>
 589 telnet stream tcp nowait root /usr/sbin/tcpd in.telnetd -L /usr/local/citadel/citadel
 590 </pre>
 591
 592 <p>An example for <tt>xinetd</tt> (if you have a file called <tt>/etc/xinetd.d/telnet</tt>
 593 then simply replace that file with this one):</p>
 594
 595 <pre>service telnet
 596 {
 597         flags           = REUSE
 598         socket_type     = stream
 599         wait            = no
 600         user            = root
 601         server          = /usr/sbin/in.telnetd
 602         server_args     = -L /usr/local/citadel/citadel
 603         log_on_failure  += USERID
 604         disable         = no
 605 }
 606 </pre>
 607
 608 <p>Please make sure you know what you're doing before you install
 609 this!  If you are going to put Citadel somewhere other than <tt>/usr/local/citadel</tt>
 610 then change the directory name accordingly.  If you know of any other local
 611 peculiarities which need to be observed, edit the above configuration accordingly
 612 as well.  And, of course, if you're working remotely, make sure you can successfully
 613 log in using SSH before you start changing your telnet configuration, otherwise
 614 you could lock yourself out of your system (ask any networking specialist
 615 about the dangers of "working inline" -- then pull up a chair and get a fresh
 616 cup of coffee, because you're going to hear some war stories).</p>
 617
 618 <h3>Compiling the programs</h3>
 619
 620 <p>You can easily compile the Citadel system with the following commands:</p>
 621
 622 <pre>
 623 ./configure<br>make
 624 make install
 625 </pre>
 626
 627 <p>The 'configure' script will generate a Makefile from the Makefile.in,
 628 and it will also write the file "sysdep.h" to your Citadel directory.  Please
 629 do not edit sysdep.h or Makefile.in yourself.  The configure script will
 630 figure out your system dependencies and set everything correctly.</p>
 631
 632 <p>Mac OS X 10.1 and later are now supported.  (Sorry, 10.0 cannot
 633 be supported, now or in the future.)  You need to install the Developer Tools
 634 CD, which you can purchase or download for free from
 635 <a href="http://developer.apple.com">http://developer.apple.com</a>. Then run
 636 configure like this:</p>
 637
 638 <pre>
 639 env CC=/usr/bin/cc ./configure (options - see below)
 640 </pre>
 641
 642 <p>By default, the Citadel system will install in <tt>/usr/local/citadel</tt>.
 643 If you wish to place it in a different directory, you can instead do:</p>
 644
 645 <pre>
 646 ./configure --prefix=/export/home/citadel      (or whatever)
 647 </pre>
 648
 649 <p>If you've got Berkeley DB installed in a non-standard location,
 650 you can help the configure script find it by doing something like this:</p>
 651
 652 <pre>
 653 ./configure --with-db=/usr/local/BerkeleyDB-4.1
 654 </pre>
 655
 656 <p>The configure script prefers Berkeley DB if it is available, but
 657 will fall back to GDBM if it has to.</p>
 658
 659 <p>File permissions are always a bother to work with. You don't want
 660 Citadel to crash because someone couldn't access a file, but you also don't
 661 want shell users peeking into the binaries to do things like reading others'
 662 mail, finding private rooms, etc.  The Citadel server needs to be started
 663 as root in order to bind to privileged ports, but as soon as its initialization
 664 is finished, it changes its user ID to your BBS user ID in order to avoid
 665 security holes.</p>
 666
 667 <h3>Upgrading</h3>
 668
 669 <p>Upgrading to a new version uses the same build procedure as compiling
 670 the program for a fresh install, except that you want to do <tt>make install-exec</tt>
 671 instead of <tt>make install</tt>.  This will overwrite the programs but not
 672 your data.  <b>Be sure to shut down citserver during this process!</b>  If
 673 Citadel is running while you upgrade, you may face data corruption issues.</p>
 674
 675 <h3>The <tt>citadel.rc</tt> file</h3>
 676
 677 <p>The text-based client included with Citadel is suitable for BBS
 678 applications.  Much of its command set and other behavior is configurable
 679 through a Run Control (RC) file. The standard client looks for this file
 680 in the following locations:
 681 <ul>
 682 <li><tt>$HOME/.citadelrc</tt></li>
 683 <li><tt>/usr/local/lib/citadel.rc</tt></li>
 684 <li><i>your-Citadel-directory</i><tt>/citadel.rc</tt></li>
 685 </ul>
 686 The next couple of sections deal with client-side configuration.</p>
 687
 688 <h3>Using an external editor for message composition</h3>
 689
 690 <p>Citadel/UX has a built-in message editor.  However, you can also
 691 use your favorite text editor to write messages.  To do this you simply put
 692 a line in your citadel.rc file like this:</p>
 693
 694 <pre>
 695 editor=/usr/bin/vi
 696 </pre>
 697
 698 <p>The above example would make Citadel call the vi editor when using
 699 the <tt><b>.E</b>nter <b>E</b>ditor</tt> command. You can also make it the
 700 default editor for the <tt><b>E</b>nter</tt> command by editing the <tt>citadel.rc</tt>
 701 file.  <b>But be warned:</b> external editors on public systems can be a
 702 security hole, because they usually provide users with the ability to drop
 703 into a shell on the host system, or save files using names other than the
 704 name of the temporary file they are editing.  If you intend to use an external
 705 editor on a public BBS, make sure you use one that has been hardened for
 706 such a purpose -- one which has had the 'shell' and 'save as' commands disabled,
 707 as well as any other functions which a destructive user could use to gain
 708 unauthorized access to your host system.</p>
 709
 710 <h3>Printing messages</h3>
 711
 712 <p>Citadel/UX can send messages to a printer, or just about anywhere
 713 else in your system.  The variable <tt>PRINTCMD</tt> in <tt>citadel.rc</tt>
 714 specifies what command you use to print.  Text is sent to the standard input
 715 (stdin) of the print command.</p>
 716
 717 <p>So if you did this:</p>
 718
 719 <pre>
 720 printcmd="nl|pr|lpr -Plocal"
 721 </pre>
 722
 723 <p>...that would add line numbers, then paginate, then print on the
 724 printer named "local".  There's tons of stuff you can do with this feature.
 725  For example, you could use a command like <tt>cat &lt;&lt;$HOME/archive</tt>
 726 to save copies of important messages in a textfile.  Again, this is probably
 727 something you don't want to configure for a public BBS host -- most system
 728 administrators don't want remote users sending arbitrary things to local
 729 printers.</p>
 730
 731 <h3>URL viewing</h3>
 732
 733 <p>This is one more feature which is appropriate for local users.
 734  While reading a message that has Internet URL's in it, you can select the
 735 <tt><b>U</b>RL-view</tt> command, and it will perform some pre-defined action
 736 (usually, this is to open up the URL in a web browser).  For example:</p>
 737
 738 <pre>
 739 urlcmd=netscape -remote "openURL(%s)"
 740 </pre>
 741
 742 <p>In the above example, it would open up the URL in an open
 743 <a href="http://www.netscape.com/download">Netscape</a> window.</p>
 744
 745 <h3>Setup and login</h3>
 746
 747 <p>Before logging in for the first time, you must run the setup program.
 748 To begin this procedure, enter the following commands:</p>
 749
 750 <pre>
 751 cd /usr/local/citadel
 752 ./setup
 753 </pre>
 754
 755 <p>The setup program will guide you through a simple configuration
 756 procedure. It will ask you what directory to place your data files in --
 757 the default is the current directory, which is usually the sensible thing
 758 to select.  If you want to run more than one instance of Citadel on the same
 759 host, however, you can specify a different directory here -- just remember
 760 to specify the directory name again when you start up the server later on.</p>
 761
 762 <p><tt>setup</tt> will then shut down the Citadel service if it is
 763 found to be running.</p>
 764
 765 <p>You will then be prompted for the name of the system administrator.
 766 This is not merely a cosmetic option -- when you log in to your system a
 767 little while from now, you'll log in with this name, and it will automatically
 768 assign your account the highest access level.</p>
 769
 770 <p>Next, you will be prompted for the User ID of the Citadel account
 771 on your host system.  If you have an account called <tt>bbs</tt>, <tt>guest</tt>,
 772 or <tt>citadel</tt>, that account's UID will be the default.  If you are
 773 upgrading or reconfiguring an existing system, the existing value will be
 774 preserved.</p>
 775
 776 <p>Then you will be prompted for a server port number.  This is the
 777 TCP port which Citadel clients use to connect to your Citadel server.  In
 778 almost all cases, you want to use the default -- port 504, which is the official
 779 port number assigned by the IANA for Citadel implementations.</p>
 780
 781 <p>The Citadel service will then be started, and you will see the
 782 following message:</p>
 783
 784 <pre>
 785 Setup is finished.  You may now log in.
 786 </pre>
 787
 788 <p>Setup is now complete, on most systems, anyway.  Please see below
 789 to find out if you need to do anything else:</p>
 790
 791 <h3>Configuring your host system to start the service</h3>
 792
 793 <p><b>Please note:</b> this topic involves modifications made to
 794 <tt>/etc/services</tt> and <tt>/etc/inittab</tt> in order to configure your
 795 host system to automatically start the Citadel service.  <tt>setup</tt> will
 796 automatically perform these steps if it can, and if you allow it to -- just
 797 answer 'Yes' when prompted, and everything will be taken care of for you.
 798  If you answer 'No' -- or if your system is a little bit odd (for example,
 799 BSD systems don't have <tt>/etc/inittab</tt>) -- read this section and do
 800 what you need to in order to get things configured.</p>
 801
 802 <p>Before you can use Citadel, you must define the "citadel" service
 803 to your  system.  This is accomplished by adding a line to your /etc/services
 804 file that looks something like this:</p>
 805
 806 <pre>citadel            504/tcp                 # Citadel/UX Server<br></pre>
 807
 808 <p>504 is the port number officially designated by the IANA for use
 809 by Citadel.  There should not be any need to use a different port number,
 810 unless you are  running multiple Citadels on the same computer and therefore
 811 need a different port for each one.</p>
 812
 813 <p>The next step is to arrange for the server to start.  The <tt>citserver</tt>
 814 program is the main Citadel server.  Before we cover the recommended method
 815 of starting the server, let's examine its usage options:</p>
 816
 817 <pre>citserver [-hHomeDir] [-xDebugLevel] [-tTraceFile] [-d] [-f]<br></pre>
 818
 819 <p>The options are as follows:</p>
 820
 821 <p><tt>-hHomeDir</tt> - the directory your BBS data files live in.
 822  This should, of course, be a directory that you've run the <tt>setup</tt>
 823 program against to set up some data files.  If a directory is not specified,
 824 the directory name which was specified in the <tt>Makefile</tt> will be used.</p>
 825
 826 <p><tt>-xDebugLevel</tt> - Set the verbosity of trace messages printed.
 827  The available  debugging levels are: </p>
 828 <ul>
 829  <li>1 - Internal errors (failed thread creation, malloc problems,
 830 etc.) </li>
 831   <li>2 - Network errors (broken sockets, failed socket creation)
 832     </li>
 833   <li>3 - Begin and end of sessions, startup/shutdown of server </li>
 834   <li>5 - Server commands being sent from clients </li>
 835   <li>7 - Entry and exit of various functions  </li>
 836   <li>8 - Entry and exit of critical sections </li>
 837   <li>9 - Various debugging checkpoints (insanely verbose) </li>
 838 </ul>
 839
 840 <p><tt>-tTraceFile</tt> - Tell the server where to send its debug/trace
 841 output.   Normally it is sent to stdout.</p>
 842
 843 <p><tt>-d</tt> - Run as a daemon; i.e. in the background.  This switch
 844 would be necessary if you were  starting the Citadel server, for example,
 845 from an rc.local script (which is  not recommended, because this won't allow
 846 the server to automatically restart when it is shut down).</p>
 847
 848 <p><tt>-f</tt> - Defragment all the databases upon startup.  This
 849 isn't normally necessary due to the nature of the data stored in Citadel,
 850 but the option is provided in case you need it.  (Note that this only applies
 851 to GDBM installations; if you are using Berkeley DB it has no effect.)</p>
 852
 853 <p>The preferred method of starting the Citadel server is to place
 854 an entry in your /etc/inittab file.  This will conveniently bring the server
 855 up when your  system is up, and terminate it gracefully when your system
 856 is shutting down.   The exact syntax for your system may vary, but here's
 857 an entry that could be used on a Linux system:</p>
 858
 859 <pre>
 860 cit:2345:respawn:/usr/local/citadel/citserver -h/usr/local/citadel -t/dev/tty9 -x3
 861 </pre>
 862
 863 <p>In this example, we've chosen debugging level 3, and have the
 864 trace stuff output to one of the virtual consoles.  It's important to remember
 865 to turn off any getty that is set up on that virtual console, if you do this.
 866  After making this change, the command <tt>init q</tt> works on most systems
 867 to tell init to re-read the file.  If in doubt, just reboot the computer.</p>
 868
 869 <h3>Logging in for the first time</h3>
 870
 871 <p>At this point, your system is ready to run. Run the <tt>citadel</tt>
 872 program from the shell and log in as a new user.  NOTE: the first user account
 873 to be created will automatically be set to access level 6 (Aide).  This overcomes
 874 some obvious logistical problems - normally, Aide access is given by another
 875 Aide, but since there aren't any on your system yet, this isn't possible.</p>
 876
 877 <h3>Welcoming new users</h3>
 878
 879 <p>Sometimes you might decide that you want a welcome message (or
 880 several different messages) automatically mailed to new users upon their
 881 first login. Now there is a way to do this.  If you create a room called <tt>New
 882 User Greetings</tt>, and it is a <i>private</i> room (invitation-only probably
 883 makes the most sense), any messages you enter into that room will automatically
 884 be delivered to all new users upon registration.</p>
 885
 886 <p>You can put anything you want there: a welcome message, system
 887 policies, special information, etc.  You can also put as many messages there
 888 as you want to (although it really doesn't make sense to clutter new users'
 889 mailboxes with lots of junk).</p>
 890
 891 <p>Don't worry about wasting disk space, either.  Citadel has a single-instance
 892 message store, so all the new users are actually looking at the same copy
 893 of the message on disk.</p>
 894
 895 <h3>Space for adding your own client features (doors)</h3>
 896
 897 <p><b>Please take note!</b>  This function really represents the
 898 "old" way of doing things, and it doesn't fit in well with the client/server
 899 paradigm.  Please consider it "deprecated" because it may be removed someday.</p>
 900
 901 <p>The "doorway" feature is just a generic way to add features to
 902 the system. I called it "Doorway" to make it resemble the doors on non-Unix
 903 boards, but as we all know, us Unix types don't have to write special code
 904 to access the modem. :-)  Anyway, when a user hits the <tt><b>*</b></tt>
 905 (doorway) command, Citadel does...</p>
 906
 907 <pre>
 908 USERNAME=(username); export USERNAME
 909 ./subsystem (user-number) (screen-width) (access level)
 910 </pre>
 911
 912 <p>...so you can put whatever you want in there.  I suggest putting
 913 in a menu program to allow the users to pick one of a number of programs,
 914 etc.  Do be aware that door programs will only be available when the client
 915 and server programs are running on the <i>same</i> computer, and when the
 916 user is running the text-mode client.  Because of these restrictions, Door
 917 programs are being utilized less and less every day.</p>
 918
 919 <h3>Troubleshooting and getting help</h3>
 920
 921 <p>That's just about all the information you need to install the
 922 system.  But if you get stuck, you can visit UNCENSORED! BBS and report a
 923 problem or ask for help.  But if you intend to report a problem getting the
 924 Citadel server to run, <i>please</i> double-check the following things first:
 925 </p>
 926 <ul>
 927  <li>Did you do <tt>./configure &amp;&amp; make &amp;&amp; make install</tt>
 928  ?? </li>
 929   <li>Did you run setup? </li>
 930   <li>Did you start the server? </li>
 931 </ul>
 932
 933 <p>To report a problem, you can log on to UNCENSORED! or any other
 934 BBS on the Citadel network which carries the <tt>Citadel/UX&gt;</tt> room.
 935  Please DO NOT e-mail the developers directly.  Post a request for help on
 936 the BBS, with all of the following information: </p>
 937 <ul>
 938  <li>The exact nature of your difficulty </li>
 939   <li>A transcript of the error message(s) if possible </li>
 940   <li>The version of Citadel you are running </li>
 941   <li>The version of Berkeley DB present on your system </li>
 942   <li>Which operating system you are running, and what version </li>
 943   <li>If you are running a Linux system, we need to know which distribution,
 944 and the version of the kernel, libc, and pthreads you are using (it would
 945 help to post the output of a <tt>ldd ./citserver</tt> command). </li>
 946 </ul>
 947   </div>
 948  </div>
 949 </body>
 950 </html>