X Strike Force XFree86 SVN commit: r1962 - in trunk/debian: . patches
Author: branden
Date: 2004-10-18 05:58:49 -0500 (Mon, 18 Oct 2004)
New Revision: 1962
Modified:
trunk/debian/CHANGESETS
trunk/debian/changelog
trunk/debian/patches/026_xc_programs_manpage_overhaul.diff
Log:
Clean up and expand xclock(1x) manpage to document the effects the RENDER
extension has on command-line option and X resource handling. Thanks to
Vincent McIntyre for prompting this. (Closes: #241566)
Modified: trunk/debian/CHANGESETS
===================================================================
--- trunk/debian/CHANGESETS 2004-10-18 06:33:22 UTC (rev 1961)
+++ trunk/debian/CHANGESETS 2004-10-18 10:58:49 UTC (rev 1962)
@@ -162,4 +162,9 @@
(Closes: #274018)
1959
+Clean up and expand xclock(1x) manpage to document the effects the RENDER
+extension has on command-line option and X resource handling. Thanks to
+Vincent McIntyre for prompting this. (Closes: #241566)
+ 1962
+
vim:set ai et sts=4 sw=4 tw=80:
Modified: trunk/debian/changelog
===================================================================
--- trunk/debian/changelog 2004-10-18 06:33:22 UTC (rev 1961)
+++ trunk/debian/changelog 2004-10-18 10:58:49 UTC (rev 1962)
@@ -68,6 +68,10 @@
copyright file. Thanks to Ben Harris for pointing this out.
(Closes: #274018)
+ * Clean up and expand xclock(1x) manpage to document the effects the RENDER
+ extension has on command-line option and X resource handling. Thanks to
+ Vincent McIntyre for prompting this. (Closes: #241566)
+
Changes by Denis Barbier and Fabio M. Di Nitto:
* Edit xc/programs/xkbcomp/symbols/pc/Imakefile so that the new pc/us_intl
@@ -138,7 +142,7 @@
+ Set UseBios default to "no" for PROSAVAGE_DDR and PROSAVAGE_DDRK, as
described at <URL: http://www.probo.com/timr/savage40.html >.
- -- Branden Robinson <branden@debian.org> Fri, 15 Oct 2004 17:28:26 -0500
+ -- Branden Robinson <branden@debian.org> Mon, 18 Oct 2004 05:55:52 -0500
xfree86 (4.3.0.dfsg.1-8) unstable; urgency=high
Modified: trunk/debian/patches/026_xc_programs_manpage_overhaul.diff
===================================================================
--- trunk/debian/patches/026_xc_programs_manpage_overhaul.diff 2004-10-18 06:33:22 UTC (rev 1961)
+++ trunk/debian/patches/026_xc_programs_manpage_overhaul.diff 2004-10-18 10:58:49 UTC (rev 1962)
@@ -1810,3 +1810,410 @@
.SH AUTHORS
Kaleb S. Keithley, X Consortium.
.br
+--- xc/programs/xclock/xclock.man~ 2004-10-18 05:07:20.000000000 -0500
++++ xc/programs/xclock/xclock.man 2004-10-18 05:52:14.000000000 -0500
+@@ -1,15 +1,15 @@
+ .\" $Xorg: xclock.man,v 1.4 2001/02/09 02:05:39 xorgcvs Exp $
+ .\" Copyright 1988, 1994, 1998 The Open Group
+-.\"
++.\"
+ .\" Permission to use, copy, modify, distribute, and sell this software and its
+ .\" documentation for any purpose is hereby granted without fee, provided that
+ .\" the above copyright notice appear in all copies and that both that
+ .\" copyright notice and this permission notice appear in supporting
+ .\" documentation.
+-.\"
++.\"
+ .\" The above copyright notice and this permission notice shall be included
+ .\" in all copies or substantial portions of the Software.
+-.\"
++.\"
+ .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+ .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+@@ -17,7 +17,7 @@
+ .\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ .\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ .\" OTHER DEALINGS IN THE SOFTWARE.
+-.\"
++.\"
+ .\" Except as contained in this notice, the name of The Open Group shall
+ .\" not be used in advertising or otherwise to promote the sale, use or
+ .\" other dealings in this Software without prior written authorization
+@@ -25,154 +25,254 @@
+ .\"
+ .\" $XFree86: xc/programs/xclock/xclock.man,v 1.13 2002/10/21 13:33:08 alanh Exp $
+ .\"
+-.TH XCLOCK 1 __xorgversion__
++.TH xclock __mansuffix__ __xorgversion__
+ .SH NAME
+ xclock \- analog / digital clock for X
+ .SH SYNOPSIS
+-.ta 8n
+-\fBxclock\fP [ \fB\-help\fP ] [ \fB\-analog\fP ] [ \fB\-digital\fP ]
+-[ \fB\-brief\fP ] [ \fB\-chime\fP ] [ \fB\-hd\fP \fIcolor\fP ]
+-[ \fB\-hl\fP \fIcolor\fP ] [ \fB\-update\fP \fIseconds\fP ]
+-[ \fB\-strftime\fP \fIformat\fP ]
++.B xclock
++[ \fB\-help\fP ]
++[ \fB\-analog\fP ]
++[ \fB\-brief\fP ]
++[ \fB\-chime\fP ]
++[ \fB\-digital\fP ]
++[ \fB\-face\fP \fIpattern\fP ]
++[ \fB\-hd\fP \fIcolor\fP ]
++[ \fB\-hl\fP \fIcolor\fP ]
++[ \fB\-norender\fP ]
+ [ \fB\-padding\fP \fInumber\fP ]
++[ \fB\-render\fP ]
++[ \fB\-sharp\fP ]
++[ \fB\-strftime\fP \fIformat\fP ]
++[ \fB\-update\fP \fIseconds\fP ]
+ .SH DESCRIPTION
+ The
+-.I xclock
+-program displays the time in analog or digital form. The time is continuously
+-updated at a frequency which may be specified by the user.
++.B xclock
++program displays the time in analog or digital form.
++The time is continuously updated at a frequency which may be specified by
++the user.
++.PP
++Where available,
++.B xclock
++uses the RENDER extension for drawing operations.
++Using RENDER can cause some configuration options to be ignored, and
++several RENDER\-specific options are available; see below.
++The RENDER extension is not used if the
++.B \-norender
++option is specified, if
++.B xclock
++was compiled without support for the extension, or if the X server does not
++support the extension.
+ .SH OPTIONS
+-.I Xclock
+-accepts all of the standard X Toolkit command line options along with the
++.B xclock
++accepts all of the standard X Toolkit command line options along with the
+ additional options listed below:
+-.TP 8
++.TP
+ .B \-help
+ This option indicates that a brief summary of the allowed options should be
+ printed on the standard error.
+-.TP 8
+-.B \-analog
+-This option indicates that a conventional 12 hour clock face with tick marks
+-and hands should be used. This is the default.
+-.TP 8
+-\fB\-digital\fP or \fB\-d\fP
+-This option indicates that a 24 hour digital clock should be used.
+-.TP 8
+-\fB\-brief\fP
++.TP
++.B \-analog
++This option indicates that a conventional 12\-hour clock face with tick marks
++and hands should be used.
++This is the default.
++.TP
++.BR \-digital " or " \-d
++This option indicates that a 24\-hour digital clock should be used.
++.TP
++.B \-brief
+ This option indicates that the digital clock should only display the hours
+-and minutes fields. The default is to show the full time and date information.
+-.TP 8
+-\fB\-utime\fP or \fB\-d\fP
++and minutes fields.
++The default is to show the full time and date information.
++.TP
++.B \-utime
+ This option indicates that a digital clock should display seconds since
+-the Epoch (in format '970012340 seconds since Epoch' instead of a standard
+-24-hour time.
+-.TP 8
++the Epoch (in the format \(oq970012340 seconds since Epoch\(cq) instead of a
++standard 24\-hour time.
++This option is ignored for analog clocks.
++.TP
+ .B \-strftime \fIformat\fP
+-This option allows an strftime(3) format string to be specified for the
++This option allows an
++.BR strftime (__oslibmansuffix__)
++format string to be specified for the
+ digital clock's display.
+-.TP 8
++.TP
+ .B \-twelve
+ This option indicates that a digital clock should display the time in
+ twelve hour format.
+-.TP 8
++.TP
+ .B \-twentyfour
+ This option indicates that a digital clock should display the time in
+-twenty-four hour format. This is the default when a digital clock is used.
+-.TP 8
++twenty\-four hour format.
++This is the default when a digital clock is used.
++.TP
+ .B \-chime
+-This option indicates that the clock should chime
++This option indicates that the clock should chime
+ once on the half hour and twice on the hour.
+-.TP 8
++.TP
+ \fB\-hands\fP \fIcolor\fP (or \fB\-hd\fP \fIcolor\fP)
+-This option specifies the color of the hands on an analog clock. The default
+-is \fIblack\fP.
+-.TP 8
++This option specifies the color of the hands on an analog clock.
++The default is \fIblack\fP.
++.I This option is ignored when the RENDER extension is used.
++.TP
+ \fB\-highlight\fP \fIcolor\fP (or \fB\-hl\fP \fIcolor\fP)
+ This option specifies the color of the edges of the hands on an analog clock,
+-and is only useful on color displays. The default is \fIblack\fP.
+-.TP 8
++and is only useful on color displays.
++The default is \fIblack\fP.
++.I This option is ignored when the RENDER extension is used.
++.TP
+ .B \-update \fIseconds\fP
+-This option specifies the frequency in seconds at which \fIxclock\fP
+-should update its display. If the clock is obscured and then exposed,
+-it will be updated immediately. A value of 30 seconds or less will enable a
+-second hand on an analog clock. The default is 60 seconds.
+-.TP 8
++This option specifies the frequency in seconds at which
++.B xclock
++should update its display.
++If the clock is obscured and then exposed, it will be updated immediately.
++A value of 30 seconds or less will enable a
++second hand on an analog clock.
++The default is 60 seconds.
++.TP
+ .B \-padding \fInumber\fP
+-This option specifies the width in pixels of the padding
+-between the window border and clock text or picture. The default is 10
+-on a digital clock and 8 on an analog clock.
+-.SH X DEFAULTS
+-This program uses the
++This option specifies the width in pixels of the padding
++between the window border and clock text or picture.
++The default is 10 on a digital clock and 8 on an analog clock.
++.TP
++.B \-render
++This option tells
++.B xclock
++to use the RENDER extension to draw an
++anti\-aliased face.
++This is the default if
++.B xclock
++has been compiled with support for the RENDER extension.
++.TP
++.B \-norender
++This option turns off the use of the RENDER extension to draw the clock.
++.TP
++.B \-sharp
++This option tells
++.B xclock
++to use sharper edges when drawn using
++the RENDER extension.
++.TP
++.B \-face \fIpattern\fP
++This option specifies the font to use in digital mode when the
++RENDER extension is used.
++.SH "X DEFAULTS"
++This program uses the
+ .I Clock
+-widget. It understands all of the core resource names and classes as well as:
+-.PP
+-.TP 8
++widget.
++It understands all of the core resource names and classes as well as:
++.TP
+ .B width (\fPclass\fB Width)
+-Specifies the width of the clock. The default for analog clocks is 164
+-pixels; the default for digital clocks is whatever is needed to hold the
+-clock when displayed in the chosen font.
+-.TP 8
++Specifies the width of the clock.
++The default for analog clocks is 164 pixels; the default for digital clocks
++is whatever is needed to hold the clock when displayed in the chosen font.
++.TP
+ .B height (\fPclass\fB Height)
+-Specifies the height of the clock. The default for analog clocks is 164
+-pixels; the default for digital clocks is whatever is needed to hold the
+-clock when displayed in the chosen font.
+-.TP 8
++Specifies the height of the clock.
++The default for analog clocks is 164 pixels; the default for digital clocks
++is whatever is needed to hold the clock when displayed in the chosen font.
++.TP
+ .B update (\fPclass\fB Interval)
+ Specifies the frequency in seconds at which the time should be redisplayed.
+-.TP 8
++.TP
+ .B foreground (\fPclass\fB Foreground)
+-Specifies the color for the tic marks. The default is depends on whether
+-\fIreverseVideo\fP is specified. If \fIreverseVideo\fP is specified
+-the default is \fIlwhite\fP, otherwise the default is \fIblack\fP.
+-
+-.TP 8
++Specifies the color for the tick marks.
++The default depends on whether \fIreverseVideo\fP is specified.
++If \fIreverseVideo\fP is specified the default is \fIwhite\fP, otherwise
++the default is \fIblack\fP.
++.TP
+ .B hands (\fPclass\fB Foreground)
+-Specifies the color of the insides of the clock's hands. The default is
+-depends on whether
+-\fIreverseVideo\fP is specified. If \fIreverseVideo\fP is specified
+-the default is \fIlwhite\fP, otherwise the default is \fIblack\fP.
+-.TP 8
++Specifies the color of the insides of the clock's hands.
++The default depends on whether \fIreverseVideo\fP is specified.
++If \fIreverseVideo\fP is specified the default is \fIwhite\fP, otherwise
++the default is \fIblack\fP.
++.I This resource is ignored when the RENDER extension is used.
++.TP
+ .B highlight (\fPclass\fB Foreground)
+-Specifies the color used to highlight the clock's hands. The default is
+- depends on whether
+-\fIreverseVideo\fP is specified. If \fIreverseVideo\fP is specified
+-the default is \fIlwhite\fP, otherwise the default is \fIblack\fP.
+-.TP 8
++Specifies the color used to highlight the clock's hands.
++The default is depends on whether \fIreverseVideo\fP is specified.
++If \fIreverseVideo\fP is specified the default is \fIwhite\fP, otherwise
++the default is \fIblack\fP.
++.I This resource is ignored when the RENDER extension is used.
++.TP
+ .B analog (\fPclass\fB Boolean)
+-Specifies whether or not an analog clock should be used instead of a digital
+-one. The default is True.
+-.TP 8
++Specifies whether or not an analog clock should be used instead of a
++digital one.
++The default is True.
++.TP
+ .B twentyfour (\fPclass\fB Boolean)
+ Specifies whether or not a digital clock should display the time in
+-twenty-four hour format. The default is True.
+-.TP 8
++twenty\-four hour format.
++The default is True.
++.TP
+ .B chime (\fPclass\fB Boolean)
+ Specifies whether or not a bell should be rung on the hour and half hour.
+-.TP 8
++.TP
+ .B padding (\fPclass\fB Margin)
+-Specifies the amount of internal padding in pixels to be used. The default is
+-8.
+-.TP 8
++Specifies the amount of internal padding in pixels to be used.
++The default is 8.
++.TP
+ .B font (\fPclass\fB Font)
+-Specifies the font to be used for the digital clock. Note that variable width
+-fonts currently will not always display correctly.
++Specifies the font to be used for the digital clock.
++Note that variable width fonts currently will not always display correctly.
++.I This resource is ignored when the RENDER extension is used.
++.TP
++.B render (\fPclass\fB Boolean)
++Specifies whether or not the RENDER extension should be used for the
++display.
++The default is True if
++.B xclock
++has been compiled with support for the RENDER extension.
++.PP
++When the RENDER extension is used for drawing, the following additional
++resources are understood:
++.TP
++.B face (\fPclass\fB FaceName)
++Specify the pattern for the font used to draw the digital clock.
++.TP
++.B sharp (\fPclass\fB Boolean)
++Specifies if sharp edges should be used when rendering the clock.
++The default is False.
++.TP
++.B buffer (\fPclass\fB Boolean)
++Specifies that the updates of the image are drawn to a pixmap before copied
++into the window instead drawing them into the window directly.
++.PP
++The defaults of the following color resources depend on whether
++\fIreverseVideo\fP is specified.
++If \fIreverseVideo\fP is specified the default is \fIwhite\fP, otherwise
++the default is \fIblack\fP.
++.TP
++.B hourColor (\fPclass\fB Foreground)
++The color of the hour hand.
++.TP
++.B minuteColor (\fPclass\fB Foreground)
++The color of the minute hand.
++.TP
++.B secondColor (\fPclass\fB Foreground)
++The color of the second hand.
++.TP
++.B majorColor (\fPclass\fB Foreground)
++The color of the major scale ticks (i.e., each five minutes).
++.TP
++.B minorColor (\fPclass\fB Foreground)
++The color of the minor scale ticks (between major ticks).
+ .SH WIDGETS
+-In order to specify resources, it is useful to know the hierarchy of
+-the widgets which compose \fIxclock\fR. In the notation below,
+-indentation indicates hierarchical structure. The widget class name
+-is given first, followed by the widget instance name.
++In order to specify resources, it is useful to know the hierarchy of the
++widgets which compose
++.BR xclock .
++In the notation below, indentation indicates hierarchical structure.
++The widget class name is given first, followed by the widget instance name.
+ .sp
+ .nf
+-.TA .5i
+-.ta .5i
++.ta .5i
+ XClock xclock
+ Clock clock
+ .fi
+-.sp
+ .SH ENVIRONMENT
+-.PP
+-.TP 8
++.TP
+ .B DISPLAY
+ to get the default host and display number.
+-.TP 8
++.TP
+ .B XENVIRONMENT
+ to get the name of a resource file that overrides the global resources
+ stored in the RESOURCE_MANAGER property.
+@@ -181,16 +281,19 @@
+ .I __apploaddir__/XClock
+ specifies required resources
+ .SH "SEE ALSO"
+-X(__miscmansuffix__), xrdb(1), time(3C)
++.BR X (__miscmansuffix__),
++.BR xrdb (__mansuffix__),
++.BR time (__oslibmansuffix__)
+ .SH BUGS
+-.I Xclock
++.B xclock
+ believes the system clock.
+ .PP
+ When in digital mode, the string should be centered automatically.
+ .SH AUTHORS
+-Tony Della Fera (MIT-Athena, DEC)
++Tony Della Fera (MIT\-Athena, DEC)
+ .br
+-Dave Mankins (MIT-Athena, BBN)
++Dave Mankins (MIT\-Athena, BBN)
+ .br
+ Ed Moy (UC Berkeley)
+-
++.br
++Keith Packard (HP)
Reply to: