home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS 1992 September / Simtel20_Sept92.cdr / msdos / sysutl / alarm400.arc / ALARM.DOC < prev    next >
Text File  |  1987-10-11  |  22KB  |  471 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.                    ALARM : Alarm Clock Program and Utilities
  7.                            Version 4.00, 11-Oct-1987
  8.                                   SMG Software
  9.  
  10.                            (C) Copyright 1986,1987 by
  11.                                Steven Georgiades
  12.                               All Rights Reserved
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.                                Table of Contents
  27.                                -----------------
  28.  
  29.               I.    Overview  ...........................  Page 2
  30.  
  31.               II.   Program Installation and Usage  .....  Page 3
  32.  
  33.               III.  The ALARM Configuration File  .......  Page 5
  34.  
  35.               IV.   Revision History  ...................  Page 6
  36.  
  37.               V.    Additional Utilities  ...............  Page 7
  38.  
  39.               VI.   Program Restrictions  ...............  Page 7
  40.  
  41.               VII.  Program License  ....................  Page 8
  42.  
  43.               VIII. Program Registration  ...............  Page 8
  44.  
  45.               IX.   Disclaimer  .........................  Page 9
  46.  
  47.               X.    Reporting Problems  .................  Page 9
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.                                        1
  59.  
  60.     ALARM, Version 4.00                                              Page 2
  61.  
  62.  
  63.  
  64.  
  65.     I. OVERVIEW
  66.  
  67.          The  ALARM  program  provides a memory resident alarm  clock  with 
  68.     eight  different  alarms,   each  of which can be set to go  off  at  a 
  69.     different  time  of  day.   This is useful to signal the user  about  a 
  70.     meeting,   a   lunch date,  or an appointment.   ALARM  also  has  four 
  71.     reminders,   which  can be set to go off at different  time  intervals.  
  72.     These are useful for reminding the user to perform periodic tasks, such 
  73.     as doing saves while editing,  or taking medication.  Each of the eight 
  74.     alarms  and four reminders may have a user-defined  message  associated 
  75.     with it, up to 32 characters in length.  When the alarm time is reached 
  76.     (or  when  the reminder interval has expired),  the computer's  current 
  77.     activity  will be suspended,  and a window will appear in the middle of 
  78.     the  screen indicating the alarm or reminder number,  the current time, 
  79.     and  the corresponding message.   In addition,  a  musical tune will be 
  80.     played,   as  specified in the alarm configuration  file.    Using  the 
  81.     supplied tune-files and configuration file (ALARM.CFG),  these tunes 
  82.     will be as follows: 
  83.  
  84.  
  85.               Alarm #1 : Funeral March of the Marionettes 
  86.               Alarm #2 : Carnival
  87.               Alarm #3 : Holiday Road
  88.               Alarm #4 : When The Saints Go Marching In
  89.               Alarm #5 : Fur Elise
  90.               Alarm #6 : O' Solo Mio
  91.               Alarm #7 : Turkey in the Straw
  92.               Alarm #8 : Aura Lee
  93.            Reminder #1 : Oh! Susanna
  94.            Reminder #2 : London Bridge
  95.            Reminder #3 : Mary had a Little Lamb
  96.            Reminder #4 : Yankee Doodle
  97.  
  98.  
  99.     Note that upon installation,  the message associated with each alarm or 
  100.     reminder is set to the title of the corresponding tune.   In all cases, 
  101.     a  tune can be terminated before completion by pressing the Escape key.  
  102.     Once  an  alarm  or reminder has sounded,  the  window  will  disappear 
  103.     immediately, unless it was set to persist. In this case the window will 
  104.     remain (persist)  on the screen until the Escape key is pressed.   If a 
  105.     second  alarm time should be reached before the Escape key is  pressed, 
  106.     that alarm will supersede the first, and the first one will be aborted.  
  107.          In  addition to alarms and reminders,  the ALARM program also  has 
  108.     Westminster chimes which can be enabled to sound on the hour, half-hour 
  109.     or quarter-hour.  The chimes can also be disabled.  
  110.          A   facility  is  also  included  to  disable  the  ALARM  program 
  111.     completely.    This  is  useful when executing programs  which  may  be 
  112.     adversely  affected  by  a  pop-up window,   such  as  FORMAT  or  disk 
  113.     optimizing software.  
  114.  
  115.     ALARM, Version 4.00                                              Page 3
  116.  
  117.  
  118.  
  119.  
  120.     II. PROGRAM INSTALLATION AND USAGE
  121.  
  122.          In order for the ALARM program to work, it must first be installed 
  123.     as  resident in memory.   This is accomplished by one of the  following 
  124.     commands: 
  125.  
  126.          ALARM I             or             ALARM Ifilename.ext
  127.  
  128.     The first form will look for the default configuration file, ALARM.CFG, 
  129.     in  the  current  directory.    If  not  found,   ALARM  will  use   no 
  130.     configuration  data  and will install a very simple (and  very  boring) 
  131.     form of the program,  with "beeps"  instead of tunes.   The second form 
  132.     will look for the specified configuration file.  If not found, an error 
  133.     will be flagged.  Note that the filename may optionally include a drive 
  134.     letter and/or a path specification.   For more information on the ALARM 
  135.     configuration file, see section III, below. 
  136.  
  137.          Once installed in memory, three sub-systems are available: Alarms, 
  138.     Reminders, and Chimes.  The Alarms Sub-System consists of eight alarms, 
  139.     which may be set by issuing one of the following commands: 
  140.  
  141.          ALARM An=hh:mm          or           ALARM An=hh:mm/"msg"
  142.  
  143.          ALARM An=*hh:mm         or           ALARM An=*hh:mm/"msg"
  144.  
  145.     where "n"  is the alarm number (1 to 8), "hh:mm" is the alarm time,  in 
  146.     24-hour  format (5:00 pm  is 17:00),  and "msg"  is an  optional  alarm 
  147.     message  which  may be up to 32  characters in length.   If  "msg"   is 
  148.     omitted,  as in the left column above,  then the alarm message  remains 
  149.     unchanged.   If an asterisk ("*") is specified with the alarm time,  as 
  150.     in the bottom row above, then that alarm is set to persist.  Individual 
  151.     alarms may be enabled, disabled, queried, and tested, respectively,  by 
  152.     entering the following commands: 
  153.  
  154.          ALARM An+      ALARM An-      ALARM An?      ALARM AnT
  155.  
  156.     Disabling an alarm will not change it's setting.  When it is once again 
  157.     enabled,   it  will  still  be set to the same time as  before  it  was 
  158.     disabled.  Note that the act of setting an alarm enables it.  The query 
  159.     option  will  list the alarm number,  the current setting  (or  OFF  if 
  160.     disabled), and the current message associated with that alarm.  Testing 
  161.     an  alarm  will  cause an alarm window to pop up and  the  tune  to  be 
  162.     played,   just as if the alarm time had been reached.   This will  work 
  163.     regardless of whether the specified alarm is enabled.  
  164.          In addition to this,  the entire Alarms Sub-System may be enabled, 
  165.     disabled, or queried, as follows: 
  166.  
  167.          ALARM A+               ALARM A-               ALARM A?
  168.  
  169.     Disabling the Alarms Sub-System will disable all eight alarms.  This is 
  170.     different from disabling all eight alarms individually, since disabling 
  171.     and re-enabling the Alarms Sub-System will preserve the  enable/disable 
  172.     status of each alarm.   Querying the Alarms Sub-System is equivalent to 
  173.     querying each of the eight alarms individually.  
  174.  
  175.     ALARM, Version 4.00                                              Page 4
  176.  
  177.  
  178.  
  179.  
  180.     II. PROGRAM INSTALLATION AND USAGE (Continued)
  181.  
  182.          The  Reminders Sub-System behaves virtually the same as the Alarms 
  183.     Sub-System,   the only major difference being that a Reminder  Interval 
  184.     ("mm")   must be specified,  instead of an Alarm Time ("hh:mm").    The 
  185.     reminder interval may be from 1 to 255  minutes.   Note that there  are 
  186.     only  4  reminders,  so "n"  must be in the range 1 to 4.    To  set  a 
  187.     reminder, use the following commands: 
  188.  
  189.          ALARM Rn=mm             or           ALARM Rn=mm/"msg"
  190.  
  191.          ALARM Rn=*mm            or           ALARM Rn=*mm/"msg"
  192.  
  193.     To  enable,   disable,  query or test individual  reminders,   use  the 
  194.     following commands: 
  195.  
  196.          ALARM Rn+      ALARM Rn-      ALARM Rn?      ALARM RnT
  197.  
  198.     To enable,  disable or query the entire Reminders Sub-System,  use  the 
  199.     following commands: 
  200.  
  201.          ALARM R+               ALARM R-               ALARM R?
  202.  
  203.          The  Chimes  Sub-System  enables the user  to  select  Westminster 
  204.     Chimes to sound on the quarter hour,  the half hour, or on the hour, as 
  205.     follows: 
  206.  
  207.          ALARM C15              ALARM C30              ALARM C60
  208.  
  209.     Note  that  only these three values are permitted for chime  intervals.  
  210.     All  other  values will cause an error.   The Chimes Sub-System may  be 
  211.     enabled, disabled, or queried by the following commands: 
  212.  
  213.          ALARM C+               ALARM C-               ALARM C?
  214.  
  215.          In  addition to all of the above,  there are Global ALARM  Program 
  216.     functions,   which enable you to completely disable the ALARM  program, 
  217.     re-enable ALARM, and query all ALARM parameters, as follows: 
  218.  
  219.          ALARM -             ALARM +             ALARM ?
  220.  
  221.     The  global disable will cease all ALARM functions until alarm  is  re-
  222.     enabled.    The global query will respond with the status of the  ALARM 
  223.     program, as well as the complete status of all Sub-Systems.  
  224.  
  225.  
  226.     ALARM, Version 4.00                                              Page 5
  227.  
  228.  
  229.  
  230.  
  231.     III. THE ALARM CONFIGURATION FILE
  232.  
  233.          The  ALARM program allows the user to customize the alarm tunes to 
  234.     his   or  her  liking  through  use  of  a  configuration  file.    The 
  235.     configuration  file is a simple ASCII file which may be  created  using 
  236.     any standard text editor,  or word processor with an ASCII save option.  
  237.     This file must contain at least twelve lines,  the first eight of which 
  238.     must contain the eight alarm tune entries,  and the remainder of  which 
  239.     must  contain  the four reminder tune entries.   Any  additional  lines 
  240.     found  in the configuration file beyond these 12  are read in by  ALARM 
  241.     and  interpreted  exactly as if they were found on the command line  of 
  242.     the ALARM program.  
  243.          Each tune  entry may be a file specification (with  optional drive 
  244.     and/or  path,  i.e.  [d:][path/]filename.ext),  or one of a few special 
  245.     codes,  explained below.  If a file specification is given,  ALARM will 
  246.     look for that file, and if not found, will flag an error.  Note that if 
  247.     no drive is specified, the current default drive is assumed,  and if no 
  248.     path is specified, the current default directory is used.  
  249.          The  special codes that are permitted in a tune entry are a  blank 
  250.     line (CR only,  no spaces or tabs), a double quote character ("),  or a 
  251.     pound  sign (#)  followed by a single digit,  1  to 9.   A  blank  line 
  252.     indicates  to  ALARM  that  you wish for that tune to  be  set  to  the 
  253.     program's default tune, a simple series of tones.   The quote character 
  254.     indicates  that  you  wish for that tune entry to be identical  to  the 
  255.     preceding tune entry.   Finally,  the "#"  character indicates that the 
  256.     current  tune  entry  should  be  made  identical  to  the  tune  entry 
  257.     corresponding  to the following digit,  i.e. "#2" in the 6th line would 
  258.     indicate that the tune for alarm #6 should be identical to the tune for 
  259.     alarm  #2.    Note that this form MUST point to a preceding  tune:   it 
  260.     cannot point forward, or an error will be flagged.  Also note that only 
  261.     the  first nine tunes can be repeated using this method,  since only  a 
  262.     single digit is recognized.  Using the quote or "#" options will reduce 
  263.     the amount of memory that the ALARM program occupies,  since a repeated 
  264.     tune will only appear once in memory.  
  265.  
  266.          Twelve  standard  tune files are supplied with the ALARM  program, 
  267.     and   19   additional  tunes  are  available  in  the  optional   file, 
  268.     ALMTUNES.ARC.   In addition,  the user may create his own custom tunes, 
  269.     using the ATC utility, discussed in section VI,  below, and in ATC.DOC.  
  270.     Additional optional tune sets may be released from time to time.  
  271.  
  272.     ALARM, Version 4.00                                              Page 6
  273.  
  274.  
  275.  
  276.  
  277.     IV. REVISION HISTORY
  278.  
  279.          The development of the ALARM program has been evolutionary (though 
  280.     not necessarily REVolutionary).   Since the first release, I  have been 
  281.     getting a great deal of feedback from users,  which has helped ALARM to 
  282.     become what it is today.  
  283.  
  284.  
  285.          Version 3.10        Initial Release.
  286.  
  287.          Version 3.11        The program was modified to permit poly-phonic 
  288.                              music (chords).  
  289.  
  290.          Version 3.12        The program was modified to allow for more 
  291.                              accurate timekeeping, and the quarter-hour 
  292.                              chimes were changed to hourly. 
  293.  
  294.          Version 3.13        The program was modified to add the persist 
  295.                              option, and to permit the user to interrupt an 
  296.                              alarm tune in progress.  (Thanks to Robert 
  297.                              Warren of El Paso for these suggestions) 
  298.  
  299.          Version 3.14        The program was modified to fix bugs in the 
  300.                              persist option, and improve it's usefulness.  
  301.                              The hourly chimes were also modified to 
  302.                              disappear upon completion. 
  303.  
  304.          Version 3.15        The program was modified to fix a bug that 
  305.                              would cause the program to re-install if run 
  306.                              above the 512K boundary. 
  307.  
  308.          Version 3.20        The program was modified to allow alarm 
  309.                              overlaps. 
  310.  
  311.          Version 4.00        MAJOR REVISION.  This new version increases 
  312.                              the number of alarms from 5 to 8, enhances the 
  313.                              chimes to allow for a user-specified chime 
  314.                              interval of 15, 30 or 60 minutes, adds four 
  315.                              reminders (NEW), adds the ability to disable 
  316.                              the ALARM program completely, allows the user 
  317.                              to create his own customized alarm tunes, adds 
  318.                              configuration file support, and numerous other 
  319.                              minor changes and improvements.  Users of 
  320.                              older versions should read the documentation 
  321.                              thoroughly.  
  322.  
  323.     ALARM, Version 4.00                                              Page 7
  324.  
  325.  
  326.  
  327.  
  328.     V. ADDITIONAL UTILITIES
  329.  
  330.          Included with the ALARM program are three special utilities  which 
  331.     make it a much more powerful program.  Each of these utilities has it's 
  332.     own documentation file, but a brief description is given here. 
  333.  
  334.          The first utility is DTCHK, the Date and Time Check Utility.  This 
  335.     program allows you to test the current date,  time,  and/or day-of-week 
  336.     from  within a batch file,  and conditionally execute code.    This  is 
  337.     useful for setting alarms based on the date.  For example,  if you want 
  338.     to be reminded to attend a 10:00 status meeting every friday, but don't 
  339.     wish to have an alarm go  off  EVERY  day at 10:00,  you can  use DTCHK 
  340.     within  your  AUTOEXEC.BAT  to set that alarm ONLY  on  fridays.    See 
  341.     DTCHK.DOC for more information.  
  342.  
  343.          Another  utility  is ATC,  the Alarm Tune Compiler.   This is  the 
  344.     program which allows you to create your own customized tunes.  A  music 
  345.     "source"   file is created using a text editor or word processor,   and 
  346.     this  file is compiled by ATC into a tune file,  suitable for use  with 
  347.     ALARM.  Tunes created with ATC may also be played using ATP.  
  348.  
  349.          ATP  is the Alarm Tune Play Utility.   This is used to play  tunes 
  350.     compiled with ATC,  or the tunes supplied with the ALARM program.  This 
  351.     program  is  supplied  to allow the user to hear what tunes sound  like 
  352.     without  having  to install  them into ALARM (or just to play tunes for 
  353.     fun).  See ATC.DOC for more information on both ATC and ATP.  
  354.  
  355.  
  356.  
  357.  
  358.     VI. PROGRAM RESTRICTIONS
  359.  
  360.          The ALARM program should work on any IBM PC, XT, AT or compatible, 
  361.     running  DOS Version 2.0  or later.   In order for the program to  run, 
  362.     there  must be at least 20K bytes of free memory in the system.    When 
  363.     installed,  the  resident portion will occupy between 4K and 10K bytes, 
  364.     depending  upon  the  configuration.   The sum of the  lengths  of  all 
  365.     installed tunes files must not exceed 7503 bytes.  
  366.  
  367.     ALARM, Version 4.00                                              Page 8
  368.  
  369.  
  370.  
  371.  
  372.     VII. PROGRAM LICENSE
  373.  
  374.          The ALARM program is copyrighted material,  but is distributed  as 
  375.     ShareWare.  "ShareWare" means that you are granted free license to use, 
  376.     copy and distribute this software, within the following restrictions: 
  377.  
  378.          1).  It must be distributed in its original,  unmodified  form, 
  379.               including program, documentation and all associated files.  
  380.  
  381.          2).  No  fee may be charged for use,  copying  or  distribution 
  382.               (With the exception of nominal "per disk" copying charges, 
  383.               not to exceed $6.00 per disk).  
  384.  
  385.          3).  The  program  may  not  be included with  other  goods  or 
  386.               services supplied for a fee,  unless written permission to 
  387.               do so is obtained in advance from the author.  
  388.  
  389.  
  390.     VIII. PROGRAM REGISTRATION
  391.  
  392.          Since  ALARM  is  ShareWare,   you have  no  legal  obligation  to 
  393.     register.   But if you are using the program, and find it helpful,  you 
  394.     are expected to register.  Registration fees are as follows: 
  395.  
  396.               Full Registration (w/full support) ........ $35.00
  397.               Basic Registration (w/basic support) ...... $20.00
  398.  
  399.     Please make checks payable to Steven M.  Georgiades.  Note that you are 
  400.     not  LEGALLY  obligated  to  register,  but if  you  use  the  software 
  401.     regularly,  you are MORALLY obligated to do so.  Aside from easing your 
  402.     conscience,  basic registration will also get you a diskette containing 
  403.     the  latest  version  of the software (unless you  currently  have  the 
  404.     latest version, in which case I will send you the next major revision), 
  405.     and  basic  user  support,  which means that I will work  with  you  to 
  406.     resolve problems,  and will do minor customization.   Full registration 
  407.     will  get you everything that basic registration does,  plus full  user 
  408.     support,   which includes telephone support and all major revisions  of 
  409.     the  software  for  a  period  of two  (2)   years  from  the  date  of 
  410.     registration.    When  you register,  please specify the  name  of  the 
  411.     program,  and the version number.   Fully registered users will also be 
  412.     eligible  to receive custom tune creation,  by sending me a copy of the 
  413.     sheet music.  If you do not have the sheet music, send me the title and 
  414.     composer, or any other information you have to identify the tune, and I 
  415.     will do my best.  
  416.          Source code for ALARM and it's subsidiary programs is available to 
  417.     all  registered users for a fee of $75.00.   The source code for  ALARM 
  418.     and  ATP  is Microsoft Macro Assembler,  Version 5.0,  and for ATC  and 
  419.     DTCHK,  is Microsoft  C,   Version 4.0.  All source code is COPYRIGHTED 
  420.     material  and  is NOT shareware,  and therefore may NOT  be  copied  or 
  421.     distributed.  
  422.          Note that no support will be given to unregistered users EXCEPT in 
  423.     the  case of MAJOR bugs which prevent the user from using the  program.  
  424.     I  will then do my best to resolve these problems so that the user  may 
  425.     evaluate the software fully.  
  426.  
  427.     ALARM, Version 4.00                                              Page 9
  428.  
  429.  
  430.  
  431.  
  432.     IX. DISCLAIMER
  433.  
  434.          This program is provided AS IS without any warranty,  expressed or 
  435.     implied,  including but  not limited to fitfulness for a particular use 
  436.     or  purpose.   Neither the author nor SMG Software assume liability for 
  437.     any damages incurred through the use of the program.  
  438.          The ALARM, DTCHK, ATC and ATP programs are: 
  439.  
  440.                       (C) Copyright 1987 Steven Georgiades
  441.  
  442.  
  443.  
  444.  
  445.     X. REPORTING PROBLEMS
  446.  
  447.          If you have any problem,  or feel you have found a bug in these or 
  448.     any other SMG programs, please let me know.  I also welcome any and all 
  449.     questions   and  comments.    Address  all  correspondence   (including 
  450.     registrations) to the following address: 
  451.  
  452.                 Steven Georgiades
  453.                 SMG Software
  454.                 701-H South Hayward Street
  455.                 Anaheim, CA  92804
  456.  
  457.     Or leave a message for me on the Circuit Board:
  458.  
  459.                 The Circuit Board RBBS
  460.                 SysOp: Dave Kleinschmidt
  461.                 (714) 778-0948
  462.                 1200/2400 Baud, No Fee
  463.  
  464.     All  SMG  Software  is  initially released to the  public  through  the 
  465.     Circuit  Board.   The latest version of any SMG Software can always  be 
  466.     found there.  
  467.  
  468.     A diskette containing all of the latest SMG Software can be obtained by 
  469.     sending a check or money order for $6.00  to the above address.    Make 
  470.     all checks payable to Steven M. Georgiades.  Thank you.  
  471.