File: r1061.html

package info (click to toggle)
findlib 1.9.6-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 1,852 kB
  • sloc: ml: 7,721; xml: 3,119; sh: 1,582; makefile: 399
file content (401 lines) | stat: -rw-r--r-- 6,753 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>site-lib</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
TITLE="The findlib Reference Manual"
HREF="index.html"><LINK
REL="UP"
TITLE="Files"
HREF="p757.html"><LINK
REL="PREVIOUS"
TITLE="findlib.conf"
HREF="r865.html"><LINK
REL="NEXT"
TITLE="Library"
HREF="p1119.html"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>The findlib Reference Manual</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="r865.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="p1119.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="AEN1061"
></A
>site-lib</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="SITE-LIB"
></A
><H2
>Name</H2
>site-lib&nbsp;--&nbsp;[Location of package directories]</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1069"
></A
><H2
>STANDARD LAYOUT</H2
><PRE
CLASS="SYNOPSIS"
>...somewhere in the filesystem hierarchy...
   |
   \ 
     site-lib
     |
     +- (optional) stublibs
     +- (optional) postinstall
     +- (optional) postremove
     |
     +- <TT
CLASS="REPLACEABLE"
><I
>package1</I
></TT
>
     |  |
     |  +- META
     |  +- <TT
CLASS="REPLACEABLE"
><I
>archive files</I
></TT
>
     |  +- <TT
CLASS="REPLACEABLE"
><I
>interface definitions</I
></TT
>
     |
     +- <TT
CLASS="REPLACEABLE"
><I
>package2</I
></TT
>
     +
     :
     :
     \
        <TT
CLASS="REPLACEABLE"
><I
>packageN</I
></TT
></PRE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1077"
></A
><H2
>DESCRIPTION</H2
><P
>Every installation of "findlib" has a default location for package
directories, which is normally a directory called "site-lib". The
location can be set by the configuration variables
<TT
CLASS="LITERAL"
>path</TT
> (used to look up packages), and
<TT
CLASS="LITERAL"
>destdir</TT
> (used to install new packages);
see <A
HREF="r865.html#FINDLIB.CONF"
>findlib.conf</A
>.</P
><P
>The name of a package is the name of the package directory. For
example, if <TT
CLASS="LITERAL"
>destdir=/usr/local/lib/ocaml/site-lib</TT
>, the
package p will be installed in the subdirectory
<TT
CLASS="LITERAL"
>/usr/local/lib/ocaml/site-lib/p</TT
>. This subdirectory
must contain the META file and all other files belonging to the package.
Package names must not contain the '.' character.</P
><P
>The variable <TT
CLASS="LITERAL"
>destdir</TT
> specifies the directory for
new packages. You can only have one such directory at a time; but of
course you can change this directory in findlib.conf. The command
<TT
CLASS="LITERAL"
>ocamlfind install</TT
> puts new packages into this
directory; it is recommended to use this command for installation
because it ensures that the directory layout is right.</P
><P
>For searching packages, findlib uses (only) the variable
<TT
CLASS="LITERAL"
>path</TT
> which may name several locations to look at.</P
><P
>For systems with DLL support another directory may exist: stublibs. 
If present, findlib will install DLLs into this directory that is
shared by all packages at the same site-lib location. Findlib remembers
which DLL belongs to which package by special files with the suffix
".owner"; e.g. for the DLL "dllpcre.so" there is another file
"dllpcre.so.owner" containing the string "pcre", so findlib knows
that the package "pcre" owns this DLL. It is not possible that a DLL
is owned by several packages.</P
><P
>If the stublibs directory does not exist, DLLs are installed regularly
in the package directories like any other file.</P
><P
>For special needs, a postinstall and/or a postremove script may be
installed in the site-lib directory. These scripts are invoked after
installation or removal of a package, respectively.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1094"
></A
><H2
>ALTERNATE LAYOUT</H2
><P
>&#13;<PRE
CLASS="PROGRAMLISTING"
>...somewhere in the filesystem hierarchy...
   |
   \ 
     site-lib
     |
     +- (optional) stublibs
     +- (optional) postinstall
     +- (optional) postremove
     |
     +- <TT
CLASS="REPLACEABLE"
><I
>package1</I
></TT
>
     |  |
     |  +- <TT
CLASS="REPLACEABLE"
><I
>archive files</I
></TT
>
     |  +- <TT
CLASS="REPLACEABLE"
><I
>interface definitions</I
></TT
>
     |
     +- <TT
CLASS="REPLACEABLE"
><I
>package2</I
></TT
>
     +
     :
     :
     \
  :     <TT
CLASS="REPLACEABLE"
><I
>packageN</I
></TT
>
  |
  \
    metaregistry
    |
    +- META.package1
    +- META.package2
    +
    :
    \
       META.packageN</PRE
></P
><P
>This is an alternate directory layout collecting all META files in one
directory. You can configure this layout by setting
<TT
CLASS="LITERAL"
>path</TT
> to the absolute location of
<TT
CLASS="LITERAL"
>metaregistry</TT
>. Findlib recognizes that there are
META files in this directory and uses them; it is not necessary to
include <TT
CLASS="LITERAL"
>site-lib</TT
> into the <TT
CLASS="LITERAL"
>path</TT
>.</P
><P
>In order to work, the META files must contain a
<TT
CLASS="LITERAL"
>directory</TT
> directive pointing to the corresponding
package directory that resides below <TT
CLASS="LITERAL"
>site-lib</TT
>.</P
><P
>The command <TT
CLASS="LITERAL"
>ocamlfind install</TT
> copes with this
layout, too. The variable <TT
CLASS="LITERAL"
>destdir</TT
> must contain the
absolute location of <TT
CLASS="LITERAL"
>site-lib</TT
>, and the variable
<TT
CLASS="LITERAL"
>metadir</TT
> must contain the absolute location of
<TT
CLASS="LITERAL"
>metaregistry</TT
>. Note that <TT
CLASS="LITERAL"
>ocamlfind
install</TT
> automatically adds a <TT
CLASS="LITERAL"
>directory</TT
>
directive to the META file, so you need not do it manually.</P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="r865.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="p1119.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>findlib.conf</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="p757.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Library</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>