wmclock/README

   1 _______________________
   2 |O|  About wmclock  |X|
   3 ^^^^^^^^^^^^^^^^^^^^^^^
   4
   5 Wmclock is an applet which displays the date and time in a dockable
   6 tile in the same style as the clock from the NEXTSTEP(tm) operating
   7 system.  Wmclock is specially designed for the Window Maker window
   8 manager, by Alfredo Kojima, and features multiple language support,
   9 twenty-four-hour and twelve-hour (am/pm) time display, and, optionally,
  10 can run a user-specified program on a mouse click.  Wmclock is derived
  11 from asclock, a similar clock for the AfterStep window manager.
  12
  13 ____________________________
  14 |O|  Installing wmclock  |X|
  15 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  16
  17 Please see the INSTALL file accompanying the wmclock source for
  18 instructions on installing wmclock.
  19
  20 _________________________
  21 |O|  Getting Started  |X|
  22 ^^^^^^^^^^^^^^^^^^^^^^^^^
  23
  24 Wmclock is designed especially for Window Maker; hence, putting wmclock
  25 into your Window Maker dock is quick and easy.  After you've installed
  26 wmclock according to the instructions, there are three steps:
  27
  28   (1) Start wmclock.  The easiest way to accomplish this is to accept
  29       the defaults for things such as led color, blinking, etc, and
  30       just start the clock:
  31
  32           wmclock
  33
  34   (2) Drag the resulting wmclock appicon to an empty slot in your dock.
  35       You can do this in one of two fashions:
  36
  37       (a) Position the mouse pointer over a portion of the appicon tile
  38           that is not covered by wmclock's LED display or calendar
  39           display.  Press the primary mouse button (usually the left
  40           one) and drag to the dock.  This requires a little bit of
  41           precision in aiming the mouse, but requires no keyboard
  42           action.
  43
  44       (b) Hold down the [Alt] or [Meta] key (whichever one you have
  45           configured Window Maker to use), position the mouse pointer
  46           over any part of the wmlock appicon, press the primary mouse
  47           button (usually the left one), and drag to the dock. This
  48           method requires less precision, but requires you to press and
  49           hold a key while dragging.
  50
  51   (3) Set wmclock to launch when Window Maker starts.  Press the menu
  52       mouse button (usually the right one) on the portion of the docked
  53       wmclock tile that is not covered by wmclock's LED display or
  54       calendar display to bring up the dock icon menu, and choose
  55       `Settings...'.  In the resulting dialog, check the box labelled
  56       `Start when Window Maker is started' and press `OK'.  That's it!
  57
  58 _________________________
  59 |O|  Troubleshooting  |X|
  60 ^^^^^^^^^^^^^^^^^^^^^^^^^
  61
  62 As with any dockable applet, there are a few possible `gotchas' with
  63 wmclock and Window Maker:
  64
  65   - If you have the Clip set to `AutoAttract Icons', the wmclock
  66     appicon will appear in the Clip instead of on the desktop.  If your
  67     Clip is collapsed, you won't be able to see the wmclock appicon,
  68     even though it's running.  Make sure you uncollapse your Clip and
  69     look for wmclock there if it doesn't appear on your desktop.
  70
  71   - If your Clip is too close to your dock, you may have difficulty
  72     docking wmclock, because the Clip may grab the wmclock appicon
  73     instead.  Try moving your Clip farther away from your dock before
  74     docking wmclock.
  75
  76 _________________________________________________
  77 |O|  Differences Between asclock and wmclock  |X|
  78 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  79
  80 Wmclock is derived from asclock version 1.0.12 by Beat Christen.
  81 The major differences between asclock and wmclock are:
  82
  83   (1) Asclock is designed for use with the AfterStep window manager.
  84       To use asclock with Window Maker, a patch is required.  Wmclock
  85       is better behaved with Window Maker and requires no patch or
  86       special command-line options; it `just works'.
  87
  88   (2) Wmclock corrects a few of asclock's aesthetic defects.  Most
  89       notably, the `off-by-one-pixel' defect at the lefthand side of
  90       the LED display is corrected.
  91
  92   (3) Asclock use a simple system() call to execute the command
  93       specified using the `-exe' command-line option; this method could
  94       create lots of unwanted zombie processes.  Wmclock cleans up its
  95       chiled processes every so often to eliminate the zombies.
  96
  97       Also, if no command was specified when asclock was started, it
  98       would output a message warning that no command was specified each
  99       time you click the mouse on asclock window area.  Wmclock does not
 100       output that message; if no command was specified, wmclock simply
 101       does nothing when you click on it.
 102
 103 Other minor differences include:
 104
 105   (1) The `-shape' and `-iconic' command-line options are no longer
 106       needed with wmclock.  Wmclock recognizes them for backwards
 107       compatibility with asclock, but they have no effect.
 108
 109   (2) Asclock contained an arbitrary limitation on the length of the
 110       command (approximately 50 characters) that you could specify with
 111       the `-exe' option.  Wmclock removes that arbitrary limitation and
 112       cleans up the code significantly in the process.
 113
 114 _______________________________________________________
 115 |O|  Authors, Copyright, License, Disclaimer, etc.  |X|
 116 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 117
 118 Wmclock is Copyright (C) 1999 by Jim Knoble <jmknoble@pobox.com>.
 119 Significant portions of wmclock are directly derived from asclock by
 120 Beat Christen <spiff@longstreet.ch>, who, along with asclock's other
 121 authors, owns the copyright to those portions of wmclock.
 122
 123 Wmclock is licensed under the GNU General Public License, version 2, or
 124 (at your option) any later version.  See <http://www.gnu.org/> for more
 125 information.
 126
 127 The software is provided ``as is'', without warranty of any kind,
 128 express or implied, including but not limited to the warranties of
 129 merchantability, fitness for a particular purpose and noninfringement.
 130 In no event shall the author(s) be liable for any claim, damages or
 131 other liability, whether in an action of contract, tort or otherwise,
 132 arising from, out of or in connection with the software or the use or
 133 other dealings in the software.
 134
 135 Your mileage may vary.  Eat your vegetables.
 136
 137 --
 138 Window Maker Developers Team <wmaker-dev@googlegroups.com>