wmclock/README

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