home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS 1992 June / SIMTEL_0692.cdr / msdos / sysutl / idclog20.arc / IDCLOG.DOC next >
Encoding:
Text File  |  1988-05-09  |  7.5 KB  |  199 lines
  1.  
  2.  
  3.             Documentation for IDCLOG.COM
  4.  
  5.                Written by Gary Conway
  6.  
  7.             Infinity Design Concepts, Inc.
  8.  
  9.                  1052 Parkway Drive
  10.  
  11.                          Louisville, Kentucky 40217
  12.  
  13.  
  14.                 Release 2.0
  15.  
  16.  
  17.  
  18. IDCLOG.EXE and its associated files are ShareWare programs. The shareware
  19. concept allows you, the end user, to use the program and decide whether or
  20. not it has value to you. If you find that it does and continue to use it,
  21. then you are obligated to register your copy.
  22.  
  23. All materials and files associated with this program are copyrighted 1986,88
  24. by Infinity Design Concepts, Inc. and may not be used in commercial endeavors
  25. or as a sales aid without the expressed written consent of the author.
  26.  
  27.  
  28. If you like this program and find that it has value to you, then you may send
  29.  $25.00 to the above address. This will put you on our mailing list which means
  30. that you will recieve notices of all new IDC products as well as how to
  31. recieve phone help from our private lines.
  32.  
  33.  
  34. The philosophy:
  35.  
  36. IDCLOG.EXE is a memory resident time logging facility. It is useful to those
  37. of you who do work for customers and need a way of tracking the time without
  38. making 4000 notes. The program can be called up from within any other program 
  39. and the time can be logged on or off or paused. It is a very intelligent
  40. TSR in that it checks with DOS before performing any operations. There are
  41. times when DOS should not be interrupted, such as during a disk read/write.
  42. All too many TSR programs ignore this fact and consequently cause serious
  43. problems. IDCLOG intercepts 10 of the DOS interrupts. In almost all cases,
  44. IDCLOG allows the original interrupt handler to execute its functions first,
  45. deferring IDCLOG functions until the resident handler has finished. In the
  46. case of function 1 of Int 21h (used when COMMAND.COM is waiting for input),
  47. this is a must and is all too often overlooked by TSR programs. Another
  48. major error found in TSR's is the fact that many of them try to make use
  49. of Int 21h functions 01h thru 0Ch. This is not acceptable, since these
  50. functions are non-reentrant and use the IOstack of DOS. They can be forced
  51. (and are) to use the auxillary DOS stack, but this is also not acceptable
  52. since they also use buffering schemes that are definitely not reentrant.
  53.  
  54.  
  55.     At any point, when the main window menu is called up, the data file
  56. IDCLOG.BIN can be written out to an ASCII text file. The program will write
  57. all of the data available to this text file (IDCLOG.TXT), which can then
  58. be edited with your favorite word processor. The format for the binary file
  59. is also given in this documentation for those of you who would like to create
  60. some other program that deals with the data more appropriately for your 
  61. application.
  62.  
  63. NOTE: all data files are written to the root directory on the drive
  64.       that IDCLOG was called up from.
  65.      
  66.      
  67. Loading the program:
  68.  
  69.     Load IDCLOG by simply typing IDCLOG at the dos prompt. Once the
  70. program is loaded, messages are issued with version information etc. This
  71. program intercepts the Int 9 function of DOS and checks for the ALT - ENTER
  72. key sequence. When the program is first loaded, it determines the character-
  73. isitics of the environment that it will operating in, such as color or mono
  74. and which drive is the default. IDCLOG reads the default drive when it is
  75. loaded and uses this drive for all reading and writing.
  76.  
  77. Activating the program:
  78.  
  79.     ALT-ENTER will activate the IDCLOG program. Note that IDCLOG
  80.     checks the current activity of DOS and determines whether or not
  81.     it is safe to interrupt the operation. If,for example, DOS is
  82.     writing to disk, then IDCLOG will not interrupt this operation
  83.     until DOS is finished.
  84.  
  85. First:        (IMPORTANT)
  86.  
  87.     The first thing that must be done is to Initialize the log files, 
  88. option F5 from the mainmenu. This option will create or truncate the data
  89. files on the disk. Any previous data will be lost, so be forewarned! If this
  90. initializing step is not performed, then no log data can be written at logoff.
  91. The log files are created in the root directory on the default drive.
  92.  
  93. Logging ON:
  94.  
  95.     The F1 option from the mainmenu, starts the time logging operation.
  96. The next time the mainmenu is called up, the F1 line will be highlighted,
  97. denoting that time is being logged.
  98.  
  99. Logging OFF:
  100.  
  101.     The F2 option will stop the time logging and write the data to the
  102. IDCLOG.BIN file. If the logged time has crossed midnight, the time will still
  103. be counted accurately. Since DOS does not increment the date at midnight
  104. rollover, IDCLOG performs this function and updates the DOS date clock.
  105. The month and year are also incremented as necessary. The only potential
  106. problem here is if you are logged on from Februrary 28 to Februrary 29 in 
  107. leap year. The program will not handle this case. Why not ? I just couldn't
  108. justify the effort involved in handling this very special case! The logged time
  109. will be correct, the only problem is that the finish date will read 03/01/xx
  110. instead of 02/29/xx.
  111.  
  112.  When logging off, you will be shown the current customers one at a time.
  113. You may thumb through the list with the arrow keys. There are three other
  114. option available also. If you respond "N", then you will be asked for the new
  115. customers name. The name entered is checked against the customer file to see 
  116. if it already exists, if it does, then a NEW client name entry is not made. 
  117. If it doesn't exist, then the new name is added to the customer file. If you 
  118. respond "D" then the customer name shown in the window is deleted from the
  119. customer file. The desired customer is selected with the ENTER key.
  120.  
  121.  
  122. Pausing:
  123.  
  124.     The F3 option is a pause toggle, that is the first time it is called,
  125. it pauses the logging of time and the second it resumes the time log. The total
  126. logged time reflects the pause time by subtracting the total paused time from
  127. the total logged time. The logging operation may be paused as many times as
  128. desired. When the Pause feature is active, that selection will be highlighted
  129. the next time the menu window is called up.
  130.  
  131.  
  132. Writing ASCII text file:
  133.  
  134.     The F4 option will take all of the data in the IDCLOG.BIN file and
  135. write it in ASCII with carriage returns and line feeds to IDCLOG.TXT. This
  136. file can then be edited to produce any desired format.
  137.  
  138.  
  139.  
  140.                           File Formats
  141. ------------------------------------------------------------------------------
  142.  
  143.  
  144. IDCLOG.HDR
  145.  
  146.     This file holds the Users name and Company data. The total length
  147.     of this file is always 40 bytes.
  148.  
  149.     Record Structure:
  150.  
  151. User Name    20 bytes ASCII
  152. Company        20 bytes ASCII
  153.  
  154.  
  155. IDCLOG.BIN
  156.  
  157.     This file holds the time/date data for each log on log off. It is
  158.     keyed on the Client name field.
  159.  
  160.     Record Structure:
  161.       Field     Len    Type
  162.  
  163.     Client Name    20     ASCII
  164.     Start Year    2     Binary Word format Lo/Hi
  165.     Start Month    1    Binary
  166.     Start Day    1    Binary
  167.     Start Hour    1    Binary
  168.     Start Minute    1    Binary
  169.     Start Second    1    Binary
  170.     End Year    2    Binary Word Format Lo/Hi
  171.     End Month    1    Binary
  172.     End Day        1    Binary
  173.     End Hour    1    Binary
  174.     End Minute    1    Binary
  175.     End Second    1    Binary
  176.     Pause Hours    1    Binary
  177.     Pause Minutes    1    Binary
  178.     Pause Seconds    1    Binary
  179.     Total Hours    1    Binary
  180.     Total Minutes    1    Binary
  181.     Total Seconds    1    Binary
  182.  
  183. IDCLOG.CUS
  184.  
  185.     This file holds all of the customer names. It is used when making
  186.     new log entries. When logging off, this file is searched showing 
  187.     each client in the file and allowing the user to thumb through 
  188.     the records with the arrow keys. 
  189.  
  190.     Record Structure:
  191.  
  192.        Field    Len    Type
  193.  
  194.     Client Name    20    ASCII
  195.  
  196.  
  197.  
  198. EOF: IDCLOG.DOC
  199.