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
Wrap
Text File
|
1992-05-10
|
8KB
|
178 lines
*==========================================================================*
|| ||
|| AlarmingClock © 1992 by Brian G. Neal ||
|| ||
|| THIS PROGRAM IS COPYRIGHT 1992 BY BRIAN G. NEAL. ||
|| PLEASE READ THE FOLLOWING LEGAL MUSH ||
|| ||
|| Permission is hereby granted to distribute this program's ||
|| executable and documentation for non-commercial purposes, so long as ||
|| the executable and documentation are not modified in any way. ||
|| This program may not be distributed for a profit without the express ||
|| written consent of the author Brian G. Neal. ||
|| ||
|| This program is not in the public domain. ||
|| ||
|| Fred Fish is expressly granted permission to distribute this program's ||
|| executable and documentation as part of the "Fred Fish freely ||
|| redistributable Amiga software library." ||
|| ||
*==========================================================================*
AlarmingClock 2.3 Documentation - May 4, 1992
WHAT IS IT?
===========
AlarmingClock is an alarm clock program that plays IFF 8SVX sound files
for the alarm. It runs from the Workbench or the shell. It features an
easy to use gadget interface and even a snooze button! AlarmingClock can
also open up on a public screen, use the asl file requester, and has many
startup options.
REQUIREMENTS
============
You need an Amiga (duh) running release 2 of the operating system.
Sorry 1.3 (and earlier?) users. Upgrade, its well worth it...
You also need a few of your favorite IFF 8SVX sampled sound files.
HOW TO RUN
==========
From the shell you start AlarmingClock by using the following syntax:
aclock SOUND,ALARM/N,LEFT/N,TOP/N,SNOOZE/N,24HOUR/S,PUBSCREEN/K
See your Amiga documentation for the meaning of the notation (its quite
easy, actually). Note that with version 2.3, the sound argument is no
longer required. If it is missing AlarmingClock will open the system
file requester for you. Explanation below, but here are some examples:
aclock work:sounds/fx/boom.snd
aclock kapow.8svx 1300
aclock kablam.iff ALARM 1300 SNOOZE 2
aclock bang.snd 730 0 0 10 24hour
aclock sound bang.snd left 0 TOP 0 snooze 10 24HOUR
aclock music:fx/prong.snd PUBSCREEN MegaCommScreen
aclock top 0 left 200 24hour alarm 800
If you want to put AlarmingClock in your S:User-Startup file, make sure
you start it with:
run aclock <NIL: >NIL: ....
so the initial shell window will close.
From the Workbench, simply double click the aclock icon. The following
tool types are supported.
SOUND=soundfile
ALARM=alarmtime
LEFT=x
TOP=y
SNOOZE=snoozetime
24HOUR
PUBSCREEN=pubscreenname
DONOTWAIT
Here is an explanation of the parameters for both shell and Workbench
use.
SOUND - This is the optional name of the IFF 8SVX sound file
ALARM - This is optional time you want the alarm to go off, given in
24 hour notation. E.g. 1910
LEFT - The optional initial left edge of AlarmingClock's window
TOP - The optional initial top edge of AlarmingClock's window
SNOOZE - The optional time you defer the alarm when hitting the snooze
button. If not present, the default is 5 minutes.
24HOUR - If present AlarmingClock will startup in 24 hr. mode. The
default is 12 hr. mode.
PUBSCREEN - The optional name of the public screen to open on. Defaults
to the Workbench.
DONOTWAIT - This is a tool type only. If you put AlarmingClock in your
WBStartup drawer have this tool type present so the inital
shell window will close.
HOW TO USE
==========
If you start AlarmingClock with no sound filename, it will open the
system file requester. Use the requester to select your IFF 8SVX sound
file. Next, AlarmingClock will present a small window (just a title
bar actually) displaying the time. To access the control panel, click the
right mouse button when the window is active. I hope that the operation is
painfully obvious from here. The current time is displayed in the recessed
area marked "Current", the alarm time is displayed in the area marked
"Alarm". Change the alarm time with the sliders. Change between 12 & 24
hr. mode with the cycle gadget. Hit "Test" to hear the alarm sound file.
The "Alarm Set" gadget sets/unsets the alarm. The ZZZ gadget is the snooze
button. When the alarm is ringing this gadget will become available.
Clicking it turns off the alarm and advances the alarm time by the amount
you specified with the SNOOZE parameter (default is 5 minutes). Click the
right mouse button at any time to return to the smaller time only display.
LIMITATIONS
===========
This version has some limitations on the types of IFF 8SVX sound files
it will play. Currently, stereo is not supported. Compressed files are
not supported either. Please let me know if these features are critical,
and I'll work on getting them in there. Also, if you come across a sound
file that AlarmingClock chokes on or acts weird on, let me know. Either
send me the sound file or let me know how to get it. Thanks! In any
event I think it can handle the vast majority of simple one shot sound
files that exist, even large ones (double buffering!).
A CAUTIONARY NOTE ON MULTITASKING
=================================
The Amiga (currently, fingers crossed) has 4 audio channels. Thus
in a multitasking environment these can become scarce resources. Programs
must be written to share these channels to make the user happy. Sharing
is a 2 way street. I think that AlarmingClock will live up to its side
of the bargain. It only allocates a channel when it needs to play the
alarm, plays it, then releases the channel. If your system crashes or
AlarmingClock doesn't play the alarm, chances are you are also running an
audio hog program. Such programs typically write directly to the hardware
or lock all 4 channels. I do know that Marc Espie followed the rules, and
his wonderful module player Experiment IV will coexist peacefully with
AlarmingClock. I haven't tried it with any other module players.
DIFFERENCES BETWEEN VERSION 2.3 AND 2.2
=======================================
Version 2.3 no longer requires you to supply the name of the alarm
file. If it is not given, AlarmingClock will open the system file
requester and let you choose one that way.
AlarmingClock will now exit when it receives a CTRL-C.
EPILOGUE
========
Thanks for using AlarmingClock. Please send me any comments, flames,
bug reports, suggestions, misplaying sound files, etc. This program
was written for fun, but donations will not be turned away :^). They
will also encourage me to implement your suggestions! I hope you enjoy
this program!
Thanks go to:
Terry Austin for beta testing and sending me sounds!
Charles Wuethrich for suggesting the snooze button (good one!)
The Amiga software engineers
Does anyone want to design a better icon???
Brian Neal
620 S. Riverside Dr. #1
Iowa City, IA 52246
USA.
Internet: bneal@umaxc.weeg.uiowa.edu
GEnie: B.NEAL2 (don't count on a quick reply)
All the above addresses, except possibly GEnie, will change in the next
few months. (Today is May 4, 1992)