| 1 |
.\" $Xorg: xclock.man,v 1.4 2001/02/09 02:05:39 xorgcvs Exp $ |
| 2 |
.\" Copyright 1988, 1994, 1998 The Open Group |
| 3 |
.\" |
| 4 |
.\" Permission to use, copy, modify, distribute, and sell this software and its |
| 5 |
.\" documentation for any purpose is hereby granted without fee, provided that |
| 6 |
.\" the above copyright notice appear in all copies and that both that |
| 7 |
.\" copyright notice and this permission notice appear in supporting |
| 8 |
.\" documentation. |
| 9 |
.\" |
| 10 |
.\" The above copyright notice and this permission notice shall be included |
| 11 |
.\" in all copies or substantial portions of the Software. |
| 12 |
.\" |
| 13 |
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS |
| 14 |
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
| 15 |
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
| 16 |
.\" IN NO EVENT SHALL THE OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR |
| 17 |
.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, |
| 18 |
.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR |
| 19 |
.\" OTHER DEALINGS IN THE SOFTWARE. |
| 20 |
.\" |
| 21 |
.\" Except as contained in this notice, the name of The Open Group shall |
| 22 |
.\" not be used in advertising or otherwise to promote the sale, use or |
| 23 |
.\" other dealings in this Software without prior written authorization |
| 24 |
.\" from The Open Group. |
| 25 |
.\" |
| 26 |
.\" $XFree86: xc/programs/xclock/xclock.man,v 1.15 2003/07/04 16:24:30 eich Exp $ |
| 27 |
.\" |
| 28 |
.TH XCLOCK 1 "xclock 1.1.1" "X Version 11" |
| 29 |
.SH NAME |
| 30 |
xclock \- analog / digital clock for X |
| 31 |
.SH SYNOPSIS |
| 32 |
\fBxclock\fP [ \fB\-help\fP ] [ \fB\-analog\fP | \fB\-digital\fP ] |
| 33 |
[ \fB\-brief\fP ] [ \fB\-chime\fP ] [ \fB\-hd\fP \fIcolor\fP ] |
| 34 |
[ \fB\-hl\fP \fIcolor\fP ] [ \fB\-update\fP \fIseconds\fP ] |
| 35 |
[ \fB\-strftime\fP \fIformat\fP ] |
| 36 |
[ \fB\-twelve\fP | \fB-twentyfour\fP | \fB-utime\fP ] |
| 37 |
[ \fB\-padding\fP \fInumber\fP ] |
| 38 |
[ \fB\-norender\fP ] |
| 39 |
[ \fB\-render\fP ] |
| 40 |
[ \fB\-sharp\fP ] |
| 41 |
[ \fB\-face\fP \fIpattern\fP ] |
| 42 |
.SH DESCRIPTION |
| 43 |
The |
| 44 |
.I xclock |
| 45 |
program displays the time in analog or digital form. The time is continuously |
| 46 |
updated at a frequency which may be specified by the user. |
| 47 |
.SH OPTIONS |
| 48 |
.I Xclock |
| 49 |
accepts all of the standard X Toolkit command line options along with the |
| 50 |
additional options listed below: |
| 51 |
.TP 8 |
| 52 |
.B \-help |
| 53 |
This option indicates that a brief summary of the allowed options should be |
| 54 |
printed on the standard error. |
| 55 |
.TP 8 |
| 56 |
.B \-analog |
| 57 |
This option indicates that a conventional 12 hour clock face with tick marks |
| 58 |
and hands should be used. This is the default. |
| 59 |
.TP 8 |
| 60 |
\fB\-digital\fP or \fB\-d\fP |
| 61 |
This option indicates that a 24 hour digital clock should be used. |
| 62 |
.TP 8 |
| 63 |
\fB\-brief\fP |
| 64 |
This option indicates that the digital clock should only display the hours |
| 65 |
and minutes fields. The default is to show the full time and date information. |
| 66 |
.TP 8 |
| 67 |
\fB\-utime\fP |
| 68 |
This option indicates that a digital clock should display seconds since |
| 69 |
the Epoch (in format '970012340 seconds since Epoch' instead of a standard |
| 70 |
24-hour time. |
| 71 |
.TP 8 |
| 72 |
.B \-strftime \fIformat\fP |
| 73 |
This option allows an strftime(3) format string to be specified |
| 74 |
for the digital clock's display. |
| 75 |
.TP 8 |
| 76 |
.B \-twelve |
| 77 |
This option indicates that a digital clock should display the time in |
| 78 |
twelve hour format. |
| 79 |
This is only effective for the brief display. |
| 80 |
.TP 8 |
| 81 |
.B \-twentyfour |
| 82 |
This option indicates that a digital clock should display the time in |
| 83 |
twenty-four hour format. |
| 84 |
This is only effective for the brief display. |
| 85 |
This is the default when a digital clock is used. |
| 86 |
.TP 8 |
| 87 |
.B \-chime |
| 88 |
This option indicates that the clock should chime |
| 89 |
once on the half hour and twice on the hour. |
| 90 |
.TP 8 |
| 91 |
\fB\-hands\fP \fIcolor\fP (or \fB\-hd\fP \fIcolor\fP) |
| 92 |
This option specifies the color of the hands on an analog clock. The default |
| 93 |
is \fIblack\fP. |
| 94 |
This option is effectively ignored when Xrender is in use. |
| 95 |
.TP 8 |
| 96 |
\fB\-highlight\fP \fIcolor\fP (or \fB\-hl\fP \fIcolor\fP) |
| 97 |
This option specifies the color of the edges of the hands on an analog clock, |
| 98 |
and is only useful on color displays. The default is \fIblack\fP. |
| 99 |
This option is effectively ignored when Xrender is in use. |
| 100 |
.TP 8 |
| 101 |
.B \-update \fIseconds\fP |
| 102 |
This option specifies the frequency in seconds at which \fIxclock\fP |
| 103 |
should update its display. If the clock is obscured and then exposed, |
| 104 |
it will be updated immediately. A value of 30 seconds or less will enable a |
| 105 |
second hand on an analog clock. The default is 60 seconds. |
| 106 |
.TP 8 |
| 107 |
.B \-padding \fInumber\fP |
| 108 |
This option specifies the width in pixels of the padding |
| 109 |
between the window border and clock text or picture. The default is 10 |
| 110 |
on a digital clock and 8 on an analog clock. |
| 111 |
.TP 8 |
| 112 |
.B \-render |
| 113 |
This option tells \fIxclock\fP to use the Xrender extension to draw an |
| 114 |
anti-aliased face. This is the default if \fIxclock\fP has been |
| 115 |
compiled with Xrender support. |
| 116 |
Note that the color selection options and resources used when Xrender is |
| 117 |
in effect differ from the standard options. |
| 118 |
.TP 8 |
| 119 |
.B \-norender |
| 120 |
This option turns off the use of Xrender to draw the clock. |
| 121 |
.TP 8 |
| 122 |
.B \-sharp |
| 123 |
This option tells \fIxclock\fP to use sharper edges when drawn using |
| 124 |
the Xrender extension. |
| 125 |
.TP 8 |
| 126 |
.B \-face \fIpattern\fP |
| 127 |
This option specifies the font to use in digital mode when the |
| 128 |
Xrender extension is used. Patterns are specified using the |
| 129 |
fontconfig face format described in the |
| 130 |
.I Font Names |
| 131 |
section of |
| 132 |
.IR fonts.conf (5). |
| 133 |
.SH X DEFAULTS |
| 134 |
This program uses the |
| 135 |
.I Clock |
| 136 |
widget. It understands all of the core resource names and classes as well as: |
| 137 |
.PP |
| 138 |
.TP 8 |
| 139 |
.B width (\fPclass\fB Width) |
| 140 |
Specifies the width of the clock. The default for analog clocks is 164 |
| 141 |
pixels; the default for digital clocks is whatever is needed to hold the |
| 142 |
clock when displayed in the chosen font. |
| 143 |
.TP 8 |
| 144 |
.B height (\fPclass\fB Height) |
| 145 |
Specifies the height of the clock. The default for analog clocks is 164 |
| 146 |
pixels; the default for digital clocks is whatever is needed to hold the |
| 147 |
clock when displayed in the chosen font. |
| 148 |
.TP 8 |
| 149 |
.B update (\fPclass\fB Interval) |
| 150 |
Specifies the frequency in seconds at which the time should be redisplayed. |
| 151 |
.TP 8 |
| 152 |
.B foreground (\fPclass\fB Foreground) |
| 153 |
Specifies the color for the tick marks. The default depends on whether |
| 154 |
\fIreverseVideo\fP is specified. If \fIreverseVideo\fP is specified |
| 155 |
the default is \fIlwhite\fP, otherwise the default is \fIblack\fP. |
| 156 |
|
| 157 |
.TP 8 |
| 158 |
.B hands (\fPclass\fB Foreground) |
| 159 |
Specifies the color of the insides of the clock's hands. The default |
| 160 |
depends on whether |
| 161 |
\fIreverseVideo\fP is specified. If \fIreverseVideo\fP is specified |
| 162 |
the default is \fIlwhite\fP, otherwise the default is \fIblack\fP. |
| 163 |
Note that this resource is not used when Xrender is in effect. |
| 164 |
.TP 8 |
| 165 |
.B highlight (\fPclass\fB Foreground) |
| 166 |
Specifies the color used to highlight the clock's hands. The default is |
| 167 |
depends on whether |
| 168 |
\fIreverseVideo\fP is specified. If \fIreverseVideo\fP is specified |
| 169 |
the default is \fIlwhite\fP, otherwise the default is \fIblack\fP. |
| 170 |
Note that this resource is not used when Xrender is in effect. |
| 171 |
.TP 8 |
| 172 |
.B analog (\fPclass\fB Boolean) |
| 173 |
Specifies whether or not an analog clock should be used instead of a digital |
| 174 |
one. The default is True. |
| 175 |
.TP 8 |
| 176 |
.B twentyfour (\fPclass\fB Boolean) |
| 177 |
Specifies whether or not a digital clock should display the time in |
| 178 |
twenty-four hour format. The default is True. |
| 179 |
.TP 8 |
| 180 |
.B chime (\fPclass\fB Boolean) |
| 181 |
Specifies whether or not a bell should be rung on the hour and half hour. |
| 182 |
.TP 8 |
| 183 |
.B padding (\fPclass\fB Margin) |
| 184 |
Specifies the amount of internal padding in pixels to be used. The default is |
| 185 |
8. |
| 186 |
.TP 8 |
| 187 |
.B font (\fPclass\fB Font) |
| 188 |
Specifies the font to be used for the digital clock. Note that variable width |
| 189 |
fonts currently will not always display correctly. |
| 190 |
This font is only used when Xrender is not in effect. |
| 191 |
.TP 8 |
| 192 |
.B render (\fPclass\fB Boolean) |
| 193 |
Specifies whether or not the Xrender extension should be used for the |
| 194 |
display. The default is True if \fIxclock\fP has been compiled with |
| 195 |
Xrender support. |
| 196 |
.PP |
| 197 |
When Xrender is in effect, the following additional resources are |
| 198 |
understood: |
| 199 |
.PP |
| 200 |
.TP 8 |
| 201 |
.B face (\fPclass\fB FaceName) |
| 202 |
Specify the pattern for the font to be used for the digital clock when |
| 203 |
Xrender is used. Patterns are specified using the fontconfig face format |
| 204 |
described in the |
| 205 |
.I Font Names |
| 206 |
section of |
| 207 |
.IR fonts.conf (5). |
| 208 |
.TP 8 |
| 209 |
.B sharp (\fPclass\fB Boolean) |
| 210 |
Specifies if sharp edges should be used when rendering the clock. |
| 211 |
The default is False. |
| 212 |
.TP 8 |
| 213 |
.B buffer (\fPclass\fB Boolean) |
| 214 |
Specifies that the updates of the image are drawn to a pixmap before copied |
| 215 |
into the window instead drawing them into the window directly. |
| 216 |
.PP |
| 217 |
The defaults of the following color resources depend on whether |
| 218 |
\fIreverseVideo\fP is specified. |
| 219 |
If \fIreverseVideo\fP is specified the default is \fIlwhite\fP, |
| 220 |
otherwise the default is \fIblack\fP. |
| 221 |
.TP 8 |
| 222 |
.B hourColor (\fPclass\fB Foreground) |
| 223 |
The color of the hour hand. |
| 224 |
.TP 8 |
| 225 |
.B minuteColor (\fPclass\fB Foreground) |
| 226 |
The color of the minute hand. |
| 227 |
.TP 8 |
| 228 |
.B secondColor (\fPclass\fB Foreground) |
| 229 |
The color of the second hand. |
| 230 |
.TP 8 |
| 231 |
.B majorColor (\fPclass\fB Foreground) |
| 232 |
The color of the major scale ticks (i. e. each five minutes). |
| 233 |
.TP 8 |
| 234 |
.B minorColor (\fPclass\fB Foreground) |
| 235 |
The color of the minor scale ticks (between major ticks). |
| 236 |
.SH WIDGETS |
| 237 |
In order to specify resources, it is useful to know the hierarchy of |
| 238 |
the widgets which compose \fIxclock\fR. In the notation below, |
| 239 |
indentation indicates hierarchical structure. The widget class name |
| 240 |
is given first, followed by the widget instance name. |
| 241 |
.sp |
| 242 |
.ft CW |
| 243 |
.nf |
| 244 |
XClock xclock |
| 245 |
Clock clock |
| 246 |
.fi |
| 247 |
.ft |
| 248 |
.sp |
| 249 |
.SH ENVIRONMENT |
| 250 |
.PP |
| 251 |
.TP 8 |
| 252 |
.B DISPLAY |
| 253 |
to get the default host and display number. |
| 254 |
.TP 8 |
| 255 |
.B XENVIRONMENT |
| 256 |
to get the name of a resource file that overrides the global resources |
| 257 |
stored in the RESOURCE_MANAGER property. |
| 258 |
.SH FILES |
| 259 |
.TP |
| 260 |
.I /etc/X11/app-defaults/XClock |
| 261 |
specifies required resources |
| 262 |
.SH "SEE ALSO" |
| 263 |
X(7), xrdb(1), time(3), fonts.conf (5). |
| 264 |
.SH BUGS |
| 265 |
.I Xclock |
| 266 |
believes the system clock. |
| 267 |
.PP |
| 268 |
When in digital mode, the string should be centered automatically. |
| 269 |
.SH AUTHORS |
| 270 |
Tony Della Fera (MIT-Athena, DEC) |
| 271 |
.br |
| 272 |
Dave Mankins (MIT-Athena, BBN) |
| 273 |
.br |
| 274 |
Ed Moy (UC Berkeley) |
| 275 |
|