home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format 64 / af064sub.adf / TinyClock / TinyClock.doc < prev    next >
Text File  |  1994-07-29  |  9KB  |  286 lines
  1.             TinyClock v2.0
  2.  
  3.              by Mika "MKsa" Kuulusa 
  4.         Original Source by Martin W. Scott
  5.     Copyright (C) Martin W. Scott & Mika Kuulusa, 1993.
  6.  
  7.              Released March '93
  8.               This is Freeware.
  9.  
  10.           [NOTE: Requires OS 2.04 or higher]
  11.  
  12. DISCLAIMER
  13.  
  14.  
  15. The programs and files in this distribution are freely distributable, but 
  16. are also Copyright (C) Martin W. Scott & Mika Kuulusa. They may be freely 
  17. distributed as long as no more than a nominal fee is charged to cover time
  18. and copying costs. No commercial usage is permitted without written
  19. permission from the authors. Everything in this distribution must be kept
  20. together, in original unmodified form.  
  21. The above is generally known as FreeWare.
  22.  
  23.  
  24. INTRODUCTION
  25.  
  26.  
  27. Martin W. Scott:
  28.   There are far too many clock programs for the Amiga -- it seems that
  29.   no-one likes what's on offer and so writes their own, and places it
  30.   in the Public Domain. And good, too: we have a LOT of choice.
  31.  
  32.   But what about ANALOG clocks? Well, there's Commodore's clock, but 
  33.   that uses over 40K memory and too much of the processor. Then there's
  34.   WizardClock, but again that is big, and not resizeable (though it is
  35.   neat, and has lots of nice extras). And lastly (as far as I know) 
  36.   there's FAClock, but the less said about that the better...
  37.  
  38.   But, like so many before me, the clock I wanted wasn't there. One that
  39.   came close was a small analog clock by Matt Dillon. It was rather too
  40.   limited though. However, using that source as a starting point, I
  41.   produced TinyClock. Much has been added, for both aesthetics and
  42.   functionality.
  43.  
  44.   My aim is to make TinyClock the clock you want, as ubiquitous as
  45.   xclock on Sun Workstations.
  46.  
  47. I (Mika Kuulusa):
  48.   When I first got TinyClock, I was stunned. I just loved the 
  49.   functionality of the program. But... I didn't like the look of the 
  50.   clock.
  51.  
  52.   So, I emailed Martin and asked for the sources to do some 
  53.   enhancements. I got them and TinyClock v2.0 was the result.
  54.   I hope prefer the new hands (triangles) to the old 'lines'.
  55.   Oh and there is more to come... 
  56.  
  57.  
  58. DESCRIPTION
  59.  
  60.  
  61.   TinyClock is an Analog-type clock Commodity for Amigas with os2.0 or
  62. higher. Here's a rundown of TinyClock's features:
  63.  
  64. (* = new/enhanced feature compared to TinyClock v1.x)
  65.  
  66.     - Resizeable ANALOG display
  67.  
  68.     * Enhanced hands (drawn as triangles)
  69.  
  70.     * Enhanced pips (drawn as filled rectangles or circles)
  71.  
  72.     * Preferences GUI (Graphic User Interface)
  73.  
  74.     - An alarm facility
  75.  
  76.     * Optionally chirps every half-hour, and twice on the hour
  77.  
  78.     * Optionally moves window to front or to back of other
  79.       windows automatically 
  80.  
  81.     * Colors used in clock rendering can be changed as desired.
  82.       Colors now chosen from palette of the screen.
  83.  
  84.     - Can save position,size etc. for subsequent runs
  85.  
  86.     * Whole window is a 'drag bar', except right-hand and bottom
  87.       edges, which act as a 'sizing gadget'. There is FreezeWindow
  88.       toggle to disable these gadgets.
  89.  
  90.     * Displays day,date and alarm ON/OFF status in MenuBar when
  91.       window is active
  92.  
  93.     - WB 2.0 'icon look', with menus that use screen's font
  94.  
  95.     - Uses tiny amount of processor (only redraws when necessary)
  96.  
  97.     * Is a Commodity
  98.  
  99.     * AGA and OS3.0 NewLookMenus supported
  100.  
  101.  
  102. My aim is to make TinyClock The clock you want, as ubiquitous as
  103. xclock on Sun Workstations.
  104.  
  105.  
  106. RUNNING TINYCLOCK
  107.  
  108.  
  109. From Workbench:
  110.     Double click the TinyClock icon.
  111.  
  112. From CLI:
  113.     Give the command 'TinyClock' Command-line options are't used.
  114.     If you want it go backround use command 'run >NIL: TinyClock'.
  115.  
  116. You may want to start TinyClock in startup. If you do, just drag the 
  117. TinyClock icon to WBStartup drawer and it will be run every time
  118. you boot.
  119.  
  120.  
  121. USAGE
  122.  
  123.  
  124. As mentioned in the 'features' list, almost the whole window is a 'drag bar' 
  125. (this is like some programs' iconified states). The picture below shows what 
  126. parts of the window do what:
  127.  
  128.     +-------------------------+-+
  129.     |              | |
  130.     |              | |
  131.     |    Click here to      | <----    Click in this region
  132.     |              | |
  133.     |      POSITION      | |          to RESIZE window
  134.     |              | |
  135.     |       window      | |
  136.     |              | |
  137.     |              | |
  138.     +-------------------------+ |
  139.     +---------------------------+
  140.  
  141. Menus Self-explanatory, I hope. Here's a quick rundown though...
  142.  
  143.                    +--- Shortcut
  144. MENUS:                   |    +--- Description
  145.                    |     |
  146.      Project:
  147.     WindowToFront  F    Moves window to front of all other windows
  148.     WindowToBack   B    Moves window to back of all other windows
  149.     Set Prefs...   P        Modify current Preferences
  150.     Set Colors...  C        Choose colors from the palette
  151.     ----------------
  152.     Reset Prefs    R    Reloads previously saved Preferences
  153.     Save Prefs     S    Save current Preferences
  154.     About...       ?    Displays a small 'about' message
  155.     Quit           Q    Terminate program
  156.  
  157.      Alarm:
  158.      Alarm         O    Togglesalarm ON/OFF. See NOTE !
  159.     Set Alarm...   A    Pops up a requester letting you set alarm time
  160.  
  161. (NOTE1: the preferences are saved to "ENVARC:TinyClockPrefs", it will save 
  162.         all current properties, except Alarm ON/OFF status)
  163.  
  164. (NOTE3: Alarm is ON  if there is a ' * ' after the date in the menubar.
  165.         Alarm is OFF if there isn't a ' * ' in the menubar.)
  166. (NOTE3: Alarm requester uses a 24-hour clock, with hour 00 meaning midnight.)
  167.  
  168.  
  169. PREFERENCES GUI:
  170.  
  171.     AutoMove
  172.       Off               no automatic moves
  173.       AutoGoFront       keep window always in the front
  174.       AutoGoBack        keep window always in the back
  175.     BevelBox
  176.       Off               no bevel box at all
  177.       Box Up        lifted look
  178.       Box Down          recessed look
  179.     Chirp
  180.       Off               no beeps used
  181.       On Hour           make 2 beeps on hour
  182.       On Hour&Half      make 2 beeps on hour and 1 beep on half
  183.  
  184.     FreezeWindow        set window drag and size gadgets on/off
  185.     CenterPip             draw the tiny pip to the centre of the clock
  186.  
  187.     Hotkey                keycode for clock window popup
  188.     Set Colors...         select colors
  189.  
  190. CAVEATS
  191.  
  192.  
  193. Since TinyClock updates once every four seconds, it will take (at most)
  194. that long for its window to come to the front/back, and for the display 
  195. to reflect a new system time. However, the display will update on the 
  196. minute, not a few seconds either side.
  197.  
  198. Commodity Active/InActive commands only enable/disable the HotKey of the
  199. clock. 
  200.  
  201.  
  202. AUTHORS
  203.  
  204.  
  205. TinyClock is written in C and compiled with SAS/C v6.2. The ancient
  206. source code for clock was (C) Matt Dillon (although it's now
  207. unrecognisable). Thanks to Martin W. Scott for letting me enhance
  208. his magnificent clock! Thanks also to Michael 'Dense' Lorant for
  209. A4000 betatesting and all the others dudez on #amiga :)
  210.  
  211. Martin wants to thank Mike Meyer et al. for Mg3 (the best pd text editor)
  212. and Steve Koren for SKsh. GadToolsBox v1.3 generated the alarm window and
  213. gadgets - thanks to Jaba Development for a great program.
  214.  
  215. Here are the addresses where we can be reached. I'm always happy to
  216. receive _gifts_, bug-reports, comments or suggestions for enhancement of
  217. TinyClock. Martin is busy finishing his studies, so  I am the first port 
  218. of call then.
  219.  
  220. My address:    Mika Kuulusa
  221.         Yliopistonkatu 46B49
  222.         33100 Tampere
  223.         Finland
  224.  
  225. Telephone:    +358-31-236 304
  226.  
  227. Email:        k114636@cc.tut.fi
  228.  
  229. I (Mika Kuulusa) can be also reached from IRC (Internet Relay Chat)
  230. as 'MKsa' ...daily    =)
  231.  
  232. Enjoy!
  233.  
  234.     Mika Kuulusa & Martin W. Scott
  235.  
  236.  
  237. Ps. IF YOU LIKE THIS CLOCK A LOT, SEND ME A POSTCARD!
  238. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  239.  
  240. HISTORY
  241.  
  242.  v2.0    - major face-lift (hands now drawn as filled triangles)
  243.  
  244.     - a nifty gadtools.library preferences GUI
  245.  
  246.     - runs now as Commodity (there is a HotKey for clock popup)
  247.  
  248.     - freezewindow option (drag & size gadgets disabled)
  249.  
  250.     - if alarm is ON, you can see it as '*' in the MenuTitle
  251.  
  252.     - chirp occurrences modified (Off/On Hour/On Hour&Half)
  253.  
  254.     - now optionally pops window to back if it is in front of
  255.       other window (automove)
  256.  
  257.     - colors are now chosen from palette of the screen
  258.  
  259.     - pips drawn as scaled rectangles or circles
  260.  
  261.     - saves Preferences now to 'ENVARC:TinyClockPrefs'
  262.  
  263.     - AGA and OS3.0 NewLookMenus supported
  264.  
  265.  v1.04    - alarm window now has 'Time now' gadget to fill in current time.
  266.  
  267.     - increased audio priority of beep, so sound gets through when it
  268.       needs to (unless programs ask for the audio.device with a higher
  269.       priority than they ought too...).
  270.  
  271.  v1.03    - now has alarm facility.
  272.  
  273.     - fixed small bugette whereby minute hand was not pointing to
  274.       the exactly ideal place -- now you can read-off the minutes
  275.       fairly accurately with a small window.
  276.  
  277.  v1.02    - now optionally pops its window to front when obscured; thus,
  278.       v1.01 and below .config files will not be loaded -- sorry...
  279.  
  280.  v1.01    - now sets its priority to 10, to update on time regardless
  281.       of heavy CPU load.
  282.  
  283.     - improved beep sound (doesn't 'grate' so much now).
  284.  
  285.  v1.0   - initial release.
  286.