← 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/XSeWMINam.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/XSeWMINam.man
 
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/XSeWMINam.man,v 1.2 2001/01/27 18:20:05 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 XSetWMIconName 3X11 __xorgversion__ "XLIB FUNCTIONS"
 
144
.SH NAME
 
145
XSetWMIconName, XGetWMIconName, XSetIconName, XGetIconName \- set or read a window's WM_ICON_NAME property
 
146
.SH SYNTAX
 
147
void XSetWMIconName\^(\^\fIdisplay\fP, \fIw\fP, \fItext_prop\fP\^)
 
148
.br
 
149
      Display *\fIdisplay\fP\^;
 
150
.br
 
151
      Window \fIw\fP\^;
 
152
.br
 
153
      XTextProperty *\fItext_prop\fP\^;
 
154
.LP
 
155
Status XGetWMIconName\^(\^\fIdisplay\fP, \fIw\fP, \fItext_prop_return\fP\^)
 
156
.br
 
157
      Display *\fIdisplay\fP\^;
 
158
.br
 
159
      Window \fIw\fP\^;
 
160
.br
 
161
      XTextProperty *\fItext_prop_return\fP\^;
 
162
.LP
 
163
XSetIconName\^(\^\fIdisplay\fP, \fIw\fP\^, \fIicon_name\fP\^)
 
164
.br
 
165
      Display *\fIdisplay\fP\^;
 
166
.br
 
167
      Window \fIw\fP\^;
 
168
.br
 
169
      char *\fIicon_name\fP\^;
 
170
.LP
 
171
Status XGetIconName\^(\^\fIdisplay\fP, \fIw\fP\^, \fIicon_name_return\fP\^)
 
172
.br
 
173
      Display *\fIdisplay\fP\^;
 
174
.br
 
175
      Window \fIw\fP\^;
 
176
.br
 
177
      char **\fIicon_name_return\fP\^;
 
178
.SH ARGUMENTS
 
179
.IP \fIdisplay\fP 1i
 
180
Specifies the connection to the X server.
 
181
.IP \fIicon_name\fP 1i
 
182
Specifies the icon name,
 
183
which should be a null-terminated string.
 
184
.IP \fIicon_name_return\fP 1i
 
185
Returns the window's icon name,
 
186
which is a null-terminated string.
 
187
.IP \fItext_prop\fP 1i
 
188
Specifies the
 
189
.ZN XTextProperty
 
190
structure to be used.
 
191
.IP \fItext_prop_return\fP 1i
 
192
Returns the
 
193
.ZN XTextProperty
 
194
structure.
 
195
.IP \fIw\fP 1i
 
196
Specifies the window.
 
197
.SH DESCRIPTION
 
198
The
 
199
.ZN XSetWMIconName
 
200
convenience function calls
 
201
.ZN XSetTextProperty
 
202
to set the WM_ICON_NAME property.
 
203
.LP
 
204
The 
 
205
.ZN XGetWMIconName 
 
206
convenience function calls
 
207
.ZN XGetTextProperty 
 
208
to obtain the WM_ICON_NAME property.
 
209
It returns a nonzero status on success;
 
210
otherwise, it returns a zero status.
 
211
.LP
 
212
The
 
213
.ZN XSetIconName
 
214
function sets the name to be displayed in a window's icon.
 
215
.LP
 
216
.ZN XSetIconName
 
217
can generate
 
218
.ZN BadAlloc
 
219
and
 
220
.ZN BadWindow
 
221
errors.
 
222
.LP
 
223
The
 
224
.ZN XGetIconName
 
225
function returns the name to be displayed in the specified window's icon.
 
226
If it succeeds, it returns a nonzero status; otherwise, 
 
227
if no icon name has been set for the window,
 
228
it returns zero.
 
229
If you never assigned a name to the window,
 
230
.ZN XGetIconName
 
231
sets icon_name_return to NULL.
 
232
If the data returned by the server is in the Latin Portable Character Encoding,
 
233
then the returned string is in the Host Portable Character Encoding.
 
234
Otherwise, the result is implementation-dependent.
 
235
When finished with it, a client must free
 
236
the icon name string using
 
237
.ZN XFree .
 
238
.LP
 
239
.ZN XGetIconName
 
240
can generate a
 
241
.ZN BadWindow
 
242
error.
 
243
.SH PROPERTIES
 
244
.TP 1i
 
245
\s-1WM_ICON_NAME\s+1
 
246
The name to be used in an icon.
 
247
.SH DIAGNOSTICS
 
248
.TP 1i
 
249
.ZN BadAlloc
 
250
The server failed to allocate the requested resource or server memory.
 
251
.TP 1i
 
252
.ZN BadWindow
 
253
A value for a Window argument does not name a defined Window.
 
254
.SH "SEE ALSO"
 
255
XAllocClassHint(3X11),
 
256
XAllocIconSize(3X11),
 
257
XAllocSizeHints(3X11),
 
258
XAllocWMHints(3X11),
 
259
XFree(3X11),
 
260
XSetCommand(3X11),
 
261
XSetTransientForHint(3X11),
 
262
XSetTextProperty(3X11),
 
263
XSetWMClientMachine(3X11),
 
264
XSetWMColormapWindows(3X11),
 
265
XSetWMName(3X11),
 
266
XSetWMProperties(3X11),
 
267
XSetWMProtocols(3X11),
 
268
XStringListToTextProperty(3X11)
 
269
.br
 
270
\fI\*(xL\fP