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