1
.\" Hey, EMACS: -*- nroff -*-
2
.\" First parameter, NAME, should be all caps
3
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
4
.\" other parameters are allowed: see man(7), man(1)
5
.TH WMCLOCKMON 1 "September 07, 2002"
6
.\" Please adjust this date whenever revising the manpage.
8
.\" Some roff macros, for reference:
9
.\" .nh disable hyphenation
10
.\" .hy enable hyphenation
11
.\" .ad l left justify
12
.\" .ad b justify to both left and right margins
13
.\" .nf disable filling
14
.\" .fi enable filling
15
.\" .br insert line break
16
.\" .sp <n> insert n+1 empty lines
17
.\" for manpage-specific macros, see man(7)
19
wmclockmon \- A dockapp to monitor hour, date and alarms
23
.B wmclockmon [options]
27
This manual page documents briefly the
31
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
32
.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
34
\fBWMClockMon\fP is a program to display a digital clock. It is a dockapp that
35
is supported by X window managers such as Window Maker, AfterStep, BlackBox,
38
It displays time and date, an AM/PM indicator if wanted and an alarm indicator.
39
It has an LCD look\-alike user interface. The back-light may be turned on/off by
40
clicking the mouse button 1 (left) over the application. When alarm raises, an
41
alarm\-mode will alert you by turning on and off back\-light for 1 minute and
42
running the configured command. This can be stopped (and restarted) by clicking
43
the mouse button 3 (right) over the application. Clicking on AM or PM will
44
toggle 12h/24h clock mode, and clicking on ALRM will toggle alarm mode (you
45
should have alarms for that). If an alarm time has been set to \fBoff\fP (see
46
config file section) it will not be set back on. Updating the config will allow
49
By clicking on the background with the button 1 while holding down the control
50
key, you can switch to internet time display (in beats) and the same action
51
bring back to the local time. You can start directly with internet time (see
54
Clicking with the mouse button 2 (middle) while holding down the control
55
key, launches the configuration tool. If you don't hold the control key
56
down, it cycles through the different styles.
58
Clicking with the mouse button 3 (right) while holding down the control
59
key, launches the calendar tool.
61
Command\-line options override the default configuration file options. But if
62
a file is given at command\-line (with the \-f option), its options will
63
override those given before.
65
Alarms can be added automatically with the included calendar (see below and
66
wmclockmon-cal(1) for more informations). Moreover the today's calendar can
67
be displayed at startup or at 00:00. In that order, the \fIMessageCmd\fP
71
+-------------------------+-------------------------+
72
| no modifier | control key |
73
+----------+-------------------------+-------------------------+
74
| Button 1 | action/backlight on-off | internet time |
75
+----------+-------------------------+-------------------------+
76
| Button 2 | cycle style | configuration tool |
77
+----------+-------------------------+-------------------------+
78
| Button 3 | blinking on/off | calendar tool |
79
+----------+-------------------------+-------------------------+
83
This program follows the usual GNU command line syntax, with long options
84
starting with two dashes (`\-'). A summary of options is included below.
86
.B \-d, \-\-display <string>
87
Attempt to open a window on the named X display. In the absence of this option,
88
the display specified by the
90
environment variable is used.
93
show help text and exit.
96
show program version and exit.
98
.B \-bl, \-\-backlight
101
.B \-lc, \-\-light\-color <color>
102
back-light or LEDs color (rgb:6E/C6/3B is default for LCD looks, rgb:00/B0/EA
103
is default for LED looks).
105
.B \-it, \-\-internet\-time
106
start with internet time (in beats).
108
.B \-i, \-\-interval <number>
109
number of secs between updates (1 is default).
112
run the application in windowed mode.
114
.B \-bw, \-\-broken\-wm
115
activate broken window manager fix.
117
.B \-a, \-\-alarm <HH:MM>
118
set alarm time to HH:MM (24h clock mode).
120
.B \-c, \-\-alarm\-cmd <string>
121
command to launch when an alarm raises.
123
.B \-mc, \-\-message\-cmd <string>
124
command to display messages when an alarm raises.
127
12 hours clock mode (default is 24).
129
.B \-s, \-\-style <name>
130
style to use for display. If \-sd is given, there is no need to give an
131
extention since it is automatically given (\fI.mwcs\fP). Using this option
132
to a \fI.mwcs\fP file automatically sets the styles directory if not already
133
given. A subsequent use of \-sd will overwrite it. Using another extention
134
may give erroneous results.
136
.B \-sd, \-\-style\-dir <directory>
137
set the directory where styles are stored.
139
.B \-nb, \-\-no\-blink
140
disable blinking when alarm raises.
143
load configuration file.
145
.B \-nl, \-\-no\-locale
146
don't use the current locale (use the C locale instead).
149
use a label instead of the current date (usefull if you have multiple
150
instances running different timezones).
152
.B \-sc, \-\-show\-cal
153
show today's calendar/TODO list at startup/00:00.
155
.B \-ca, \-\-cal\-alrms
156
load calendar alarms for today.
161
uses one default file : ~/.wmclockmonrc. Empty lines or lines begining
162
with a # are ignored. Entries are summarized below (default value in
163
parenthesis). Booleans can be either 1/0, true/false, yes/no or
164
on/off, case insensitive. A sample file is given in the source package.
170
String (#6EC63B for LCD looks, #00B0EA for LED looks).
173
String (noting). You can have several \fBAlarm\fP entries. An entry is in the
174
form of [bool@]HH:MM[\-D][.M], with bool representing the alarm status (on or
175
off), HH:MM the hours and minutes of alarm, D the number of the day it should
176
happen and M is the message that should be displayed when this alarm raises.
177
The bool, the D and the M values are optionals (the boolean defaults to on, no
178
day value means 'every day' and the message is optional). @, \- and . are the
179
separators between the each of them and the time (or the day, for the message).
180
The alarm time HAVE to be in 24h mode and with 2 digits for hours and 2 for
181
minutes (no spaces). The day value, if given, should be between 1 and 7. Time
182
and day values are used with strftime (%H:%M and %u). For more examples, see
183
samples files in package...
186
String (nothing). Command that is executed once an alarm raises (eg: ogg123 -d
187
esd -q /home/thomas/documents/sons/alarme.ogg).
190
String (nothing). Command that is executed with the MESSAGE part of the alarm
191
that is raised as argument.
197
Boolean (false). Set 12h/24h clock mode.
200
Boolean (yes). Use your current locale or not (use C locale instead).
206
String (nothing). Directory where styles are stored.
209
Integer (0: normal clock, 1: internet time, 2: binary clock).
212
Boolean (No). Show today's calendar at startup/00:00.
215
Boolean (Off). Load calendar's alarms for today.
217
Calendar files can be unique (for a particular day), yearly or monthly. For a
218
day, all calendar files are used (if they exist).
222
Building a new style is quite easy. A style is composed of 4 description
223
files and several pixmaps files : a main style file, a parts style file, a
224
letters style file and a internet time style file. Each of them contains
225
several variables and their associated values. If only the main style file
226
have its extension fixed to \fI.mwcs\fP, the others can have whatever name
227
you want but using those given is usefull for understanding :)
229
.SS MAIN STYLE FILE (.mwcs)
233
file where parts style is described.
236
file where letters style is described.
239
file where internet time style is described.
242
background pixmap for backlight on display (58x58).
245
background pixmap for backlight off display (58x58).
248
number of shadow colors.
255
hours position in pixels in the background pixmaps.
259
hours displayed in big (boolean).
282
seconds are a blinking colon.
332
.SS PARTS STYLE FILE (.pwcs)
336
pixmaps for parts of graphics (big and small digits, graphs, AM/PM/ALRM).
339
big digits height in pixels.
342
big digits width in pixels.
349
same as for big digits but for small digits.
352
.SS LETTERS STYLE FILE (.lwcs)
363
same as for big and small digits.
366
.SS INTERNET TIME STYLE FILE (.iwcs)
370
background pixmap for backlight on internet time display.
373
same as above for backlight off.
382
as usual, same as for hours.
391
same as above for tenths of beat.
395
display or not tenths of beat (boolean).
404
same as for tenths of beat.
407
.SS BINARY CLOCK STYLE FILE (.bwcs)
411
background pixmap for backlight on binary clock display.
414
same as above for backlight off.
420
hours bits start position (most significant bits first).
427
minutes bits start position (most significant bits first).
434
seconds bits start position (most significant bits first).
441
size of time bits squares.
448
week day bits start position (most significant bits first).
455
month day bits start position (most significant bits first).
462
month bits start position (most significant bits first).
469
size of date bits squares.
470
.B Specifying -1 for Bin_IX disable date displaying and other date specs are not needed.
477
space between 2 bits of the same number for the time.
484
space between 2 binary numbers of the same time part.
491
space between 2 bits of the same number for the date.
498
space between 2 binary numbers of the same date part.
503
wmclockmon-config(1), wmclockmon-cal(1)
507
WMClockMon was assembled by Thomas Nemeth <tnemeth@free.fr>. It is largely
508
based on WMMemMon and WMCPULoad by Seiichi SATO <ssato@sh.rim.or.jp> and
509
WMMemLoad by Mark Staggs <me@markstaggs.net>.
added
removed
doc/wmclockmon.1
