Welcome to the twclock README

twclock is free software. Please see the file COPYING for details.
For documentation, please see the files in the doc subdirectory.
For building and installation instructions please see the INSTALL file


ADDITIONAL INSTALLATION NOTES:

   See the INSTALL file for basic install instructions.  It is the standard
   "./configure", "make", and "make install" procedure.  Once that is done,
   you will want to follow the process below.
   
   The "make install" put a copy of the resource file (Twclock)
   in one of many places where X looks for resource files on your system.  
   To find where Twclock was installed, you can run "make install" again and
   look near the bottom of the output.  There will be a line like: 
      /usr/bin/install -c src/Twclock /etc/X11/app-defaults
   In this case, it was installed in the /etc/X11/app-default directory.

   You will want to make changes to Twclock to tailor it to your needs.
   The easiest way is to edit the copy of Twclock just installed 
   by "make install".  But, you must be root!  

   You can also:
      copy Twclock to your home directory.
      -OR-
      cat it to the end of your .Xdefaults file.
      -OR-
      set the XUSERFILESEARCHPATH or XAPPLRESDIR 
      environmental variables and copy Twclock to your own 
      resources directory.  

      To use XUSERFILESEARCHPATH, follow these steps:
      1) Edit the .profile file in your home directory and add
         the line below:
            export XUSERFILESEARCHPATH=/home/ted/app-defaults/%N 
      2) Create the app-defaults directory in your home directory. 
      3) Copy resource files to the $HOME/app-defaults directory.
   
   Now edit the new copy of Twclock (root is not needed).  There are
   comments (lines beginning with an !) in Twclock explaining the values.
   After you change the values, restart the program to have them take effect.

   See http://www.faqs.org/faqs/x-faq/part2/section-22.html or
   the X manual pages for more information.

   Maintainers can use:
      ./configure --bindir="path" --datarootdir="path"
      and
      make install DESTDIR="rootpath"
      to build their distribution trees.
   

DESCRIPTION:

  This is a clock program which will prove to be very helpful for
ham operators and will displays the current time in major cities
around the world.  It also has an ID timer and alarm.  The alarm
can be set to beep, flash or send your call in CW via the soundcard.

An alarm will notify you when it is time for a station ID.  The
delay before an ID is set in the resource file (Twclock).  It can
also be set at runtime via a popup menu.  The popup menu also lets
you pick alarm options at runtime.  You have a choice of CW ID, blink,
and beep.  There is also a Auto Reset option.  This option automatically
starts another time out without any user action.

  Local or GMT time can be displayed.  In addition, the current
time at some point on the globe can be displayed by using the time
zone information contained in the files located under the directory
/usr/lib/zoneinfo or /usr/share/zoneinfo.  A file selection box
allows you to pick the region and city of interest, and the environment
variable TZ is set to the pathname for that time zone file.  The clock
will then display the current time for the selected location.  This
only changes TZ for the clock process - other processes are unaffected


USER INTERFACE:

  The interface has two functions, a Clock and an ID timer.

Clock Operation:

  The GUI uses scale widgets to display hours, minutes, and seconds.  
The button at the top is used to start and stop the alarm timer.  
When the time expires, the selected alarm options are performed.  
You can choose to have the button flash, the PC speaker beep and a
CW ID can be sent via the soundcard.  See the notes in the resource
file (Twclock) and the ID Timer Operation section below for more
information.

  There is only this one "undocumented" popup menu (via the right
mouse button).  Two of the menu buttons, "Local" and "GMT" set the
clock to that time.  Ctrl-L and Ctrl-G do the same thing as pushing
the "Local" and "GMT" menu buttons.

  The third menu button, "Others:" (or Control-O), pops up a file
selection box dialog that allows you to select an area and city. Then,
the OK button will set the clock to the selected zone.  The Cancel
button can be pressed at any time to popdown the dialog, leaving the
time unchanged.

  The fourth button is the Set Timer button.  This button (or Ctrl-S)
pops up a window where you can set the time for the alarm and alarm
options.  See the next section (ID Timer Operation) for a complete
description.

  The last button is labeled QRT.  Nuff said.


ID Timer Operation:

  The ID timer is started with the button at the top of the interface.
Pushing it in starts the timer.  When the time expires, the alarm goes off.
There are three alarms - blink the button, beep the PC speaker and send a
CW ID via the soundcard.  Press the button again to turn the alarm off.

The popup menu (left mouse click) has a Set Timer button which opens a
Options dialog where you can set timer options.  This window can also
be opened with Control-S. There are three sections on this window and
it will initially display the default options you defined in the resource
file (Twclock).

The Timer section allows you to set a time out interval.  You can set the
delay from 0 (?) to 9999 minutes and 9999 seconds. Push the OK button to
apply the new value, or push Cancel to leave it unchanged.  

The Auto Reset option for the timer.  When it is enabled, a new time out
is automatically started with each alarm.  There is no need for user action.
For example, with the timer set for 10 minutes, pushing the timer button
will generate an alarm every 10 minutes until the button` is pushed again. 

An ID can be generated at any time from the ID Now button on the 
popup menu.

Alarm options can be selected on this menu also.


Got any problems, comments, suggestions, etc?

My email is: wa0eir@mchsi.com

73,
Ted - wa0eir

