home *** CD-ROM | disk | FTP | other *** search
/ Best Objectech Shareware Selections / UNTITLED.iso / boss / util / misc / 003 / alarm.doc < prev    next >
Encoding:
Text File  |  1991-01-08  |  11.6 KB  |  207 lines

  1. TITLE:         ALARM 3.02
  2. PURPOSE:       Resident clock, chime, and alarm program
  3. DATE:          12-6-90
  4. AUTHOR:        Thomas A. Lundin
  5.                16267 Hudson Avenue
  6.                Lakeville, MN 55044
  7.                Daytime # (612) 588-7571
  8.  
  9. DESCRIPTION:   ALARM provides a memory-resident on-screen clock in the upper 
  10.                or lower right corner. On the hour and half-hour, a short 
  11.                tune is played (the tunes are programmable by you). The 
  12.                program can also store up to 10 alarm times per day which 
  13.                will be indicated by another tune and a flashing reminder 
  14.                message at the bottom of the screen, all of which are 
  15.                programmable. The clock display, chimes, and alarms can be 
  16.                toggled on or off individually.
  17.                
  18. OPERATION:     The command line invocation is:
  19.  
  20.                alarm302 [-options]
  21.                
  22.                Options:
  23.                
  24.                -?             displays program usage
  25.                -c             toggle Chimes on and off
  26.                -a             toggle Alarms on and off
  27.                -k             toggle clocK display on and off
  28.                -p             toggle clock display Position
  29.                -s             Set alarms (read from ALARM.DAT)
  30.                -tFILENAME     load a Tune from FILENAME
  31.                -dMM/DD/YY     load alarms for specified Date
  32.                
  33.                The first time ALARM is run, no options can be specified on 
  34.                the command line; they won't be processed. Subsequent 
  35.                executions can invoke the options. Multiple options can be 
  36.                specified on one command line.
  37.                
  38.                1.   FORMAT OF THE ALARM.DAT FILE:
  39.                     ALARM.DAT is an ASCII file which contains the alarm 
  40.                     dates, times, and messages that the program will store. 
  41.                     Up to 10 alarm times can be programmed for one date, but 
  42.                     your ALARM.DAT file can contain alarms for as many dates 
  43.                     as you want. Each alarm is entered as:
  44.                     
  45.                     MM/DD/YY HH:MM Your message here!
  46.                     
  47.                     The first item in the line is the date. It must be 
  48.                     followed by only one space. The next item is the time 
  49.                     that the alarm will be called. It is entered in 24-hour 
  50.                     notation (where 1:00pm is 13:00, also known as military 
  51.                     time). It must be followed by only one space. The last 
  52.                     item is the message that will be displayed at alarm 
  53.                     time. It can be up to 40 characters long. See the sample 
  54.                     ALARM.DAT file for examples.
  55.                     
  56.                     If you enter an alarm time that is on the hour or 
  57.                     half-hour, the alarm tune will override the normal 
  58.                     chime. Since I like listening to tunes, I usually set my 
  59.                     alarms to sound off a few minutes before or after the 
  60.                     hour or half-hour.
  61.                     
  62.                     Alarm messages will be displayed on the last line of 
  63.                     your screen, and the alarm tune will cycle through 
  64.                     twice. The message remains on the screen only as long as 
  65.                     no other program writes over it.
  66.                     
  67.                     Use the -s option in the command line to set the alarms 
  68.                     from ALARM.DAT. ALARM.DAT must reside in the current 
  69.                     subdirectory, or in a subdirectory that is part of your 
  70.                     PATH command. When alarms are set, the alarm is 
  71.                     automatically turned ON, even if you toggled it off 
  72.                     earlier.
  73.                     
  74.                2.   FORMAT OF THE TUNES FILES:
  75.                     A tune file is an ASCII file which contains the 
  76.                     individual musical frequencies which make up an hourly, 
  77.                     half-hourly, or alarm chime. Each tune file can contain 
  78.                     up to 3 lines, one for each type of chime. The format of 
  79.                     a tune line is:
  80.                     
  81.                     ALARM_TYPE,BEEP_SPEED,NOTE1,NOTE2,NOTE3,...,NOTE63,0
  82.                     
  83.                     All elements are comma-separated.
  84.                     
  85.                     ALARM_TYPE must be one of three letters: A for Alarm, T 
  86.                     for Top-of-the-hour, or H for Half-hour.
  87.                     
  88.                     BEEP_SPEED must be a number from 1 to 18. It determines 
  89.                     how long each note is played, in increments of 1/18th of 
  90.                     a second. For example, a BEEP_SPEED value of 3 will play 
  91.                     each note for about 1/6 of a second. BEEP_SPEED is an 
  92.                     absolute timing measure based on the 18.2 ticks per 
  93.                     second of the system clock, so chimes and alarms will 
  94.                     sound the same regardless of processor speed.
  95.                     
  96.                     NOTE1 through NOTE63 are the individual notes, entered 
  97.                     as frequency values, which compose the tune being 
  98.                     played. See the sample file SCALE.TXT for a chart of 
  99.                     musical note frequency values. A "rest" is entered as a 
  100.                     -1 frequency. Two or more consecutive notes of the same 
  101.                     frequency will sound like one long note (useful for 
  102.                     providing aesthetically-pleasing musical phrasing). The 
  103.                     series of notes must be terminated with a 0.
  104.                     
  105.                     The Top-of-the-hour and Half-hour tunes can each be up 
  106.                     to 63 notes in length. The Alarm tune can be up to 29 
  107.                     notes in length. Violating these restrictions could 
  108.                     cause the program to crash, possibly locking up the 
  109.                     system, or, more likely, emit an interminable series of 
  110.                     random beeps instead of the tune you want.
  111.                
  112.                     To load a tune into memory, use the -tFILENAME option, 
  113.                     where FILENAME is any valid PC path/filename that 
  114.                     contains tune information. You can do as I've done, and 
  115.                     create a little library of tunes -- one tune per file -- 
  116.                     and mix and match them on a single command line (see the 
  117.                     ALARM.BAT batch file for an example), or you can load 
  118.                     pre-defined combinations of tunes in each file.
  119.                     
  120.                     See the sample files with an extension of .TUN for 
  121.                     examples of tunes. Notice how I've subdivided the basic 
  122.                     tempo in some of the tunes into halves or thirds to 
  123.                     allow for simulated rests, quarter- and half-notes, etc.
  124.                     
  125. NOTES:         The way I write my tunes is to use the PIANOMAN program to 
  126.                tap out the tune on the keyboard and write down the notes. 
  127.                Then I transpose them into frequency values with SNR, a 
  128.                multi-string search-and-replace program.
  129.                
  130.                ALARM loads the alarms for the current date only. Use the -d 
  131.                option to load alarms for a different date. If your computer 
  132.                runs past midnight, the time will show correctly, but the 
  133.                date will not be updated.
  134.                
  135.                ALARM uses approximately 17K of RAM when resident.
  136.  
  137.                ALARM is written in Turbo C++ (ANSI mode). No assembly 
  138.                language was required.
  139.  
  140. MACHINE:       The program will run on any PC-compatible computer using 
  141.                MS-DOS 2.x or higher, with a minimum of 128K RAM.
  142.  
  143. DISCLAIMER:    This program is distributed as shareware.  Use it, copy 
  144.                it, upload it, give it to your friends.  No warranties, 
  145.                either expressed or implied, are given by the author or 
  146.                distributor of the program, and the user accepts all risk of 
  147.                damage arising out of the application and use of the program.
  148.  
  149. BEG:           If you find this program to be of value, contributions ($10 
  150.                suggested) will be gratefully accepted. If you'd like the 
  151.                source code to this program, please send $20 and a stamped 
  152.                disk mailer. If you decide not to contribute, but suffer with 
  153.                the guilt instead, at least upload this file to as many BBSes 
  154.                as you can.
  155.  
  156.                Send comments/bug reports/contributions to:
  157.  
  158.                          ╔═════════════════════════════╗
  159.                          ║      THOMAS A. LUNDIN       ║
  160.                          ║     16267 Hudson Avenue     ║
  161.                          ║     Lakeville, MN  55044    ║
  162.                          ║   Daytime # (612) 588-7571  ║
  163.                          ╚═════════════════════════════╝
  164.  
  165.                Thank you for using ALARM.
  166.  
  167.  
  168. CATALOG:       Other shareware programs I've written:
  169.  
  170.                SBREAK.EXE: SuperBreaker (ver 3.1B)
  171.                What I call the world's best file splitting program -- splits
  172.                files by size, string match, line count; converts fixed-length
  173.                data files to CRLF-terminated text files; can split files to
  174.                floppy diskettes; splits binary or text files; files split to
  175.                size can also be split at the next nearest user-definable
  176.                string (e.g. CRLF); other features. You can use this program to
  177.                split a really big .ARC file onto multiple floppies and then
  178.                easily reconstruct it on a different computer.
  179.  
  180.                SNR.EXE: Search-N-Replace (ver 4.0)
  181.                This is a multi-string, global file search-and-replace 
  182.                program. It allows you to create up to 50 search-and-replace 
  183.                equations of up to 200 characters each. You can search for 
  184.                and replace all text and binary characters. A toggle feature 
  185.                allows you to make the same search string output two 
  186.                different replacement strings. All translations occur in a 
  187.                single pass. This program is very handy for making fast, 
  188.                easy, global changes to the contents of a disk file (or group 
  189.                of files).
  190.  
  191.                CCUR.EXE: The Counting Cursor (ver 3.1)
  192.                This program uses your cursor as a counting device, allowing
  193.                you to count the number of characters between two points on the
  194.                screen simply by moving the cursor. These width counts can be
  195.                written to a disk file for use in other programs. CCUR will
  196.                also record row-column screen coordinates if you choose. The
  197.                HEX and ASCII decimal values of the character under the cursor
  198.                are displayed, giving you a fast way to identify those control
  199.                and graphic characters by code value. An on-demand screen
  200.                blanker is built-in. A screen capture command is provided,
  201.                allowing you to capture the display to any disk file or DOS
  202.                device (yes, the printer, too). This is a handy program for you
  203.                database file hackers.
  204.  
  205.                If you are interested in any of these programs, check your
  206.                local BBS or call me or drop me a note at my work address.
  207.