← Back to branch summary

~ubuntu-branches/ubuntu/quantal/openmotif/quantal

« back to all changes in this revision

Viewing changes to doc/man/man3/MrmOpenHierarchyPerDisplay.3

  • Committer: Bazaar Package Importer
  • Author(s): Stefan Bauer
  • Date: 2010-06-23 12:12:31 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20100623121231-u89gxdp51sg9wjj2
Tags: 2.3.0-1
http://bugs.debian.org/379258
http://bugs.debian.org/494375
http://bugs.debian.org/288537
* New Maintainer (Closes: #379258) 
* Acknowledge NMU changes
* New upstream release (Closes: #494375)
* Get rid of security patches as they are already part of new upstream
  release (00-xpmvuln.openmotif.patch, 342092-CVE-2005-3964.patch)
* Bump Standards to 3.8.4
* Added {misc:Depends} to make the package lintian cleaner
* Fix weak-library-dev-dependency by adding ${binary:Version}) for the
  -dev Package of openmotif
* Let package depend on autotools-dev to use newer autotools-helper-files
* Work around an autoconf-bug (Gentoo-Bug #1475)
* Added Client-side anti-aliased fonts support via XFT
* Added UTF-8 and UTF8_STRING atom support
* Ability to show text and pixmaps in Label, LabelGadget and all
  derived widgets
* Support of PNG/JPEG image formats in the same way as XPM is supported
* Increase FILE_OFFSET_BITS to 64 to show files >2GB in file-selector
  Idea taken from Magne Oestlyngen (Closes: #288537)

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/man/man3/MrmOpenHierarchyPerDisplay.3
 
1
'\" t
 
2
...\" OpenHieC.sgm /main/10 1996/09/08 21:26:00 rws $
 
3
.de P!
 
4
.fl
 
5
\!!1 setgray
 
6
.fl
 
7
\\&.\"
 
8
.fl
 
9
\!!0 setgray
 
10
.fl                     \" force out current output buffer
 
11
\!!save /psv exch def currentpoint translate 0 0 moveto
 
12
\!!/showpage{}def
 
13
.fl                     \" prolog
 
14
.sy sed -e 's/^/!/' \\$1\" bring in postscript file
 
15
\!!psv restore
 
16
.
 
17
.de pF
 
18
.ie     \\*(f1 .ds f1 \\n(.f
 
19
.el .ie \\*(f2 .ds f2 \\n(.f
 
20
.el .ie \\*(f3 .ds f3 \\n(.f
 
21
.el .ie \\*(f4 .ds f4 \\n(.f
 
22
.el .tm ? font overflow
 
23
.ft \\$1
 
24
..
 
25
.de fP
 
26
.ie     !\\*(f4 \{\
 
27
.       ft \\*(f4
 
28
.       ds f4\"
 
29
'       br \}
 
30
.el .ie !\\*(f3 \{\
 
31
.       ft \\*(f3
 
32
.       ds f3\"
 
33
'       br \}
 
34
.el .ie !\\*(f2 \{\
 
35
.       ft \\*(f2
 
36
.       ds f2\"
 
37
'       br \}
 
38
.el .ie !\\*(f1 \{\
 
39
.       ft \\*(f1
 
40
.       ds f1\"
 
41
'       br \}
 
42
.el .tm ? font underflow
 
43
..
 
44
.ds f1\"
 
45
.ds f2\"
 
46
.ds f3\"
 
47
.ds f4\"
 
48
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n 
 
49
.TH "MrmOpenHierarchyPerDisplay" "library call"
 
50
.SH "NAME"
 
51
\fBMrmOpenHierarchyPerDisplay\fP \(em Allocates a hierarchy ID and opens all the UID files in the hierarchy
 
52
.iX "MrmOpenHierarchyPer\\%Display"
 
53
.iX "uil functions" "MrmOpenHierarchyPer\\%Display"
 
54
.SH "SYNOPSIS"
 
55
.PP
 
56
.nf
 
57
#include <Mrm/MrmPublic\&.h>
 
58
\fBCardinal \fBMrmOpenHierarchyPerDisplay\fP\fR(
 
59
\fBDisplay *\fBdisplay\fR\fR,
 
60
\fBMrmCount \fBnum_files\fR\fR,
 
61
\fBString \fBfile_names_list\fR[]\fR,
 
62
\fBMrmOsOpenParamPtr *\fBancillary_structures_list\fR\fR,
 
63
\fBMrmHierarchy *\fBhierarchy_id\fR\fR);
 
64
.fi
 
65
.SH "DESCRIPTION"
 
66
.PP
 
67
\fBMrmOpenHierarchyPerDisplay\fP allows you to specify the list
 
68
of UID files that MRM searches in subsequent fetch operations\&.
 
69
All subsequent fetch operations return the first occurrence of the
 
70
named item encountered while traversing the UID hierarchy from
 
71
the first list element (UID file specification) to the last list
 
72
element\&.
 
73
This function also
 
74
allocates a hierarchy ID and opens all the UID files in the
 
75
hierarchy\&.
 
76
It initializes the optimized search lists in the hierarchy\&.
 
77
If
 
78
\fBMrmOpenHierarchyPerDisplay\fP
 
79
encounters any errors during its execution, any files that were opened
 
80
are closed\&.
 
81
.PP
 
82
The application must call \fBXtAppInitialize\fP before calling
 
83
\fBMrmOpenHierarchyPerDisplay\fP\&.
 
84
.IP "\fIdisplay\fP" 10
 
85
Specifies the connection to the X server and the value to pass
 
86
to \fBXtResolvePathname\fP\&. For more information on the \fBDisplay\fR
 
87
structure, see the Xlib function \fBXOpenDisplay\fP\&.
 
88
.IP "\fInum_files\fP" 10
 
89
Specifies the number of files in the name list\&.
 
90
.IP "\fIfile_names_list\fP" 10
 
91
Specifies an array of character strings that identify
 
92
the UID files\&.
 
93
.IP "\fIancillary_structures_list\fP" 10
 
94
A list of operating-system-dependent ancillary structures corresponding
 
95
to items such as filenames, clobber flags, and so forth\&.
 
96
This argument should be NULL for most operations\&.
 
97
If you need to reference this structure,
 
98
see the definition of
 
99
\fBMrmOsOpenParamPtr\fR
 
100
in the \fBMrmPublic\&.h\fP header file for more information\&.
 
101
.IP "\fIhierarchy_id\fP" 10
 
102
Returns the search hierarchy ID\&.
 
103
The search hierarchy ID identifies the list of UID files that
 
104
MRM searches (in order) when performing subsequent
 
105
fetch calls\&.
 
106
.PP
 
107
Each UID file string in \fIfile_names_list\fP can specify either a full
 
108
pathname or a filename\&.
 
109
If a UID file string has a leading / (slash), it specifies a full
 
110
pathname, and MRM opens the file as specified\&.
 
111
Otherwise, the UID file string specifies a filename\&.
 
112
In this case MRM looks for the file along a search path specified by the
 
113
\fBUIDPATH\fP environment variable or by a default search path, which
 
114
varies depending on whether or not the \fBXAPPLRESDIR\fP environment
 
115
variable is set\&.
 
116
.PP
 
117
The \fBUIDPATH\fP environment variable specifies a search path and
 
118
naming conventions associated with UID files\&.
 
119
It can contain the substitution field \fB%U\fP, where the UID file string from
 
120
the \fIfile_names_list\fP argument to \fBMrmOpenHierarchyPerDisplay\fP is
 
121
substituted for \fB%U\fP\&.
 
122
It can also contain the substitution fields accepted by
 
123
\fBXtResolvePathname\fP\&.
 
124
The substitution field \fB%T\fP is always mapped to \fIuid\fP\&.
 
125
The entire path is searched first with \fB%S\fP mapped to \fB\&.uid\fP\&.
 
126
If no file is found, it is searched again with \fB%S\fP mapped to NULL\&.
 
127
For example, the following \fBUIDPATH\fP value and
 
128
\fBMrmOpenHierarchyPerDisplay\fP call cause MRM to open two separate UID
 
129
files:
 
130
.PP
 
131
.nf
 
132
\f(CWUIDPATH=/uidlib/%L/%U\&.uid:/uidlib/%U/%L
 
133
  static char *uid_files[] = {"/usr/users/me/test\&.uid", "test2"};
 
134
  MrmHierarchy  *Hierarchy_id;
 
135
  MrmOpenHierarchyPerDisplay((MrmCount)2,uid_files, NULL, Hierarchy_id)\fR
 
136
.fi
 
137
.PP
 
138
.PP
 
139
MRM opens the first file, \fB/usr/users/me/test\&.uid\fP, as specified in
 
140
the \fIfile_names_list\fP argument to \fBMrmOpenHierarchyPerDisplay\fP,
 
141
because the UID file string in the \fIfile_names_list\fP argument
 
142
specifies a full pathname\&.
 
143
MRM looks for the second file,
 
144
\fBtest2\fP,
 
145
first as
 
146
\fB/uidlib/%L/test2\&.uid\fP
 
147
and second as
 
148
\fB/uidlib/test2/%L\fP,
 
149
where the display\&'s language string is substituted for \fB%L\fP\&.
 
150
.PP
 
151
After
 
152
\fBMrmOpenHierarchyPerDisplay\fP
 
153
opens the UID hierarchy, you should not delete or modify the
 
154
UID files until you close the UID hierarchy by calling
 
155
\fBMrmCloseHierarchy\fP\&.
 
156
.PP
 
157
If \fBUIDPATH\fP is not set, but the environment variable
 
158
\fBXAPPLRESDIR\fP is set, MRM searches the following pathnames:
 
159
.IP "   \(bu" 6
 
160
\fB%U%S\fP
 
161
.IP "   \(bu" 6
 
162
\fB$XAPPLRESDIR/%L/uid/%N/%U%S\fP
 
163
.IP "   \(bu" 6
 
164
\fB$XAPPLRESDIR/%l/uid/%N/%U%S\fP
 
165
.IP "   \(bu" 6
 
166
\fB$XAPPLRESDIR/uid/%N/%U%S\fP
 
167
.IP "   \(bu" 6
 
168
\fB$XAPPLRESDIR/%L/uid/%U%S\fP
 
169
.IP "   \(bu" 6
 
170
\fB$XAPPLRESDIR/%l/uid/%U%S\fP
 
171
.IP "   \(bu" 6
 
172
\fB$XAPPLRESDIR/uid/%U%S\fP
 
173
.IP "   \(bu" 6
 
174
\fB$HOME/uid/%U%S\fP
 
175
.IP "   \(bu" 6
 
176
\fB$HOME/%U%S\fP
 
177
.IP "   \(bu" 6
 
178
\fB/usr/lib/X11/%L/uid/%N/%U%S\fP
 
179
.IP "   \(bu" 6
 
180
\fB/usr/lib/X11/%l/uid/%N/%U%S\fP
 
181
.IP "   \(bu" 6
 
182
\fB/usr/lib/X11/uid/%N/%U%S\fP
 
183
.IP "   \(bu" 6
 
184
\fB/usr/lib/X11/%L/uid/%U%S\fP
 
185
.IP "   \(bu" 6
 
186
\fB/usr/lib/X11/%l/uid/%U%S\fP
 
187
.IP "   \(bu" 6
 
188
\fB/usr/lib/X11/uid/%U%S\fP
 
189
.IP "   \(bu" 6
 
190
\fB/usr/include/X11/uid/%U%S\fP
 
191
.PP
 
192
If neither \fBUIDPATH\fP nor \fBXAPPLRESDIR\fP is set, MRM searches the
 
193
following pathnames:
 
194
.IP "   \(bu" 6
 
195
\fB%U%S\fP
 
196
.IP "   \(bu" 6
 
197
\fB$HOME/%L/uid/%N/%U%S\fP
 
198
.IP "   \(bu" 6
 
199
\fB$HOME/%l/uid/%N/%U%S\fP
 
200
.IP "   \(bu" 6
 
201
\fB$HOME/uid/%N/%U%S\fP
 
202
.IP "   \(bu" 6
 
203
\fB$HOME/%L/uid/%U%S\fP
 
204
.IP "   \(bu" 6
 
205
\fB$HOME/%l/uid/%U%S\fP
 
206
.IP "   \(bu" 6
 
207
\fB$HOME/uid/%U%S\fP
 
208
.IP "   \(bu" 6
 
209
\fB$HOME/%U%S\fP
 
210
.IP "   \(bu" 6
 
211
\fB/usr/lib/X11/%L/uid/%N/%U%S\fP
 
212
.IP "   \(bu" 6
 
213
\fB/usr/lib/X11/%l/uid/%N/%U%S\fP
 
214
.IP "   \(bu" 6
 
215
\fB/usr/lib/X11/uid/%N/%U%S\fP
 
216
.IP "   \(bu" 6
 
217
\fB/usr/lib/X11/%L/uid/%U%S\fP
 
218
.IP "   \(bu" 6
 
219
\fB/usr/lib/X11/%l/uid/%U%S\fP
 
220
.IP "   \(bu" 6
 
221
\fB/usr/lib/X11/uid/%U%S\fP
 
222
.IP "   \(bu" 6
 
223
\fB/usr/include/X11/uid/%U%S\fP
 
224
.PP
 
225
These paths are defaults that vendors may change\&.
 
226
For example, a vendor may use different directories for
 
227
\fB/usr/lib/X11\fP and \fB/usr/include/X11\fP\&.
 
228
.PP
 
229
The following substitutions are used in these paths:
 
230
.IP "\fB%U\fP" 10
 
231
The UID file string, from the \fIfile_names_list\fP argument\&.
 
232
.IP "\fB%N\fP" 10
 
233
The class name of the application\&.
 
234
.IP "\fB%L\fP" 10
 
235
The display\&'s language string\&.
 
236
This string is influenced by \fBXtSetLanguageProc\fP\&.
 
237
The default string is determined by
 
238
calling setlocale(\fBLC_ALL, NULL\fP)\&.
 
239
.IP "\fB%l\fP" 10
 
240
The language component of the display\&'s language string\&.
 
241
.IP "\fB%S\fP" 10
 
242
The suffix to the filename\&.
 
243
The entire path is first searched with a suffix of
 
244
\fB\&.uid\fP\&.
 
245
If
 
246
no file is found, it is searched again with a NULL suffix\&.
 
247
.SH "RETURN"
 
248
.PP
 
249
This function returns one of the following status return constants:
 
250
.iX "MrmSUCCESS"
 
251
.iX "MrmNOT_FOUND"
 
252
.iX "MrmFAILURE"
 
253
.IP "\fBMrmSUCCESS\fP" 10
 
254
The function executed successfully\&.
 
255
.IP "\fBMrmNOT_FOUND\fP" 10
 
256
File not found\&.
 
257
.IP "\fBMrmFAILURE\fP" 10
 
258
The function failed\&.
 
259
.SH "RELATED"
 
260
.PP
 
261
\fBMrmCloseHierarchy\fP(3)\&.
 
262
...\" created by instant / docbook-to-man, Sun 22 Dec 1996, 20:17