home *** CD-ROM | disk | FTP | other *** search
/ Crawly Crypt Collection 1 / crawlyvol1.bin / bbs / warn003 / warning.doc < prev    next >
Text File  |  1993-02-15  |  6KB  |  205 lines
  1.  
  2.                 Logon Warning , text file displayer
  3.                 ===================================
  4.  
  5.    Another Tavern BBS utility, other Turbo utilities from these stables
  6.  
  7.                 FILEBASE   - File database/freq list generator (Turbo V2)
  8.                 PAGE       - Chat program for V2 of Turbo
  9.                 PRIG       - IGS text file Processor
  10.                 STATSGEN   - BBS Stats generator
  11.                 ACCESS     - Turbo V2 User access editor
  12.                 VTMENU     - VT52 Menu Generator
  13.                 OLDFILE    - Old Download File Manager (Turbo V2 ONLY)
  14.                 JEKSHELL   - Jekyll Protocol / Turbo V2 interface
  15.                 FILEREP    - New file reporter into QBBS message structures
  16.                 PREPACK    - Gives you greater control of who receives
  17.                              Prepacked mail and when. (Turbo V2)
  18.  
  19. What does WARNING.PRG do ?
  20.  
  21. When run in your LOGON.BAT file it will display warnings/messages to a
  22. user which are determined by time , date , access level , name or day.
  23.  
  24. How to use WARNING.PRG
  25.  
  26. Create and place WARNING.INF in your default BBS directory, run WARNING.PRG
  27. in your LOGON.BAT , Turbo V2 users need to add the parameter
  28.  
  29. ~ACCESS ~NAME
  30.  
  31. (Substitute # for ~)
  32.  
  33. if your BBS software lets you run programs on login and has the above
  34. equivalents then you can use the program to the same extent as Turbo V2
  35. owners.
  36.  
  37. e.g.  E:\turbo\warning.ttp ~ACCESS ~NAME  This allows sending of messages
  38.                                           to users with specified access
  39.                                           levels or names.
  40.  
  41. All other systems just use
  42.  
  43. e:\turbo\warning.ttp                 You cannot specify messages to users
  44.                                      using access levels or name but can 
  45.                                      still use Time , Day and Date messages.
  46.  
  47. An example WARNING.INF file is enclosed.
  48.  
  49. How to create WARNING.INF
  50. =========================
  51.  
  52. Each Entry in the file consists of 2 parameters seperated by a comma 
  53. on the first line followed by the message to be displayed or further
  54. parameters to be tested. if those parameters are valid when the user
  55. logs on and finally a ! on a new line to signal the end of the message.
  56.  
  57. All parameter lines MUST start with a # , if you wish to use # as part of
  58. your message then make sure there is a leading space on the left hand side.
  59.  
  60. There are 5 possible options for parameters
  61.  
  62. START AND FINISH TIME
  63. ---------------------
  64.  
  65. These will make any following message be repeated every day between the
  66. defined times.
  67.  
  68. By putting the macro %MIN in your text when you use time parameters the 
  69. number of minutes before the finish time will be substituted instead.
  70.  
  71. Times MUST be 24 hour format , pre 1000 times MUST start with an 0
  72.   eg #0934,0959
  73.  
  74.  
  75. START AND FINISH DATE
  76. ---------------------
  77.  
  78. These will make any following message appear every time a user logs on
  79. between the specified dates.
  80.  
  81. Dates should only be the day and month seperated by a /  
  82.  
  83.   eg #01/01,02/10 
  84.  
  85.  
  86. ACCESS LEVELS
  87. -------------
  88.  
  89. You have 3 options for access level    #> , #< or #=
  90.  
  91. The format for using access level is the mathmatical parenthesis followed
  92. by a comma , followed by the value you want tested against the users access
  93. level.
  94.  
  95.  e.g.   #<,32767
  96.         #>,0
  97.         #=,5
  98.  
  99. USER NAME
  100. ---------
  101.  
  102. This is the Keyword #NAME followed by the name you want tested against the 
  103. user name.
  104.  
  105. e.g.
  106.  
  107.      #NAME,BAKER
  108.      #NAME,SMITH
  109.  
  110. if you include a trailing space then only the forename will be matched , a 
  111. preceeding space will usually only test the surname.
  112.  
  113. e.g.  #NAME, BAKER
  114.       #NAME,PAUL      <- There is a space there honest!
  115.  
  116. CURRENT DAY
  117. -----------
  118.  
  119. This is the Keyword #DAY followed by the day you want the message to be
  120. shown.
  121.  
  122. Valid days are MON TUE WED THU FRI SAT SUN
  123.  
  124. e.g.
  125.  
  126.          #DAY,MON
  127.          #DAY,FRI
  128.          #DAY,SUN
  129.  
  130.  
  131. MESSAGE MACROS
  132. --------------
  133.  
  134. At the end of each run the program will pause for 1 second , you can make
  135. the program pause for as many seconds as you wish between messages by adding
  136. the macro   #PAUSE to a new line in the text with a 1 second delay for each
  137. #PAUSE on a new line , so the following in a message will pause for 3 seconds
  138.  
  139. #PAUSE
  140. #PAUSE
  141. #PAUSE
  142.  
  143. You can also make it wait for a keypress from the user by adding the macro
  144. #WAIT to a new line , the message 'Any key to continue' will be sent and a
  145. keypress waited for.
  146.  
  147. You can have more than one message displayed during each time/date period.
  148.  
  149. e.g.
  150.  
  151. #2359,0100
  152.  
  153. The BBS will be coming down for networking in %MINS
  154.  
  155. !
  156. #15/12,25/12
  157.  
  158.                            Wishing a
  159.                                x
  160.                                *
  161.           A Merry Christmas   ***  and a Happy Year
  162.                              *****
  163.                             *******
  164.                                |
  165.                        To ALL my BBS Users
  166.  
  167. !
  168.  
  169.  
  170.  
  171. The above networking message will be displayed every day between 11:59pm
  172. and 1:00am, whilst the pre-christmas message will be displayed at every
  173. login during the defined dates.
  174.  
  175. You could have 2 messages defined in such a way that one is within the 
  176. time/date period of the other.
  177.  
  178. e.g.
  179.  
  180. #0100,0500
  181.  
  182. It's %MIN to 5:00am
  183.  
  184. !
  185. #0300,0400
  186.  
  187. It's nearly time for networking!
  188.  
  189. !
  190.  
  191. between 3am and 4am , both of the above would be displayed, the same can 
  192. be applied to dates.
  193.  
  194. The following are examples of Access Level messages.
  195.  
  196. #>,0
  197. Only users above access level 0 can see this
  198. !
  199. #<,1
  200. Only New users (level 0) can see this
  201. !
  202. #=,5
  203. Only users at access level 5 will see this
  204. !
  205.