wmail: use automake.
[dockapps.git] / wmcalclockkbd / README
blob378afd1242c7c80e6e4cb0d5823388716a4652bd
1 What is wmCalClock?
2 -------------------
4 wmCalClock is a simple Calendar Clock that uses anti-aliased characters and
5 drop shadows. Doesn't do much except tell time...
8 What is wmCalClockKbd?
9 ----------------------
11 wmCalClockKbd has all features of wmCalClock and add very simple actual
12 keyboard group indicator (for XFree86 >= 4.3.0).
13 In another way, it's dockable application for WindowMaker (but you can also
14 use it in AfterStep, BlackBox, ...) window manager. wmCalClockKbd can show
15 actual time, date and keyboard group. This application was written, because I
16 could not find any application such wmkbd, which I use with previous versions
17 of XFree86. I could not think out any nice looking app using the whole dock
18 icon, so I modified one of the app in my dock. The inspiration was also
19 gSwitchIt applet and its libxklavier.
22 Installation
23 -----------
25 You also need to have installed devel packages of XFree86 and libxpm in order
26 to compile this application. Then unpack the application and run
28   make
29   make install (as root)
31 to compile and install. You shouldn't have any problem with it, application was
32 tested on Mandrake Linux 9.1. There might be also some .rpm packages on
33 project web pages.
34 The wmCalClockKbd should also run on other un*x systems too, but I don't test
35 it. If you have any good experience of running it on such system, please send
36 me some report describing this system.
39 Usage
40 -----
42 If you want to use the keyboard indicator, you really need to have
43 XFree86 >= 4.3.0! If you use more keyboard maps, it should be set properly.
44 There is example of my X86Config-4 InputDevice section:
46   Section "InputDevice"
47     Identifier "Keyboard1"`             # keyboard name
48     Driver "Keyboard"
49     Option "XkbModel" "pc102"           # you might use pc105, if you have Win keys on your keyboard
50     Option "XkbLayout" "us,cz_qwerty"   # most important! I have configured two keyboard layouts (groups) - US/ASCII and Czech(qwerty), you can use up to 4 layouts
51     Option "XkbCompat" ""
52     Option "XkbOptions" "default,grp_led:scroll,grp:alt_shift_toggle,grp:switch"
53   #                         ^^^ use some default options to avoid Mandrake bug
54   #                                     ^^^ indicate alternative groups by switching the scroll led
55   #                                                     ^^^ switch groups by pressing Alt+Shift (left)
56   #                                                                     ^^^ use right alt to set second group, while it is pressed down
57   EndSection
59 you can also use setxkbmap, if you don't want to edit you XF86Config-4:
61   setxkbmap -layout "us,cz_qwerty,de" -option "default,grp:alt_shift_toogle"
63 for example. Once, when you have configured your keyboard properly, you can
64 run wmCalClockKbd with -kb option:
66   wmCalClockKbd -kb "us.xpm,cz.xpm"
68 which tells to wmCalClockKbd to use us.xpm file for first group and cz.xpm for
69 the second group. Images are taken from the default location specified in
70 PREFIX file. You can use up to 4 images, but the number of images must be the
71 same as number of configured layouts (groups), otherwise app disable keyboard
72 indicator functions. Please make also sure, that there is your national image
73 in pixmaps directory. If not, you can make new one (dimension are 54x35
74 pixels, color depth depends on you system) and send it to me (I will add it to
75 source files, but please don't break any Copyrights when making it).
76 There is another one new option -kbt, which sets how much will be the keyboard
77 image transparent when merging with date sign (default options is 0.25, you
78 can you any number from 0.0-1.0, but useful values are 0.1-0.5).
79 All wmCalClock options works like in the original version, you can read about
80 them in olddoc/ dir of source codes or use -help switch.
83 Copyright
84 ---------
85 wmCalClock is copyright (c) 1998, 1999, 2003 by Michael G. Henderson, Petr
86 Hlavka and licensed through the GNU General Public License. Read the COPYING
87 file for the complete GNU license.