wmclockmon/doc/wmclockmon.1

   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.
   7 .\"
   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)
  18 .SH NAME
  19 wmclockmon \- A dockapp to monitor hour, date and alarms
  20
  21
  22 .SH SYNOPSIS
  23 .B wmclockmon [options]
  24
  25
  26 .SH DESCRIPTION
  27 This manual page documents briefly the
  28 .B wmclockmon
  29 command.
  30 .PP
  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,
  33 .\" respectively.
  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,
  36 and Enlightenment.
  37
  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
  47 this.
  48
  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
  52 the \-it option).
  53
  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.
  57
  58 Clicking with the mouse button 3 (right) while holding down the control
  59 key, launches the calendar tool.
  60
  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.
  64
  65 Alarms can be added automatically with the included calendar (see below and
  66 wmclockmon-cal(1) for more information). Moreover the today's calendar can
  67 be displayed at startup or at 00:00. In that order, the \fIMessageCmd\fP
  68 option is used.
  69
  70 .rj 9
  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 +----------+-------------------------+-------------------------+
  80
  81
  82 .SH OPTIONS
  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.
  85 .TP
  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
  89 .B DISPLAY
  90 environment variable is used.
  91 .TP
  92 .B \-h,  \-\-help
  93 show help text and exit.
  94 .TP
  95 .B \-v,  \-\-version
  96 show program version and exit.
  97 .TP
  98 .B \-bl, \-\-backlight
  99 turn on back\-light.
 100 .TP
 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).
 104 .TP
 105 .B  \-it, \-\-internet\-time
 106 start with internet time (in beats).
 107 .TP
 108 .B \-i,  \-\-interval <number>
 109 number of secs between updates (1 is default).
 110 .TP
 111 .B \-w,  \-\-windowed
 112 run the application in windowed mode.
 113 .TP
 114 .B \-bw, \-\-broken\-wm
 115 activate broken window manager fix.
 116 .TP
 117 .B \-a,  \-\-alarm <HH:MM>
 118 set alarm time to HH:MM (24h clock mode).
 119 .TP
 120 .B \-c,  \-\-alarm\-cmd <string>
 121 command to launch when an alarm raises.
 122 .TP
 123 .B \-mc,  \-\-message\-cmd <string>
 124 command to display messages when an alarm raises.
 125 .TP
 126 .B \-12, \-\-h12
 127 12 hours clock mode (default is 24).
 128 .TP
 129 .B \-s,  \-\-style <name>
 130 style to use for display. If \-sd is given, there is no need to give an
 131 extension 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 extension
 134 may give erroneous results.
 135 .TP
 136 .B \-sd, \-\-style\-dir <directory>
 137 set the directory where styles are stored.
 138 .TP
 139 .B \-nb, \-\-no\-blink
 140 disable blinking when alarm raises.
 141 .TP
 142 .B \-f,  \-\-cfgfile
 143 load configuration file.
 144 .TP
 145 .B \-nl,  \-\-no\-locale
 146 don't use the current locale (use the C locale instead).
 147 .TP
 148 .B \-l,  \-\-label
 149 use a label instead of the current date (useful if you have multiple
 150 instances running different timezones).
 151 .TP
 152 .B \-sc,  \-\-show\-cal
 153 show today's calendar/TODO list at startup/00:00.
 154 .TP
 155 .B \-ca,  \-\-cal\-alrms
 156 load calendar alarms for today.
 157
 158
 159 .SH FILES
 160 .B wmclockmon
 161 uses one default file : ~/.wmclockmonrc. Empty lines or lines beginning
 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.
 165 .TP
 166 .B Backlight =
 167 Boolean (off).
 168 .TP
 169 .B Color =
 170 String (#6EC63B for LCD looks, #00B0EA for LED looks).
 171 .TP
 172 .B Alarm =
 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...
 184 .TP
 185 .B Command =
 186 String (nothing). Command that is executed once an alarm raises (eg: ogg123 -d
 187 esd -q /home/thomas/documents/sons/alarme.ogg).
 188 .TP
 189 .B MessageCmd =
 190 String (nothing). Command that is executed with the MESSAGE part of the alarm
 191 that is raised as argument.
 192 .TP
 193 .B Blink =
 194 Boolean (yes).
 195 .TP
 196 .B H12 =
 197 Boolean (false). Set 12h/24h clock mode.
 198 .TP
 199 .B Locale =
 200 Boolean (yes). Use your current locale or not (use C locale instead).
 201 .TP
 202 .B Style =
 203 String (nothing).
 204 .TP
 205 .B StyleDir =
 206 String (nothing). Directory where styles are stored.
 207 .TP
 208 .B TimeMode =
 209 Integer (0: normal clock, 1: internet time, 2: binary clock).
 210 .TP
 211 .B ShowCal =
 212 Boolean (No). Show today's calendar at startup/00:00.
 213 .TP
 214 .B CalAlrms =
 215 Boolean (Off). Load calendar's alarms for today.
 216
 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).
 219
 220
 221 .SH STYLES
 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 useful for understanding :)
 228
 229 .SS MAIN STYLE FILE (.mwcs)
 230
 231 .TP
 232 .B PartsStyle =
 233 file where parts style is described.
 234 .TP
 235 .B LettersStyle =
 236 file where letters style is described.
 237 .TP
 238 .B ITimeStyle =
 239 file where internet time style is described.
 240 .TP
 241 .B BacklightOn =
 242 background pixmap for backlight on display (58x58).
 243 .TP
 244 .B BacklightOff =
 245 background pixmap for backlight off display (58x58).
 246 .TP
 247 .B NbColors =
 248 number of shadow colors.
 249 .P
 250 .B Hours_PosX =
 251 .br
 252 .B Hours_PosY =
 253 .br
 254 .RS
 255 hours position in pixels in the background pixmaps.
 256 .RE
 257 .TP
 258 .B Hours_Big =
 259 hours displayed in big (boolean).
 260 .P
 261 .B Minutes_PosX =
 262 .br
 263 .B Minutes_PosY =
 264 .br
 265 .B Minutes_Big =
 266 .br
 267 .RS
 268 same as for hours.
 269 .RE
 270 .P
 271 .B Seconds_PosX =
 272 .br
 273 .B Seconds_PosY =
 274 .br
 275 .B Seconds_Big =
 276 .br
 277 .RS
 278 same as for hours.
 279 .RE
 280 .TP
 281 .B Seconds_Colon =
 282 seconds are a blinking colon.
 283 .P
 284 .B AM_PosX =
 285 .br
 286 .B AM_PosY =
 287 .br
 288 .RS
 289 same as for hours.
 290 .RE
 291 .P
 292 .B PM_PosX =
 293 .br
 294 .B PM_PosY =
 295 .br
 296 .RS
 297 same as for hours.
 298 .RE
 299 .P
 300 .B ALRM_PosX =
 301 .br
 302 .B ALRM_PosY =
 303 .br
 304 .RS
 305 same as for hours.
 306 .RE
 307 .P
 308 .B Weekday_PosX =
 309 .br
 310 .B Weekday_PosY =
 311 .br
 312 .RS
 313 same as for hours.
 314 .RE
 315 .P
 316 .B Day_PosX =
 317 .br
 318 .B Day_PosY =
 319 .br
 320 .RS
 321 same as for hours.
 322 .RE
 323 .P
 324 .B Month_PosX =
 325 .br
 326 .B Month_PosY =
 327 .br
 328 .RS
 329 same as for hours.
 330 .RE
 331
 332 .SS PARTS STYLE FILE (.pwcs)
 333
 334 .TP
 335 .B Parts =
 336 pixmaps for parts of graphics (big and small digits, graphs, AM/PM/ALRM).
 337 .TP
 338 .B BDigitHeight =
 339 big digits height in pixels.
 340 .TP
 341 .B BDigitWidth =
 342 big digits width in pixels.
 343 .P
 344 .B SDigitHeight =
 345 .br
 346 .B SDigitWidth =
 347 .br
 348 .RS
 349 same as for big digits but for small digits.
 350 .RE
 351
 352 .SS LETTERS STYLE FILE (.lwcs)
 353
 354 .TP
 355 .B Letters =
 356 pixmap for letters.
 357 .P
 358 .B LetterHeight =
 359 .br
 360 .B LetterWidth =
 361 .br
 362 .RS
 363 same as for big and small digits.
 364 .RE
 365
 366 .SS INTERNET TIME STYLE FILE (.iwcs)
 367
 368 .TP
 369 .B IBacklightOn =
 370 background pixmap for backlight on internet time display.
 371 .TP
 372 .B IBacklightOff =
 373 same as above for backlight off.
 374 .P
 375 .B Beats_PosX =
 376 .br
 377 .B Beats_PosY =
 378 .br
 379 .B Beats_Big =
 380 .br
 381 .RS
 382 as usual, same as for hours.
 383 .RE
 384 .P
 385 .B 10thOB_PosX =
 386 .br
 387 .B 10thOB_PosY =
 388 .br
 389 .B 10thOB_Big =
 390 .RS
 391 same as above for tenths of beat.
 392 .RE
 393 .TP
 394 .B 10thOB_Display =
 395 display or not tenths of beat (boolean).
 396 .P
 397 .B Graph_PosX =
 398 .br
 399 .B Graph_PosY =
 400 .br
 401 .B Graph_Display =
 402 .br
 403 .RS
 404 same as for tenths of beat.
 405 .RE
 406
 407 .SS BINARY CLOCK STYLE FILE (.bwcs)
 408
 409 .TP
 410 .B BBacklightOn =
 411 background pixmap for backlight on binary clock display.
 412 .TP
 413 .B BBacklightOff =
 414 same as above for backlight off.
 415 .P
 416 .B Bin_HX =
 417 .br
 418 .B Bin_HY =
 419 .RS
 420 hours bits start position (most significant bits first).
 421 .RE
 422 .P
 423 .B Bin_MX =
 424 .br
 425 .B Bin_MY =
 426 .RS
 427 minutes bits start position (most significant bits first).
 428 .RE
 429 .P
 430 .B Bin_SX =
 431 .br
 432 .B Bin_SY =
 433 .RS
 434 seconds bits start position (most significant bits first).
 435 .RE
 436 .P
 437 .B Bin_ZX =
 438 .br
 439 .B Bin_ZY =
 440 .RS
 441 size of time bits squares.
 442 .RE
 443 .P
 444 .B Bin_WX =
 445 .br
 446 .B Bin_WY =
 447 .RS
 448 week day bits start position (most significant bits first).
 449 .RE
 450 .P
 451 .B Bin_DX =
 452 .br
 453 .B Bin_DY =
 454 .RS
 455 month day bits start position (most significant bits first).
 456 .RE
 457 .P
 458 .B Bin_OX =
 459 .br
 460 .B Bin_OY =
 461 .RS
 462 month bits start position (most significant bits first).
 463 .RE
 464 .P
 465 .B Bin_IX =
 466 .br
 467 .B Bin_IY =
 468 .RS
 469 size of date bits squares.
 470 .B Specifying -1 for Bin_IX disable date displaying and other date specs are not needed.
 471 .RE
 472 .P
 473 .B Bin_D1X =
 474 .br
 475 .B Bin_D1Y =
 476 .RS
 477 space between 2 bits of the same number for the time.
 478 .RE
 479 .P
 480 .B Bin_D2X =
 481 .br
 482 .B Bin_D2Y =
 483 .RS
 484 space between 2 binary numbers of the same time part.
 485 .RE
 486 .P
 487 .B Bin_D3X =
 488 .br
 489 .B Bin_D3Y =
 490 .RS
 491 space between 2 bits of the same number for the date.
 492 .RE
 493 .P
 494 .B Bin_D4X =
 495 .br
 496 .B Bin_D4Y =
 497 .RS
 498 space between 2 binary numbers of the same date part.
 499 .RE
 500
 501
 502 .SH SEE ALSO
 503 wmclockmon-config(1), wmclockmon-cal(1)
 504
 505
 506 .SH AUTHOR
 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>.