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

« back to all changes in this revision

Viewing changes to unix/xc/doc/man/Xt/XtAppInit.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
.\" $Xorg: XtAppInit.man,v 1.3 2000/08/17 19:41:58 cpqbld Exp $
 
2
.\"
 
3
.\" Copyright (c) 1993, 1994  X Consortium
 
4
.\" 
 
5
.\" Permission is hereby granted, free of charge, to any person obtaining a
 
6
.\" copy of this software and associated documentation files (the "Software"), 
 
7
.\" to deal in the Software without restriction, including without limitation 
 
8
.\" the rights to use, copy, modify, merge, publish, distribute, sublicense, 
 
9
.\" and/or sell copies of the Software, and to permit persons to whom the 
 
10
.\" Software furnished to do so, subject to the following conditions:
 
11
.\" 
 
12
.\" The above copyright notice and this permission notice shall be included in
 
13
.\" all copies or substantial portions of the Software.
 
14
.\" 
 
15
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 
16
.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 
17
.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL 
 
18
.\" THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 
 
19
.\" WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF 
 
20
.\" OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 
 
21
.\" SOFTWARE.
 
22
.\" 
 
23
.\" Except as contained in this notice, the name of the X Consortium shall not 
 
24
.\" be used in advertising or otherwise to promote the sale, use or other 
 
25
.\" dealing in this Software without prior written authorization from the 
 
26
.\" X Consortium.
 
27
.\"
 
28
.\" $XFree86: xc/doc/man/Xt/XtAppInit.man,v 1.4 2001/03/04 00:04:25 tsi Exp $
 
29
.\"
 
30
.ds tk X Toolkit
 
31
.ds xT X Toolkit Intrinsics \- C Language Interface
 
32
.ds xI Intrinsics
 
33
.ds xW X Toolkit Athena Widgets \- C Language Interface
 
34
.ds xL Xlib \- C Language X Interface
 
35
.ds xC Inter-Client Communication Conventions Manual
 
36
.ds Rn 3
 
37
.ds Vn 2.2
 
38
.hw XtApp-Initialize XtVa-App-Initialize
 
39
.na
 
40
.de Ds
 
41
.nf
 
42
.\\$1D \\$2 \\$1
 
43
.ft 1
 
