← Back to branch summary

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

« back to all changes in this revision

Viewing changes to unix/xc/doc/man/X11/XmbTExt.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:
unix/xc/doc/man/X11/XmbTExt.man
 
1
.\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium
 
2
.\" Copyright \(co 2000  The XFree86 Project, Inc.
 
3
.\"
 
4
.\" Permission is hereby granted, free of charge, to any person obtaining
 
5
.\" a copy of this software and associated documentation files (the
 
6
.\" "Software"), to deal in the Software without restriction, including
 
7
.\" without limitation the rights to use, copy, modify, merge, publish,
 
8
.\" distribute, sublicense, and/or sell copies of the Software, and to
 
9
.\" permit persons to whom the Software is furnished to do so, subject to
 
10
.\" the following conditions:
 
11
.\"
 
12
.\" The above copyright notice and this permission notice shall be included
 
13
.\" in all copies or substantial portions of the Software.
 
14
.\"
 
15
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 
16
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 
17
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 
18
.\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
 
19
.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 
20
.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 
21
.\" OTHER DEALINGS IN THE SOFTWARE.
 
22
.\"
 
23
.\" Except as contained in this notice, the name of the X Consortium shall
 
24
.\" not be used in advertising or otherwise to promote the sale, use or
 
25
.\" other dealings in this Software without prior written authorization
 
26
.\" from the X Consortium.
 
27
.\"
 
28
.\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
 
29
.\" Digital Equipment Corporation
 
30
.\"
 
31
.\" Portions Copyright \(co 1990, 1991 by
 
32
.\" Tektronix, Inc.
 
33
.\"
 
34
.\" Permission to use, copy, modify and distribute this documentation for
 
35
.\" any purpose and without fee is hereby granted, provided that the above
 
36
.\" copyright notice appears in all copies and that both that copyright notice
 
37
.\" and this permission notice appear in all copies, and that the names of
 
38
.\" Digital and Tektronix not be used in in advertising or publicity pertaining
 
39
.\" to this documentation without specific, written prior permission.
 
40
.\" Digital and Tektronix makes no representations about the suitability
 
41
.\" of this documentation for any purpose.
 
42
.\" It is provided ``as is'' without express or implied warranty.
 
43
.\"
 
44
.\" $XFree86: xc/doc/man/X11/XmbTExt.man,v 1.4 2001/01/27 18:20:08 dawes Exp $
 
45
.\" 
 
46
.ds xT X Toolkit Intrinsics \- C Language Interface
 
47
.ds xW Athena X Widgets \- C Language X Toolkit Interface
 
48
.ds xL Xlib \- C Language X Interface
 
49
.ds xC Inter-Client Communication Conventions Manual
 
50
.na
 
51
.de Ds
 
52
.nf
 
53
.\\$1D \\$2 \\$1
 
54
.ft 1
 
55
.\".ps \\n(PS
 
56
.\".if \\n(VS>=40 .vs \\n(VSu
 
57
.\".if \\n(VS<=39 .vs \\n(VSp
 
58
..
 
59
.de De
 
60
.ce 0
 
