home *** CD-ROM | disk | FTP | other *** search
/ Black Box 4 / BlackBox.cdr / batch / check101.arj / CHECK.DOC next >
Encoding:
Text File  |  1991-08-14  |  6.4 KB  |  218 lines
  1. Dolist:
  2.  
  3. From the DOS promt :<path>dolist <dolist data file> <timestamp file>
  4.  
  5. This program checks the <dolist data file> for text lines up to 70 
  6. characters headed by presentation information and terminated by a CR,
  7. LF sequence. The header can take the following forms, and must be nine
  8. ascii characters long:
  9.  
  10. "*        " - Empty form.
  11. "ddmmyynnA" - Full form.
  12. "ddmm**nnB" - Annual form.
  13. "D031     " - Day of the week form.
  14.  
  15. Where:
  16. %    dd = day of month.
  17. %    mm = month of year.
  18. *    yy = two character year (ie '91 - [20]89)
  19. *    ** = Generate warning on annual basis.
  20. %    nn = Number of days before event to generate warning.
  21. ?    A  = Activate afer the specified date (Year and "days to run"
  22.          are disabled). Exclusive of the specified date.
  23. ?    B  = Sound bell with this item.
  24.      D031  = Day of the week in binary format
  25.  
  26.  
  27. % These must be present.
  28. * These two are mutually exclusive, and either must be in the string.
  29. ? These items, if present, will operate the required option and should
  30.          be replaced with a space if not required.
  31.  
  32.  
  33. Empty form.
  34.  
  35. This will generate the associated text anytime the program is run. This
  36. is ideal for reminders for items that are "to do" at no specific date 
  37. but need constant reminders.
  38.  
  39.  
  40. Full / Annual Form.
  41.  
  42. These forms generate a report if the header info is within the period 
  43. of days, including the nnth day, from the date specified by ddmm. Note
  44. that the traditonal "/" seperator is not used or expected. If yy is 
  45. present, which if not required, must be replaced by **, this will only 
  46. generate one series of warnings leading upto the specified date. If the
  47. annual form is used, the warning will be generated every year whilst 
  48. the item remains in the data file (such as birthdays).
  49.  
  50.  
  51. Day of the week form.
  52.  
  53. Four ascii characters headed with a upper or lower case "D" followed
  54. with the string representation of the binary day/s the item is to be
  55. activated.
  56.  
  57. 7  6  5  4  3  2  1  0
  58. |  |  |  |  |  |  |  |
  59. |  |  |  |  |  |  |   - Monday.
  60. |  |  |  |  |  |   ---- Tuesday.
  61. |  |  |  |  |   ------- Wednesday.
  62. |  |  |  |   ---------- Thursday.
  63. |  |  |   ------------- Friday.
  64. |  |   ---------------- Saturday.
  65. |   ------------------- Sunday.
  66.  ---------------------- Not used.
  67.  
  68. A value of 031 = Week days (Mon - Fri).
  69. A value of 096 = Weekend days (Sat & Sun).
  70.  
  71.  
  72. Editing.
  73.  
  74. A standard text editor is required to edit the file C:\DOLIST.DTA and
  75. must terminate with <header><text>, CR, LF, EOF sequence.
  76.  
  77.  
  78. Exiting.
  79.  
  80. The program exits with the follow errorlevls
  81.  
  82. 0    Successful exectution.
  83. 1    No command tail.
  84. 2    Data file not found.
  85. 4    Timestamp file creation error.
  86.  
  87.  
  88. DOS/EGA/VGA required.
  89.  
  90.  
  91. Timechk:
  92.  
  93. This program is designed to read from the command line up to four
  94. parameters, Start time, end time, interval between and control file
  95. name. Time is input in 24 hour format without any seperators.
  96.  
  97. Command line formats:
  98.  
  99. System versions:
  100.  
  101. Valid between times      : drive:\path\timechk s hhmm hhmm
  102. Valid return after time  : drive:\path\timechk s a hhmm
  103. Valid return before time : drive:\path\timechk s b hhmm
  104.  
  105. Timestamp file versions:
  106.  
  107. Valid between times      : drive:\path\timechk drive:\path\file hhmm hhmm
  108. Valid return after time  : drive:\path\timechk drive:\path\file a hhmm
  109. Valid return before time : drive:\path\timechk drive:\path\file b hhmm
  110.  
  111. Full version             : timechk  drive:\path\file mm hhmm mm
  112.  
  113. The control file can be any valid DOS file. This program uses the 
  114. timestamp in the complete format to return valid if the system time 
  115. is between the two times and mm minutes has elapsed since the file 
  116. timestamp. File date is not checked against system date.
  117.  
  118. If the control file is not specified for the other versions, the 
  119. program checks on the system time, otherwise the file timestamp is 
  120. used. Please note, one character filenames are not to be used, 
  121. otherwise an errorlevel 2 termination will occur.
  122.  
  123. The full version checks for the current time to be greater than the file
  124. time, plus the offset and then checks th that the bracket time is valid.
  125.  
  126. Full pathnames, within the DOS 64 byte limit, may be used.
  127.  
  128. The program will return true (errorlevel 0) if the system or file time
  129. is equal to the specified times.
  130.  
  131. Return errorlevels:
  132.  
  133. - 0 Time check true.
  134. - 1 Time check false.
  135. - 2 No or incomplete command tail.
  136.         (Console bell sounded once.)
  137. - 3 Specified timestamp drive:\path\file not found.
  138.         (Console bell sounded twice.)
  139.  
  140.  
  141. Datechk:
  142.  
  143. This program returns errorlevel 0 if the date is equal to, after or
  144. before the specified command line date. The date is entered in the
  145. English format ddmmyy without seperators and must be prefixed by
  146. either a, b, or e (Upper or lowlower case permited) followed by a space.
  147. therefore the command line will look like:
  148.  
  149. drive:\path\datechk a 120891    (After 12/08/91),
  150. drive:\path\datechk b 120891    (Before 12/08/91),
  151. drive:\path\datechk e 120891    (Equal to 12/08/91).
  152.  
  153. If the year is replaced by ** then the ddmm sequence will trigger on
  154. the same date every year.
  155.  
  156. drive:\path\datechk a 1208**    (After 12/08),
  157. drive:\path\datechk b 1208**    (Before 12/08),
  158. drive:\path\datechk e 1208**    (Equal to 12/08).
  159.  
  160. Exiting.
  161.  
  162. errorlevel = 0    - True exit.
  163.          1  - False exit.
  164.          2    - Command line error.
  165.             (Console bell sounded once.)
  166.  
  167.  
  168. Dowchk:
  169.  
  170. This program has two basic formats, the version without the command
  171. tail and the version with a tail which must be seven characters long 
  172. in the following format:
  173.  
  174. dowchk 12345**    - Returns true for working days.
  175. dowchk *****67  - Returns true for the weekend.
  176.  
  177. Please note that the week format is the airline version, not the
  178. computer format, begining with Monday (1).
  179.  
  180. Exiting.
  181.  
  182. For the day select version:
  183. errorlevel = 0    - True exit.
  184.          1  - False exit.
  185.          2    - Command line error.
  186.             (Console bell sounded once.)
  187.  
  188.  
  189. For the no command tail version:
  190.  
  191. errorlevel = 1    - Monday.
  192.          2  - Tuesday.
  193.          3  - Wednesday.
  194.          4  - Thursday.
  195.          5  - Friday.
  196.          6  - Saturday.
  197.          7  - Sunday.
  198.  
  199.  
  200. Monthend:
  201.  
  202. Command line : drive:\path\monthend drive:\path\file
  203.  
  204. This program checks the timestamp file and the system date for
  205. inequality and assumes that the month end has passed.
  206.  
  207.  
  208. Exiting.
  209.  
  210. The program returns the following errorlevel codes
  211.  
  212. 0  -  Monthend has passed.
  213. 1  -  Monthend has not passed.
  214. 2  -  Command tail error (no tail!).
  215.         (Sounds the console bell once).
  216. 3  -  Timestamp file error.
  217.         (Sounds the console bell twice).
  218.