← 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/XParGeom.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/XParGeom.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/XParGeom.man,v 1.3 2001/02/09 03:47:45 tsi 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 XParseGeometry 3X11 __xorgversion__ "XLIB FUNCTIONS"
 
144
.SH NAME
 
145
XParseGeometry, XWMGeometry \- parse window geometry
 
146
.SH SYNTAX
 
147
int XParseGeometry\^(\^\fIparsestring\fP\^, \fIx_return\fP\^, \fIy_return\fP\^, \fIwidth_return\fP\^, \fIheight_return\fP\^)
 
148
.br
 
149
      char *\fIparsestring\fP\^;
 
150
.br
 
151
      int *\fIx_return\fP\^, *\fIy_return\fP\^; 
 
152
.br
 
153
      unsigned int *\fIwidth_return\fP\^, *\fIheight_return\fP\^;
 
154
.LP
 
155
int XWMGeometry\^(\^\fIdisplay\fP, \fIscreen\fP, \fIuser_geom\fP,
 
156
\fIdef_geom\fP, \fIbwidth\fP, \fIhints\fP, \fIx_return\fP, \fIy_return\fP,
 
157
.br
 
158
                \fIwidth_return\fP, \fIheight_return\fP, \fIgravity_return\fP\^)
 
159
.br
 
160
      Display *\fIdisplay\fP\^;
 
161
.br
 
162
      int \fIscreen\fP\^;
 
163
.br
 
164
      char *\fIuser_geom\fP\^;
 
165
.br
 
166
      char *\fIdef_geom\fP\^;
 
167
.br
 
168
      unsigned int \fIbwidth\fP\^;
 
169
.br
 
170
      XSizeHints *\fIhints\fP\^;
 
171
.br
 
172
      int *\fIx_return\fP, *\fIy_return\fP\^; 
 
173
.br
 
174
      int *\fIwidth_return\fP\^;
 
175
.br
 
176
      int *\fIheight_return\fP\^;
 
177
.br
 
178
      int *\fIgravity_return\fP\^;
 
179
.SH ARGUMENTS
 
180
.IP \fIposition\fP 1i
 
181
.br
 
182
.ns
 
183
.IP \fIdefault_position\fP 1i
 
184
Specify the geometry specifications.
 
185
.IP \fIdisplay\fP 1i
 
186
Specifies the connection to the X server.
 
187
.IP \fIfheight\fP 1i
 
188
.br
 
189
.ns
 
190
.IP \fIfwidth\fP 1i
 
191
Specify the font height and width in pixels (increment size).
 
192
.IP \fIparsestring\fP 1i
 
193
Specifies the string you want to parse.
 
194
.IP \fIscreen\fP 1i
 
195
Specifies the screen.
 
196
.IP \fIwidth_return\fP 1i
 
197
.br
 
198
.ns
 
199
.IP \fIheight_return\fP 1i
 
200
Return the width and height determined.
 
201
.IP \fIxadder\fP 1i
 
202
.br
 
203
.ns
 
204
.IP \fIyadder\fP 1i
 
205
Specify additional interior padding needed in the window.
 
206
.IP \fIx_return\fP 1i
 
207
.br
 
208
.ns
 
209
.IP \fIy_return\fP 1i
 
210
Return the x and y offsets.
 
211
.IP \fIbwidth\fP 1i
 
212
Specifies the border width.
 
213
.IP \fIhints\fP 1i
 
214
Specifies the size hints for the window in its normal state.
 
215
.IP \fIdef_geom\fP 1i
 
216
Specifies the application's default geometry or NULL.
 
217
.IP \fIgravity_return\fP 1i
 
218
Returns the window gravity.
 
219
.IP \fIuser_geom\fP 1i
 
220
Specifies the user-specified geometry or NULL.
 
221
.SH DESCRIPTION
 
222
By convention,
 
223
X applications use a standard string to indicate window size and placement.
 
224
.ZN XParseGeometry
 
225
makes it easier to conform to this standard because it allows you
 
226
to parse the standard window geometry.
 
227
Specifically, this function lets you parse strings of the form:
 
228
.LP
 
229
.\" Start marker code here
 
230
.Ds
 
231
[=][<\fIwidth\fP>{xX}<\fIheight\fP>][{+-}<\fIxoffset\fP>{+-}<\fIyoffset\fP>] 
 
232
.De
 
233
.\" End marker code here
 
234
.LP
 
235
The fields map into the arguments associated with this function.
 
236
(Items enclosed in <\^> are integers, items in [\^] are optional, and
 
237
items enclosed in {\^} indicate ``choose one of.''
 
238
Note that the brackets should not appear in the actual string.)
 
239
If the string is not in the Host Portable Character Encoding,
 
240
the result is implementation-dependent.
 
241
.LP
 
242
The
 
243
.ZN XParseGeometry
 
244
function returns a bitmask that indicates which of the four values (width,
 
245
height, xoffset, and yoffset) were actually found in the string 
 
246
and whether the x and y values are negative. 
 
247
By convention, \-0 is not equal to +0, because the user needs to
 
248
be able to say ``position the window relative to the right or bottom edge.''
 
249
For each value found, the corresponding argument is updated.
 
250
For each value not found, the argument is left unchanged.
 
251
The bits are represented by
 
252
.ZN XValue , 
 
253
.ZN YValue , 
 
254
.ZN WidthValue , 
 
255
.ZN HeightValue ,
 
256
.ZN XNegative , 
 
257
or
 
258
.ZN YNegative
 
259
and are defined in 
 
260
.hN X11/Xutil.h .
 
261
They will be set whenever one of the values is defined 
 
262
or one of the signs is set.
 
263
.LP
 
264
If the function returns either the 
 
265
.ZN XValue 
 
266
or 
 
267
.ZN YValue 
 
268
flag,
 
269
you should place the window at the requested position.
 
270
.LP
 
271
The 
 
272
.ZN XWMGeometry 
 
273
function combines any geometry information (given in the format used by 
 
274
.ZN XParseGeometry )
 
275
specified by the user and by the calling program with size hints 
 
276
(usually the ones to be stored in WM_NORMAL_HINTS) and returns the position, 
 
277
size, and gravity
 
278
.Pn ( NorthWestGravity , 
 
279
.ZN NorthEastGravity , 
 
280
.ZN SouthEastGravity ,
 
281
or
 
282
.ZN SouthWestGravity ) 
 
283
that describe the window.
 
284
If the base size is not set in the 
 
285
.ZN XSizeHints
 
286
structure, 
 
287
the minimum size is used if set.
 
288
Otherwise, a base size of zero is assumed.
 
289
If no minimum size is set in the hints structure, 
 
290
the base size is used.
 
291
A mask (in the form returned by 
 
292
.ZN XParseGeometry ) 
 
293
that describes which values came from the user specification 
 
294
and whether or not the position coordinates are relative
 
295
to the right and bottom edges is returned.
 
296
Note that these coordinates will have already been accounted for 
 
297
in the x_return and y_return values.
 
298
.LP
 
299
Note that invalid geometry specifications can cause a width or height 
 
300
of zero to be returned.
 
301
The caller may pass the address of the hints win_gravity field 
 
302
as gravity_return to update the hints directly.
 
303
.SH "SEE ALSO"
 
304
XSetWMProperties(3X11)
 
305
.br
 
306
\fI\*(xL\fP