home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / top2src.zip / TOP.CFG < prev    next >
Text File  |  1998-01-18  |  41KB  |  912 lines
  1. ; Configuration File for The Online Pub v2.00g2
  2. ; ---------------------------------------------
  3. ;
  4. ;     All settings in this file are fully documented with comments, so you
  5. ; should not have any problems editing this file to suit your needs.  If,
  6. ; however, you do not understand what a setting is used for, leave it alone
  7. ; and contact the author before changing it.  This file is quite large, but
  8. ; there are actually only about fourty settings, and most of those do not
  9. ; have to be changed.  Those who are experienced with ASCII configuration files
  10. ; (especially Maximus users) like this one should have no trouble with this
  11. ; file.  A configuration editor will be released with a future version of TOP.
  12. ;
  13. ;     The format of each line of the configuration file is one of the
  14. ; following:
  15. ;
  16. ;     ;<comment>
  17. ;     <keyword> <setting>
  18. ;
  19. ;     The first example is a comment line, such as the lines you are reading
  20. ; now.  These lines are ignored by TOP.  The second example is an actual
  21. ; configuration setting, and many examples of them are found in the remainder
  22. ; of this file.  Note that you may seperate <keyword> and <setting> with extra
  23. ; spaces for readability, if you wish.  All keywords and settings are
  24. ; case-insensitive, except where noted.
  25. ;
  26. ;     NOTE:  Many settings refer to a "default setting".  The default setting
  27. ; is the one used in the configuration file that is provided with TOP.  The
  28. ; default setting will _NOT_ be used in place of a missing setting!  Be sure
  29. ; all keywords and settings appear in this file and are spelled correctly.  If
  30. ; you are having problems with your configuration file, refer to the one
  31. ; included in the TOP archive.
  32. ;
  33. ; -----------------------------------------------------------------------------
  34. ;
  35. ;     The first section of keywords is used to give TOP various information
  36. ; about your system and environment.
  37. ;
  38. ; -----------------------------------------------------------------------------
  39. ;
  40. ; * BBSType *
  41. ;
  42. ;     Tells TOP what type of BBS you are running.  Valid settings are:
  43. ;
  44. ;     "UNKNOWN", "RA2", "MAX2", "MAX3", "SBBS11"
  45. ;
  46. ;     UNKNOWN - Unsupported BBS type.
  47. ;     RA2 - RemoteAccess 2.00g1, 2.00, 2.01, 2.02, 2.50g1, and 2.50.
  48. ;     MAX2 - Maximus 2.00, 2.01, 2.02.
  49. ;     MAX3 - Maximus 3.00, 3.01.
  50. ;     SBBS11 - SuperBBS 1.17 (and possibly older versions).
  51. ;
  52. ;     DO NOT INCLUDE THE QUOTATION MARKS!  If you are not running any of the
  53. ; above listed BBS types, set this to UNKNOWN.  TOP will still work as usual,
  54. ; but users will not be able to see who is on the BBS, nor page these users.
  55. ;
  56. BBSType UNKNOWN
  57. ;
  58. ; -----------------------------------------------------------------------------
  59. ;
  60. ; * SysopName *
  61. ;
  62. ;     Tells TOP the name of the System Operator or LAN Supervisor.  You may use
  63. ; any printable ASCII character, but may not exceed 40 characters.  If you
  64. ; exceed 40 characters, the name will be truncated at 40.  NOTE:  If you are
  65. ; a registered user of TOP, this setting must _exactly_ match the BBS name that
  66. ; you submitted on your registration form!
  67. ;
  68. SysopName Paul Sidorsky
  69. ;
  70. ; -----------------------------------------------------------------------------
  71. ;
  72. ; * BBSName *
  73. ;
  74. ;     Tells TOP the name of your BBS.  You may use any printable ASCII
  75. ; character, but may not exceed 40 characters.  If you exceed 40 characters,
  76. ; the name will be truncated at 40.  NOTE:  If you are registered, this setting
  77. ; must _exactly_ match the BBS name that you submitted on your registration
  78. ; form!
  79. ;
  80. BBSName ISMWare Support
  81. ;
  82. ; -----------------------------------------------------------------------------
  83. ;
  84. ;     The next group of settings tell TOP where to find and create various
  85. ; files on your system.
  86. ;
  87. ; -----------------------------------------------------------------------------
  88. ;
  89. ; * TOPPath *
  90. ;
  91. ;     This should be set to the directory where TOP is located.  It will be
  92. ; used by TOP to both find and create imporant files.  The trailing backslash
  93. ; is optional, but recommended.
  94. ;
  95. TOPPath E:\BC45\TOP\
  96. ;
  97. ; -----------------------------------------------------------------------------
  98. ;
  99. ; * TOPWorkPath *
  100. ;
  101. ;     This directory is used by TOP for its inter-node communications during
  102. ; chat.  As it is used heavily, setting this to a RAMDisk is _HIGHLY_
  103. ; recommended.  The trailing backslash is optional, but recommended.
  104. ;
  105. TOPWorkPath E:\BC45\TOP\TEMP\
  106. ;
  107. ; -----------------------------------------------------------------------------
  108. ;
  109. ; * TOPANSIPath *
  110. ;
  111. ;     This setting tells TOP where to locate its various ANSI, AVATAR, and
  112. ; RIP files.  These files are used for things like help screens, so this
  113. ; setting should be correct.  The trailing backslash is optional, but
  114. ; recommended.  You can use the file MOVEANS.BAT to transfer all of TOP's
  115. ; external files to this directory after you create it.
  116. ;
  117. TOPANSIPath E:\BC45\TOP\ANSI\
  118. ;
  119. ; -----------------------------------------------------------------------------
  120. ;
  121. ; * BBSPath *
  122. ;
  123. ;     This setting tells TOP where your BBS files are located.  While this
  124. ; setting may not be used by TOP in all configurations, it is important that
  125. ; it be set correctly to avoid future problems later on.  It _IS_ used with
  126. ; RemoteAccess and SuperBBS setups.  It is _NOT_ used if you set BBSType to
  127. ; Unknown.  The trailing backslash is optional, but recommended.  See TOP.DOC
  128. ; for more information on setting this path.
  129. ;
  130. BBSPath D:\RA\
  131. ;
  132. ; -----------------------------------------------------------------------------
  133. ;
  134. ; * BBSIPCPath *
  135. ;
  136. ;     Tells TOP where to find your BBS's InterProcess Communications files.
  137. ; This is sometimes also called the Semaphore Path or Temporary Path.  If you
  138. ; intend to allow your users to communicate with users outside of TOP, this
  139. ; MUST be correct.  It may be ignored if you have set BBSType to Unknown.  The
  140. ; trailing backslash is optional, but recommended.  See TOP.DOC for more
  141. ; information about setting this path.
  142. ;
  143. BBSIPCPath E:\
  144. ;
  145. ; -----------------------------------------------------------------------------
  146. ;
  147. ; * TOPActionPath *
  148. ;
  149. ;     This setting tells TOP where to locate all of the compiled TOP Action
  150. ; files (.TAC files).  If you have a lot of action files, you may want to put
  151. ; them all in their own subdirectory to avoid cluttering your TOP directory.
  152. ; Normally, however, you can just set this to your TOP directory.  The trailing
  153. ; backslash is optional, but recommended.
  154. ;
  155. TOPActionPath E:\BC45\TOP\
  156. ;
  157. ; -----------------------------------------------------------------------------
  158. ;
  159. ;     The settings in this next section are called Options, and they toggle
  160. ; various features of TOP on or off.  You may use any one of the following
  161. ; words as valid settings.  The words on the first line turn the option ON, and
  162. ; the words on the second line turn the option OFF.
  163. ;
  164. ;      ON  YES    ENABLED   1    TRUE
  165. ;     OFF   NO   DISABLED   0   FALSE
  166. ;
  167. ; -----------------------------------------------------------------------------
  168. ;
  169. ; * ShowTitle *
  170. ;
  171. ;     TOP has the ability to display a Title Page (named TOPTITLE.ANS) to your
  172. ; users upon startup.  If you wish to enable this feature, turn this option ON.
  173. ; If you do not wish a Title Page to be displayed, turn this option OFF.
  174. ;
  175. ShowTitle No
  176. ;
  177. ; -----------------------------------------------------------------------------
  178. ;
  179. ; * ShowNews *
  180. ;
  181. ;     TOP is able to display a News Bulletin (named TOPNEWS.ANS) to your users
  182. ; once they have logged in.  This is useful if you have recently upgraded to a
  183. ; new version of TOP and there have been new User Settings added.  You can use
  184. ; this bulletin to tell the users about these options, and where to change
  185. ; them.  If you wish a News Bulletin to be displayed, turn this option ON.  If
  186. ; you don't want to use this feature, turn this option OFF.
  187. ;
  188. ShowNews No
  189. ;
  190. ; -----------------------------------------------------------------------------
  191. ;
  192. ; * AllowActions *
  193. ;
  194. ;     This option allows you to turn off Actions and all Action-related
  195. ; commands.  If you do not want to use TOP's Action features, turn this option
  196. ; OFF.  Otherwise, leave this setting ON.
  197. ;
  198. ;     NOTE:  This option does _NOT_ turn off General Actions.  Use the
  199. ; AllowGAs option for that purpose.
  200. ;
  201. AllowActions Yes
  202. ;
  203. ; -----------------------------------------------------------------------------
  204. ;
  205. ; * AllowGAs *
  206. ;
  207. ;     This option controls whether or not General Actions (GAs) are allowed.
  208. ; To allow the GA and GA'S commands to be used, turn this setting ON.  If you
  209. ; do not wish General Actions to be used, turn this setting OFF.
  210. ;
  211. AllowGAs Yes
  212. ;
  213. ; -----------------------------------------------------------------------------
  214. ;
  215. ; * AllowNewHandles *
  216. ;
  217. ;     This option tells TOP whether or not to ask the user for a new handle
  218. ; when they first enter TOP.  If this option is ON, TOP will prompt new users
  219. ; for a handle.  If this option is OFF, TOP will use the real name or handle
  220. ; provided by the BBS, as determined by the AllowHandles setting.  Note that if
  221. ; you turn this setting OFF, but turn the AllowChangeHandles option ON, then
  222. ; this setting will virtually have no effect.
  223. ;
  224. AllowNewHandles No
  225. ;
  226. ; -----------------------------------------------------------------------------
  227. ;
  228. ; * AllowHandles *
  229. ;
  230. ;     This option tells TOP whether or not it should use the user's handle or
  231. ; real name if AllowNewHandles is turned OFF.  If this setting is turned ON,
  232. ; TOP will use the user's handle during chat.  If this setting is OFF, TOP will
  233. ; use the user's real name.  If AllowNewHandles is turned ON, then this setting
  234. ; has no effect.
  235. ;
  236. AllowHandles Yes
  237. ;
  238. ; -----------------------------------------------------------------------------
  239. ;
  240. ; * AllowChangeHandle *
  241. ;
  242. ;     This option controls whether or not the user can change his or her handle
  243. ; inside TOP.  If it is set to ON, handle changes will be permitted.  If it is
  244. ; set to OFF, the user will not be able to change his or her handle.
  245. ; Obviously, if AllowHandles or AllowNewHandles is set to OFF, this option
  246. ; should be too, or the other settings will have no effect.  NOTE:  Changing
  247. ; handles in TOP does NOT affect the user's handle on the BBS.
  248. ;
  249. AllowChangeHandle Yes
  250. ;
  251. ; -----------------------------------------------------------------------------
  252. ;
  253. ; * AllowChangeSex *
  254. ;
  255. ;     This option lets you control whether or not the user may change his or
  256. ; her gender.  If you wish "instantaneous sex changes" to be performed inside
  257. ; TOP, turn this option ON.  Otherwise, turn it OFF.  This option may sound
  258. ; silly, but often several users will be at one person's house and if they are
  259. ; of different genders, this option (along with the AllowChangeHandles) option
  260. ; will allow the people at such gatherings to properly identify themselves.
  261. ; NOTE:  Changing genders inside TOP does NOT affect the user's gender on the
  262. ; BBS.
  263. ;
  264. AllowChangeSex Yes
  265. ;
  266. ; -----------------------------------------------------------------------------
  267. ;
  268. ; * AllowChangeEXMsg *
  269. ;
  270. ;     This option allows you to control whether or not your users can set
  271. ; custom messages to be displayed to others when they enter or exit TOP.
  272. ; Turning this option ON allows these messages, while turning it OFF will force
  273. ; TOP to always use the default entry and exit messages (which can be defined
  274. ; in the language file).
  275. ;
  276. AllowChangeEXMsg Yes
  277. ;
  278. ; -----------------------------------------------------------------------------
  279. ;
  280. ; * AllowPrivateMsgs *
  281. ;
  282. ;     This option controls whether or not users can send private messages.
  283. ; These messages include whispers, secret actions, and pages to users elsewhere
  284. ; on the BBS.  Turn this setting ON to allow these messages.  In the rare case
  285. ; that you do not want users to be able to send private messages, turn this
  286. ; setting OFF.
  287. ;
  288. AllowPrivateMsgs Yes
  289. ;
  290. ; -----------------------------------------------------------------------------
  291. ;
  292. ; * AllowForgetting *
  293. ;
  294. ;     This option tells TOP whether or not to allow users to forget other
  295. ; users.  When a user forgets another user, they will not be able to see any
  296. ; message from that user.  This is handy for dealing with problem users.  If
  297. ; you wish to allow users to forget other users, turn this setting ON.  If you
  298. ; do not wish users to be able to forget other users, turn this setting OFF.
  299. ;
  300. AllowForgetting Yes
  301. ;
  302. ; -----------------------------------------------------------------------------
  303. ;
  304. ; * UseHandles *
  305. ;
  306. ;     This option tells TOP whether it should use the user's Real Name or
  307. ; Handle in displays that have both available, such as a NODES listing and
  308. ; pages outside of TOP.  If you want to use the user's Handle, turn this
  309. ; option ON.  If you would rather use Real Names instead, turn it OFF.  NOTE:
  310. ; Your BBS software and drop file type must be able to provide TOP with both a
  311. ; real name and a handle, otherwise this setting has no effect.
  312. ;
  313. UseHandles Yes
  314. ;
  315. ; -----------------------------------------------------------------------------
  316. ;
  317. ; * NoRegName *
  318. ;
  319. ;     It is understood that some sysops who run handle-based systems do not
  320. ; want their real name to be shown to their users.  Registration keys must be
  321. ; issued to a user's real name, for safety reasons.  However, TOP provides an
  322. ; alternative in the form of this setting.  If you turn this setting ON, TOP
  323. ; will show a serial number instead of your name, as well as the BBS name, when
  324. ; it identifies itself as registered.  If this setting is OFF, TOP will show
  325. ; your real name and BBS name.  This allows you to have your anonymity, while
  326. ; the author can still protect his product.
  327. ;
  328. ;     NOTE:  This setting obviously has no effect for unregistered users of
  329. ; TOP.
  330. ;
  331. NoRegName No
  332. ;
  333. ; -----------------------------------------------------------------------------
  334. ;
  335. ; * ShowOpeningCredits *
  336. ;
  337. ;     This setting controls whether or not TOP will display the opening
  338. ; "credits" when a user enters TOP.  The opening credits show the name of the
  339. ; program, the author, and some other information about TOP.  If you wish this
  340. ; information to be shown in full, turn this setting ON.  If you wish this
  341. ; information not to be shown, providing a more "seamless" look, turn this
  342. ; setting OFF.
  343. ;
  344. ;     NOTE:  Even with this setting OFF, TOP will still show a two-line
  345. ; identification header.  One line will show the name, version, and copyright
  346. ; information, and the other will show the registration status of TOP.  This
  347. ; information is vital to the protection of both you and the author of TOP, and
  348. ; must be shown no matter what.
  349. ;
  350. ShowOpeningCredits Yes
  351. ;
  352. ; -----------------------------------------------------------------------------
  353. ;
  354. ; * ShowClosingCredits *
  355. ;
  356. ;     This setting tells TOP whether or not to display closing "credits" when a
  357. ; user exits TOP.  The closing credits feature a program identification and a
  358. ; message to the user that they are returning to the BBS.  To have this
  359. ; information shown to the user, leave this setting ON.  To show nothing to the
  360. ; user upon leaving TOP, turn this setting OFF.  When this setting is turned
  361. ; OFF, nothing else will be displayed, unlike the ShowOpeningCredits setting.
  362. ;
  363. ShowClosingCredits Yes
  364. ;
  365. ; -----------------------------------------------------------------------------
  366. ;
  367. ; * AllowHighASCII *
  368. ;
  369. ;     When this setting is ON, TOP will permit high ASCII characters (128 to
  370. ; 254) to be entered by users.  If it is OFF, only the standard ASCII set of
  371. ; characters (32 to 127) will be allowed.  NOTE:  This setting does _NOT_
  372. ; affect the displaying of any high ASCII characters in the language file!
  373. ;
  374. AllowHighASCII Yes
  375. ;
  376. ; -----------------------------------------------------------------------------
  377. ;
  378. ;     The next group of settings are General TOP Settings.  They tell TOP how
  379. ; you want it to function.  Most of them are numerical values, but there are
  380. ; some exceptions, which are noted.
  381. ;
  382. ; -----------------------------------------------------------------------------
  383. ;
  384. ; * MaxMsgLen *
  385. ;
  386. ;     This setting tells TOP the maximum amount of characters a user may type
  387. ; before being forced to press ENTER to send their text.  The lowest value
  388. ; permitted is 0, though this is rather foolish because users won't be able to
  389. ; type anything.  The realistic minimum is 20, which should give users enough
  390. ; room to use all of the commands in TOP.  The recommended value is 255.  This
  391. ; is also the maximum value.
  392. ;
  393. MaxMsgLen 255
  394. ;
  395. ; -----------------------------------------------------------------------------
  396. ;
  397. ; * InactiveTimeout *
  398. ;
  399. ;     This setting tells TOP how long, in seconds, to wait before ejecting
  400. ; users from TOP if they have not typed anything or issued any commands.
  401. ; Acceptable values are from 0 to 32767.  Setting this to 0 will disable the
  402. ; Inactivity Timeout completely.  The recommended value is 300, which allows
  403. ; five minutes of inactivity before ejecting the user.  NOTE:  Users who are in
  404. ; chat may want to do things like check information on files or go to the
  405. ; bathroom, thus you may want to set this higher than you would for door games
  406. ; or the BBS itself.
  407. ;
  408. InactiveTimeout 300
  409. ;
  410. ; -----------------------------------------------------------------------------
  411. ;
  412. ; * UseCredits *
  413. ;
  414. ;     TOP is capable of using RemoteAccess 2.xx's user credit system to limit
  415. ; the time spent in TOP.  To enable credit usage, set this to the amount of
  416. ; credits that you wish to deduct per minute.  TOP will exit when this number
  417. ; reaches 0.  TOP will also show the amount of credits the user has remaining
  418. ; when the user does a TIME command.  Valid settings are 0 which disables RA
  419. ; credit usage, a positive number which will cause TOP to monitor credit
  420. ; usage but _NOT_ subtract the credits on exit (assuming RA will do so when
  421. ; it returns), and a negative number, which will cause TOP to monitor credit
  422. ; usage and deduct them on exit.  Negative numbers can be from -65535 to -1,
  423. ; and positive numbers from 1 to 65535.
  424. ;
  425. ;     NOTE:  TOP's credit support is not as sophisticated as RA's.  You can not
  426. ; deduct fractions of a credit as you can with RA, and you can only have one
  427. ; UseCredits setting for all users as opposed to one setting for each security
  428. ; level.  For this reason, you should set this value the same as the setting
  429. ; for the most common security level that your BBS uses.  If you use fractional
  430. ; credit deduction in RA, round this value up to the nearest credit (or down if
  431. ; you're feeling generous).  This way TOP will at least be able to approximate
  432. ; when to kick a user out of TOP and back to the BBS.  It is recommended you
  433. ; test to see if RA deducts the credits itself upon return from TOP.  If so,
  434. ; use a positive number.  Otherwise, use a negative number so TOP will
  435. ; deduct the credits itself.  This may depend on the RA version and/or
  436. ; settings you are using.
  437. ;
  438. ;     IMPORTANT:  RA credit usage requires EXITINFO.BBS to be used as the drop
  439. ; file.  Also, if you are using a negative number, RA must be able to
  440. ; reread the changed EXITINFO.BBS file when TOP exits.
  441. ;
  442. UseCredits 0
  443. ;
  444. ; -----------------------------------------------------------------------------
  445. ;
  446. ; * LocalBeeping *
  447. ;
  448. ;     This setting controls which type of nodes TOP will sound beeps for on the
  449. ; local console. Valid settings for this keyword consist of one or more of the
  450. ; following words:
  451. ;
  452. ;     "None", "Remote", "Local", "LAN", or "All"
  453. ;
  454. ;     None - Never sound beeps on the local console.
  455. ;     Remote - Sound beeps for Remote type nodes.
  456. ;     Local - Sound beeps for Local type nodes, or when a local user is logged
  457. ;             on to a node of Remote type.
  458. ;     LAN - Sound beeps for LAN type nodes.
  459. ;     All - Always sound beeps on the local console.
  460. ;
  461. ;     As with other settings of this type, do not include the quotation marks!
  462. ; The recommended setting for this keyword is "Local LAN", which will only
  463. ; sound beeps when there is somebody at the local console inside TOP who needs
  464. ; to hear them.  The "None" and "All" settings should not be used with any of
  465. ; the other settings.
  466. ;
  467. LocalBeeping Local LAN
  468. ;
  469. ; -----------------------------------------------------------------------------
  470. ;
  471. ; * LangFile *
  472. ;
  473. ;     This setting tells TOP the base file name of the Language File to use for
  474. ; TOP.  IT IS IMPORTANT THAT YOU DO _NOT_ SPECIFY A PATH OR EXTENSION!  TOP
  475. ; will append the .LNG extension automatically, and look for this file in the
  476. ; TOP Path as set above.
  477. ;
  478. LangFile PUB
  479. ;
  480. ; -----------------------------------------------------------------------------
  481. ;
  482. ; * DefaultChannel *
  483. ;
  484. ;     This setting specifies which channel TOP will place users in when they
  485. ; enter TOP.  Valid settings are 1 to 3999999999.  Conference names cannot be
  486. ; used here in this version of TOP.
  487. ;
  488. DefaultChannel 1
  489. ;
  490. ; -----------------------------------------------------------------------------
  491. ;
  492. ; * MaxNodes *
  493. ;
  494. ;     Specifies the maximum number of nodes you have on your system.  It's
  495. ; recommended you set this value a little higher than the actual total number
  496. ; of nodes so you have a bit of breathing space.  Acceptable values are from 1
  497. ; to 32767.  WARNING - The higher you set this value, the more memory TOP will
  498. ; need!
  499. ;
  500. ;     VERY IMPORTANT:  This setting specifies the maximum NUMBER of nodes, not
  501. ; the HIGHEST node!  Because node numbers in TOP start at 0, setting this
  502. ; setting to a value of 10 would enable nodes 0 through 9 only, and NOT node
  503. ; 10!  Some systems use node 0 as a local-only node, and future versions of TOP
  504. ; will support this convention, hence the need for this setting to include
  505. ; node 0.  This version does _NOT_ support node 0, however, and will default
  506. ; to use node 1 if 0 is passed on the command line as the node number.  In
  507. ; short, always set this setting no lower than your highest node number PLUS
  508. ; ONE.
  509. ;
  510. MaxNodes 10
  511. ;
  512. ; -----------------------------------------------------------------------------
  513. ;
  514. ; * MaxPWTries *
  515. ;
  516. ;     This setting controls how many failed attempts at entering a password TOP
  517. ; will allow before returning the user to the BBS.  The default setting is 3.
  518. ; Valid settings are from 1 to 256.
  519. ;
  520. MaxPWTries 3
  521. ;
  522. ; -----------------------------------------------------------------------------
  523. ;
  524. ; * ActionFiles *
  525. ;
  526. ;     This setting specifies the compiled TOP Action Files (.TAC files) that
  527. ; TOP will load and use.  All of the names should be listed on the same line
  528. ; following this keyword, seperated by spaces and _WITHOUT_ the .TAC extension
  529. ; (VERY IMPORTANT!!!).  TOP will add the extension itself and look for these
  530. ; files in the directory specified by the TOPActionPath keyword.  You can have
  531. ; up to 32767 different files, however the string following this keyword may
  532. ; only be at most 256 characters in length.
  533. ;
  534. ActionFiles MAIN SYSOP
  535. ;
  536. ; -----------------------------------------------------------------------------
  537. ;
  538. ; * MaxChannelDefs *
  539. ;
  540. ;     This setting specifies the maximum number of channel definitions that
  541. ; TOP can expect.  You should check this number against the number of
  542. ; definitions in CHANNELS.CFG each time you update CHANNELS.CFG.  SETTING THIS
  543. ; TOO LOW WILL CAUSE MAJOR PROBLEMS!  The recommended setting is 50, which
  544. ; should allow for plenty of channel and conference definitions without taking
  545. ; up very much memory.  Acceptable values are from 0 to 2 147 483 648, but you
  546. ; need memory to hold all them!  Each channel definition takes up roughly 128
  547. ; bytes.
  548. ;
  549. MaxChannelDefs 50
  550. ;
  551. ; -----------------------------------------------------------------------------
  552. ;
  553. ;     This group of settings tells TOP the minimum security level that a user
  554. ; must have in order to use certain features of TOP.
  555. ;
  556. ; -----------------------------------------------------------------------------
  557. ;
  558. ; * SecuritySysop *
  559. ;
  560. ;     This setting tells TOP the security level of people that you wish to have
  561. ; Sysop access inside TOP.  IT IS VITAL THAT THIS SETTING BE CORRECT, OR YOU
  562. ; MAY ALLOW YOUR USERS TO DO DAMAGING THINGS TO YOUR SYSTEM!  Accepted values
  563. ; are 0 - 65535.
  564. ;
  565. ;     IMPORTANT:  Users who meet this security level have access to SYSOP
  566. ; commands, have moderator powers in ALL channels, and cannot be forgotten by
  567. ; other users!
  568. ;
  569. SecuritySysop 65535
  570. ;
  571. ; -----------------------------------------------------------------------------
  572. ;
  573. ; * SecurityNewUser *
  574. ;
  575. ;     This setting determines which security level TOP assigns to a user who
  576. ; first enters TOP.  If set to a value above 0, TOP will give _all_ users,
  577. ; including yourself, this security when they first enter TOP.  It will be up
  578. ; to you to upgrade or downgrade users inside TOP (using the SYSOP SETSEC)
  579. ; command.  You will also have to upgrade yourself manually by running TOP
  580. ; with the EDIT parameter.  Valid settings are from 0, which uses the
  581. ; security obtained from the BBS drop file, to 65535.
  582. ;
  583. SecurityNewUser 0
  584. ;
  585. ; -----------------------------------------------------------------------------
  586. ;
  587. ; * SecurityTalk *
  588. ;
  589. ;    This setting tells TOP what security level is required for a user to send
  590. ; any text in TOP.  If a user does not have this security level, they will only
  591. ; be able to read the conversation (or send actions or whispers if they meet
  592. ; those security levels).  Valid settings are from 0 to 65535.
  593. ;
  594. SecurityTalk 25
  595. ;
  596. ; -----------------------------------------------------------------------------
  597. ;
  598. ; * SecurityChangeHandle *
  599. ;
  600. ;     This setting specifies the security a user requires in order to change
  601. ; his or her handle.  It has no effect if the AllowChangeHandles option is
  602. ; turned OFF.  Valid settings are from 0 to 65535.
  603. ;
  604. SecurityChangeHandle 0
  605. ;
  606. ; -----------------------------------------------------------------------------
  607. ;
  608. ; * SecurityChangeSex *
  609. ;
  610. ;     This setting controls the security required in order for a user to be
  611. ; able to change their sex (gender).  It has no effect when the AllowChangeSex
  612. ; keyword is turned OFF.  Valid settings are from 0 to 65535.
  613. ;
  614. SecurityChangeSex 0
  615. ;
  616. ; -----------------------------------------------------------------------------
  617. ;
  618. ; * SecurityChangeEXMsg *
  619. ;
  620. ;     This setting tells TOP the security a user needs to be able to change
  621. ; their entry and exit messages.  Entry and exit messages are customized
  622. ; messages that can be displayed by TOP when a user enters and exits TOP.
  623. ; Valid settings are from 0 to 65535.
  624. ;
  625. SecurityChangeEXMsg 0
  626. ;
  627. ; -----------------------------------------------------------------------------
  628. ;
  629. ; * SecuritySendPrivate *
  630. ;
  631. ;     This setting tells TOP what security is required to send private messages
  632. ; (whispers, secret actions, and BBS pages).  Valid settings are from 0 to
  633. ; 65535.
  634. ;
  635. SecuritySendPrivate 0
  636. ;
  637. ; -----------------------------------------------------------------------------
  638. ;
  639. ; * SecurityActionUse *
  640. ;
  641. ;     This setting tells TOP the security required to use actions.  It will
  642. ; _not_ prevent these users from seeing actions, just using them.  Valid
  643. ; settings are from 0 to 65535.
  644. ;
  645. SecurityActionUse 0
  646. ;
  647. ; -----------------------------------------------------------------------------
  648. ;
  649. ; * SecurityForget *
  650. ;
  651. ;     This setting specifies the security required to forget and remember other
  652. ; users.  Valid settings are from 0 to 65535.
  653. ;
  654. SecurityForget 0
  655. ;
  656. ; -----------------------------------------------------------------------------
  657. ;
  658. ;     The next group of settings are used to tune TOP's performance.
  659. ;
  660. ; -----------------------------------------------------------------------------
  661. ;
  662. ; * PollDelay *
  663. ;
  664. ;     Specifies the delay, in tenths of a second, between "polls" (checks) of
  665. ; the incoming message queue.  Valid settings are from 0 to 65535.  If TOP
  666. ; slows down your system too much, raising this setting may help.  If you don't
  667. ; experience any slowness while running TOP, you can try lowering this setting.
  668. ; A setting of 0 is NOT recommended, as it will cause rather ballistic polling
  669. ; and almost certainly slow down your system.  A value of 1, however, should be
  670. ; alright if you're using a RAMDisk.
  671. ;
  672. PollDelay 5
  673. ;
  674. ; -----------------------------------------------------------------------------
  675. ;
  676. ; * RetryDelay *
  677. ;
  678. ;     This setting specifies the amount of time, in tenths of a second, between
  679. ; retries of a failed file i/o operation.  The default setting of 5 should be
  680. ; fine, but if you have a slow hard drive or computer you may want to raise
  681. ; this value to take some stress off of your system should a file i/o operation
  682. ; ever fail.  Acceptable values are from 0 to 65535.
  683. ;
  684. RetryDelay 5
  685. ;
  686. ; -----------------------------------------------------------------------------
  687. ;
  688. ; * RetryMax *
  689. ;
  690. ;     Specifies the maximum number of times to retry a file i/o operation
  691. ; before reporting failure.  Acceptable values are from 0 to 65535.
  692. ; Multiplying this value with the value for RetryDelay will give you the total
  693. ; amount of time it takes for TOP to report a failure.  It's recommended you
  694. ; adjust this value so that when multiplied with RetryDelay it will yield about
  695. ; 50, which is 5 seconds.
  696. ;
  697. RetryMax 10
  698. ;
  699. ; -----------------------------------------------------------------------------
  700. ;
  701. ; * CrashProtDelay *
  702. ;
  703. ;     TOP's Crash Protection ensures that any node listed as being active
  704. ; really IS active.  It does this by having each node update the NODEIDX.TCH
  705. ; file every so often.  This setting determines the maximum allowable time, in
  706. ; seconds, between each update.  Valid settings are from 10 to 65535, or 0 to
  707. ; disable crash protection.
  708. ;
  709. ;     If you're running a RAMDisk, start this value off around 30 and test TOP
  710. ; with several users at once.  If users "vanish" for no reason, bump this up in
  711. ; 30 second increments until you find the value where this does not happen.  If
  712. ; you don't run a RAMDisk, start this off at 180 and do likewise.  Generally,
  713. ; values between 180 and 300 (3-5 minutes) should be reliable on all systems
  714. ; while still allowing crashed nodes to be removed within a reasonable amount
  715. ; of time.  If TOP still removes nodes falsely, try using a very high value
  716. ; like 900 or 1200 (15 or 20 minutes).  This will diminish the effectiveness of
  717. ; crash protection somewhat, but will at least allow TOP to remove crashed
  718. ; nodes without human intervention.  If TOP _still_ creates "vanishing" nodes
  719. ; even at rediculously high values, set this to 0 and contact the author.
  720. ; Crash protection is a very difficult feature for the author to test and
  721. ; effectiveness will vary greatly between systems.
  722. ;
  723. CrashProtDelay 0
  724. ;
  725. ; -----------------------------------------------------------------------------
  726. ;
  727. ; * PrivChatBufSize *
  728. ;
  729. ;     This setting controls the internal private chat transmit buffer size.
  730. ; When this buffer is full, TOP will automatically flush the private chat
  731. ; buffer, causing the text typed by a user to be sent to the other user.  This
  732. ; buffer is normally dumped after each character typed, but if a write fails it
  733. ; will start to fill up.  The default setting of 1024 is high, but it is best
  734. ; to err on the side of caution.  Valid settings are from 1 to 65535.
  735. ;
  736. PrivChatBufSize 1024
  737. ;
  738. ; -----------------------------------------------------------------------------
  739. ;
  740. ; * PrivChatMaxTries *
  741. ;
  742. ;     This setting tells TOP how many times to retry a failed file operation
  743. ; during private chats.  It should be sufficiently high to account for system
  744. ; lag or natural file I/O delays.  An extremely high amount of I/O takes place
  745. ; during a private chat (even more than during regular chat), so a value around
  746. ; 100 (the default) is recommended.  Valid settings are from 1 to 65535.
  747. ;
  748. PrivChatMaxTries 100
  749. ;
  750. ; -----------------------------------------------------------------------------
  751. ;
  752. ;   The settings below are new and have not been categorized yet.
  753. ;
  754. ; -----------------------------------------------------------------------------
  755. ;
  756. ; * MaxCensorWarnHigh *
  757. ;
  758. ;     This setting tells TOP how many highly offensive words a user may
  759. ; attempt to say before being disconnected.  Highly offensive words are those
  760. ; with severity levels 1 through 3.  Once the user is over the warn limit,
  761. ; any word assigned severity level 2 will immediately disconnect the user who
  762. ; says the word.  High- and low-grade offensive words each have their own
  763. ; warn counter.  Valid settings are from 0 to 65535.  A setting of 0 means
  764. ; that the consequences for these levels are ALWAYS enforced, effectively
  765. ; making levels 2 and 1 the same.  For further details on setting up TOP's
  766. ; censor, see CENSOR.CFG.
  767. ;
  768. MaxCensorWarnHigh 3
  769. ;
  770. ; -----------------------------------------------------------------------------
  771. ;
  772. ; * MaxCensorWarnLow *
  773. ;
  774. ;     This setting tells TOP how many low-grade offensive words a user may
  775. ; say before the user is disconnected.  Low-grade offensive words are those
  776. ; with severity levels 4 and 5.  Once the user is over the warn limit, any
  777. ; word assigned severity level 4 will immediately disconnect the user who
  778. ; says the word.  High- and low-grade offensive words each have their own
  779. ; warn counter.  Valid settings are from 0 to 65535.  A setting of 0 means
  780. ; that the consequences for these levels are ALWAYS enforced, effectively
  781. ; making levels 4 and 1 the same.  For further details on setting up TOP's
  782. ; censor, see CENSOR.CFG.
  783. ;
  784. MaxCensorWarnLow 5
  785. ;
  786. ; -----------------------------------------------------------------------------
  787. ;
  788. ; * CensorTimerHigh *
  789. ;
  790. ;     This setting determines how long TOP will preserve the warning count
  791. ; for highly offensive words.  Once the specified number of seconds has
  792. ; elapsed without a highly offensive word being typed by a user, TOP will
  793. ; decrease the number of high-level warnings for that user (if any have
  794. ; accumulated) by one.  This setting allows TOP to "see" that a problem user
  795. ; has "cooled off" and act more tolerant.  This timer is not affected by
  796. ; low-grade offensive words.  Valid settings are from 0 to 65535.  A setting
  797. ; of 0 means that TOP will NEVER forget a user's past highly offensive
  798. ; language unless he or she reenters TOP.  Please see CENSOR.CFG for further
  799. ; details on how to use this setting.
  800. ;
  801. CensorTimerHigh 180
  802. ;
  803. ; -----------------------------------------------------------------------------
  804. ;
  805. ; * CensorTimerLow *
  806. ;
  807. ;     This setting determines how long TOP will preserve the warning count
  808. ; for low-grade offensive words.  Once the specified number of seconds has
  809. ; elapsed without a low-grade offensive word being typed by a user, TOP will
  810. ; decrease the number of low-level warnings for that user (if any have
  811. ; accumulated) by one.  This setting allows TOP to "see" when topics that are
  812. ; considered inappropriate have passed, and act more tolerant towards users
  813. ; that might have participated in the discussion.  This timer is not affected
  814. ; by highly offensive words.  Valid settings are from 0 to 65535.  A setting
  815. ; of 0 means that TOP will NEVER forget a user's past low-grade offensive
  816. ; language unless he or she reenters TOP.  Please see CENSOR.CFG for further
  817. ; details on how to use this setting.
  818. ;
  819. CensorTimerLow 60
  820. ;
  821. ; -----------------------------------------------------------------------------
  822. ;
  823. ; * DefaultPrefs *
  824. ;
  825. ;     This setting lets you set the default personal preference options for
  826. ; new users.  This is useful if you have just switched from a different
  827. ; conferencing program and want TOP to behave more like that program by
  828. ; default, to ease the transition for your users.  It is also useful if you
  829. ; have changed the language file and want TOP to behave in a manner suited to
  830. ; that language file by default.  For example, some language files may be more
  831. ; suited to Dual Window chat mode, thus it may be desirable to have TOP default
  832. ; to Dual Window chat mode for new users.
  833. ;
  834. ;     This setting is actually a combination of 12 different option-style
  835. ; settings.  Each option is turned ON by default by using a Y or a 1.  Use
  836. ; the letter N or a 0 to turn the option OFF by default.
  837. ;
  838. ;     The 12 different options are listed below.  The letter for each
  839. ; option is the same as that option's letter in the profile editor (unless
  840. ; you have changed them via the language file).  A template is provided above
  841. ; the actual keyword so you can easily change one or all of the settings.  The
  842. ; recommended settings (which are those that previous versions of TOP and RAP
  843. ; had fixed as defaults) for each option are listed in parentheses.
  844. ;
  845. ;     A   Action echoing                                       (ON)
  846. ;     B   Talktype action echoing                              (ON)
  847. ;     C   Talktype message echoing                             (ON)
  848. ;     D   Message sent response                                (ON)
  849. ;     E   General action echoing                               (ON)
  850. ;     F   Talktype sent response                               (ON)
  851. ;     G   Dual Window chat mode enabled                        (OFF)
  852. ;     H   Text blocked while typing                            (OFF)
  853. ;     -   Setting is not currently used.  Always set to OFF.   (OFF)
  854. ;     I   Channel listed on scan                               (ON)
  855. ;     J   Echo own text                                        (ON)
  856. ;     K   Actions disabled/blocked                             (OFF)
  857. ;
  858. ;  Template: ABCDEFGH-IJK
  859. DefaultPrefs YYYYYYNNNYYN
  860. ;
  861. ; -----------------------------------------------------------------------------
  862. ;
  863. ; * ActionPrefix *
  864. ;
  865. ;     This setting allows you to specify one or more characters that must be
  866. ; placed in front of an action command.  This helps prevent "accidental
  867. ; actions", which occur when a user starts a sentence with an action verb but
  868. ; doesn't intend to send an action.  It also helps distinguish actions from
  869. ; other TOP commands.
  870. ;
  871. ;     You may specify up to 10 characters as a prefix, though it is recommended
  872. ; that you just use one.  Be sure not to use a character or characters that
  873. ; might be used in other TOP commands (such as /).  The recommended prefix is a
  874. ; single period character.  This means that action commands will look like
  875. ; ".slap joe" and ".yell WAKE UP!".  You may also specify "NONE", which tells
  876. ; TOP that no prefix is required to send an action (i.e. the user only needs to
  877. ; type the action verb to use an action).  This is how TOP has treated action
  878. ; commands in the past.  NOTE:  This setting also affects personal actions.
  879. ;
  880. ActionPrefix NONE
  881. ;
  882. ; -----------------------------------------------------------------------------
  883. ; * ForceBio *
  884. ;
  885. ;     This setting lets you force users to fill out their biography before they
  886. ; are allowed to chat.  This setting will most likely be used for systems where
  887. ; meeting people is the sole objective.  It is also useful if you have been
  888. ; running a previous version of TOP or RAP and want your users to use the new
  889. ; biography feature.  To force people to fill out their biographies, turn this
  890. ; setting ON.  Otherwise, leave this setting OFF.
  891. ;
  892. ;     When this setting is ON, _ANY_ user that has not filled out _all_ of the
  893. ; biography questions will be forced to do so before they may chat!  This
  894. ; includes users who already have chatted in TOP.  If users try to skip a
  895. ; question or hang up and call back, they will still be forced to fill out the
  896. ; remainder of their biography next time they log on.  Note that this setting
  897. ; obviously can't prevent users from entering garbage or "none" for every
  898. ; question, but remember that a poorly filled out biography usually tells other
  899. ; users more about a person than a properly filled out biography does!
  900. ;
  901. ;     NOTE:  If you turn this setting ON, you should not configure any
  902. ; biography string responses with a minimum string length of 0.  Otherwise,
  903. ; when TOP is forcing the user to fill out his or her biography, TOP will let
  904. ; the user press ENTER to skip the question, however, after the remaining
  905. ; questions have been completed, TOP will see that this question has not been
  906. ; filled out and ask for the user's response again.  This can be confusing to a
  907. ; user.
  908. ;
  909. ForceBio No
  910. ;
  911. ; ---- End of TOP.CFG ----
  912.