home *** CD-ROM | disk | FTP | other *** search
/ Crawly Crypt Collection 1 / crawlyvol1.bin / bbs / citadel2 / install.doc < prev    next >
Text File  |  1989-12-01  |  7KB  |  151 lines
  1. /************************************************************************/
  2. /*                  install.doc                */
  3. /************************************************************************/
  4.  
  5. /************************************************************************/
  6. /*                History                 */
  7. /*                                    */
  8. /* 87Mar01 orc    Modified for STAdel.                    */
  9. /* 85Oct15 HAW    Details update.                     */
  10. /* 85Apr27 HAW    Modified for MS-DOS.                    */
  11. /* 82Dec06 CrT    Created.                        */
  12. /************************************************************************/
  13.  
  14. /************************************************************************/
  15. /*                Audience                */
  16. /*                                    */
  17. /* People with the disks in one hand and this listing in the other,    */
  18. /* wondering, "What next?"                        */
  19. /************************************************************************/
  20.  
  21. /************************************************************************/
  22. /*                Purpose                 */
  23. /*                                    */
  24. /*  Step-by-step guide to get Citadel to sit up and bark.        */
  25. /************************************************************************/
  26.  
  27.     To quote a paragraph from aabuyme.doc:
  28.  
  29.     Citadel is written in Alycon C.  The distributed system can be
  30.     installed and run without recompilation in most cases.  Citadel
  31.     needs an Atari ST and an auto-answer modem.
  32.  
  33.     The source files run to about 150K, the .TOS files to about 120K.  In an
  34.     operating system, the message and userlog files together take about
  35.     150K, and one would normally like about 200K for message text, to
  36.     keep the wraparound time longer than a week.
  37.  
  38.     If that doesn't describe your system, this isn't the file for you.
  39. Either recycle the disks, or drag out the source code and documentation
  40. and settle down to some serious hacking...
  41.  
  42.     Still with us?  OK.  For purposes of getting the basic system working,
  43. you need to sort out and get acquainted with the following files:
  44.  
  45. CONFIGUR.TOS    A special installation program.
  46. CTDLCNFG.SYS    (CiTaDeL CoNFiGuration SYStem file.)  You will edit your
  47.         local system customizations into this file and then
  48.         feed it to CONFIGUR.TOS, which will do all the remaining
  49.         work for you.  (Do you believe that?)
  50. CITADEL.TOS    This is the actual Bulletin Board ("BB" hereafter) program.
  51.  
  52.  
  53. NOTE: Sometimes CONFIGUR.TOS and CITADEL.TOS are called CONFG.TOS and CTDL.TOS,
  54. respectively.
  55.  
  56.  
  57.     In order to get lost properly, it is very important to have a map.
  58. Very briefly, the installation steps are:
  59.  
  60.     (1)   Edit CTDLCNFG.SYS.
  61.  
  62.     (2)   Feed CTDLCNFG.SYS into CONFIGUR.TOS.     CONFIGUR.TOS will:
  63.        (A)  Create  CTDLLOG.SYS,   a file to contain all the userlog entries.
  64.        (B)  Create  CTDLMSG.SYS,   a file to contain all the messages.
  65.        (C)  Create  CTDLROOM.SYS,  a file to contain all the rooms.
  66.  
  67.        (D)  Create  CTDLTABL.SYS,  a file which contains indices to the
  68.                    first four files plus stuff derived
  69.                    from the CTDLCNFG.SYS configuration file.
  70.  
  71.     (3)   Run CITADEL.TOS, which read the above files
  72.       and then let you enter messages, create rooms and all manner of
  73.       good things.
  74.  
  75.  
  76.     Three steps.  How trivial can you get?  But please do study the
  77. above carefully enough to get a feel for what's going on and an
  78. understanding of what the major files do.
  79.  
  80.   *    *    *     *    *    *    *    *      *    *    *     *    *    *    *
  81.  
  82. (1).
  83.     So: go edit CTDLCNFG.SYS.  It's massively self-documented,
  84. just work your way through top to bottom putting in values appropriate
  85. to your system.  You may wish to use a small message-file size during
  86. testing to reduce the length of time CONFIGUR.TOS takes to index the
  87. file.  (It reads through the complete file each time it is run.)
  88.     A few gotchas to watch for:
  89.     Really, truly, all the instructions take hex values.  If you put
  90. octal or decimal numbers in, it's not going to work.
  91.     CONFIGUR.TOS is not very bright.  It wants to see blanks (not
  92. tabs or carriage-returns) between and following all the fields it
  93. reads.    On the other hand, it really doesn't care what happens on
  94. lines which don't start with "#", or on the trailing half of those
  95. which do.  If you end each instruction line with a comment and put
  96. single blanks between the arguments, as I have, you should have no
  97. problems on this score.  (BASIC programmers: don't worry, the comments
  98. won't slow the system down.  Relax!).
  99.  
  100.  
  101. (2)
  102.     Run CONFIGUR.TOS.  CONFIGUR.TOS expects to find CTDLCNFG.SYS on
  103. the default disk in the current directory.  Once it has read this file,
  104. it will shift to HOMEDISK.
  105.     CONFIGUR.TOS is used to rebuild a system as well as install it.
  106. When it fails to find CTDLMSG.SYS, CTDLROOM.SYS and CTDLLOG.SYS, it
  107. will create them and remind you to initialize them.  When it asks you
  108. if you want to initialize them (and then double-checks on each individual
  109. file), type a "Y" each time first time through.  On subsequent runs,
  110. you can answer "N", which will leave the three data files untouched,
  111. only building new indices etc for a new CTDLTABL.SYS file.  This way
  112. you can reconfigure the system within reasonable limits without trashing
  113. all existing messages, rooms etc.
  114.     CONFIGUR lists various things as it runs, mostly to convince you
  115. it hasn't crashed yet.    Don't worry particularly unless it seems
  116. excited about something. Cheap code?  Well, you get what you pay for...
  117.  
  118. (3)
  119.     Run CITADEL.TOS.  It will expect to find CTDLTABL.SYS on the default
  120. disk in the current userspace when it is run.  It will then expect to
  121. find everything else on HOMEDISK in the root dir, with the sole exception of
  122. CTDLMSG.SYS, which it will look for on MSGDISK in the root.  You
  123. should copy all the .HLP, .BLB and .MNU files in the distribution into
  124. HOMEDISK in root, since CITADEL.TOS will expect to find them
  125. there.    (It won't crash without them, but you'll be missing all
  126. the automatic hints etc.)
  127.     CITADEL.TOS will delete CTDLTABL.SYS after it has
  128. read it, and will recreate CTDLTABL.SYS only when you exit.  This is
  129. because it contains indices to the other three data files, and it
  130. would not be good to load an out-of-date index file.  If
  131. CITADEL.TOS crashes, leaving you without a CTDLTABL.SYS, just run
  132. CONFIGUR.TOS again to recreate it.
  133.     Play around with CITADEL.TOS for awhile: learn to enter messages,
  134. create rooms, read messages, and so forth.  Create several different
  135. identities, and log them in and out in rotation to see how new
  136. messages and rooms with new messages are found.  (The system is much
  137. easier to understand with lots of rooms and messages around to
  138. experiment on!)
  139.  
  140.     When things are clearly working correctly, try running over the
  141. modem.  You'll need to have someone dialing the system up to test that
  142. carrier-detect etc are working correctly.  This will probably be painful.
  143. Note that you can use "chat mode" to type directly to the modem,
  144. bypassing everything but the modem routines.
  145.  
  146.     If you survive this far... congratulations!   and... Welcome!
  147.  
  148.  Ulterior notes:
  149.  o There has been no testing of Citadel residing anywhere besides in
  150.    the root directory.
  151.