wmclockmon: rename `DFLAGS` `debug_CFLAGS`
[dockapps.git] / wmclockmon / doc / wmclockmon-cal.1
blob45aeb2b6c04f51793b0a69c33a5f5137e88b6310
1 .TH WMCLOCKMON\-CAL "1" "February 2004" "wmclockmon-cal " "User Commands"
4 .SH NAME
5 wmclockmon\-cal \- A calendar to use with wmclockmon
8 .SH SYNOPSIS
9 .B wmclockmon\-cal [\-h] [\-v]
12 .SH DESCRIPTION
13 This manual page documents briefly the
14 .B wmclockmon\-cal
15 command.
16 .PP
17 .\" TeX users may be more comfortable with the \fB<whatever>\fP and
18 .\" \fI<whatever>\fP escape sequences to invode bold face and italics, 
19 .\" respectively.
20 \fBwmclockmon\-cal\fP is a program that displays a calendar and TODO list
21 with wmclockmon.
22 .PP
23 A calendar/TODO list can contain special lines that will be taken as alarms
24 for \fBwmclockmon\fP. An alarm line MUST begin with an @, then contain the time
25 (hours and minutes un 24h format) and, at least, the message, such as :
26 .TP
27 @ 09:20 Prepare for RDV hairdresser at 9:30...
30 .SH OPTIONS
31 This program follows the usual GNU command line syntax, with long options
32 starting with two dashes (`\-'). A summary of options is included below.
33 .TP
34 .B \-h,  \-\-help
35 show help text and exit.
36 .TP
37 .B \-v,  \-\-version
38 show program version and exit.
41 .SH FILE
42 .B wmclockmon\-cal
43 uses files in ~/.wmclockmoncal/. Each file contain a day's TODO list. Calendar
44 files are all in form of yyyy-mm-dd. Yearly files are in form of XXXX-mm-dd
45 and monthly files are in form of XXXX-XX-dd. There are currently no weekly
46 files since weekly alarms are in wmclockmon's configuration file.
49 .SH SEE ALSO
50 wmclockmon(1), wmclockmon-config(1)
53 .SH AUTHOR
54 WMClockMon\-cal was written by Thomas Nemeth <tnemeth@free.fr>.