home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS 1992 December / simtel1292_SIMTEL_1292_Walnut_Creek.iso / msdos / fido / newfido.lzh / EVENTS.INI < prev    next >
Text File  |  1988-02-24  |  8KB  |  202 lines
  1. ;
  2. ;    EVENTS.INI: Fido/FidoNet events definition file
  3. ;    For: Fido/Fidonet version 12a
  4. ;    Copyright T. Jennings 
  5. ;    9 July 87
  6. ;
  7. ;This file defines all of the events that Fido/FidoNet can execute. 
  8. ;After making any changes to this file, please be sure to run SET-FIDO 
  9. ;to make the changes take effect.
  10. ;
  11. ;You do not need to have any events defined at all in order to 
  12. ;use Fido; you may want to set an event to allow callers to use the
  13. ;P)age-Operator command however. The example supplied below does this.
  14. ;
  15. ;If you want to use FidoNet, the electronic mail program, then you
  16. ;need to add one or more events to cause FidoNet to run at a predetermined
  17. ;time. Please refer to the manual for details on installing FidoNet.
  18. ;
  19. ;Each event definition must fit on one line, and the various components
  20. ;of the event line must be in the order below; you can use tabs, spaces,
  21. ;etc to make it more readable. There is room for 100 events.
  22. ;
  23. ; - EVENT DEFINITIONS -
  24. ;
  25. ; You can have any number of the same type events. 
  26. ; 
  27. ; The DAY is the day of the week the even should run; days are named
  28. ;MON, TUE, WED, THU, FRI, SAT, SUN and ALL. ALL means every day; it 
  29. ;saves you the trouble of entering seven nearly identical events when you
  30. ;want the same thing to happen every day.
  31. ;
  32. ; The TIME is the time of day the event should start. This is given as
  33. ;hours and minutes, in 24 hour format: 00:00 is midnight, 12:00 is noon,
  34. ;and 23:59 is one minute before midnight (11:59 PM).
  35. ;
  36. ; WINDOW is the number of minutes that the event should be run for; if 
  37. ;you want an event to run from 9 AM until 11:30 AM, you'd use a TIME of
  38. ;11:30, and a window of 150. (2 hrs 30 minutes; 2 * 60 plus 30).
  39. ;
  40. ;The EVENT type can be any one of the following. Please refer
  41. ;to the manual for what the various event types are.
  42. ;
  43. ; PAGE
  44. ;    This is the "event" that tells Fido when to honor caller
  45. ;    P)age-Operator commands or not. It is not truly an event. During the
  46. ;    time the "event" is active, the P)age-Operator command will try to
  47. ;    get the attention of the Sysop, who can talk to the caller
  48. ;    via the local keyboard. This example enables the P)age-Operator
  49. ;    command from 9:00AM until 5:00PM:
  50. ;
  51. ; ALL 9:00 480 Page        ;480 minutes is 8 hrs
  52. ;
  53. ;
  54. ; FIDONET (tag letter A - W)
  55. ;    This causes FidoNet to run during the specified time. In
  56. ;    many cases you will use only "FidoNet A".
  57. ;
  58. ; ALL 2:00 60 FidoNet A    ;typical IFNA National Mail Hour
  59. ;
  60. ;
  61. ; ERRORLEVEL (number 3 - 255)
  62. ;    This causes Fido to terminate to DOS with the specified
  63. ;    ERRORLEVEL, which can be tested for within a .BAT batch file.
  64. ;    Refer to the manual and to your DOS documentation.
  65. ;
  66. ;    Note that the "WINDOW" here is somewhat misleading. Fido/FidoNet
  67. ;    will run the event only once, regardless of how long it is
  68. ;    set to run. What the time does do is allow a wide "window" for
  69. ;    the event to run; for instance, a FidoNet event as in the example
  70. ;    above won't actually end at 3:00; it does post-processing that
  71. ;    takes a few minutes. To compensate for this, set the ERRORLEVEL
  72. ;    event wide to make sure it catches it.
  73. ;
  74. ; Mon 4:00 20 ERRORLEVEL 17 ;exit to DOS at 4:00AM or thereabouts
  75. ;
  76. ;
  77. ; IDLE
  78. ;    The IDLE event causes Fido/FidoNet to do nothing at all
  79. ;    for the entire event; it will not answer the phone either.
  80. ;
  81. ; Sat 9:00 480 IDLE        ;be IDLE during business hours
  82. ;
  83. ;
  84. ;
  85. ; SPECIAL OPTIONS:
  86. ;
  87. ; There are special options that can be applied to events. 
  88. ;
  89. ;OPT:
  90. ;Normally, Fido will limit callers time limits so that they do
  91. ;not interfere with upcoming events; for example, if there is an
  92. ;event scheduled for 9:00 AM, and the caller logs in at 8:45 and 
  93. ;has a 60 minute limit, the caller could potentially stay connected
  94. ;throughout the entire event, causing Fido/FidoNet to miss it.
  95. ;
  96. ;To prevent this, Fido will shorten a callers time limit to ensure
  97. ;the system will be free to execute the event. (The caller gets
  98. ;appropriate warnings, etc as to the shortened limit.)
  99. ;
  100. ;There are times however when it is acceptable for callers to 
  101. ;preempt scheduled events; for example, if you merely need to run
  102. ;a program via an ERRORLEVEL event sometime during the day, but not
  103. ;necessarily at some specific time, the event modifier "OPTIONAL"
  104. ;can be used. This tells Fido/FidoNet not to cut a callers limit short;
  105. ;the caller can stay on during all or part of an events time window,
  106. ;causing the event to be missed entirely or its start time delayed.
  107. ;
  108. ; Here are two examples:
  109. ;
  110. ;OPT    ALL    8:00    240    errorlevel 8    ;execute when no user is on
  111. ;OPT    ALL    8:00    10    errorlevel 8    ;coudl be missed entirely
  112. ;
  113. ; Assume that the caller has a 60 minute maximum time limit. In the first
  114. ;example, if the caller logs in at 7:59 and stays on 55 minutes, the event
  115. ;will start at 8:54. No matter what time a caller logs in, the event will
  116. ;be run.
  117. ;
  118. ; In the second example, if a caller logs in before the event and stays 
  119. ;connected betwwen 8:00 and 8:20, the event will be missed entirely. This
  120. ;is another way of deferring events. Keep in mind that there may be up to
  121. ;100 events.
  122. ;
  123. ;
  124. ;RUSH
  125. ;RUSH mail is way to make Fido/FidoNet send messages out as soon
  126. ;as a caller logs off the system. It does this by modifying
  127. ;FidoNet events so that it gets run after each caller logs off,
  128. ;and stops the event when there is no mail to send, or no more
  129. ;tries left. 
  130. ;
  131. ;For example, you could define a daytime event such as "FidoNet L"
  132. ;to handle only the few system you send to regularly, such as the
  133. ;one below:
  134. ;
  135. ;RUSH All 9:00 360 FidoNet L    ;special FidoNet event
  136. ;
  137. ;(in ROUTE.L)
  138. ;Send-To 999/1 990/23 777/34             ;only these systems
  139. ;Send-Only                               ;send rapid fire
  140. ;dial-tries 2                            ;try only twice
  141. ;
  142. ;After any caller disconnects, Fido will invoke FidoNet, and if it
  143. ;is between the hours defied (here, 9:00AM until 3:00PM) FidoNet
  144. ;will run schedule L. If there is no mail for the systems in the
  145. ;send-to line, the event terminates instantly, and Fido will
  146. ;accept calls. If there is mail however, FidoNet will attempt to
  147. ;send it in the normal manner, in this case as send-only, maximum
  148. ;two tries per system. When either the mail is sent, or it has
  149. ;tried twice for each system, FidoNet returns to Fido.
  150. ;
  151. ;There are no restrictions on FidoNet events, schedule tags,
  152. ;routing controls or scheduling of RUSH events. You can also
  153. ;define RUSH ERRORLEVEL events.
  154. ;
  155. ;
  156. ;QUICK
  157. ;
  158. ;This option makes FidoNet events extremely fast, with one
  159. ;limitation. When FidoNet starts, it readies the nodelist files,
  160. ;reading all applicable ROUTE.* files. This can take up to a few
  161. ;minutes, depending on your system and the complexity of the route
  162. ;files.
  163. ;
  164. ;QUICK tells FidoNet to re-use the tables generated from the last
  165. ;FidoNet schedule, if the last FidoNet schedule has the same
  166. ;letter tag.
  167. ;
  168. ;To put it simply, on a 4.77MHz pclone with slow hard disk, a
  169. ;complete QUICK RUSH FIDONET event takes only 13 seconds to
  170. ;complete when there is no outgoing mail.
  171. ;
  172. ;QUICK only helps when you run the same FidoNet letter over and
  173. ;over, such as a RUSH event. If you run different events one after
  174. ;the other, FidoNet cannot take advantage of the previous
  175. ;schedules tables.
  176. ;
  177. ;
  178. ;The catch is: FidoNet will no notice if you edit a ROUTE file,
  179. ;unless you run SET-FIDO afterwards. In general, you should run
  180. ;SET-FIDO whenever you change any of Fido's files; if you do this,
  181. ;you will never have any problems, and QUICK will work correctly
  182. ;every time.
  183. ;
  184. ;
  185. ;
  186. ; - EVENT EXECUTION: -
  187. ;
  188. ; Fido/FidoNet searches the event list from top to bottom, and executes the
  189. ;first one found that is runnable (current time is within the window) and
  190. ;has not been run yet. You can have events that overlap, such as one that
  191. ;runs every day, with single-day exceptions before it.
  192. ;
  193. ;
  194. ;
  195. ;DAY    TIME    WINDOW    EVENT TYPE    DESCRIPTION
  196. ;
  197. ;all    9:00    480    Page        ;enable the Page command (9a - 5p)
  198. ;all    9:00    180    Page        ;enable Page, (9a - noon)
  199. ;all    13:00    240    Page        ;enable Page, (1p - 5p)
  200.  
  201. ;all    2:00    60    FidoNet A    ;normal, default FidoNet event (PST)
  202.