61
.if \\n(BD .DF
 
62
.nr BD 0
 
63
.in \\n(OIu
 
64
.if \\n(TM .ls 2
 
65
.sp \\n(DDu
 
66
.fi
 
67
..
 
68
.de FD
 
69
.LP
 
70
.KS
 
71
.TA .5i 3i
 
72
.ta .5i 3i
 
73
.nf
 
74
..
 
75
.de FN
 
76
.fi
 
77
.KE
 
78
.LP
 
79
..
 
80
.de IN          \" send an index entry to the stderr
 
81
..
 
82
.de C{
 
83
.KS
 
84
.nf
 
85
.D
 
86
.\"
 
87
.\"     choose appropriate monospace font
 
88
.\"     the imagen conditional, 480,
 
89
.\"     may be changed to L if LB is too
 
90
.\"     heavy for your eyes...
 
91
.\"
 
92
.ie "\\*(.T"480" .ft L
 
93
.el .ie "\\*(.T"300" .ft L
 
94
.el .ie "\\*(.T"202" .ft PO
 
95
.el .ie "\\*(.T"aps" .ft CW
 
96
.el .ft R
 
97
.ps \\n(PS
 
98
.ie \\n(VS>40 .vs \\n(VSu
 
99
.el .vs \\n(VSp
 
100
..
 
101
.de C}
 
102
.DE
 
103
.R
 
104
..
 
105
.de Pn
 
106
.ie t \\$1\fB\^\\$2\^\fR\\$3
 
107
.el \\$1\fI\^\\$2\^\fP\\$3
 
108
..
 
109
.de ZN
 
110
.ie t \fB\^\\$1\^\fR\\$2
 
111
.el \fI\^\\$1\^\fP\\$2
 
112
..
 
113
.de hN
 
114
.ie t <\fB\\$1\fR>\\$2
 
115
.el <\fI\\$1\fP>\\$2
 
116
..
 
117
.de NT
 
118
.ne 7
 
119
.ds NO Note
 
120
.if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
 
121
.if \\n(.$ .if !'\\$1'C' .ds NO \\$1
 
122
.ie n .sp
 
123
.el .sp 10p
 
124
.TB
 
125
.ce
 
126
\\*(NO
 
127
.ie n .sp
 
128
.el .sp 5p
 
129
.if '\\$1'C' .ce 99
 
130
.if '\\$2'C' .ce 99
 
131
.in +5n
 
132
.ll -5n
 
133
.R
 
134
..
 
135
.               \" Note End -- doug kraft 3/85
 
136
.de NE
 
137
.ce 0
 
138
.in -5n
 
139
.ll +5n
 
140
.ie n .sp
 
141
.el .sp 10p
 
142
..
 
143
.ny0
 
144
.TH XmbTextExtents 3X11 __xorgversion__ "XLIB FUNCTIONS"
 
145
.SH NAME
 
146
XmbTextExtents, XwcTextExtents, Xutf8TextExtents \- compute text extents
 
147
.SH SYNTAX
 
148
int XmbTextExtents\^(\^\fIfont_set\fP\^, \fIstring\fP\^, \fInum_bytes\fP\^, \fIoverall_ink_return\fP\^, \fIoverall_logical_return\fP\^)
 
149
.br
 
150
      XFontSet \fIfont_set\fP\^;
 
151
.br
 
152
      char *\fIstring\fP\^;
 
153
.br
 
154
      int \fInum_bytes\fP\^;
 
155
.br
 
156
      XRectangle *\fIoverall_ink_return\fP\^;
 
157
.br
 
158
      XRectangle *\fIoverall_logical_return\fP\^;
 
159
.LP
 
160
int XwcTextExtents\^(\^\fIfont_set\fP\^, \fIstring\fP\^, \fInum_wchars\fP\^, \fIoverall_ink_return\fP\^, \fIoverall_logical_return\fP\^)
 
161
.br
 
162
      XFontSet \fIfont_set\fP\^;
 
163
.br
 
164
      wchar_t *\fIstring\fP\^;
 
165
.br
 
166
      int \fInum_wchars\fP\^;
 
167
.br
 
168
      XRectangle *\fIoverall_ink_return\fP\^;
 
169
.br
 
170
      XRectangle *\fIoverall_logical_return\fP\^;
 
171
.LP
 
172
int Xutf8TextExtents\^(\^\fIfont_set\fP\^, \fIstring\fP\^, \fInum_bytes\fP\^, \fIoverall_ink_return\fP\^, \fIoverall_logical_return\fP\^)
 
173
.br
 
174
      XFontSet \fIfont_set\fP\^;
 
175
.br
 
176
      char *\fIstring\fP\^;
 
177
.br
 
178
      int \fInum_bytes\fP\^;
 
179
.br
 
180
      XRectangle *\fIoverall_ink_return\fP\^;
 
181
.br
 
182
      XRectangle *\fIoverall_logical_return\fP\^;
 
183
.SH ARGUMENTS
 
184
.IP \fIfont_set\fP 1i
 
185
Specifies the font set.
 
186
.IP \fInum_bytes\fP 1i
 
187
Specifies the number of bytes in the string argument.
 
188
.IP \fInum_wchars\fP 1i
 
189
Specifies the number of characters in the string argument.
 
190
.ds Ov dimensions
 
191
.IP \fIoverall_ink_return\fP 1i
 
192
Returns the overall ink \*(Ov.
 
193
.IP \fIoverall_logical_return\fP 1i
 
194
Returns the overall logical \*(Ov.
 
195
.IP \fIstring\fP 1i
 
196
Specifies the character string.
 
197
.SH DESCRIPTION
 
198
The
 
199
.ZN XmbTextExtents ,
 
200
.ZN XwcTextExtents
 
201
and
 
202
.ZN Xutf8TextExtents
 
203
functions set the components of the specified overall_ink_return and
 
204
overall_logical_return
 
205
arguments to the overall bounding box of the string's image
 
206
and a logical bounding box for spacing purposes, respectively.
 
207
They return the value returned by 
 
208
.ZN XmbTextEscapement ,
 
209
.ZN XwcTextEscapement
 
210
or
 
211
.ZN Xutf8TextEscapement .
 
212
These metrics are relative to the drawing origin of the string,
 
213
using the fonts loaded for the specified font set.
 
214
.LP
 
215
If the overall_ink_return argument is non-NULL,
 
216
it is set to the bounding box of the string's character ink.
 
217
The overall_ink_return for a nondescending, horizontally drawn
 
218
Latin character is conventionally entirely above the baseline;
 
219
that is, overall_ink_return.height <= \-overall_ink_return.y.
 
220
The overall_ink_return for a nonkerned character
 
221
is entirely at, and to the right of, the origin;
 
222
that is, overall_ink_return.x >= 0.
 
223
A character consisting of a single pixel at the origin would set
 
224
overall_ink_return fields y = 0, x = 0, width = 1, and height = 1.
 
225
.LP
 
226
If the overall_logical_return argument is non-NULL,
 
227
it is set to the bounding box that provides minimum spacing
 
228
to other graphical features for the string.
 
229
Other graphical features, for example, a border surrounding the text,
 
230
should not intersect this rectangle.
 
231
.LP
 
232
When the 
 
233
.ZN XFontSet
 
234
has missing charsets,
 
235
metrics for each unavailable character are taken 
 
236
from the default string returned by 
 
237
.ZN XCreateFontSet 
 
238
so that the metrics represent the text as it will actually be drawn.
 
239
The behavior for an invalid codepoint is undefined.
 
240
.LP
 
241
The function
 
242
.ZN Xutf8TextExtents
 
243
is an XFree86 extension introduced in XFree86 4.0.2. Its presence is
 
244
indicated by the macro
 
245
.ZN X_HAVE_UTF8_STRING .
 
246
.SH "SEE ALSO"
 
247
XmbTextEscapement(3X11),
 
248
XmbTextPerCharExtents(3X11)
 
249
\fI\*(xL\fP