home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 633.lha / AlarmingClock_v2.2 / AlarmingClock.doc.pp / AlarmingClock.doc
Encoding:
Text File  |  1992-05-10  |  7.7 KB  |  178 lines
  1. *==========================================================================*
  2. ||                                                                        ||
  3. ||                  AlarmingClock © 1992 by Brian G. Neal                 ||
  4. ||                                                                        ||
  5. ||            THIS PROGRAM IS COPYRIGHT 1992 BY BRIAN G. NEAL.            ||
  6. ||                  PLEASE READ THE FOLLOWING LEGAL MUSH                  ||
  7. ||                                                                        ||
  8. || Permission is hereby granted to distribute this program's              ||
  9. || executable and documentation for non-commercial purposes, so long as   ||
  10. || the executable and documentation are not modified in any way.          ||
  11. || This program may not be distributed for a profit without the express   ||
  12. || written consent of the author Brian G. Neal.                           ||
  13. ||                                                                        ||
  14. || This program is not in the public domain.                              ||
  15. ||                                                                        ||
  16. || Fred Fish is expressly granted permission to distribute this program's ||
  17. || executable and documentation as part of the "Fred Fish freely          ||
  18. || redistributable Amiga software library."                               ||
  19. ||                                                                        ||
  20. *==========================================================================*
  21.  
  22. AlarmingClock 2.3 Documentation - May 4, 1992
  23.  
  24. WHAT IS IT?
  25. ===========
  26.  
  27.    AlarmingClock is an alarm clock program that plays IFF 8SVX sound files
  28. for the alarm.  It runs from the Workbench or the shell.  It features an
  29. easy to use gadget interface and even a snooze button!  AlarmingClock can
  30. also open up on a public screen, use the asl file requester, and has many 
  31. startup options.
  32.  
  33. REQUIREMENTS
  34. ============
  35.  
  36.    You need an Amiga (duh) running release 2 of the operating system.
  37. Sorry 1.3 (and earlier?) users.  Upgrade, its well worth it...
  38. You also need a few of your favorite IFF 8SVX sampled sound files.
  39.  
  40. HOW TO RUN
  41. ==========
  42.  
  43.    From the shell you start AlarmingClock by using the following syntax:
  44.  
  45.       aclock SOUND,ALARM/N,LEFT/N,TOP/N,SNOOZE/N,24HOUR/S,PUBSCREEN/K
  46.  
  47. See your Amiga documentation for the meaning of the notation (its quite
  48. easy, actually).  Note that with version 2.3, the sound argument is no
  49. longer required.  If it is missing AlarmingClock will open the system
  50. file requester for you.  Explanation below, but here are some examples:
  51.  
  52.       aclock work:sounds/fx/boom.snd
  53.       aclock kapow.8svx 1300
  54.       aclock kablam.iff ALARM 1300 SNOOZE 2
  55.       aclock bang.snd 730 0 0 10 24hour
  56.       aclock sound bang.snd left 0 TOP 0 snooze 10 24HOUR
  57.       aclock music:fx/prong.snd PUBSCREEN MegaCommScreen
  58.       aclock top 0 left 200 24hour alarm 800
  59.  
  60. If you want to put AlarmingClock in your S:User-Startup file, make sure
  61. you start it with:
  62.  
  63.       run aclock <NIL: >NIL: ....
  64.  
  65. so the initial shell window will close.
  66.  
  67.    From the Workbench, simply double click the aclock icon.  The following
  68. tool types are supported.
  69.  
  70.    SOUND=soundfile
  71.    ALARM=alarmtime
  72.    LEFT=x
  73.    TOP=y
  74.    SNOOZE=snoozetime
  75.    24HOUR
  76.    PUBSCREEN=pubscreenname
  77.    DONOTWAIT
  78.  
  79.    Here is an explanation of the parameters for both shell and Workbench
  80. use.
  81.  
  82. SOUND       - This is the optional name of the IFF 8SVX sound file
  83. ALARM       - This is optional time you want the alarm to go off, given in
  84.               24 hour notation.  E.g.  1910
  85. LEFT        - The optional initial left edge of AlarmingClock's window
  86. TOP         - The optional initial top edge of AlarmingClock's window
  87. SNOOZE      - The optional time you defer the alarm when hitting the snooze
  88.               button.  If not present, the default is 5 minutes.
  89. 24HOUR      - If present AlarmingClock will startup in 24 hr. mode.  The
  90.               default is 12 hr. mode.
  91. PUBSCREEN   - The optional name of the public screen to open on.  Defaults
  92.               to the Workbench.
  93. DONOTWAIT   - This is a tool type only.  If you put AlarmingClock in your
  94.               WBStartup drawer have this tool type present so the inital
  95.               shell window will close.
  96.  
  97. HOW TO USE
  98. ==========
  99.  
  100.    If you start AlarmingClock with no sound filename, it will open the
  101. system file requester.  Use the requester to select your IFF 8SVX sound
  102. file.  Next, AlarmingClock will present a small window (just a title
  103. bar actually) displaying the time.  To access the control panel, click the
  104. right mouse button when the window is active.  I hope that the operation is
  105. painfully obvious from here.  The current time is displayed in the recessed
  106. area marked "Current", the alarm time is displayed in the area marked
  107. "Alarm".  Change the alarm time with the sliders.  Change between 12 & 24
  108. hr. mode with the cycle gadget.  Hit "Test" to hear the alarm sound file.
  109. The "Alarm Set" gadget sets/unsets the alarm.  The ZZZ gadget is the snooze
  110. button.  When the alarm is ringing this gadget will become available.
  111. Clicking it turns off the alarm and advances the alarm time by the amount
  112. you specified with the SNOOZE parameter (default is 5 minutes).  Click the
  113. right mouse button at any time to return to the smaller time only display.
  114.  
  115. LIMITATIONS
  116. ===========
  117.  
  118.    This version has some limitations on the types of IFF 8SVX sound files
  119. it will play.  Currently, stereo is not supported.  Compressed files are
  120. not supported either.  Please let me know if these features are critical,
  121. and I'll work on getting them in there.  Also, if you come across a sound
  122. file that AlarmingClock chokes on or acts weird on, let me know.  Either
  123. send me the sound file or let me know how to get it.  Thanks!  In any
  124. event I think it can handle the vast majority of simple one shot sound
  125. files that exist, even large ones (double buffering!).
  126.  
  127. A CAUTIONARY NOTE ON MULTITASKING
  128. =================================
  129.  
  130.    The Amiga (currently, fingers crossed) has 4 audio channels.  Thus
  131. in a multitasking environment these can become scarce resources.  Programs
  132. must be written to share these channels to make the user happy.  Sharing
  133. is a 2 way street.  I think that AlarmingClock will live up to its side
  134. of the bargain.  It only allocates a channel when it needs to play the
  135. alarm, plays it, then releases the channel.  If your system crashes or
  136. AlarmingClock doesn't play the alarm, chances are you are also running an
  137. audio hog program.  Such programs typically write directly to the hardware
  138. or lock all 4 channels.  I do know that Marc Espie followed the rules, and
  139. his wonderful module player Experiment IV will coexist peacefully with
  140. AlarmingClock.  I haven't tried it with any other module players.
  141.  
  142. DIFFERENCES BETWEEN VERSION 2.3 AND 2.2
  143. =======================================
  144.  
  145.    Version 2.3 no longer requires you to supply the name of the alarm
  146. file.  If it is not given, AlarmingClock will open the system file
  147. requester and let you choose one that way.
  148.    AlarmingClock will now exit when it receives a CTRL-C.
  149.  
  150.  
  151. EPILOGUE
  152. ========
  153.  
  154.    Thanks for using AlarmingClock.  Please send me any comments, flames,
  155. bug reports, suggestions, misplaying sound files, etc.  This program
  156. was written for fun, but donations will not be turned away :^).  They
  157. will also encourage me to implement your suggestions!  I hope you enjoy
  158. this program!
  159.  
  160. Thanks go to:
  161.  
  162.    Terry Austin for beta testing and sending me sounds!
  163.    Charles Wuethrich for suggesting the snooze button (good one!)
  164.    The Amiga software engineers
  165.  
  166.    Does anyone want to design a better icon???
  167.  
  168. Brian Neal
  169. 620 S. Riverside Dr. #1
  170. Iowa City, IA 52246
  171. USA.
  172.  
  173. Internet:      bneal@umaxc.weeg.uiowa.edu
  174. GEnie:         B.NEAL2     (don't count on a quick reply)
  175.  
  176. All the above addresses, except possibly GEnie, will change in the next
  177. few months. (Today is May 4, 1992)
  178.