~ubuntu-branches/ubuntu/gutsy/vnc4/gutsy

« back to all changes in this revision

Viewing changes to unix/xc/doc/man/X11/XDrRect.man

  • Committer: Bazaar Package Importer
  • Author(s): Ola Lundqvist
  • Date: 2006-05-15 20:35:17 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20060515203517-l4lre1ku942mn26k
Tags: 4.1.1+X4.3.0-10
* Correction of critical security issue. Thanks to Martin Kogler
  <e9925248@student.tuwien.ac.at> that informed me about the issue,
  and provided the patch.
  This flaw was originally found by Steve Wiseman of intelliadmin.com.
* Applied patch from Javier Kohen <jkohen@users.sourceforge.net> that
  inform the user that only 8 first characters of the password will
  actually be used when typing more than 8 characters, closes:
  #355619.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium
 
2
.\"
 
3
.\" Permission is hereby granted, free of charge, to any person obtaining
 
4
.\" a copy of this software and associated documentation files (the
 
5
.\" "Software"), to deal in the Software without restriction, including
 
6
.\" without limitation the rights to use, copy, modify, merge, publish,
 
7
.\" distribute, sublicense, and/or sell copies of the Software, and to
 
8
.\" permit persons to whom the Software is furnished to do so, subject to
 
9
.\" the following conditions:
 
10
.\"
 
11
.\" The above copyright notice and this permission notice shall be included
 
12
.\" in all copies or substantial portions of the Software.
 
13
.\"
 
14
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 
15
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 
16
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 
17
.\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
 
18
.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 
19
.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 
20
.\" OTHER DEALINGS IN THE SOFTWARE.
 
21
.\"
 
22
.\" Except as contained in this notice, the name of the X Consortium shall
 
23
.\" not be used in advertising or otherwise to promote the sale, use or
 
24
.\" other dealings in this Software without prior written authorization
 
25
.\" from the X Consortium.
 
26
.\"
 
27
.\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
 
28
.\" Digital Equipment Corporation
 
29
.\"
 
30
.\" Portions Copyright \(co 1990, 1991 by
 
31
.\" Tektronix, Inc.
 
32
.\"
 
33
.\" Permission to use, copy, modify and distribute this documentation for
 
34
.\" any purpose and without fee is hereby granted, provided that the above
 
35
.\" copyright notice appears in all copies and that both that copyright notice
 
36
.\" and this permission notice appear in all copies, and that the names of
 
37
.\" Digital and Tektronix not be used in in advertising or publicity pertaining
 
38
.\" to this documentation without specific, written prior permission.
 
39
.\" Digital and Tektronix makes no representations about the suitability
 
40
.\" of this documentation for any purpose.
 
41
.\" It is provided ``as is'' without express or implied warranty.
 
42
.\" 
 
43
.\" $XFree86: xc/doc/man/X11/XDrRect.man,v 1.2 2001/01/27 18:19:58 dawes Exp $
 
44
.\"
 
45
.ds xT X Toolkit Intrinsics \- C Language Interface
 
46
.ds xW Athena X Widgets \- C Language X Toolkit Interface
 
47
.ds xL Xlib \- C Language X Interface
 
48
.ds xC Inter-Client Communication Conventions Manual
 
49
.na
 
50
.de Ds
 
51
.nf
 
52
.\\$1D \\$2 \\$1
 
53
.ft 1
 
54
.\".ps \\n(PS
 
55
.\".if \\n(VS>=40 .vs \\n(VSu
 
56
.\".if \\n(VS<=39 .vs \\n(VSp
 
57
..
 
58
.de De
 
59
.ce 0
 
