@DATABASE DClock.guide

@NODE Main "DClock - The guide"

    DClock V1.6 - The ultimate, menu driven Workbench-Clock
    =======================================================


    Table of Contents
    -----------------

    @{" Introduction    " link Intro}  DClock - The introduction
    @{" Installation    " link Installation}  DClock - The installation
    @{" Menus           " link Menus}  DClock - The magic menus
    @{" Tooltypes       " link Tooltypes}  DClock - The tooltypes
    @{" Legalities      " link Legals}  DClock - The legal stuff
    @{" Author Info     " link Author}  DClock - The author
    @{" History         " link History}  DClock - The story
    @{" Commercial      " link Commercial}  DClock - The t-shirt


@ENDNODE

@NODE Intro "DClock - The Introduction"

    Introduction
    ------------

    DClock is a digital clock program for the Amiga.
    Features include:

    - DClock has it's own small window which can be placed
      anywhere on the Workbench or any other public screen.

    - DClock  comes with a completely  menu-driven GUI. No
      commandline options are necessary (but they are
      nevertheless possible. See @{" Tooltypes " link Tooltypes}).

    - Timer and alarm clock function with the ability to
      run user-defined Shell commands (including ARexx-
      scripts if you use the RX command, and Shell-scripts
      with the Execute command).

    - Date function

    - Fore- and  background colors of the window are user-
      defineable.

    - All settings  can be saved and will automatically be
      loaded upon startup. This  includes the  position of
      the DClock window, the  colors, and  the settings of
      the alarm clock.

    - Iconify function

@ENDNODE

@NODE Installation "DClock - The installation"

    Requirements and Installation
    -----------------------------

    DClock makes use of the  reqtools.library, which is not part
    of this distribution. It is  available  on Aminet or  on the
    Amiga software library (fish) disks. Thanks to Nico Francois
    for his great product.
    You need Kickstart 2.04+ to be able to run DClock. If DClock
    immediately  returns after startup, check  whether you  have

           Kickstart V37+
           reqtools.library V38+
           a public screen called 'Workbench'
           enough free memory


    Installation is very simple: Simply drag  the DClock icon to
    the WBStartup drawer of your system partition/disk or to any
    other drawer, if you don't want DClock to be started automa-
    tically after booting.

@ENDNODE

@NODE Menus "DClock - The magic menus"

    DClock Menus
    ------------

    While the DClock window is active, you can select the follo-
    wing menu items:

    DClock menu:

       Seconds (toggle) : Display seconds on/off

       24H (toggle)     : Toggle between 24 hour mode or 12 hour
                          AM/PM mode, and, if Date is on,
                          between DD.MM.YYYY and MM.DD.YYYY

       Date (toggle)    : Turn date on/off

       dd-mm-yyyy       : Select date format: DD-MM-YYYY
       (toggle)           or MM-DD-YYYY

       Alarm on (toggle): Turn alarm function on/off

       Timer on (toggle): Turn timer function on/off

       Set alarm clock  : Set the alarm time

       Set timer        : Set the timer

       Alarm command    : Enter a Shell-command which will be
                          executed when the alarm went off.
                          RUN your command if if it takes longer
                          and you don't want to block out the GUI.

       Timer command    : dito for the timer.

       Save Preferences : Save all the settings to
                          ENVARC:DClock.prefs

       About...         : Information about @{" The Author " link Author}

       Quit             : Call the Terminator

    Window menu:

       Foreground Color : Set the foreground (text) color

       Background Color : Set the background color (who would
                          have guessed...)

       Dragbar (toggle) : Turn the window dragbar and title on
                          and off. The state of the checkmark
                          will be saved in the preferences file.

       Activate (toggle): Activate DClock window after startup/
                          reopen.

       Iconify          : Iconify the DClock window and unlock the
                          public screen DClock is running on. This
                          allows you to change the screenmode of
                          your Workbench screen without quitting
                          DClock.


    When you select `Save Preferences'  from  the  Project menu, the
    state  of the alarm  clock  will be saved, too. The  alarm  will
    then be automatically turned on after startup (if it was on when
    you saved  the prefs, off course). I e.g. set the  alarm to 1.00
    AM, switched  it on and  selected `Save preferences'. I  now get
    reminded every day that it's time to go to bed without having to
    set the alarm again and again.

@ENDNODE


@NODE Tooltypes "DClock - The tooltypes"

    Tooltypes
    ---------

    Well, as for now there are only two of them:

    DONOTWAIT
               You need this if you  put DClock into the WBStartup
               drawer so that Workbench doesn't wait for DClock to
               return

    PUBSCREEN=name
               The name of an open  public screen  you want DClock
               to pop up  on. If the specified screen  is not open
               or if it can't be locked for any reason, the  Work-
               bench screen is used instead.

    You can enter this as argument on the commandline of your shell:

       DClock PUBSCREEN=Gaga_Screen