44
.ps \\n(PS
 
45
.\".if \\n(VS>=40 .vs \\n(VSu
 
46
.\".if \\n(VS<=39 .vs \\n(VSp
 
47
..
 
48
.de De
 
49
.ce 0
 
50
.if \\n(BD .DF
 
51
.nr BD 0
 
52
.in \\n(OIu
 
53
.if \\n(TM .ls 2
 
54
.sp \\n(DDu
 
55
.fi
 
56
..
 
57
.de FD
 
58
.LP
 
59
.KS
 
60
.TA .5i 3i
 
61
.ta .5i 3i
 
62
.nf
 
63
..
 
64
.de FN
 
65
.fi
 
66
.KE
 
67
.LP
 
68
..
 
69
.de IN          \" send an index entry to the stderr
 
70
..
 
71
.de C{
 
72
.KS
 
73
.nf
 
74
.D
 
75
.\"
 
76
.\"     choose appropriate monospace font
 
77
.\"     the imagen conditional, 480,
 
78
.\"     may be changed to L if LB is too
 
79
.\"     heavy for your eyes...
 
80
.\"
 
81
.ie "\\*(.T"480" .ft L
 
82
.el .ie "\\*(.T"300" .ft L
 
83
.el .ie "\\*(.T"202" .ft PO
 
84
.el .ie "\\*(.T"aps" .ft CW
 
85
.el .ft R
 
86
.ps \\n(PS
 
87
.ie \\n(VS>40 .vs \\n(VSu
 
88
.el .vs \\n(VSp
 
89
..
 
90
.de C}
 
91
.DE
 
92
.R
 
93
..
 
94
.de Pn
 
95
.ie t \\$1\fB\^\\$2\^\fR\\$3
 
96
.el \\$1\fI\^\\$2\^\fP\\$3
 
97
..
 
98
.de ZN
 
99
.ie t \fB\^\\$1\^\fR\\$2
 
100
.el \fI\^\\$1\^\fP\\$2
 
101
..
 
102
.de NT
 
103
.ne 7
 
104
.ds NO Note
 
105
.if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
 
106
.if \\n(.$ .if !'\\$1'C' .ds NO \\$1
 
107
.ie n .sp
 
108
.el .sp 10p
 
109
.TB
 
110
.ce
 
111
\\*(NO
 
112
.ie n .sp
 
113
.el .sp 5p
 
114
.if '\\$1'C' .ce 99
 
115
.if '\\$2'C' .ce 99
 
116
.in +5n
 
117
.ll -5n
 
118
.R
 
119
..
 
120
.               \" Note End -- doug kraft 3/85
 
121
.de NE
 
122
.ce 0
 
123
.in -5n
 
124
.ll +5n
 
125
.ie n .sp
 
126
.el .sp 10p
 
127
..
 
128
.ny0
 
129
.TH XtAppInitialize 3Xt __xorgversion__ "XT FUNCTIONS"
 
130
.SH NAME
 
131
XtAppInitialize, XtVaAppInitialize \- initialize, open, or close a display
 
132
.SH SYNTAX
 
133
Widget XtAppInitialize(\fIapp_context_return\fP, \fIapplication_class\fP,
 
134
\fIoptions\fP, \fInum_options\fP, \fIargc_in_out\fP, \fIargv_in_out\fP,
 
135
\fIfallback_resources\fP, \fIargs\fP, \fInum_args\fP)
 
136
.br
 
137
      XtAppContext* \fIapp_context_return\fP;
 
138
.br
 
139
      String \fIapplication_class\fP;
 
140
.br
 
141
      XrmOptionDescRec* \fIoptions\fP;
 
142
.br
 
143
      Cardinal \fInum_options\fP;
 
144
.br
 
145
      int* \fIargc_in_out\fP;
 
146
.br
 
147
      String* \fIargv_in_out\fP;
 
148
.br
 
149
      String* \fIfallback_resources\fP;
 
150
.br
 
151
      ArgList \fIargs\fP;
 
152
.br
 
153
      Cardinal \fInum_args\fP;
 
154
.LP
 
155
Widget XtVaAppInitialize(\fIapp_context_return\fP, \fIapplication_class\fP,
 
156
\fIoptions\fP, \fInum_options\fP, \fIargc_in_out\fP, \fIargv_in_out\fP,
 
157
\fIfallback_resources\fP, ...)
 
158
.br
 
159
      XtAppContext* \fIapp_context_return\fP;
 
160
.br
 
161
      String \fIapplication_class\fP;
 
162
.br
 
163
      XrmOptionDescRec* \fIoptions\fP;
 
164
.br
 
165
      Cardinal \fInum_options\fP;
 
166
.br
 
167
      int* \fIargc_in_out\fP;
 
168
.br
 
169
      String* \fIargv_in_out\fP;
 
170
.br
 
171
      String* \fIfallback_resources\fP;
 
172
.SH ARGUMENTS
 
173
.IP \fIapp_context_return\fP 1i
 
174
Specifies the application context.
 
175
.ds Ac , which usually is the generic name for all instances of this application
 
176
.IP \fIapplication_class\fP 1i
 
177
Specifies the class name of this application\*(Ac.
 
178
.IP \fIoptions\fP 1i
 
179
Specifies how to parse the command line for any application-specific resources.
 
180
The options argument is passed as a parameter to
 
181
.ZN XrmParseCommand .
 
182
For further information,
 
183
see \fI\*(xL\fP.
 
184
.IP \fInum_options\fP 1i
 
185
Specifies the number of entries in the options list.
 
186
.IP \fIargc_in_out\fP 1i
 
187
Specifies a pointer to the number of command line parameters.
 
188
.IP \fIargv_in_out\fP 1i
 
189
Specifies the command line parameters.
 
190
.IP \fIfallback_resources\fP 1i
 
191
Specifies resource valus to be used if the application class resource
 
192
file cannot be opened or read, or NULL.
 
193
.IP \fIargs\fP 1i
 
194
Specifies the argument list to override any other resource specification
 
195
for the created shell widget.
 
196
.IP \fInum_args\fP 1i
 
197
Specifies the number of entries in the argument list.
 
198
.IP \fI...\fP 1i
 
199
Specifies the variable argument list to override any other resource 
 
200
specification for the created shell widget.
 
201
.SH DESCRIPTION
 
202
The
 
203
.ZN XtAppInitialize
 
204
function calls
 
205
.ZN XtToolkitInitialize
 
206
followed by
 
207
.ZN XtCreateApplicationContext ,
 
208
then calls
 
209
.ZN XtOpenDisplay
 
210
with \fIdisplay_string\fP NULL and \fIapplication_name\fP NULL, and
 
211
finally calls
 
212
.ZN XtAppCreateShell
 
213
with \fIapplication_name\fP NULL, \fIwidget_class\fP
 
214
.ZN applicationShellWidgetClass ,
 
215
and the specified \fIargs\fP and \fInum_args\fP and returns the
 
216
created shell. The modified \fIargc\fP and \fIargv\fP returned by
 
217
.ZN XtDisplayInitialize
 
218
are returned in \fIargc_in_out\fP and \fIargv_in_out\fP. If
 
219
\fIapp_context_return\fP is not NULL, the created application context
 
220
is also returned. If the display specified by the command line cannot
 
221
be opened, an error message is issued and
 
222
.ZN XtAppInitialize
 
223
terminates the application. If \fIfallback_resources\fP is non-NULL,
 
224
.ZN XtAppSetFallbackResources
 
225
is called with the value prior to calling
 
226
.ZN XtOpenDisplay .
 
227
.LP
 
228
XtAppInitialize and XtVaAppInitialize have been superceded by
 
229
.ZN XtOpenApplication
 
230
and
 
231
.ZN XtVaOpenApplication
 
232
respectively.
 
233
.SH "SEE ALSO"
 
234
XtOpenApplication(3Xt), XtVaOpenApplication(3Xt)
 
235
.br
 
236
\fI\*(xT\fP
 
237
.br
 
238
\fI\*(xL\fP