| 1 |
.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) |
| 2 |
.\" |
| 3 |
.\" Standard preamble: |
| 4 |
.\" ======================================================================== |
| 5 |
.de Sp \" Vertical space (when we can't use .PP) |
| 6 |
.if t .sp .5v |
| 7 |
.if n .sp |
| 8 |
.. |
| 9 |
.de Vb \" Begin verbatim text |
| 10 |
.ft CW |
| 11 |
.nf |
| 12 |
.ne \\$1 |
| 13 |
.. |
| 14 |
.de Ve \" End verbatim text |
| 15 |
.ft R |
| 16 |
.fi |
| 17 |
.. |
| 18 |
.\" Set up some character translations and predefined strings. \*(-- will |
| 19 |
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left |
| 20 |
.\" double quote, and \*(R" will give a right double quote. \*(C+ will |
| 21 |
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and |
| 22 |
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, |
| 23 |
.\" nothing in troff, for use with C<>. |
| 24 |
.tr \(*W- |
| 25 |
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
| 26 |
.ie n \{\ |
| 27 |
. ds -- \(*W- |
| 28 |
. ds PI pi |
| 29 |
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
| 30 |
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch |
| 31 |
. ds L" "" |
| 32 |
. ds R" "" |
| 33 |
. ds C` "" |
| 34 |
. ds C' "" |
| 35 |
'br\} |
| 36 |
.el\{\ |
| 37 |
. ds -- \|\(em\| |
| 38 |
. ds PI \(*p |
| 39 |
. ds L" `` |
| 40 |
. ds R" '' |
| 41 |
. ds C` |
| 42 |
. ds C' |
| 43 |
'br\} |
| 44 |
.\" |
| 45 |
.\" Escape single quotes in literal strings from groff's Unicode transform. |
| 46 |
.ie \n(.g .ds Aq \(aq |
| 47 |
.el .ds Aq ' |
| 48 |
.\" |
| 49 |
.\" If the F register is >0, we'll generate index entries on stderr for |
| 50 |
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 51 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 52 |
.\" output yourself in some meaningful fashion. |
| 53 |
.\" |
| 54 |
.\" Avoid warning from groff about undefined register 'F'. |
| 55 |
.de IX |
| 56 |
.. |
| 57 |
.nr rF 0 |
| 58 |
.if \n(.g .if rF .nr rF 1 |
| 59 |
.if (\n(rF:(\n(.g==0)) \{\ |
| 60 |
. if \nF \{\ |
| 61 |
. de IX |
| 62 |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 63 |
.. |
| 64 |
. if !\nF==2 \{\ |
| 65 |
. nr % 0 |
| 66 |
. nr F 2 |
| 67 |
. \} |
| 68 |
. \} |
| 69 |
.\} |
| 70 |
.rr rF |
| 71 |
.\" |
| 72 |
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
| 73 |
.\" Fear. Run. Save yourself. No user-serviceable parts. |
| 74 |
. \" fudge factors for nroff and troff |
| 75 |
.if n \{\ |
| 76 |
. ds #H 0 |
| 77 |
. ds #V .8m |
| 78 |
. ds #F .3m |
| 79 |
. ds #[ \f1 |
| 80 |
. ds #] \fP |
| 81 |
.\} |
| 82 |
.if t \{\ |
| 83 |
. ds #H ((1u-(\\\\n(.fu%2u))*.13m) |
| 84 |
. ds #V .6m |
| 85 |
. ds #F 0 |
| 86 |
. ds #[ \& |
| 87 |
. ds #] \& |
| 88 |
.\} |
| 89 |
. \" simple accents for nroff and troff |
| 90 |
.if n \{\ |
| 91 |
. ds ' \& |
| 92 |
. ds ` \& |
| 93 |
. ds ^ \& |
| 94 |
. ds , \& |
| 95 |
. ds ~ ~ |
| 96 |
. ds / |
| 97 |
.\} |
| 98 |
.if t \{\ |
| 99 |
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" |
| 100 |
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' |
| 101 |
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' |
| 102 |
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' |
| 103 |
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' |
| 104 |
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' |
| 105 |
.\} |
| 106 |
. \" troff and (daisy-wheel) nroff accents |
| 107 |
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' |
| 108 |
.ds 8 \h'\*(#H'\(*b\h'-\*(#H' |
| 109 |
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] |
| 110 |
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' |
| 111 |
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' |
| 112 |
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] |
| 113 |
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] |
| 114 |
.ds ae a\h'-(\w'a'u*4/10)'e |
| 115 |
.ds Ae A\h'-(\w'A'u*4/10)'E |
| 116 |
. \" corrections for vroff |
| 117 |
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' |
| 118 |
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' |
| 119 |
. \" for low resolution devices (crt and lpr) |
| 120 |
.if \n(.H>23 .if \n(.V>19 \ |
| 121 |
\{\ |
| 122 |
. ds : e |
| 123 |
. ds 8 ss |
| 124 |
. ds o a |
| 125 |
. ds d- d\h'-1'\(ga |
| 126 |
. ds D- D\h'-1'\(hy |
| 127 |
. ds th \o'bp' |
| 128 |
. ds Th \o'LP' |
| 129 |
. ds ae ae |
| 130 |
. ds Ae AE |
| 131 |
.\} |
| 132 |
.rm #[ #] #H #V #F C |
| 133 |
.\" ======================================================================== |
| 134 |
.\" |
| 135 |
.IX Title "@@RXVT_NAME@@ 1" |
| 136 |
.TH @@RXVT_NAME@@ 1 "2023-01-02" "@@RXVT_VERSION@@" "RXVT-UNICODE" |
| 137 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 138 |
.\" way too many mistakes in technical documents. |
| 139 |
.if n .ad l |
| 140 |
.nh |
| 141 |
.SH "NAME" |
| 142 |
urclock (oUR CLOCK) \-\- clock and appointment reminder for X11 |
| 143 |
.SH "SYNOPSIS" |
| 144 |
.IX Header "SYNOPSIS" |
| 145 |
.Vb 1 |
| 146 |
\& urclock [options] |
| 147 |
.Ve |
| 148 |
.SH "DESCRIPTION" |
| 149 |
.IX Header "DESCRIPTION" |
| 150 |
\&\fBurclock\fR \*(-- version \fB@@RXVT_VERSION@@\fR \*(-- is an analog clock |
| 151 |
for X intended as an \fIxclock\fR(1) replacement that conserves memory and has |
| 152 |
extra features: \fBurclock\fR enters reverse video if there is mail waiting; an |
| 153 |
appointment reminder is also builtin. |
| 154 |
.SS "\s-1OPTIONS\s0" |
| 155 |
.IX Subsection "OPTIONS" |
| 156 |
The options supported by \fBurclock\fR: |
| 157 |
.IP "\fB\-display\fR \fIdisplayname\fR" 4 |
| 158 |
.IX Item "-display displayname" |
| 159 |
Attempt to open a window on the named X display. In the absence of this |
| 160 |
option, the display specified by the \f(CW\*(C`DISPLAY\*(C'\fR environment variable is used. |
| 161 |
.IP "\fB\-geometry\fR \fIgeom\fR" 4 |
| 162 |
.IX Item "-geometry geom" |
| 163 |
Create the window with the specified X window |
| 164 |
geometry [default \f(CW\*(C`80x80\*(C'\fR]. |
| 165 |
.IP "\fB\-bg\fR \fIcolor\fR" 4 |
| 166 |
.IX Item "-bg color" |
| 167 |
Window background color [default \f(CW\*(C`white\*(C'\fR]. |
| 168 |
.IP "\fB\-fg\fR \fIcolor\fR" 4 |
| 169 |
.IX Item "-fg color" |
| 170 |
Window foreground color [default \f(CW\*(C`black\*(C'\fR]. |
| 171 |
.IP "\fB\-fn\fR \fIfontname\fR" 4 |
| 172 |
.IX Item "-fn fontname" |
| 173 |
Select font |
| 174 |
used for reminders [default \f(CW\*(C`7x14\*(C'\fR]. |
| 175 |
.IP "\fB\-nodate\fR" 4 |
| 176 |
.IX Item "-nodate" |
| 177 |
Do not display today's date on the face of the clock. |
| 178 |
.IP "\fB\-iconic\fR" 4 |
| 179 |
.IX Item "-iconic" |
| 180 |
Start iconified, if supported by the window manager. |
| 181 |
.IP "\fB\-adjust\fR \fIddhhmm\fR" 4 |
| 182 |
.IX Item "-adjust ddhhmm" |
| 183 |
Adjust the clock by +/\- \fIddhhmm\fR (\fIdd\fR = days, \fIhh\fR = hours, \fImm\fR = |
| 184 |
minutes) to fix an incorrect clock without being root or for working in |
| 185 |
another time-zone. |
| 186 |
.IP "\fB\-update\fR \fIn\fR" 4 |
| 187 |
.IX Item "-update n" |
| 188 |
Update clock face every \fIn\fR seconds [default \f(CW30\fR]. If \fIn\fR=1, a seconds |
| 189 |
hand is displayed. |
| 190 |
.IP "\fB\-mail\fR \fIn\fR" 4 |
| 191 |
.IX Item "-mail n" |
| 192 |
Check for new mail every \fIn\fR seconds [default \f(CW60\fR]. The actual interval |
| 193 |
is a multiple of the clock update interval. |
| 194 |
.IP "\fB\-mailfile\fR \fImailfile\fR" 4 |
| 195 |
.IX Item "-mailfile mailfile" |
| 196 |
Override environmental variable \f(CW\*(C`MAIL\*(C'\fR with \fImailfile\fR as location for |
| 197 |
mail. |
| 198 |
.IP "\fB\-mailspawn\fR \fIcmd\fR" 4 |
| 199 |
.IX Item "-mailspawn cmd" |
| 200 |
Execute \fIcmd\fR when the face of the clock is clicked by the mouse button. |
| 201 |
.IP "\fB#\fR\fIgeom\fR" 4 |
| 202 |
.IX Item "#geom" |
| 203 |
Specify the preferred icon window size [default \f(CW\*(C`65x65\*(C'\fR]. |
| 204 |
.PP |
| 205 |
Some of these options may not be available based on how urclock was |
| 206 |
compiled. Run \fBurclock \-help\fR to determine which features are available. |
| 207 |
.SH "X RESOURCES" |
| 208 |
.IX Header "X RESOURCES" |
| 209 |
No X resources are used \*(-- only command-line options. |
| 210 |
.SH "TITLES AND ICONS" |
| 211 |
.IX Header "TITLES AND ICONS" |
| 212 |
The window and icon titles are set to the day of the week and the |
| 213 |
date. The date is also displayed on the lower half of the clock unless the |
| 214 |
\&\fB\-nodate\fR option is specified. The icon window is \*(L"active\*(R" and will show |
| 215 |
the time, if supported by the window manager. |
| 216 |
.SH "REMINDERS" |
| 217 |
.IX Header "REMINDERS" |
| 218 |
The \fB~/.rclock\fR file (note: \fInot\fR \fB~/.urclock\fR) lists the messages |
| 219 |
to display and/or the programs to run at specified times and dates. At |
| 220 |
the specified time, \fBurclock\fR will pop-up a window in the center of |
| 221 |
the screen to display the message or will simply run the scheduled |
| 222 |
program. \fBurclock\fR will read the \fB~/.rclock\fR file at startup, and every |
| 223 |
10 minutes (to look for changes) and after a message window has been |
| 224 |
dismissed (to find the next appointment). |
| 225 |
.PP |
| 226 |
An entry in \fB~/.rclock\fR may be one of two formats (blank and comment |
| 227 |
lines will be ignored): |
| 228 |
.PP |
| 229 |
\&\fBhh:mm [dd] \s-1MM/DD/YY\s0 message[; program]\fR |
| 230 |
.PP |
| 231 |
or |
| 232 |
.PP |
| 233 |
\&\fB[hh:mm [dd] \s-1MM/DD/YY\s0 [message]]; program\fR |
| 234 |
.PP |
| 235 |
\&\fBhh\fR \- hour (0\-23; * = current) |
| 236 |
.PP |
| 237 |
\&\fBmm\fR \- minute (0\-59; * = 0) |
| 238 |
.PP |
| 239 |
\&\fBdd\fR \- days-of-week (some/all/none of umtwrfs; * = all) |
| 240 |
.PP |
| 241 |
\&\fB\s-1MM\s0\fR \- month (1\-12; * = current) |
| 242 |
.PP |
| 243 |
\&\fB\s-1DD\s0\fR \- day of month (1\-31; * = current) |
| 244 |
.PP |
| 245 |
\&\fB\s-1YY\s0\fR \- year (0\-99 or 1900\-????; * = current) |
| 246 |
.PP |
| 247 |
\&\fBmessage\fR \- message to display |
| 248 |
.PP |
| 249 |
\&\fBprogram\fR \- program to execute |
| 250 |
.PP |
| 251 |
The days-of-the-week use the following abbreviations: |
| 252 |
\&\fBu\fR=Sunday, \fBm\fR=Monday, \fBt\fR=Tuesday, \fBw\fR=Wednesday, \fBr\fR=Thursday, \fBf\fR=Friday, \fBs\fR=Saturday, |
| 253 |
\&\fB*\fR=all. |
| 254 |
.PP |
| 255 |
If \fBmessage\fR is empty and \fBprogram\fR has been specified, it is executed |
| 256 |
without a dialog box. If time/date are also not specified, \fBprogram\fR |
| 257 |
is executed on start-up. Note \fBmessage\fR may contain escape values (\en: |
| 258 |
newline, \e;: semicolon). |
| 259 |
.PP |
| 260 |
Here's a silly example file that shows some of the permissible constructs: |
| 261 |
.PP |
| 262 |
.Vb 1 |
| 263 |
\& # ~/.rclock \- My appointment file |
| 264 |
\& |
| 265 |
\& # startup functions |
| 266 |
\& ; xsetroot \-solid Black & |
| 267 |
\& |
| 268 |
\& # cron functions |
| 269 |
\& |
| 270 |
\& 10:00; xsetroot \-solid Grey25 & |
| 271 |
\& 14:00; xsetroot \-solid Grey75 & |
| 272 |
\& |
| 273 |
\& # daily/weekly reminders |
| 274 |
\& |
| 275 |
\& 08:15 mtwrf * Good Morning!\e\enRead News?; urxvt \-e News |
| 276 |
\& 12:00 mtwrf * Lunch Time! |
| 277 |
\& 17:00 mtwrf * Go Home |
| 278 |
\& 23:00 mtwrf * Still Here? Go to bed |
| 279 |
\& 08:10 twrf * Did you do your time card yesterday? |
| 280 |
\& 15:00 f * Friday, do your time card early! |
| 281 |
\& 16:00 mtwr * Do your time card |
| 282 |
\& 16:30 mtwrf * Did you do your time card? |
| 283 |
\& *:00 us * It\*(Aqs the weekend, why are you here? |
| 284 |
\& 8:15 f */13/* Friday the 13th! Careful! |
| 285 |
\& 8:15 * 4/1/* fkrkrmfismsmkd...dkdfk |
| 286 |
\& 8:16 * 4/1/* April Fools! |
| 287 |
\& |
| 288 |
\& # birthdays/anniversaries |
| 289 |
\& |
| 290 |
\& 16:00 05/21/* Pam\*(Aqs Birthday (next week) |
| 291 |
\& 16:00 05/24/* Pam\*(Aqs Birthday (in a few days) |
| 292 |
\& |
| 293 |
\& # once\-of appointments |
| 294 |
\& |
| 295 |
\& 08:30 03/15/94 Dentist appointment |
| 296 |
\& 08:30 03/15/1999 Dentist appointment |
| 297 |
\& 08:30 03/15/2004 Dentist appointment |
| 298 |
.Ve |
| 299 |
.SH "ENVIRONMENT" |
| 300 |
.IX Header "ENVIRONMENT" |
| 301 |
\&\fBurclock\fR uses the environment variable \fB\s-1MAIL\s0\fR to determine the location |
| 302 |
of the user's mail spool file unless the \fB\-mailfile\fR option is specified. |
| 303 |
.SH "BUGS" |
| 304 |
.IX Header "BUGS" |
| 305 |
\&\fBurclock\fR is not very smart about dealing with errors encountered while |
| 306 |
reading the \fB~/.rclock\fR file. Each reminder must be a single line not |
| 307 |
exceeding 255 characters. Reminder windows are sometimes not redrawn (left |
| 308 |
blank) when raised or uncovered. |
| 309 |
.SH "HISTORY" |
| 310 |
.IX Header "HISTORY" |
| 311 |
When \*(L"unicodifying\*(R" rxvt to urxvt-unicode, other programs than rxvt were |
| 312 |
dropped, as they would be identical to their rxvt counterparts, and |
| 313 |
therefore could still be installed independently by installing rxvt. |
| 314 |
.PP |
| 315 |
Since distributions have started dropping rxvt (and thus rclock), the |
| 316 |
rclock program has been added to the rxvt-unicode package under the name |
| 317 |
urclock. It should be functionally identical to rxvt's rclock program, |
| 318 |
including using the same configuration file name. |
| 319 |
.SH "AUTHORS" |
| 320 |
.IX Header "AUTHORS" |
| 321 |
Rob Nation <nation@rocket.sanders.lockheed.com> |
| 322 |
.PP |
| 323 |
Modifications by mj olesen <olesen@me.QueensU.CA> |
| 324 |
.PP |
| 325 |
Modifications by Marc A. Lehmann <urclock@schmorp.de> |
| 326 |
.PP |
| 327 |
Modifications by Emanuele Giaquinta <emanuele.giaquinta@gmail.com> |
| 328 |
.PP |
| 329 |
Currently maintained as part of the rxvt-unicode package. |
