home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 11 Util / 11-Util.zip / eggtm101.zip / EGGTIMER.HLP (.txt) < prev    next >
OS/2 Help File  |  2000-01-17  |  10KB  |  255 lines
  1.  
  2. ΓòÉΓòÉΓòÉ 1. What is Egg Timer/2? ΓòÉΓòÉΓòÉ
  3.  
  4. Egg Timer/2 does what it says. 
  5.  
  6. It counts down for a certain time, then completes one or more actions, eg beep, 
  7. play a system sound in the background, execute a program, and/or pop up a 
  8. reminder message. 
  9.  
  10. Set the minute and second spin buttons independently; maximum time is 60 
  11. minutes and 60 seconds. 
  12.  
  13. The window is small enough to overlap the WarpCenter and therefore not 
  14. interfere with running programs. 
  15.  
  16. Use the popup menu to select actions, or use command line parameters. 
  17.  
  18. The Go button starts countdown, and the Stop button stops countdown and resets 
  19. initial time. 
  20.  
  21. This is not a replacement for a full chron program eg Egg Timer/2 does not 
  22. allow you to start from a fixed time. 
  23.  
  24.  
  25. ΓòÉΓòÉΓòÉ 2. Installation ΓòÉΓòÉΓòÉ
  26.  
  27. Requirements: 
  28.  
  29.    1. OS/2 PM Shell (tested only on Warp 4 with FixPak 12; should also work in 
  30.       OS/2 2.x and Warp 3) 
  31.  
  32.    2. VROBJ v2.1d (available from many places including 
  33.       http://www.powersoft.com/services/support/vxrexx/; you may already have 
  34.       it) 
  35.  
  36.    3. REXX support (installed by default during OS/2 installation; just don't 
  37.       delete it) 
  38.  
  39.    4. No real eggs necessary. :-) 
  40.  
  41.  How to install: 
  42.  
  43.    1. Unzip EGGTIMER.ZIP into an appropriate directory 
  44.  
  45.    2. There will be only 3 files: EGGTIMER.EXE, EGGTIMER.HLP, and README.TXT 
  46.  
  47.    3. You're ready to go! 
  48.  
  49.  Removing Egg Timer/2: :-( 
  50.  
  51.    1. Delete EGGTIMER.EXE, EGGTIMER.HLP and the README.TXT files 
  52.  
  53.    2. Remove the folder if you gave it one of its own 
  54.  
  55.    3. PLEASE send me an email to tell me why you don't like it any more! 
  56.  
  57.  
  58. ΓòÉΓòÉΓòÉ 3. Copyright ΓòÉΓòÉΓòÉ
  59.  
  60. Copyright (C) January 2000 Christopher Angelico, Mount Waverley, Victoria, 
  61. AUSTRALIA. All rights reserved. 
  62.  
  63. This program is released as emailware. Please send an email to 
  64. talldad@pobox.com.au if you like it! 
  65.  
  66. This program comes only with this warranty: "If it breaks, you get to keep both 
  67. pieces!" 
  68.  
  69. However, if you are having trouble, tell us and we may be able to fix it. 
  70.  
  71. Feel free to pass it on, spread it around, give it to anyone who needs an OS/2 
  72. egg timer, but leave the ZIP file intact. 
  73.  
  74. If you think of an improvement, please let me know (talldad@pobox.com.au) and 
  75. I'll try to include it. 
  76.  
  77. Successful suggestions win a prize - the next version is free! 
  78.  
  79. If you don't agree with this license, return the entire .ZIP file unopened for 
  80. a full refund. :-) 
  81.  
  82.  
  83. ΓòÉΓòÉΓòÉ 4. Using Egg Timer/2 ΓòÉΓòÉΓòÉ
  84.  
  85. Basic usage: 
  86.  
  87.    1. Start the program by double-clicking the executable to show a window in 
  88.       the center of the screen. 
  89.  
  90.    2. Set the time to count down by adjusting the spin buttons for minutes and 
  91.       seconds. 
  92.  
  93.    3. RMB click anywhere on the window to popup a menu 
  94.  
  95.    4. Select the actions to perform after countdown 
  96.  
  97.           Close program - for one time use 
  98.  
  99.           Beep - played through the internal speaker 
  100.  
  101.           Play .WAV - select a .WAV file from system sounds (requires MMOS2 
  102.            and multimedia support) 
  103.  
  104.           Message - type a message in the box to be displayed as a reminder 
  105.            when the time is up 
  106.  
  107.    5. Press Go to start the countdown (button changes to Stop) 
  108.  
  109.    6. Click Stop to reset the timer and cancel countdown 
  110.  
  111.  Advanced usage: 
  112.  
  113.    1. Create a program object for EggTimer.EXE, giving it a name appropriate to 
  114.       your requirements, eg BBS Dialer, AntiVirus Scan, Children's Bedtime, or 
  115.       Phone Home. 
  116.  
  117.    2. Set the Command Line Parameters. 
  118.  
  119.    3. Put the object in a handy place ready for use. Try Desktop, LaunchPad, or 
  120.       WarpCenter. 
  121.  
  122.  Multiple objects can be created and used simultaneously without interfering 
  123.  with each other. 
  124.  
  125.  However, responding to the actions is still up to you. 
  126.  IF THIS DOESN'T SOLVE YOUR PROBLEMS, DON'T BLAME ME! :-) 
  127.  
  128.  Example parameters for Advanced method: 
  129.  
  130.   20:0 GO MSG="Children's Bedtime!" QUIT
  131.  
  132.  will wait 20 minutes (20:0), starting immediately without showing the window 
  133.  (GO), then will open a reminder box saying Children's Bedtime! (MSG="..."), 
  134.  and close the program (QUIT). 
  135.  
  136.  Example 2: 
  137.  
  138.   OSACTION="START MYPROGRAM MYPARAMETERS" 0:50 QUIT GO
  139.  
  140.  Put this into the Startup folder to start a program which must wait for 
  141.  everything else. 50 seconds after Egg Timer/2 starts, MYPROGRAM will be 
  142.  STARTed; by then everything else will have completed initialisation. 
  143.  
  144.  
  145. ΓòÉΓòÉΓòÉ 4.1. Command Line Parameters ΓòÉΓòÉΓòÉ
  146.  
  147. Any of these, in any order: 
  148.  
  149.  Parameter                          Meaning 
  150.  min:sec                            Initial countdown time; if omitted, 
  151.                                     defaults to 1 second (rarely useful). 
  152.                                     Fixed format is required - 
  153.                                     {min}{colon}{sec} 
  154.  OSACTION="command string"          OS/2 command string or executable program 
  155.                                     name; parameters can be passed. Prefix 
  156.                                     batch file name with CALL. 
  157.  RXACTION="REXX string"             REXX command string. Take care - you can do 
  158.                                     a lot of damage here! 
  159.  GO                                 Immediately begin counting down. When 
  160.                                     selected, window is minimised. 
  161.  MSG="string"                       Pop up text message as reminder. 
  162.  QUIT                               Close after timer expires 
  163.  
  164.  Note:  "CALL PLAY FILE=wav_file_name" in either ACTION parameter plays a WAV 
  165.  file. All actions are executed when the timer finishes its countdown. 
  166.  
  167.  If a program or file is not found when you call an OSACTION, check the 
  168.  following: 
  169.  
  170.    1. Is it in the expected path? For executables, this includes directories in 
  171.       the CONFIG.SYS PATH statement; for data files check the program's 
  172.       documentation - it may use the DPATH. 
  173.  
  174.    2. For safety, use a fully qualified path. This is foolproof if you get it 
  175.       right. 
  176.  
  177.    3. The working directory for programs started by Egg Timer is the same as 
  178.       for Egg Timer itself. If you are working from a program object, set the 
  179.       Working Directory to suit. 
  180.  
  181.   CAUTION:
  182.  All parameters are CASE SENSITIVE. 
  183.  
  184.  
  185. ΓòÉΓòÉΓòÉ 5. The Egg Timer display ΓòÉΓòÉΓòÉ
  186.  
  187. This is where you interact with Egg Timer. 
  188.  
  189. The window consists of the following: 
  190.  
  191.      Seconds spin button 
  192.  
  193.      Minutes spin button 
  194.  
  195.      Go button 
  196.  
  197.      Stop button 
  198.  
  199.  
  200. ΓòÉΓòÉΓòÉ 5.1. Minutes spin button ΓòÉΓòÉΓòÉ
  201.  
  202. Select the number of minutes to time - 0 to 60. 
  203.  
  204. See also: 
  205.  
  206.      Seconds spin button 
  207.  
  208.      Go button 
  209.  
  210.      Command Line Parameters 
  211.  
  212.  
  213. ΓòÉΓòÉΓòÉ 5.2. Seconds spin button ΓòÉΓòÉΓòÉ
  214.  
  215. Select the number of seconds to time - 0 to 60. 
  216.  
  217. See also: 
  218.  
  219.      Minutes spin button 
  220.  
  221.      Go button 
  222.  
  223.      Command Line Parameters 
  224.  
  225.  
  226. ΓòÉΓòÉΓòÉ 5.3. Go button ΓòÉΓòÉΓòÉ
  227.  
  228. Pressing the Go button starts the timing, and replaces Go with Stop. 
  229.  
  230. Note:  Be sure to select an action (either with command line parameters, or 
  231. with the popup menu) before the timer expires! Otherwise nothing will appear to 
  232. have happened. 
  233.  
  234. See also: 
  235.  
  236.      Minutes spin button 
  237.  
  238.      Seconds spin button 
  239.  
  240.      Stop button 
  241.  
  242.  
  243. ΓòÉΓòÉΓòÉ 5.4. Stop button ΓòÉΓòÉΓòÉ
  244.  
  245. Pressing the Stop button stops the timing, replaces Stop with Go, and restores 
  246. the initial time. 
  247.  
  248. See also: 
  249.  
  250.      Minutes spin button 
  251.  
  252.      Seconds spin button 
  253.  
  254.      Go button 
  255.