home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS - Coast to Coast / simteldosarchivecoasttocoast2.iso / citadel / k2ne603c.zip / CTDLCNFG.DOC < prev    next >
Text File  |  1991-10-20  |  13KB  |  305 lines
  1. A Line by Line Explanation of CTDLCNFG.SYS (V5.18 update, May 1991)
  2. - ---- -- ---- ----------- -- ------------
  3.  In the following I will explain the meaning of each line in the
  4. CTDLCNFG.SYS file by putting the explanation immediately following
  5. the line it deals with.
  6.  
  7. #nodeTitle "the Jersey Devil"
  8.  This line tells Citadel the name of your BBS.  If you do not
  9. use a BANNER.BLB file, then the string between the quotes will
  10. be displayed to your callers in the phrase "Welcome to ...".
  11.  
  12. #nodeId "US 609 893 2152"
  13.  This is the telephone number that your bbs uses.  The networker
  14. uses this to identify your bbs to others that you may be netting with.
  15.  
  16. #baseRoom "Lobby"
  17.  The "baseRoom" is the first room your users will see when they log in.
  18.  
  19. #MainFloor "Main"
  20.  The MainFloor is the "first floor" of your system.  It will ALWAYS
  21. contain your baseRoom, the Mail room and the Aide room.  Other rooms
  22. may also be on this floor, or can be moved to other floors once they
  23. are created by you or one of your Aides.
  24.  
  25. #CRYPTSEED 64
  26.  Cryptseed was originally used by file encryption algorithms which
  27. are no longer supported.  We left it in the code for a possible future
  28. use, so you should leave it in your CTDLCNFG.SYS file.  The value may
  29. be any non-zero two-digit number.
  30.  
  31. #AIDESEEALL 0
  32.  If you want your Aides to automatically "know" any hidden rooms on your
  33. system, you should set AideSeeAll to 1, otherwise 0.
  34.  
  35. #ROOMOK 1
  36.  This determines whether anyone can create rooms, or only Aides.  If you
  37. want only Aides to create rooms, set this to 0.
  38.  
  39. #ALLMAIL 1
  40.  If you want only Aides to be able to send mail to all users, set this to
  41. 0.  If you want all your users to be able to use private mail, set it to 1.
  42.  
  43. #sysopName "Vince Quaresima"
  44.  Put the name you want your users to know you by on this line.
  45.  
  46. #NEVERCHAT 0
  47.  This replaces the "nochatatall" load-line parameter in CTDL.EXE.
  48.  To completely disable CHAT, use a 1 here.  This option is NEW
  49.  as of version 5.18.
  50.  
  51. #SESSIONTIMELIMIT 60
  52.  This defines the maximum time permitted for any one logged session.
  53.  The variable (60 in this example) is in minutes.  This option is NEW
  54.  as of version 5.18.
  55.  
  56. #NEWDOORPRIVS 1
  57.  If you want your new users to automatically get door privileges, use
  58. 1.  Otherwise, use 0.  This option is NEW as of version 5.18.
  59.  
  60. #LOGTRY 3
  61.  This determines how many times a caller can enter a bad password before
  62. the system drops carrier on him.  3 seems like a reasonable number.  It
  63. gives chances to correct honest mistakes and yet still eliminates most
  64. hacking.  This option is NEW as of version 5.18.
  65.  
  66. #ANSICONSOLE 1
  67.  This replaces the ANSI parameter in the load-line for CTDL.EXE, and when
  68. set to 0 it disables ANSI color support to the system console.  When set
  69. to 1, ANSI colors are used at the console, and the COLTB= "color palette"
  70. is utilized.  See the relevant INCREM file for a description of COLTB=.
  71. This option is NEW as of version 5.18.
  72.  
  73. #MODEMSPEED 1
  74.  If your modem can respond properly when your computer "dumps" control
  75. commands at full speed, set this to 1.  If your modem requires a slower
  76. rate, set it to 0.  Note: True Hayes modems cannot respond to high-speed
  77. dumps, so use 0 if you have a "real Hayes."  Most other modems can use 1.
  78. This option is NEW as of version 5.18.
  79.  
  80. #LOGINOK 0
  81.  If you want folks to be able to login and set up their own accounts without
  82. bothering to be validated, set LOGINOK to 1, otherwise, when it is 0, they
  83. can only send mail to the sysop.
  84.  
  85. #ENTEROK 0
  86.  If you set ENTEROK to 1, then users will be able to enter messages without
  87. being logged in.  Some folks like it that way.
  88.  
  89. #READOK 0
  90.  If READOK is set to 1, then an unlogged user can wander around your system
  91. and read messages in any room he can get to.  Otherwise, with READOK 0, the
  92. only room an unlogged user can read is your baseRoom.
  93.  
  94. #MSG-SLOTS 95
  95.  This is the maximum number of messages in any one room other than Mail>.
  96.  
  97. #MAIL-SLOTS 58
  98.  This is the maximum number of messages in the Mail> room for each user.
  99.  
  100. #MAXROOMS 80
  101.  This is the maximum number of rooms on your system.  DO NOT EXCEED 127!!
  102.  
  103. #MESSAGEK 700
  104.  This is the size of your CTDLMSG.SYS file in KiloBytes.
  105.  
  106. #LOGSIZE 200
  107.  This is the number of user-accounts you want to be able to handle.
  108.  
  109. #HELPAREA "c:helparea"
  110.  This is where your .HLP, .MNU, and .BLB files go.
  111.  
  112. #LOGAREA "c:system"
  113. #ROOMAREA "c:system"
  114. #MSGAREA "c:system"
  115. #FLOORAREA "c:system"
  116. #CALLAREA "c:system"
  117. #HOLDAREA "c:system"
  118.  These variables tell Citadel where to find the files it needs to maintain
  119. your BBS in an orderly fashion.  You should not have to change these.  Once
  120. you are "up and running" you should NEVER change these.
  121.  
  122. #IBM 1
  123.  This variable should always be a 1.  It tells Citadel you are running on a
  124. machine compatible with the IBM PC (XT or AT).  There are a few machines out
  125. there that simply refuse to run this software.  If you are unfortunate enough
  126. to own one of these, there is only one solution short of buying a new computer,
  127. and that is to obtain the source code to Citadel:K2NE and hack it to suit your
  128. operating platform.  Most "plain vanilla" clones, from ordinary XT machines
  129. through and including '386 monsters run this software just fine, so chances
  130. are very much in your favor.
  131.  
  132. #COM 1
  133.  The COM port you are using (COM1 and COM2 are supported).
  134.  
  135. #SYSBAUD 2
  136.  This tells Citadel the maximum baudrate your modem can handle.
  137.  (0=300, 1=1200, 2=2400, 4=9600)
  138.  
  139. #SEARCHBAUD 0
  140.  If you want your users to have to press ENTER until Citadel figures
  141. out their baudrate, set SEARCHBAUD to 1.  When it is set to 0, Citadel
  142. will read the modem result codes to determine the speed of the incoming
  143. caller.
  144.  
  145. #RESULT-300 "1"
  146. #RESULT-1200 "5"
  147. #RESULT-2400 "10"
  148. #RING        "2"
  149.  These tell Citadel how your modem responds when it sends result messages
  150. or codes.  The examples above indicate that the modem in use is sending
  151. numeric or "terse" result codes.  This is very strongly recommended.
  152. Consult your modem manual for the codes your modem uses.  The ones in
  153. the lines above are compatible with the Hayes Smartmodem-2400.
  154.  
  155. #MODEMSETUP "string"
  156.  This is the string used to configure your modem prior to going online.
  157. If you have a Hayes-compatible modem, this string should start off with
  158. "AT" and contain the commands peculiar to your hardware.  Note that
  159. Citadel MUST be sent NUMERIC result codes!  It would also be helpful to
  160. NOT echo-back your commands.  Beginning with Citadel:K2NE V6.01, the
  161. presence of this command (#MODEMSETUP) is MANDATORY!
  162.  
  163. #MODEMRESET "string"
  164.  If your modem has problems resetting to the proper baudrate in between
  165. calls (or after networking) then perhaps it needs a bit of help!  You can
  166. put a modem reset string here.  This command is OPTIONAL.  If you leave it
  167. out, Citadel:K2NE will DEFAULT to a reset-string of "AT", which will be
  168. sent after each carrier-session and prior to resending the MODEMSETUP string.
  169. This option is NEW with Citadel:K2NE Version 6.01.
  170.  
  171. #DTR-DELAY n
  172.  Some modems need a bit of a waiting period after pulling DTR down in order
  173. to allow carrier to drop.  If your modem is having a problem hanging up the
  174. phone at the end of a call, then try using this command.  You do NOT need
  175. to have this command in order for Citadel:K2NE to configure itself properly.
  176. If you leave it out, Citadel will default to a value of 0, otherwise the
  177. DTR-DELAY value will assume whatever INTEGER you type for "n" (1 to 99).
  178. Delay introduced is approximately 20 milliseconds times the value of n.
  179. This option is NEW with Citadel:K2NE Version 6.01.
  180.  
  181. #nodeName "Jersey Devil"
  182.  This string is what gets used in networked messages (the "@Jersey Devil"
  183. that you see in messages from Jersey Devil in networked rooms, for example).
  184.  
  185. #NETWORK 1
  186.  Set to 0 if you are not participating in networking.
  187.  
  188. #LONG-HAUL 1
  189.  Set to 0 if you are not participating in networking.
  190.  
  191. #NewNetPrivs 1
  192.  Set to 0 if you do not want new users to have net privileges.
  193.  
  194. #NETAREA "c:system"
  195.  Tells Citadel where to put net-related stuff, and where to find
  196. messages coming in from other systems you may network with.
  197.  
  198. #NETLOG 1
  199.  Set to 0 if you are not in the net or if you don't want a
  200.  logfile of your net sessions kept on disk.  This replaces
  201.  the command-line parameter "+netlog" beginning with V5.18.
  202.  
  203. #SHARED-ROOMS 25
  204.  Maximum number of networked rooms on your system.
  205.  
  206. #NET-ARCH-ROOMS 25
  207.  Maximum number of net-archive rooms on your system (obviously, this
  208. can't be greater than the number in the previous line!).
  209.  
  210. #NET_RECEPT_AREA "c:\k2ne\net"
  211.  If another system sends you a file via the network, this is where Citadel
  212. will store it for you.
  213.  
  214. #NET_AREA_SIZE 1000
  215.  Total size of the network for any one session (in kilobytes).
  216.  
  217. #MAX_NET_FILE 750
  218.  This is the maximum file-size that your BBS will accept from another system
  219. during networking (in kilobytes).
  220.  
  221. #callOutPrefix "ATM1DT"
  222.  Rather obvious, eh?
  223.  
  224. #callOutSuffix "\r"
  225.  The "\r" tells Citadel that everytime your modem is dialed, it should end
  226. the dial instruction with a RETURN.
  227.  
  228. /* sample event line */
  229. -#event <days> <time> <class> <type> <duration> <warning string> <depends>
  230.  
  231. /* External event processor */
  232. #event All 00:01 external preempt 1 "Nightly Housekeeping" 9
  233.  
  234. /* Regular Network schedules */
  235. #event All 04:00 network preempt 15 "Networking" 1
  236.  
  237. /* Anytime-Net time-frames */
  238. #event All 6:01 anytime-net quiet 118 "" 9     /* 6:01am to 7:59am - daily */
  239. #event All 08:00 anytime-net quiet 1139 "" 8   /* 8:00am to 2:59am - daily */
  240. #event All 03:00 anytime-net quiet 45 "" 8     /* 3:00am to 3:45am - daily */
  241.  
  242. /* Download time limits */
  243. #event All 14:00 dl-time quiet 749 "" 30   /* 2:00pm to 2:29am */
  244. #event All 2:30 dl-time quiet 270 "" 1     /* 2:30am to 7:00am */
  245. #event All 7:01 dl-time quiet 418 "" 60    /* 7:01am to 1:59pm */
  246.  
  247. The preceeding lines control "what happens when" while your bbs is running.
  248. For additional information, please consult CTDL_MANual's files.
  249.  
  250. #sysPassword "c:fleegle.sys"
  251.  This tells Citadel the name of the FILE containing the Sysop PASSWORD.
  252. This is NOT the actual password.  The password in this example would
  253. go in a file called FLEEGLE.SYS located in the same directory as CTDL.EXE.
  254. The actual password MUST be at LEAST 15 characters in length.
  255.  
  256. #MIRRORMSG 0
  257.  Set this to 1 if you are going to use a RAMdisk to hold your message file.
  258.  
  259. #MSG2AREA "c:system"
  260.  This tells Citadel where to store your RAMdisk (if used).
  261.  
  262. /******* patch file for external Hayes 2400 clones ********/
  263. /* This collection of routines is absolutely essential if */
  264. /* you are using ANY type of 2400bps modem which claims   */
  265. /* Hayes compatibility.  They won't hurt you if you are   */
  266. /* running at slower baudrates, and are probably needed   */
  267. /* for proper functioning of auto-baudrate detection.     */
  268. /*  ++NOTE++ Be sure to set the proper value for LOADI    */
  269. /* in the lines where baudrate dependency is commented!   */
  270. /**********************************************************/
  271.  
  272. #start HANGUP x
  273.  
  274. #code LOADI 0
  275. #code OUTP 3FC   /* change to 2FC for COM2              */
  276. #code PAUSEI 25  /* this wait holds DTR down for 250 ms */
  277. #code LOADI 1
  278. #code OUTP 3FC   /* change to 2FC for COM2              */
  279. #code LOADI 83
  280. #code OUTP 3FB   /* change to 2FB for COM2              */
  281. #code LOADI 30   /* 30h = 2400 baud   60h = 1200 baud   */
  282.                  /* 18h = 4800 baud   0Ch = 9600 baud   */
  283. #code OUTP 3F8   /* change to 2F8 for COM2              */
  284. #code LOADI 0
  285. #code OUTP 3F9   /* change to 2F9 for COM2              */
  286. #code LOADI 3
  287. #code OUTP 3FB   /* change to 2FB for COM2              */
  288. #code OUTSTRING "AT" /* wake up modem at baudrate, then...        */
  289. #code PAUSEI 20  /* this 250 ms wait gives modem chance to settle */
  290. #code OUTSTRING "ATS2=255E0V0X3M1S0=2&D2" /* your modem reset string!  */
  291. #code PAUSEI 20  /* this 250 ms wait gives modem chance to settle */
  292. #code RET x      /* irrelevant return value        I              */
  293.  
  294. #start INITPORT x  /* this routine is now dummied to keep CTDL happy */
  295. #code RET x        /* don't care about x */
  296. #alldone x x       /* end of file        */
  297.  
  298. That last line, "#alldone x x", MUST be the last line of
  299. the CTDLCNFG.SYS file.  That is ABSOLUTELY essential!!
  300.  
  301. And that is all there is to it!  Dump a copy of this file to your printer
  302. so that you can have it as a reference should you need to make adjustments
  303. to CTDLCNFG.SYS somewhere down the road when all this stuff has been
  304. long forgotten!
  305.