home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 11 Util / 11-Util.zip / tt106.zip / readme.TXT next >
Text File  |  1998-06-07  |  6KB  |  115 lines
  1. TimeTrak is freeware. You may use and distribute this program as you wish.
  2. Distribution must include this readme file.The author of TimeTrak is in no way
  3. responsible for any damages caused by the use of TimeTrak. If you find that
  4. TimeTrak is useful, please send an email just to let me know how many people
  5. are using the program.
  6.  
  7. Copyright 1998 Tom Stevic <stevic@ibm.net>
  8.  
  9. *************************************************************************************
  10. TimeTrak is a little timer that records the elapsed time between pressing
  11. the Start button and exiting the program. Pressing the Stop button will cause
  12. the timer to stop, but not reset. When the program is exited, a file will be
  13. created, or appended to, the default name is "timetrak.log" that has the date of shut down,the elapsed time, and, if selected, the start and stop times for that session. This file will be created in the directory where TimeTrak is run from.
  14.  
  15. I use the program to keep track of billable hours on projects that I do. 
  16.  
  17. If anyone has any suggestions feel free to forward them to me at the above
  18. email address.
  19.  
  20. *********************************************************************************
  21. Directions for use.
  22.  
  23. Starting the program with no arguments will cause a log file with the name
  24. "timetrak.log" to be created if any logging options are selected.If you wish to
  25. use a different log file name, start the program with that name passed as an
  26. argument. Such as, 'timetrak project1' ( no quotes ). Then the logfile will
  27. be called project1.log, and any options you choose will be kept in a file called
  28. project1.ini.  
  29.  
  30. The program may be set up with many different log file names if you wish to use
  31. it for different timing functions. Create program object for each name that you
  32. wish to use and place the name you want to use in the parameters field. The program
  33. can also be started from the command line or a *.cmd file.
  34.  
  35. **Note: There is no error checking when TimeTrak writes to a file. If the name you
  36. use in not a valid name, or if there is not enough room to write the file, TimeTrak
  37. will ignore the error without warning, or it may crash. Please make sure the file
  38. name you choose is valid. Do not supply and extension, do not use blanks ( TimeTrak
  39. will ignore everything after the blank ), and use no more than 8 characters if saving
  40. to a FAT partition.
  41.  
  42. Once started, TimeTrak has 4 control buttons. The Green one starts the timer, the Red
  43. one Stops it, the Black button exits and the Blue button pops up a dialog that will
  44. insert a 'note' into the log file. The 'note' can be up to 80 characters in length,
  45. and pressing the 'Accept' button on the dialog will write the text immediately into
  46. the log file.
  47.  
  48. Clicking the mouse on the time display will bring up the settings page.
  49.  
  50. On the settings page, selecting 'Save Start Time' will cause the start time
  51. to be written to the log file every time the time is started.
  52.  
  53. Selecting 'Save Stop Time' will cause the stop time to be written to the log
  54. file every time the timer is stopped.
  55.  
  56. Selecting 'Save Elapsed Time' Causes the elapsed time to be saved to the log file
  57. when the program is terminated.
  58.  
  59. Selecting 'Display Total Time' will record the elapsed time and reload it between
  60. sessions, giving you a running total time. ( useful for things like total time spent
  61. on a job over several days )
  62.  
  63. Pressing the 'Clear Total' Button will reset the stored time back to 0 seconds.
  64.  
  65. Selecting 'Start When Opened' will start the time when the program is started.
  66.  
  67. Selecting 'Log Elapsed on Stop' will cause the current elapsed time to be written
  68. to the log file when ever the stop button is pressed. Normally the elapsed time is
  69. only written when the program terminates.
  70.  
  71. Selecting 'Log Day of Week' will add the day of the week ( Sunday, Monday, etc ) to 
  72. the date code in the log file.
  73.  
  74. Selecting 'Add CR in Log' will insert a blank line into the log after a timer stop
  75. and after the elapsed time is written. This make the file a little easier to read
  76. by humans.
  77.  
  78. ************************************************************************************
  79. History:
  80. V 1.00 Released to public 2/15/98
  81.  
  82. V 1.01 Replaced objectrexx function with classicrexx to fix error on exit 2/16/98
  83.  
  84. V 1.02 Added the options of changing the log file name, and storing the start and
  85. stop times.
  86.  
  87. V 1.03 Added the option to start timing when opened. Also added the ability to create
  88. different setups. When a log file name other than "timetrak.log" is used, a separate
  89. *.ini file will be created. Then if the first part of the *.ini file is passed as a
  90. parameter when timetrak is started, it will use the settings stored in the separate
  91. *.ini file.
  92.  
  93. For example, if you create a setup with the logfile "project1.log" and another setup
  94. with the logfile "project2.log", the you can start either setup by creating a program
  95. object with 'project1' or 'project2' in the parameters field of the properties notebook.
  96. ( note: do not include the quotes ). It can also be started from the command line by
  97. typing 'timetrak project1'
  98.  
  99. v 1.04 Added the option to save a running total time that is loaded into the display
  100. window upon start up of the program. Also, in the settings window, a stored time can
  101. be cleared.
  102.  
  103. This release has two executable files TimeTrak.exe and TimeTrk2.exe. The second program
  104. has the window sizes adjusted for proper display on some video card / resolution combinations. It has been noted that the right side of the window was chopped of when
  105. displayed using some display card at high resolutions. You can erase TimeTrak.exe and
  106. rename TimeTrk2.exe if you see this behavior on your monitor. 3/27/98
  107.  
  108. v 1.05 Fixed bug that would cause the time for a current session to be lost when the
  109. stop button was pushed. 3/29/98
  110.  
  111. v 1.06 Added the options "Log Elapsed on Stop", "Log Day of Week", "Add CR in Log",
  112. and the optional 'note' entry. Changed the buttons from having text descriptions to
  113. smaller colored ones. Made Y2K compatible with the following note: TimeTrak will now
  114. work properly after the year 2000 as long as the timer is not started when the year
  115. is 1999 and allowed to run over the year change. 6/7/98