home *** CD-ROM | disk | FTP | other *** search
/ Crawly Crypt Collection 1 / crawlyvol1.bin / bbs / citadel2 / ctdlcnfg.sys < prev    next >
Text File  |  1989-12-01  |  17KB  |  329 lines
  1. /************************************************************************/
  2. /*                ctdlCnfg.sys                */
  3. /*                                    */
  4. /*    configuration file for Citadel bulletin board system.        */
  5. /*    This is >>>NOT<<< a C file!  It is read in by confg.exe     */
  6. /*    which sets up a "CTDLTABL.SYS" binary file recording the local    */
  7. /*    configuration parameters.  (CTDLTABL.SYS is read by the other    */
  8. /*    Citadel programs.)                        */
  9. /*                                    */
  10. /*    WARNING WARNING WARNING WARNING WARNING WARNING WARNING!!!!    */
  11. /*    This version of CONFIGUR uses decimal numbers throughout; if    */
  12. /*    you leave the existing hexidecimal numbers in, ugly things    */
  13. /*    will happen to your system.                    */
  14. /*                                    */
  15. /************************************************************************/
  16.  
  17. /************************************************************************/
  18. /*                History                 */
  19. /*                                    */
  20. /* 87Apr28 orc    More things are changed around, for added confusion.    */
  21. /* 87Apr05 orc    STadel version 2; gone to decimal numbers.        */
  22. /* 87Feb16 orc    STadel version 1                    */
  23. /* 86Jul09 HAW    Added muchos.  The history gets worse.            */
  24. /* 85Nov10 HAW    Reviewed.  Note: This file's history is, uh, execrable. */
  25. /* 85Aug26 HAW    NETDISK, MIRRORMSG, MSG2DISK.                */
  26. /* 85Mar03 HAW    Customize for Sperry PC.                */
  27. /* 85Feb20 HAW    Kill off MDATA.                     */
  28. /* 85Feb17 HAW    Install 300/1200 access code.                */
  29. /* 85Jan22 HAW    Modified to read MSDOS clock.                */
  30. /* 84Sep03 HAW    Now fer MS-DOS!                     */
  31. /* 84Jun10 HAW    ALLMAIL...                        */
  32. /* 83Feb26 CrT    LOGINOK, ENTEROK & READOK...                */
  33. /* 83Feb06 CrT    Mods to debug ICS files on ODD-DATA machine...        */
  34. /* 82Nov24 CrT    This file now handles H89 with SmartModem @ port D8    */
  35. /* 82Nov21 CrT    Created.                        */
  36. /************************************************************************/
  37.  
  38. /************************************************************************/
  39. /*   This file must be edited to be appropriate to the local environ-    */
  40. /* ment.  It specifies the name of the installation, et cetera.        */
  41. /* This file is then processed by CONFGUR.TOS, which produces the    */
  42. /* ctdlTabl.sys file which is read the other Citadel programs --    */
  43. /* currently CITADEL.TOS and some utilities.                */
  44. /*    Lines not beginning with "#" are ignored by CONFG and may be    */
  45. /* deleted once the file is successfully configured -- they are purely    */
  46. /* documentary.                             */
  47. /************************************************************************/
  48.  
  49. /************************************************************************/
  50. /* GENERAL STRING FORMATTING CONTROLS:                    */
  51. /* Strings in CTDLCNFG.SYS can be forcefully formatted by embedding    */
  52. /* certain strings of characters in them. All of these strings of    */
  53. /* characters are started by the use of the '\' character.  When Citadel*/
  54. /* sees '\', it will replace the '\' and the following character(s)    */
  55. /* with the value specified in the following table.            */
  56. /*       "\n": CR-LF                            */
  57. /*       "\t": Tab character                        */
  58. /*       "\b": Non-destructive Backspace                */
  59. /*       "\r": CR                            */
  60. /*       "\f": Formfeed                        */
  61. /*       "\\": Backslash                        */
  62. /*       "\<xxx>": The octal* ASCII value is output            */
  63. /* Strings that are output via the formatter must conform with normal    */
  64. /* formatting conventions in order for the desired effect to be     */
  65. /* achieved. For example, if you wish to force a CR-LF at a certain,    */
  66. /* your string at that point would look like                */
  67. /*    "...\n ..."                            */
  68. /* NOTE THE SPACE following the "\n"!                    */
  69. /*   The following strings are output via the formatter:        */
  70. /*      #nodeTitle                            */
  71. /*      #baseRoom                            */
  72. /*   The following strings are not output via the formatter:        */
  73. /*        #modemSetup                            */
  74. /*      #callOutPrefix                        */
  75. /*      #callOutSuffix                        */
  76. /*      #nodeId      <In fact, meaningless here>            */
  77. /*      #nodeName      <In fact, meaningless here>            */
  78. /*      #sysPassword      <In fact, meaningless here>            */
  79. /* Explanations of what these strings do follows in this file        */
  80. /*                                    */
  81. /************************************************************************/
  82.  
  83. /* nodeTitle will be printed whenever CITADEL.TOS is run, and should    */
  84. /* identify your local installation, i.e. "Welcome to .."        */
  85. #nodeTitle "your system"
  86.  
  87. /* nodeName is purely for networking purposes.    Messages which        */
  88. /* originated on your system will have headers looking like        */
  89. /* 82Nov23 From Cynbe ru Taren @ODD-DATA
  90. /* This should be a short (for the sake of the reader!) mnemonic    */
  91. /* identifying your node for humans.                    */
  92. #nodeName "your system"
  93.  
  94. /* nodeId is also purely for networking purposes.  Messages which    */
  95. /* originate on your system will be marked with the nodeId, but it will */
  96. /* not normally be printed out.  It is primarily for the use of the    */
  97. /* networking support software, and forms a globally unique name and    */
  98. /* address of your system.  It consists of a country abbreviation    */
  99. /* followed by area code and phone number.  (The "country codes" listed */
  100. /* in the phone book are >not< fixed, but depend on the country the    */
  101. /* call is originating from.  They are basically routing codes rather    */
  102. /* than addresses.)  Country abbreviation for the US is "US", for    */
  103. /* Canada is "CA".  (For others, see COUNTRY.DOC.)            */
  104. #nodeId "US 612 666 6666"
  105.  
  106. /************************************************************************/
  107. /* #sysPassword specifies the file that contains a string that will    */
  108. /* act as the password to the remote sysop abilties.  If this        */
  109. /* parameter is not specified, or if the file is not found, or is    */
  110. /* unreadable, then remote sysop abilities are disabled.  Only Aides    */
  111. /* can access remote sysop abilities, and they must* know the exact    */
  112. /* password, up to and including the case of the individual letters.    */
  113. /* Since a hacker could badly damage a system by gaining access to the    */
  114. /* remote Sysop capabilities, use of this feature is not        */
  115. /* recommended.  To access sysop abilities from remote, type CTRL-L    */
  116. /* at any room prompt. A password will be requested if you are an    */
  117. /* aide. If the correct password is given, then you have access to    */
  118. /* sysop capabilities, plus some of the room editing capabilities    */
  119. /* normally restricted to sysConsole aides.                */
  120. #sysPassword ""     /* No remote sysop capabilities         */
  121.  
  122. /* baseRoom is the homeroom of the Citadel in operation, the place you    */
  123. /* go when there are no more rooms with unread messages left.  This is    */
  124. /* usually known as the Lobby> on most systems.  It's simply a nice,    */
  125. /* easy way to customize and give character to your system..        */
  126. #baseRoom "Ybbol"
  127.  
  128. /* LOGSIZE is the number of entries that you want in your log. Once    */
  129. /* you've selected a log size and have configured, you may NOT shrink    */
  130. /* the log except by destroying the log totally. There is a utility    */
  131. /* available for expanding the log, called LEXPAND.  Each log entry    */
  132. /* needs ??? bytes on disk (I know that a 180 entry log requires app.    */
  133. /* 88K), so plan accordingly.                        */
  134.  
  135. #define LOGSIZE 10
  136.  
  137. /* CRYPTSEED is a number used in encrypting the password file.    Change    */
  138. /* it once when you install the system, but not thereafter -- or you    */
  139. /* won't be able to read the existing files any more.            */
  140.  
  141. #define CRYPTSEED  553
  142.  
  143. /* MESSAGEK sizes "ctdlmsg.sys", the file message text is stored in.    */
  144. /* The size of this parameter together with the rate message text is    */
  145. /* entered at determines message lifetime.  ICS ran for a few months    */
  146. /* with 87K, and message lifetime sometimes dropped below 3 days,    */
  147. /* upsetting the weekly callers.  A one-week minimum seems the target    */
  148. /* to try for.    ICS is currently (82Nov26) running a 250K message file. */
  149.  
  150. #define MESSAGEK  100        /* number of Kbyte to use in ctdlmsg.sys*/
  151.  
  152. /* The following 3 parameters specify on what directories STadel should    */
  153. /* look for its personal data files. These parameters take the form of    */
  154. /* drive:pathname.  (a:\help, c:\system, etc)                */
  155. /*                                    */
  156. /* helpDir: Location of all .HLP, .BLB, and .MNU files (i.e., all of    */
  157. /*   the help files), which is generated by CONFIGUR.TOS and kept up    */
  158. /*   to date by CITADEL.TOS.                        */
  159. /* msgDir: Location of CTDLMSG.SYS, the message file. (This is the    */
  160. /*   primary message file; see the parameter MIRRORMSG later in this    */
  161. /*   file.)                                */
  162. /* sysDir: Location of CTDLLOG.SYS and CTDLROOM.SYS.            */
  163.  
  164. #helpDir "a:\help\"
  165. #sysDir "a:\sys\"
  166. #msgDir "a:\msg\"
  167.  
  168. /* the trailing \ is not necessary -- configur strips them off the path    */
  169. /* and Citadel puts a \ between the pathname and the appropriate file.    */
  170.  
  171. /* MIRRORMSG: This parameter should be used when you have a RAM disk    */
  172. /* that contains the message file, and want to have the message file    */
  173. /* continuously backed up. Setting MIRRORMSG to 1 tells Citadel-86 to    */
  174. /* expect the file to be both read from and written to be on        */
  175. /* directory msgDir (and this should specify the RAM disk), and the    */
  176. /* file to only be written on to be on mirrorDir (described below).    */
  177. /* This should save wear 'n tear on your message drive while (almost)    */
  178. /* ensuring no loss of message data due to crash/power loss.        */
  179. #define MIRRORMSG 0        /* Change it to 1 if you want the above */
  180.  
  181. /* mirrorDir is the location of the file that should only be written to.*/
  182. /* This SHOULD be a normal disk rather than a RAM drive. This parameter */
  183. /* is only used if MIRRORMSG is 1. Drive specification is as the same    */
  184. /* as msgDir, sysDir, etc....                        */
  185. #mirrorDir "a:\backup"
  186.  
  187. /* netDir specifies the location of all net files: scratch files,    */
  188. /* any and all *.ML files, and CTDLNET.SYS. PLEASE do not* specify    */
  189. /* a RAM disk; crashes may leave you with using *.ML files that     */
  190. /* shouldn't exist any longer (a lesson learned at Dog House). Also,    */
  191. /* don't let this disk fill up if you ARE in networking mode; loss of    */
  192. /* data can occur if you do.                        */
  193. #netDir "a:\net"
  194.  
  195. /* The CALL-LOG parameter allows the optional generation of the     */
  196. /* CALLLOG.SYS file.  If nonzero, the parameter #auditDir is where    */
  197. /* the calllog is placed, and if zero, no calllog is generated.        */
  198. #define CALL-LOG 0            /* Feature disabled        */
  199.  
  200. /* if CALL-LOG is nonzero, the audit file is found in the directory    */
  201. /* specified in auditDir.                        */
  202. #auditDir "a:\audit"
  203.  
  204. /* shell defines the command-line interpreter that Citadel runs when    */
  205. /* you try to do an [O]utside command.  It must be the full pathname    */
  206. /* to the shell program.                        */
  207. #shell "drive:\path\shell.prg"
  208.  
  209. /* LOGINOK, ENTEROK and READOK are configuration switches used to set    */
  210. /* the privileges of new callers.                    */
  211. /*    If LOGINOK is TRUE (nonzero), callers can establish a name and    */
  212. /* password for themselves without sysop intervention.    If it is    */
  213. /* FALSE (zero), new accounts can only be established from the system    */
  214. /* console.                                */
  215. /*    If ENTEROK is TRUE callers can enter messages without logging    */
  216. /* in.    Such messages will have nameless headers but the date will be    */
  217. /* intact.  Setting ENTEROK to FALSE can reduce vandalism, or keep    */
  218. /* nonpaying folks off commercial systems.                */
  219. /*    If READOK is TRUE, callers can read messages without logging    */
  220. /* in.    This provides a friendly first contact.  Setting READOK to    */
  221. /* FALSE may again be appropriate in commercial installations.        */
  222. #define LOGINOK 1        /* user-established accounts        */
  223. #define READOK 0        /* no anonymous message-reading     */
  224. #define ENTEROK 0        /* no anonymous message-entry        */
  225.  
  226. /* ROOMOK is a configuration switch setting the room-creation privileges*/
  227. /* of established callers.  If ROOMOK is TRUE (nonzero) then regular    */
  228. /* folks can create new rooms, else only those with aide privileges    */
  229. /* can do so.                                */
  230. #define ROOMOK 1        /* general room-creation privileges    */
  231.  
  232. /* ALLMAIL is a configuration switch which lets the sysop decide whether*/
  233. /* all people should be allowed to send private mail to each other, or    */
  234. /* if only aides should have access to private mail and the ordinary    */
  235. /* folk can only send mail to the Sysop.  If ALLMAIL is TRUE, all get    */
  236. /* privileges; FALSE and only aides have the privilege.         */
  237. #define ALLMAIL 1        /* Everybody can send mail        */
  238.  
  239. /* SEARCHBAUD tells Citadel whether the user wants to do 300/1200/2400    */
  240. /* access via a flip flop search between the bauds while the user    */
  241. /* types Carriage Returns or not.                    */
  242. /* If SEARCHBAUD is set to 1, the system will quickly flip through the  */
  243. /* baud rates for about 60 seconds, spending half a second at each baud    */
  244. /* looking for a <C/R>.                            */
  245. /* If SEARCHBAUD is set to 0, SYSBAUD is the /only/ baud rate the    */
  246. /* system uses.                                */
  247. #define SEARCHBAUD     1        /* 1 == autosearch, 0 == don't    */
  248.  
  249. /* SYSBAUD is the baud setting of this system.    300 only is 0, 300/1200 */
  250. /* is 1, 3/12/24 is 2. (unless SEARCHBAUD is 0, then 0 == 300 baud,    */
  251. /* 1 == 1200 baud, and 2 == 2400 baud.)                    */                            */
  252. #define SYSBAUD 1            /* A 3/12 system.        */
  253.  
  254. /* CONNECTPROMPT tells Citadel whether you want the system to prompt    */
  255. /* callers to 'type return' after they connect.                */
  256. #define CONNECTPROMPT    0        /* no silly prompting.        */
  257.  
  258. /* Some modems/dialing areas will hang up if you send characters to    */
  259. /* your modem too soon after establishing a connection. This will kill    */
  260. /* any system using AUTOBAUD, because a bug in the ST's hardware flushes*/
  261. /* a imaginary character whenever you change the baudrate.        */
  262. /* So, Citadel will delay CONNECTDELAY seconds after somebody calls in    */
  263. /* before it starts to check for your baud rate.            */
  264. #define CONNECTDELAY 0        /* don't delay                */
  265.  
  266. /* TIMEOUT and HOUROUT allow the sysop to decide if s/he wants Citadel  */
  267. /* to jump out once every x hours or not. This is useful if the system    */
  268. /* is running on a RAM disk and is using a recursive batch file to      */
  269. /* backup the files in RAM ... allows the sysop to go out without worry.*/
  270. /* If TIMEOUT is set to 1, then HOUROUT is the number of hours Citadel    */
  271. /* will stay up before coming down.                    */
  272. #define TIMEOUT 0        /* No timeouts                */
  273. #define HOUROUT 4
  274.  
  275. /* This is the networking stuff.                    */
  276. /* If NETWORK is 0, then you are not part of a network; 1 means that    */
  277. /* this system is part of at least the local network.            */
  278. /* If LONG-HAUL is 0, then this system is ONLY part of the local    */
  279. /* network; even if there are long distance nodes on this system's list,*/
  280. /* mail will NOT be sent to them. If LONG-HAUL is 1, then this system is*/
  281. /* part of the long distance network as well as the local net.        */
  282. /* DAYDIV, NETHOUR, and NETLENGTH are all values that should NOT NOT NOT*/
  283. /* be modified unless there is general agreement on the network that    */
  284. /* such modification would be desirable.  DAYDIV refers to which days    */
  285. /* networking will take place, NETHOUR is the hour it takes place at    */
  286. /* (military), and NETLENGTH is the number of minutes the systems will    */
  287. /* be in Networking mode.                        */
  288. /*                                    */
  289. #define NETWORK 1            /* networking            */
  290. #define LONG-HAUL 0            /* Not long-haul        */
  291. #define DAYDIV 1
  292. #define NETHOUR 3            /* At 3 AM CDST         */
  293. #define NETLENGTH 30            /* This should be 30 minutes    */
  294.  
  295. /************************************************************************/
  296. /* #callOutPrefix determines what is output to the modem prior to    */
  297. /* the phone number to be dialed.  It must send all commands necessary    */
  298. /* to put the modem into dial out mode.  Additionally, it must contain    */
  299. /* what is neceessary in the way of special commands dealing with PBX's,*/
  300. /* etc.                                 */
  301. /*   For instance, a simple setup of a Hayes/compatible in a simple home*/
  302. /* setting which has Touch Tone would require:                */
  303. /*    #callOutPrefix "ATDT"                        */
  304. /*   A more complicated example of a Hayes/compatible in an office    */
  305. /* that requires a 9 and then a pause before gaining an outside line    */
  306. /* would require                            */
  307. /*    #callOutPrefix "ATDT9,"                        */
  308. /*                                    */
  309. /* #callOutSuffix determines what is output to the modem after        */
  310. /* #callOutPrefix and the phone number has been output.  Graphically,    */
  311. /*     <#callOutPrefix><phone#><#callOutSuffix>             */
  312. /* is the sequence in which data is out when the networker tries    */
  313. /* to dial out.  Since nothing is automatically appended to the     */
  314. /* number when it is being output to the modem during networking,    */
  315. /* the typical value for an installation using a Hayes/compatible is    */
  316. /*    #callOutSuffix "\r"                        */
  317. /* since Hayes/compatibles require a C/R to end a command string.    */
  318. /* This may not hold true for other brands of modems.            */
  319. /************************************************************************/
  320. #callOutPrefix "ATDP"        /* Normal Hayes installation w/o TT.    */
  321. #callOutSuffix "\r"        /* Typical Hayes suffix         */
  322.  
  323.  
  324. /************************************************************************/
  325. /* the modemSetup string is sent to your modem every time you start    */
  326. /* citadel.tos and every time you do a ^LR from the console.        */
  327. /************************************************************************/
  328. #modemSetup "ATQ1S0=1E0S2=255S5=130\r"
  329.