1 |
=head1 NAME |
2 |
|
3 |
urclock (oUR CLOCK) -- clock and appointment reminder for X11 |
4 |
|
5 |
=head1 SYNOPSIS |
6 |
|
7 |
urclock [options] |
8 |
|
9 |
=head1 DESCRIPTION |
10 |
|
11 |
B<urclock> -- version B<@@RXVT_VERSION@@> -- is an analog clock |
12 |
for X intended as an I<xclock>(1) replacement that conserves memory and has |
13 |
extra features: B<urclock> enters reverse video if there is mail waiting; an |
14 |
appointment reminder is also builtin. |
15 |
|
16 |
=head2 OPTIONS |
17 |
|
18 |
The options supported by B<urclock>: |
19 |
|
20 |
=over |
21 |
|
22 |
=item B<-display> I<displayname> |
23 |
|
24 |
Attempt to open a window on the named X display. In the absence of this |
25 |
option, the display specified by the C<DISPLAY> environment variable is used. |
26 |
|
27 |
=item B<-geometry> I<geom> |
28 |
|
29 |
Create the window with the specified X window |
30 |
geometry [default C<80x80>]. |
31 |
|
32 |
=item B<-bg> I<color> |
33 |
|
34 |
Window background color [default C<white>]. |
35 |
|
36 |
=item B<-fg> I<color> |
37 |
|
38 |
Window foreground color [default C<black>]. |
39 |
|
40 |
=item B<-fn> I<fontname> |
41 |
|
42 |
Select font |
43 |
used for reminders [default C<7x14>]. |
44 |
|
45 |
=item B<-nodate> |
46 |
|
47 |
Do not display today's date on the face of the clock. |
48 |
|
49 |
=item B<-iconic> |
50 |
|
51 |
Start iconified, if supported by the window manager. |
52 |
|
53 |
=item B<-adjust> I<ddhhmm> |
54 |
|
55 |
Adjust the clock by +/- I<ddhhmm> (I<dd> = days, I<hh> = hours, I<mm> = |
56 |
minutes) to fix an incorrect clock without being root or for working in |
57 |
another time-zone. |
58 |
|
59 |
=item B<-update> I<n> |
60 |
|
61 |
Update clock face every I<n> seconds [default C<30>]. If I<n>=1, a seconds |
62 |
hand is displayed. |
63 |
|
64 |
=item B<-mail> I<n> |
65 |
|
66 |
Check for new mail every I<n> seconds [default C<60>]. The actual interval |
67 |
is a multiple of the clock update interval. |
68 |
|
69 |
=item B<-mailfile> I<mailfile> |
70 |
|
71 |
Override environmental variable C<MAIL> with I<mailfile> as location for |
72 |
mail. |
73 |
|
74 |
=item B<-mailspawn> I<cmd> |
75 |
|
76 |
Execute I<cmd> when the face of the clock is clicked by the mouse button. |
77 |
|
78 |
=item B<#>I<geom> |
79 |
|
80 |
Specify the preferred icon window size [default C<65x65>]. |
81 |
|
82 |
=back |
83 |
|
84 |
Some of these options may not be available based on how urclock was |
85 |
compiled. Run B<urclock -help> to determine which features are available. |
86 |
|
87 |
=head1 X RESOURCES |
88 |
|
89 |
No X resources are used -- only command-line options. |
90 |
|
91 |
=head1 TITLES AND ICONS |
92 |
|
93 |
The window and icon titles are set to the day of the week and the |
94 |
date. The date is also displayed on the lower half of the clock unless the |
95 |
B<-nodate> option is specified. The icon window is "active" and will show |
96 |
the time, if supported by the window manager. |
97 |
|
98 |
=head1 REMINDERS |
99 |
|
100 |
The B<~/.rclock> file (note: I<not> B<~/.urclock>) lists the messages |
101 |
to display and/or the programs to run at specified times and dates. At |
102 |
the specified time, B<urclock> will pop-up a window in the center of |
103 |
the screen to display the message or will simply run the scheduled |
104 |
program. B<urclock> will read the B<~/.rclock> file at startup, and every |
105 |
10 minutes (to look for changes) and after a message window has been |
106 |
dismissed (to find the next appointment). |
107 |
|
108 |
An entry in B<~/.rclock> may be one of two formats (blank and comment |
109 |
lines will be ignored): |
110 |
|
111 |
B<hh:mm [dd] MM/DD/YY message[; program]> |
112 |
|
113 |
or |
114 |
|
115 |
B<[hh:mm [dd] MM/DD/YY [message]]; program> |
116 |
|
117 |
B<hh> - hour (0-23; * = current) |
118 |
|
119 |
B<mm> - minute (0-59; * = 0) |
120 |
|
121 |
B<dd> - days-of-week (some/all/none of umtwrfs; * = all) |
122 |
|
123 |
B<MM> - month (1-12; * = current) |
124 |
|
125 |
B<DD> - day of month (1-31; * = current) |
126 |
|
127 |
B<YY> - year (0-99 or 1900-????; * = current) |
128 |
|
129 |
B<message> - message to display |
130 |
|
131 |
B<program> - program to execute |
132 |
|
133 |
The days-of-the-week use the following abbreviations: |
134 |
B<u>=Sunday, B<m>=Monday, B<t>=Tuesday, B<w>=Wednesday, B<r>=Thursday, B<f>=Friday, B<s>=Saturday, |
135 |
B<*>=all. |
136 |
|
137 |
If B<message> is empty and B<program> has been specified, it is executed |
138 |
without a dialog box. If time/date are also not specified, B<program> |
139 |
is executed on start-up. Note B<message> may contain escape values (\n: |
140 |
newline, \;: semicolon). |
141 |
|
142 |
Here's a silly example file that shows some of the permissible constructs: |
143 |
|
144 |
# ~/.rclock - My appointment file |
145 |
|
146 |
# startup functions |
147 |
; xsetroot -solid Black & |
148 |
|
149 |
# cron functions |
150 |
|
151 |
10:00; xsetroot -solid Grey25 & |
152 |
14:00; xsetroot -solid Grey75 & |
153 |
|
154 |
# daily/weekly reminders |
155 |
|
156 |
08:15 mtwrf * Good Morning!\\nRead News?; urxvt -e News |
157 |
12:00 mtwrf * Lunch Time! |
158 |
17:00 mtwrf * Go Home |
159 |
23:00 mtwrf * Still Here? Go to bed |
160 |
08:10 twrf * Did you do your time card yesterday? |
161 |
15:00 f * Friday, do your time card early! |
162 |
16:00 mtwr * Do your time card |
163 |
16:30 mtwrf * Did you do your time card? |
164 |
*:00 us * It's the weekend, why are you here? |
165 |
8:15 f */13/* Friday the 13th! Careful! |
166 |
8:15 * 4/1/* fkrkrmfismsmkd...dkdfk |
167 |
8:16 * 4/1/* April Fools! |
168 |
|
169 |
# birthdays/anniversaries |
170 |
|
171 |
16:00 05/21/* Pam's Birthday (next week) |
172 |
16:00 05/24/* Pam's Birthday (in a few days) |
173 |
|
174 |
# once-of appointments |
175 |
|
176 |
08:30 03/15/94 Dentist appointment |
177 |
08:30 03/15/1999 Dentist appointment |
178 |
08:30 03/15/2004 Dentist appointment |
179 |
|
180 |
=head1 ENVIRONMENT |
181 |
|
182 |
B<urclock> uses the environment variable B<MAIL> to determine the location |
183 |
of the user's mail spool file unless the B<-mailfile> option is specified. |
184 |
|
185 |
=head1 BUGS |
186 |
|
187 |
B<urclock> is not very smart about dealing with errors encountered while |
188 |
reading the B<~/.rclock> file. Each reminder must be a single line not |
189 |
exceeding 255 characters. Reminder windows are sometimes not redrawn (left |
190 |
blank) when raised or uncovered. |
191 |
|
192 |
=head1 HISTORY |
193 |
|
194 |
When "unicodifying" rxvt to urxvt-unicode, other programs than rxvt were |
195 |
dropped, as they would be identical to their rxvt counterparts, and |
196 |
therefore could still be installed independently by installing rxvt. |
197 |
|
198 |
Since distributions have started dropping rxvt (and thus rclock), the |
199 |
rclock program has been added to the rxvt-unicode package under the name |
200 |
urclock. It should be functionally identical to rxvt's rclock program, |
201 |
including using the same configuration file name. |
202 |
|
203 |
=head1 AUTHORS |
204 |
|
205 |
Rob Nation <nation@rocket.sanders.lockheed.com> |
206 |
|
207 |
Modifications by mj olesen <olesen@me.QueensU.CA> |
208 |
|
209 |
Modifications by Marc A. Lehmann <urclock@schmorp.de> |
210 |
|
211 |
Modifications by Emanuele Giaquinta <emanuele.giaquinta@gmail.com> |
212 |
|
213 |
Currently maintained as part of the rxvt-unicode package. |
214 |
|