@ENDNODE


@NODE Legals "DClock - The legal stuff"

    Legal section
    -------------

    DClock V1.6 (c) 1994/1995 by Karl Lukas.

    This program is Freely Distributable, as  opposed to Public
    Domain.  Permission  is given  to  freely  distribute  this
    program  provided  no  fee  is charged, and  this  documen-
    tation  file  is included with the archive. All  rights re-
    served.
    From version 1.6 on  the source code is part of the distri-
    bution. You may change DClock according to your needs with-
    out permission. If you plan  to release your work publicly,
    however, you have to respect the following points:

    o Give it another name

    o Your documentation must have the following statement in
      the beginning:
      "... is based on DClockxx, (c) 1995 by Karl Lukas"

    o You must provide a history file which documents all the
      changings you made to the original code.

    o Your must make your code available to me upon request.

    o Your About-requester must mention my name (something
      like: ... written by Karl Lukas and ...).

    o You must not claim any copyright on any parts of my code.

    o You must release it as FREEWARE.


@ENDNODE


@NODE Author "DClock - The author"

    Info about the author
    ---------------------

    Send bug reports, compliments and such to

       kalle@gis.geogr.unizh.ch

    (This account will probably close down soon)

    Send postcards, money and other gifts to

       Karl Lukas
       Hinterzweienstr. 91
       CH-4132 Muttenz
       Switzerland

    Send threatening letters, letter bombs a.s.o. to

       NIL:


@ENDNODE


@NODE History "DClock - The story"

    History
    -------

    V1.0 Apr 1994 o Initial release

    V1.1 Jun 1994 o DClock now runs three independent tasks:
                    - User interface  (DClock)
                    - Updating of the DClock window, timer etc.
                      (DClockTask)
                    - display information when alarm went off or
                      timer is finished (DClockInfo).
                    Advantage: Clock and timer won't be stopped tem-
                    porarily while a window/requester is open. You
                    can get informed now when the timer/alarm went
                    off while a window/requester is open.

                  o Bug: The alarm and timer symbols were drawn with
                    incorrect offsets, so that the display got mes-
                    sed if big screen fonts were used.

                  o The settings are now stored in ENVARC:DClock.prefs
                    You can copy your old DClock.prefs file from S: to
                    ENVARC: if you want to use your old settings.

    V1.2 Nov 1994 o You can now enter a Shell command, which will be
                    executed when the alarm or the timer went off. The
                    command can be saved to the preferences file. If you
                    don't want to execute a command, just enter an empty
                    string.

                  o The current time is now displayed with two digits
                    in the alarm/timer requester (i.e. 18:08:12 instead
                    of 18:8:12). Hey, there is an ANSI function for
                    this. Why didn't anybody tell me?  ;)

                  o You can now turn the titlebar and dragbar off with
                    the menu option "Dragbar". Off course you cannot move
                    the window anymore when the dragbar is turned off.
                    You can save the state of the "Dragbar" menu item to
                    the preferences. THIS ONLY TAKES EFFECT WHEN YOU QUIT
                    AND START DCLOCK AGAIN.

    V1.3 Nov 1994 o OK, the dragbar switching was not very elegant. Now
                    you can turn the dragbar on and off without leaving
                    the program.

                  o Got rid of the `Snapshot position' menu item. Now
                    `Save preferences' saves the current position, too.

                  o I rearranged the menus to a somewhat more logical
                    order.

                  o `Alarm command' and `Timer command' now use the
                     SystemTagList() function. A console window is opened
                     as stdin/stdout for the executed program, so you can
                     actually _see_ it's output if you started DClock from
                     the Workbench. Nice, isn't it?

    V1.4 Dec 1994 o 12 hour AM/PM mode added.

    V1.5 Dec 1994 o (I should actually be preparing for my exams... :)

                  o Little bug fixed: You could deadlock DClock by
                    immediately quitting it after startup (this was
                    only theoretical as you had no chance to immediately
                    quit DClock because the window was not activated).

                  o OS3.0+ users now get white menus.

                  o Date function added. If the 24H mode is active,
                    the date is displayed as DD.MM.YYYY. Otherwise day and
                    month are swapped (i.e. MM.DD.YYYY). I hope this suits
                    your needs.

                  o New menu item `Activate' added.

                  o New menu shortcuts added

    V1.6 Feb 1995 o Pubscreens are now supported

                  o New menu item: dd-mm-yyyy
                    You can now toggle the date and time formats
                    independently.

                  o Iconify function added

                  o The source code is now part of the distribution
                    SEE `LEGALITIES' BEFORE YOU USE IT!!!
@ENDNODE

@NODE Commercial "DClock - The t-shirt"


    Just kidding ;)

@ENDNODE

