home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / top2src.zip / CONFIG.TXT < prev    next >
Text File  |  1996-09-15  |  7KB  |  128 lines
  1. Complete List of TOP Keywords
  2. -----------------------------
  3.  
  4. Keywords can appear in the config. file in any order, unless noted.  All
  5. keywords that do not appear will be assigned a default value, unless noted as
  6. mandatory.  Default values should appear in the TOP source, obviously, and
  7. should also appear in the docs and in the annotated config. file.  Commented
  8. keywords aren't currently supported by the config. reader.  Keywords marked
  9. with a ^ are not yet supported by the program itself.
  10.  
  11. -------------------- Needs Memory/Disk toggle support.
  12.  
  13. DC1 Keywords
  14. ------------
  15.  
  16. BBSType                   Type of BBS (*1)
  17. BBSName                   Name of BBS
  18. SysopName                 Name of System Operator
  19. SystemLocation            Location of System
  20. ;^SystemPhone               System Phone Number
  21. ;^SystemBPS                 System bps rates (*2)
  22. ;^SystemSummary             Description of System
  23. TOPPath                   Path to TOP Files
  24. TOPWorkPath               Path to InterTOP Messages
  25. TOPANSIPath               Path to TOP ANSI/AVT/RIP files.
  26. BBSPath                   Path to BBS Files
  27. BBSIPCPath                Path to BBS IPC Files
  28. SecuritySysop             Security Level of Sysops (All Securities = 0-65535)
  29. SecurityNewUser           Security Level to give to New Users
  30. SecurityTalk              Security Level to Talk in Pub
  31. SecurityChangeHandle      Security Level needed to Change Handles
  32. SecurityChangeSex         Security Level needed to Change Sex
  33. SecurityChangeEXMsg       Security Level needed to Change Entry/Exit
  34. SecuritySendPrivate       Security Level to Whisper/SecretAct
  35. SecurityActionUse         Security Level to use Actions
  36. ;^SecurityOverrideTime      Security Level to ignore Time Restrictions
  37. ShowTitle                 Show Title Page?
  38. ShowNews                  Show News File?
  39. AllowActions              Allow Actions to be used?
  40. AllowHandles              Allow Handles to be used?
  41. AllowNewHandles           Allow New Handles or use BBS ones?
  42. AllowChangeHandle         Allow Handles to be changed?
  43. AllowChangeSex            Allow Sex to be changed?
  44. AllowChangeEXMsg          Allow Entry/Exit to be changed?
  45. AllowPrivateMsgs          Allow Whispers/SecretAct
  46. AllowForgetting           Allow users to Forget/Be Forgotten
  47. ;^MaxCallTime               Maximum time allowed per call (0-1440)
  48. ;^MaxDayTime                Maximum time allowed per day (0-1440)
  49. InactiveTimeout           Inactivity Timeout, in seconds
  50. LocalBeeping              Sessions to beep locally for (*4)
  51. ;^MaintTime                 Time and Day to run Maintenance (*5)
  52. LangFile                  Base File Name (no path or ext.) of Language File
  53. PollDelay                 Delay between message polls, in .1s units
  54. RetryDelay                Delay between file retries, in .1s units
  55. RetryMax                  Maximum number of file retries before error/warning
  56.  
  57. DC2 Keywords
  58. ------------
  59.  
  60. MaxNodes                  Number of nodes on system
  61. ;^NameBreakChars            Characters Used for Name Capitalization (*6)
  62. ;^EditingPassword           Password for getting into the System Editor
  63. ;^SysopHandle               System Operator's Handle
  64. ;^Pipe                      Path of OS/2 Pipes (TOP/2 Only)
  65. ;^SecurityActionOp          Security Level for Action Ops
  66. ;^SecurityOverrideOptions   Security Level to ignore Allowance Options
  67. ;^SecurityOverrideSettings  Security Level to ignore TOP Restrictions
  68. ;^SecurityOverrideInactive  Security Level to ignore Inactive Timeout
  69. ;^SecurityCantForget        Security Level for people who can't be forgotten
  70. ;^SecurityForget            Security Level to forget users
  71. ShowOpeningCredits        Show opening credits?
  72. ShowClosingCredits        Show closing credits?
  73. NoRegName                 Use Sysop's Handle in Regnote.
  74. ;^LogInEditOnlyNodes        Write Editor Only logins to NODEIDX?
  75. AllowHighASCII            Allow ASCII 128-255?
  76. ;^AllowPubColour            Allow PubColour to be used at all?
  77. ;^AllowPubColourInHandles   Allow PubColour in Handles?
  78. ;^AllowPubColourInBio       Allow PubColour in Bio Entries?
  79. CrashProtDelay            Seconds between Crash Protection Sweeps (0-65535)
  80.  
  81. TOP Keywords
  82. ------------
  83.  
  84. ;^AllowPubColourInChat      Allow PubColour in typed text?
  85. DefaultChannel            Default chat channel for New Users
  86. ;^NewUsersEnterPassword     Sessions to prompt new users to enter a password (*4)
  87. ;^EnforcePassword           Sessions where a password must always be present
  88. ;^MinimumPasswordLength     Minimum number of characters for password (1-20)
  89. MaxActions                Maximum number of actions allowed
  90. MaxPWTries                Maximum number of password attempts before failure
  91. ;^PokerMinBet               Minimum bet allowed in Poker
  92. ;^PokerMaxBet               Maximum bet allowed in Poker
  93. ;^PokerAnte                 Ante for Poker games
  94.  
  95. Footnotes
  96. ---------
  97.  
  98. 1 - One of "UNKNOWN", "RA2", "MAX2", "MAX3", or "SBBS11".
  99.  
  100. 2 - The letters A through Z represent supported bps rates if present.
  101.     A=300,B=600,C=1200,D=2400,E=4800,F=7200,G=9600,H=12000,I=14400,J=16800,
  102.     K=19200,L=21600,M=24000,N=26400,O=28800,P=31200,Q=33600.  The remaining
  103.     letters are unused at this time.  The symbol * can also be used.  It
  104.     represents a customized bps rate, and should be followed immediately by a
  105.     bps rate, for example: "*38400".  There can be as many * symbols as needed.
  106.     Letters can be seperated by spaces if needed, but this should normally not
  107.     be done.
  108.  
  109. 3 - UseHandles keyword obsoleted by AllowHandles and AllowNewHandles.
  110.  
  111. 4 - Can contain the words "None", "Local", "Remote", or "LAN", each signifying
  112.     the type of session the setting is allowed to be used with.  If "None" is
  113.     present, it overrides the entire line, meaning the setting will not be used
  114.     whatsoever, even if other valid words are present.
  115.  
  116. 5 - Format is "<day|type> [<time>]".  Using a day means that maintenance will
  117.     be performed on a weekly basis on the specified day.  Days can be one of
  118.     "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", or
  119.     "Saturday", though only the first three letters are needed.  Using a type
  120.     means maintenance will be performed as described by the type used.  Types
  121.     can be one of "Daily", or "Weekly", with "Weekly" being the same as
  122.     specifying "Sunday" as a day.  Time is optional, and indicates the time (in
  123.     HH[:MM[:SS]] format.  If a time is omitted, 00:00:00 will be used.
  124.  
  125. 6 - Can contain any ASCII character including space.  Therefore, chars. should
  126.     logically not be separated by spaces.  Space can NOT be the first character
  127.     used, for obvious reasons.
  128.