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

« back to all changes in this revision

Viewing changes to unix/xc/doc/man/X11/XIntConn.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/XIntConn.man,v 1.3 2001/11/21 22:54:13 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 XAddConnectionWatch 3X11 __xorgversion__ "XLIB FUNCTIONS"
 
144
.SH NAME
 
145
XAddConnectionWatch, XRemoveConnectionWatch, XProcessInternalConnection, XInternalConnectionNumbers \- handle Xlib internal connections
 
146
.SH SYNTAX
 
147
typedef void (*XConnectionWatchProc)\^(\^\fIdisplay\fP, \fIclient_data\fP, \fIfd\fP, \fIopening\fP, \fIwatch_data\fP\^)
 
148
.br
 
149
      Display *\fIdisplay\fP\^;
 
150
.br
 
151
      XPointer \fIclient_data\fP\^;
 
152
.br
 
153
      int \fIfd\fP\^;
 
154
.br
 
155
      Bool \fIopening\fP\^;
 
156
.br
 
157
      XPointer *\fIwatch_data\fP\^;
 
158
.LP
 
159
Status XAddConnectionWatch\^(\^\fIdisplay\fP, \fIprocedure\fP\^, \fIclient_data\fP\^)
 
160
.br
 
161
      Display *\fIdisplay\fP\^;
 
162
.br
 
163
      XWatchProc \fIprocedure\fP\^;
 
164
.br
 
165
      XPointer \fIclient_data\fP\^;
 
166
.LP
 
167
Status XRemoveConnectionWatch\^(\^\fIdisplay\fP, \fIprocedure\fP\^, \fIclient_data\fP\^)
 
168
.br
 
169
      Display *\fIdisplay\fP\^;
 
170
.br
 
171
      XWatchProc \fIprocedure\fP\^;
 
172
.br
 
173
      XPointer \fIclient_data\fP\^;
 
174
.LP
 
175
void XProcessInternalConnection\^(\^\fIdisplay\fP, \fIfd\fP\^)
 
176
.br
 
177
      Display *\fIdisplay\fP\^;
 
178
.br
 
179
      int \fIfd\fP\^;
 
180
.LP
 
181
Status XInternalConnectionNumbers\^(\^\fIdisplay\fP, \fIfd_return\fP\^, \fIcount_return\fP\^)
 
182
.br
 
183
      Display *\fIdisplay\fP\^;
 
184
.br
 
185
      int **\fIfd_return\fP\^;
 
186
.br
 
187
      int *\fIcount_return\fP\^;
 
188
.SH ARGUMENTS
 
189
.IP \fIclient_data\fP 1i
 
190
Specifies the additional client data.
 
191
.ds Cn file descriptors
 
192
.IP \fIcount_return\fP 1i
 
193
Returns the number of \*(Cn.
 
194
.IP \fIdisplay\fP 1i
 
195
Specifies the connection to the X server.
 
196
.IP \fIfd\fP 1i
 
197
Specifies the file descriptor.
 
198
.IP \fIfd_return\fP 1i
 
199
Returns the file descriptors.
 
200
.IP \fIprocedure\fP 1i
 
201
Specifies the procedure to be called.
 
202
.SH DESCRIPTION
 
203
The
 
204
.ZN XAddConnectionWatch
 
205
function registers a procedure to be called each time Xlib opens or closes an
 
206
internal connection for the specified display.  The procedure is passed the
 
207
display, the specified client_data, the file descriptor for the connection,
 
208
a Boolean indicating whether the connection is being opened or closed, and a
 
209
pointer to a location for private watch data.  If opening is
 
210
.ZN True ,
 
211
the procedure can store a pointer to private data in the location pointed
 
212
to by watch_data;
 
213
when the procedure is later called for this same connection and opening is
 
214
.ZN False ,
 
215
the location pointed to by watch_data will hold this same private data pointer.
 
216
.LP
 
217
This function can be called at any time after a display is opened.
 
218
If internal connections already exist, the registered procedure will
 
219
immediately be called for each of them, before
 
220
.ZN XAddConnectionWatch
 
221
returns.
 
222
.ZN XAddConnectionWatch
 
223
returns a nonzero status if the procedure is successfully registered;
 
224
otherwise, it returns zero.
 
225
.LP
 
226
The registered procedure should not call any Xlib functions.
 
227
If the procedure directly or indirectly causes the state of internal
 
228
connections or watch procedures to change, the result is not defined.
 
229
If Xlib has been initialized for threads, the procedure is called with
 
230
the display locked and the result of a call by the procedure to any
 
231
Xlib function that locks the display is not defined unless the executing
 
232
thread has externally locked the display using
 
233
.ZN XLockDisplay .
 
234
.LP
 
235
The
 
236
.ZN XRemoveConnectionWatch
 
237
function removes a previously registered connection watch procedure.
 
238
The client_data must match the client_data used when the procedure
 
239
was initially registered.
 
240
 
 
241
.LP
 
242
The
 
243
.ZN XProcessInternalConnection
 
244
function processes input available on an internal connection.
 
245
This function should be called for an internal connection only
 
246
after an operating system facility (for example,
 
247
.ZN select
 
248
or
 
249
.ZN poll )
 
250
has indicated that input is available; otherwise,
 
251
the effect is not defined.
 
252
.LP
 
253
The
 
254
.ZN XInternalConnectionNumbers
 
255
function returns a list of the file descriptors for all internal
 
256
connections currently open for the specified display.
 
257
When the allocated list is no longer needed,
 
258
free it by using
 
259
.ZN XFree .
 
260
This functions returns a nonzero status if the list is successfully allocated;
 
261
otherwise, it returns zero.
 
262
.SH "SEE ALSO"
 
263
\fI\*(xL\fP