Return to xclock.man CVS log

Up to [Research Unix] / researchv9 / X11 / src / X.V11R1 / clients / xclock

Annotation of researchv9/X11/src/X.V11R1/clients/xclock/xclock.man, revision 1.1

1.1     ! root        1: .TH XCLOCK 1 "4 June 1986" "X Version 10"
        !             2: .SH NAME
        !             3: xclock - X Window System, analog / digital clock
        !             4: .SH SYNOPSIS
        !             5: .B xclock
        !             6: [ option ] ...
        !             7: .SH DESCRIPTION
        !             8: .I Xclock 
        !             9: is the
        !            10: .I X
        !            11: window system clock.
        !            12: .I Xclock
        !            13: Continuously  displays  the  current  time of day.  The user is given a
        !            14: choice of either an analog or a digital display (of  course  there  is
        !            15: nothing  precluding  the  user  from  having more than one clock).  It
        !            16: creates a window and displays the time in the chosen format.
        !            17: .SH ARGUMENTS
        !            18: .PP
        !            19: .TP 10
        !            20: .B \-analog 
        !            21: Use analog display mode.  Draw a conventional 12 hour clock face with ``ticks''
        !            22: for each minute and stroke marks on each hour.  The default is digital mode.
        !            23: .PP
        !            24: .TP 10
        !            25: .B \-bg \fIcolor\fP
        !            26: Determines the color of the background.
        !            27: The default color is ``white''.
        !            28: On monochrome displays this is ignored.
        !            29: .PP
        !            30: .TP 10
        !            31: .B \-bd \fIcolor\fP
        !            32: Determines the color of the border.
        !            33: The defaults color is ``black''.
        !            34: On monochrome displays this is ignored.
        !            35: .PP
        !            36: .TP 10
        !            37: .B \-bw \fIpixels\fP
        !            38: Specify the width in pixels of the border around the
        !            39: .I xclock
        !            40: window.
        !            41: .PP
        !            42: .TP 10
        !            43: .B \-digital
        !            44: Use  digital  display  mode  (default).   Display the date and time in
        !            45: digital format.
        !            46: .PP
        !            47: .TP 10
        !            48: .B \-fg \fIcolor\fP
        !            49: Determines the color of the text in digital mode and the
        !            50: tick marks in analog mode.
        !            51: The default color is ``black''.
        !            52: On monochrome displays this is ignored.
        !            53: .PP
        !            54: .TP 10
        !            55: .B \-hd \fIcolor\fP
        !            56: Determines the color of the hands of the clock.
        !            57: This is ignored on monchrome displays.
        !            58: .PP
        !            59: .TP 10
        !            60: .B \-fn \fIfont\fP
        !            61: The specified
        !            62: .I font
        !            63: will be used as the output font in digital mode.
        !            64: Any fixed width font may be used, the default is ``6x10''.
        !            65: .PP
        !            66: .TP 10
        !            67: .B \-help
        !            68: Display a brief summary of
        !            69: .I xclock's
        !            70: calling syntax and options.
        !            71: .PP
        !            72: .TP 10
        !            73: .B \-hl \fIcolor\fP
        !            74: Determines the color of the hands in analog mode.
        !            75: The defaults is to make them the same as the foreground color.
        !            76: On monochrome displays this is ignored.
        !            77: .PP
        !            78: .TP 10
        !            79: .B \-offset [\fI-\fP]\fIhours\fP[:\fIminutes\fP]
        !            80: Gives a time offset to add to (or subtract from) the system time.  This
        !            81: may be used to display a clock for a timezone other than the current one.
        !            82: .PP
        !            83: .TP 10
        !            84: .B \-padding \fIpixels\fP
        !            85: Specify the width in pixels of the padding ``white space''
        !            86: between the window border and anything
        !            87: .I xclock
        !            88: displays.  The default padding is 10 in digital mode and 8 in analog mode.
        !            89: .PP
        !            90: .TP 10
        !            91: .B \-rv
        !            92: Reverses the default color values (i.e., black becomes white and white
        !            93: becomes black).
        !            94: .PP
        !            95: .TP 10
        !            96: .B \-update \fIseconds\fP
        !            97: Specify the frequency in seconds with which
        !            98: .I xclock
        !            99: updates its display.  If the
        !           100: .I xclock
        !           101: window is obscured and then exposed,
        !           102: .I xclock
        !           103: will override this setting  and  redisplay  immediately.   The  default
        !           104: update  frequency  is  60  seconds.   The  specification  of an update
        !           105: frequency greater than 30 seconds disables the display of  the  second
        !           106: hand in analog mode.
        !           107: .PP
        !           108: .TP 10
        !           109: .B \-chime
        !           110: Cause the clock to ``chime'' once on the half hour and twice on the hour.
        !           111: .PP
        !           112: .TP 8
        !           113: .B =\fIgeometry\fP
        !           114: The clock window is created with the specified
        !           115: size according to the geometry specification.
        !           116: See \fIX(1)\fP for details.
        !           117: In digital mode if you do not specify either height and width they are
        !           118: determined  by  the font in use.  In analog mode if you do not specify
        !           119: either width or height they default to 164.  The  default  offset  for
        !           120: any unspecified offset is -0.  All values are in pixels.
        !           121: .PP
        !           122: .TP 10
        !           123: .B \fIhost\fP:\fIdisplay\fP
        !           124: Normally,
        !           125: .I xclock
        !           126: gets  the host and display number to use from the environment variable
        !           127: ``DISPLAY''.  One can, however specify them explicitly.
        !           128: The
        !           129: .I host
        !           130: specifies which machine to create the
        !           131: .I xclock
        !           132: window on, and
        !           133: the
        !           134: .I display
        !           135: argument specifies the display number.
        !           136: For example,
        !           137: ``mit-frobozz:1'' creates an
        !           138: .I xclock
        !           139: on display one on the machine mit-frobozz.  If the host is omitted the
        !           140: local  host  is  assumed.   If  the  display  is omitted, display 0 is
        !           141: assumed, the ``:'' is necessary in either case.
        !           142: .SH X DEFAULTS
        !           143: .PP
        !           144: .TP 8
        !           145: .B Foreground
        !           146: To determine the foreground color.
        !           147: Ignored on monochrome displays.
        !           148: .PP
        !           149: .TP 8
        !           150: .B Background
        !           151: To determine the background color.
        !           152: Ignored on monochrome displays.
        !           153: .PP
        !           154: .TP 8
        !           155: .B Hands
        !           156: Sets the color of the hands.
        !           157: Ignored on monochrome displays.
        !           158: .PP
        !           159: .TP 8
        !           160: .B Border
        !           161: To determine the border color.
        !           162: Ignored on monochrome displays.
        !           163: .PP
        !           164: .TP 8
        !           165: .B BorderWidth
        !           166: To determine the border width.
        !           167: .PP
        !           168: .TP 8
        !           169: .B BodyFont
        !           170: To determine digital clock display font.
        !           171: .PP
        !           172: .TP 8
        !           173: .B Highlight
        !           174: To determine the highlight color.
        !           175: Ignored on monochrome displays.
        !           176: .PP
        !           177: .TP 8
        !           178: .B InternalBorder
        !           179: To determine the internal padding value.
        !           180: .PP
        !           181: .TP 8
        !           182: .B Mode
        !           183: To determine if ``analog'' or ``digital'' mode is the default.
        !           184: .PP
        !           185: .TP 8
        !           186: .B ReverseVideo
        !           187: If ``on'', reverse the effect of the defaults colors.
        !           188: Ignored on color displays.
        !           189: .PP
        !           190: .TP 8
        !           191: .B Update
        !           192: To determine the update rate.
        !           193: .SH ENVIRONMENT
        !           194: .PP
        !           195: .TP 8
        !           196: .B DISPLAY
        !           197: To get the default host and display number.
        !           198: .SH SEE ALSO
        !           199: X(1), xwm(1), X(1), time(3C), select(2)
        !           200: .SH AUTHORS
        !           201: .PP
        !           202: Copyright 1985, Massachusetts Institute of Technology.
        !           203: .PP
        !           204: Tony Della Fera (MIT-Athena, DEC)
        !           205: .PP
        !           206: Dave Mankins (MIT-Athena, BBN)
        !           207: .PP
        !           208: Ed Moy (Berkeley) added the nicer hands.
        !           209: .SH BUGS
        !           210: .I Xclock
        !           211: believes the Unix clock.  When specifying the window size manually  in
        !           212: digital  mode  the  string should be centered automatically, currently
        !           213: you have to fiddle with the padding parameter to get it right.
        !           214: 
        !           215: When specifying an offset, the grammar requires an hours field but if
        !           216: only minutes are given they will be quietly ignored.  A negative offset
        !           217: of less than 1 hour is treated as a positive offset.

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.