60
.if \\n(BD .DF
 
61
.nr BD 0
 
62
.in \\n(OIu
 
63
.if \\n(TM .ls 2
 
64
.sp \\n(DDu
 
65
.fi
 
66
..
 
67
.de FD
 
68
.LP
 
69
.KS
 
70
.TA .5i 3i
 
71
.ta .5i 3i
 
72
.nf
 
73
..
 
74
.de FN
 
75
.fi
 
76
.KE
 
77
.LP
 
78
..
 
79
.de IN          \" send an index entry to the stderr
 
80
..
 
81
.de C{
 
82
.KS
 
83
.nf
 
84
.D
 
85
.\"
 
86
.\"     choose appropriate monospace font
 
87
.\"     the imagen conditional, 480,
 
88
.\"     may be changed to L if LB is too
 
89
.\"     heavy for your eyes...
 
90
.\"
 
91
.ie "\\*(.T"480" .ft L
 
92
.el .ie "\\*(.T"300" .ft L
 
93
.el .ie "\\*(.T"202" .ft PO
 
94
.el .ie "\\*(.T"aps" .ft CW
 
95
.el .ft R
 
96
.ps \\n(PS
 
97
.ie \\n(VS>40 .vs \\n(VSu
 
98
.el .vs \\n(VSp
 
99
..
 
100
.de C}
 
101
.DE
 
102
.R
 
103
..
 
104
.de Pn
 
105
.ie t \\$1\fB\^\\$2\^\fR\\$3
 
106
.el \\$1\fI\^\\$2\^\fP\\$3
 
107
..
 
108
.de ZN
 
109
.ie t \fB\^\\$1\^\fR\\$2
 
110
.el \fI\^\\$1\^\fP\\$2
 
111
..
 
112
.de hN
 
113
.ie t <\fB\\$1\fR>\\$2
 
114
.el <\fI\\$1\fP>\\$2
 
115
..
 
116
.de NT
 
117
.ne 7
 
118
.ds NO Note
 
119
.if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
 
120
.if \\n(.$ .if !'\\$1'C' .ds NO \\$1
 
121
.ie n .sp
 
122
.el .sp 10p
 
123
.TB
 
124
.ce
 
125
\\*(NO
 
126
.ie n .sp
 
127
.el .sp 5p
 
128
.if '\\$1'C' .ce 99
 
129
.if '\\$2'C' .ce 99
 
130
.in +5n
 
131
.ll -5n
 
132
.R
 
133
..
 
134
.               \" Note End -- doug kraft 3/85
 
135
.de NE
 
136
.ce 0
 
137
.in -5n
 
138
.ll +5n
 
139
.ie n .sp
 
140
.el .sp 10p
 
141
..
 
142
.ny0
 
143
.TH XDrawRectangle 3X11 __xorgversion__ "XLIB FUNCTIONS"
 
144
.SH NAME
 
145
XDrawRectangle, XDrawRectangles, XRectangle \- draw rectangles and rectangles structure
 
146
.SH SYNTAX
 
147
XDrawRectangle\^(\^\fIdisplay\fP, \fId\fP\^, \fIgc\fP\^, \fIx\fP\^, \fIy\fP\^, \fIwidth\fP\^, \fIheight\fP\^)
 
148
.br
 
149
      Display *\fIdisplay\fP\^;
 
150
.br
 
151
      Drawable \fId\fP\^;
 
152
.br
 
153
      GC \fIgc\fP\^;
 
154
.br
 
155
      int \fIx\fP\^, \fIy\fP\^;
 
156
.br
 
157
      unsigned int \fIwidth\fP\^, \fIheight\fP\^;
 
158
.LP
 
159
XDrawRectangles\^(\^\fIdisplay\fP, \fId\fP\^, \fIgc\fP\^, \fIrectangles\fP\^, \fInrectangles\fP\^)
 
160
.br
 
161
      Display *\fIdisplay\fP\^;
 
162
.br
 
163
      Drawable \fId\fP\^;
 
164
.br
 
165
      GC \fIgc\fP\^;
 
166
.br
 
167
      XRectangle \fIrectangles\fP\^[\^]\^;
 
168
.br
 
169
      int \fInrectangles\fP\^;
 
170
.SH ARGUMENTS
 
171
.IP \fId\fP 1i
 
172
Specifies the drawable. 
 
173
.IP \fIdisplay\fP 1i
 
174
Specifies the connection to the X server.
 
175
.IP \fIgc\fP 1i
 
176
Specifies the GC.
 
177
.IP \fInrectangles\fP 1i
 
178
Specifies the number of rectangles in the array.
 
179
.IP \fIrectangles\fP 1i
 
180
Specifies an array of rectangles.
 
181
.ds Wh , which specify the dimensions of the rectangle
 
182
.IP \fIwidth\fP 1i
 
183
.br
 
184
.ns
 
185
.IP \fIheight\fP 1i
 
186
Specify the width and height\*(Wh.
 
187
.ds Xy , which specify the upper-left corner of the rectangle
 
188
.IP \fIx\fP 1i
 
189
.br
 
190
.ns
 
191
.IP \fIy\fP 1i
 
192
Specify the x and y coordinates\*(Xy.
 
193
.SH DESCRIPTION
 
194
The
 
195
.ZN XDrawRectangle
 
196
and
 
197
.ZN XDrawRectangles
 
198
functions draw the outlines of the specified rectangle or rectangles as
 
199
if a five-point 
 
200
.ZN PolyLine 
 
201
protocol request were specified for each rectangle:
 
202
.IP
 
203
[x,y] [x+width,y] [x+width,y+height] [x,y+height] [x,y]
 
204
.LP 
 
205
For the specified rectangle or rectangles, 
 
206
these functions do not draw a pixel more than once.
 
207
.ZN XDrawRectangles
 
208
draws the rectangles in the order listed in the array.
 
209
If rectangles intersect,
 
210
the intersecting pixels are drawn multiple times.
 
211
.LP
 
212
Both functions use these GC components: 
 
213
function, plane-mask, line-width,
 
214
line-style, cap-style, join-style, fill-style, 
 
215
subwindow-mode, clip-x-origin, clip-y-origin, and clip-mask.
 
216
They also use these GC mode-dependent components: 
 
217
foreground, background, tile, stipple, tile-stipple-x-origin, 
 
218
tile-stipple-y-origin, dash-offset, and dash-list.
 
219
.LP
 
220
.ZN XDrawRectangle
 
221
and
 
222
.ZN XDrawRectangles
 
223
can generate
 
224
.ZN BadDrawable ,
 
225
.ZN BadGC ,
 
226
and
 
227
.ZN BadMatch 
 
228
errors.
 
229
.SH STRUCTURES
 
230
The
 
231
.ZN XRectangle
 
232
structure contains:
 
233
.LP
 
234
.Ds 0
 
235
.TA .5i
 
236
.ta .5i
 
237
typedef struct {
 
238
        short x, y;
 
239
        unsigned short width, height;
 
240
} XRectangle;
 
241
.De
 
242
.LP
 
243
All x and y members are signed integers.
 
244
The width and height members are 16-bit unsigned integers.
 
245
You should be careful not to generate coordinates and sizes
 
246
out of the 16-bit ranges, because the protocol only has 16-bit fields
 
247
for these values.
 
248
.SH DIAGNOSTICS
 
249
.TP 1i
 
250
.ZN BadDrawable
 
251
A value for a Drawable argument does not name a defined Window or Pixmap.
 
252
.TP 1i
 
253
.ZN BadGC
 
254
A value for a GContext argument does not name a defined GContext.
 
255
.TP 1i
 
256
.ZN BadMatch
 
257
An
 
258
.ZN InputOnly
 
259
window is used as a Drawable.
 
260
.TP 1i
 
261
.ZN BadMatch
 
262
Some argument or pair of arguments has the correct type and range but fails
 
263
to match in some other way required by the request.
 
264
.SH "SEE ALSO"
 
265
XDrawArc(3X11),
 
266
XDrawLine(3X11),
 
267
XDrawPoint(3X11)
 
268
.br
 
269
\fI\*(xL\fP