summaryrefslogtreecommitdiff
path: root/Master/tlpkg/man/TeXLive-TLPDB.1
blob: cdb4f23d25b4071a072d5c1ea074c6a04be24110 (plain)
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
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "tlpkg::TeXLive::TLPDB 3"
.TH tlpkg::TeXLive::TLPDB 3 "2008-04-19" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
\&\f(CW\*(C`TeXLive::TLPDB\*(C'\fR \-\- A database of TeX Live Packages
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use TeXLive::TLPDB;
.Ve
.PP
.Vb 2
\&  TeXLive::TLPDB\->new ();
\&  TeXLive::TLPDB\->new (root => "/path/to/texlive/installation/root");
.Ve
.PP
.Vb 24
\&  $tlpdb\->root("/path/to/root/of/texlive/installation");
\&  $tlpdb\->from_file($filename);
\&  $tlpdb\->writeout;
\&  $tlpdb\->writeout(FILEHANDLE);
\&  $tlpdb\->save;
\&  $tlpdb\->available_architectures();
\&  $tlpdb\->add_tlpcontainer($pkg, $ziploc [, $archrefs [, $dest ]] );
\&  $tlpdb\->add_tlpobj($tlpobj);
\&  $tlpdb\->needed_by($pkg);
\&  $tlpdb\->remove_package($pkg);
\&  $tlpdb\->get_package("packagename");
\&  $tlpdb\->list_packages;
\&  $tlpdb\->find_file("filename");
\&  $tlpdb\->collections;
\&  $tlpdb\->schemes;
\&  $tlpdb\->updmap_cfg_lines;
\&  $tlpdb\->fmtutil_cnf_lines;
\&  $tlpdb\->language_dat_lines;
\&  $tlpdb\->package_revision("packagename");
\&  $tlpdb\->location;
\&  $tlpdb\->config_src_container;
\&  $tlpdb\->config_doc_container;
\&  $tlpdb\->config_container_format;
\&  $tlpdb\->config_release;
.Ve
.PP
.Vb 2
\&  TeXLive::TLPDB\->listdir([$dir]);
\&  $tlpdb\->generate_listfiles([$destdir]);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
.ie n .IP """TeXLive::TLPDB\->new""" 6
.el .IP "\f(CWTeXLive::TLPDB\->new\fR" 6
.IX Item "TeXLive::TLPDB->new"
.PD 0
.ie n .IP """TeXLive::TLPDB\->new( [root => ""$path""] )""" 6
.el .IP "\f(CWTeXLive::TLPDB\->new( [root => ``$path''] )\fR" 6
.IX Item "TeXLive::TLPDB->new( [root => ""$path""] )"
.PD
\&\f(CW\*(C`TeXLive::TLPDB\->new\*(C'\fR creates a new \f(CW\*(C`TLPDB\*(C'\fR object. If the
argument \f(CW\*(C`root\*(C'\fR is given it will be initialized from the respective
location within \f(CW$path\fR. If
\&\f(CW$path\fR begins with \f(CW\*(C`http://\*(C'\fR or \f(CW\*(C`ftp://\*(C'\fR, the program \f(CW\*(C`wget\*(C'\fR
is used to download the file.
.ie n .IP """$tlpdb\->add_tlpobj($tlpobj)""" 6
.el .IP "\f(CW$tlpdb\->add_tlpobj($tlpobj)\fR" 6
.IX Item "$tlpdb->add_tlpobj($tlpobj)"
The \f(CW\*(C`add_tlpobj\*(C'\fR adds an object of the type \s-1TLPOBJ\s0 to the \s-1TLPDB\s0.
.ie n .IP """$tlpdb\->needed_by($pkg)""" 6
.el .IP "\f(CW$tlpdb\->needed_by($pkg)\fR" 6
.IX Item "$tlpdb->needed_by($pkg)"
Returns an array of package names depending on \f(CW$pkg\fR.
.ie n .IP """$tlpdb\->remove_package($pkg)""" 6
.el .IP "\f(CW$tlpdb\->remove_package($pkg)\fR" 6
.IX Item "$tlpdb->remove_package($pkg)"
Remove the package named \f(CW$pkg\fR from the tlpdb. Gives a warning if the
package is not present
.ie n .IP """$tlpdb\->from_file($filename)""" 6
.el .IP "\f(CW$tlpdb\->from_file($filename)\fR" 6
.IX Item "$tlpdb->from_file($filename)"
The \f(CW\*(C`from_file\*(C'\fR function initializes the \f(CW\*(C`TLPDB\*(C'\fR in case the
root was not given at generation time.  If \f(CW$filename\fR begins
with \f(CW\*(C`http://\*(C'\fR or \f(CW\*(C`ftp://\*(C'\fR, the program \f(CW\*(C`wget\*(C'\fR is used to download
the file.
.ie n .IP """$tlpdb\->writeout""" 6
.el .IP "\f(CW$tlpdb\->writeout\fR" 6
.IX Item "$tlpdb->writeout"
.PD 0
.ie n .IP """$tlpdb\->writeout(FILEHANDLE)""" 6
.el .IP "\f(CW$tlpdb\->writeout(FILEHANDLE)\fR" 6
.IX Item "$tlpdb->writeout(FILEHANDLE)"
.PD
The \f(CW\*(C`writeout\*(C'\fR function writes the database to \f(CW\*(C`STDOUT\*(C'\fR, or 
the file handle given as argument.
.ie n .IP """$tlpdb\->save""" 6
.el .IP "\f(CW$tlpdb\->save\fR" 6
.IX Item "$tlpdb->save"
The \f(CW\*(C`save\*(C'\fR functions saves the \f(CW\*(C`TLPDB\*(C'\fR to the file which has been set
as location. If the location is undefined, die.
.ie n .IP """$tlpdb\->available_architectures""" 6
.el .IP "\f(CW$tlpdb\->available_architectures\fR" 6
.IX Item "$tlpdb->available_architectures"
The \f(CW\*(C`available_architectures\*(C'\fR functions returns the list of available 
architectures by checking for binfiles in the \*(L"bin\-tex\*(R" \s-1TLPOBJ\s0. If this
package does not exist, die.
.ie n .IP """$tlpdb\->add_tlpcontainer($pkg, $ziploc [, $archrefs [, $dest ]] )""" 6
.el .IP "\f(CW$tlpdb\->add_tlpcontainer($pkg, $ziploc [, $archrefs [, $dest ]] )\fR" 6
.IX Item "$tlpdb->add_tlpcontainer($pkg, $ziploc [, $archrefs [, $dest ]] )"
Installs the package \f(CW$pkg\fR from the container files in \f(CW$ziploc\fR. If
\&\f(CW$archrefs\fR is given then it must be a reference to a list of 
architectures to be installed. If the normal (arch=all) package is
architecture dependent then all arch packages in this list are installed.
If \f(CW$dest\fR is given then the files are
installed into it, otherwise into the location of the \s-1TLPDB\s0.
.Sp
Note that this procedure does \s-1NOT\s0 check for dependencies. So if your package
adds new dependencies they are not necessarily fulfilled.
.ie n .IP """$tlpdb\->get_package(""packagename"")""" 6
.el .IP "\f(CW$tlpdb\->get_package(``packagename'')\fR" 6
.IX Item "$tlpdb->get_package(""packagename"")"
The \f(CW\*(C`get_package\*(C'\fR function returns a reference to a \f(CW\*(C`TLPOBJ\*(C'\fR object
in case its name the the argument name coincide.
.ie n .IP """$tlpdb\->list_packages""" 6
.el .IP "\f(CW$tlpdb\->list_packages\fR" 6
.IX Item "$tlpdb->list_packages"
The \f(CW\*(C`list_packages\*(C'\fR function returns the list of all included packages.
.ie n .IP """$tlpdb\->find_file(""filename"")""" 6
.el .IP "\f(CW$tlpdb\->find_file(``filename'')\fR" 6
.IX Item "$tlpdb->find_file(""filename"")"
The \f(CW\*(C`find_file\*(C'\fR returns a list of packages:filename
containing a file named \f(CW\*(C`filename\*(C'\fR.
.ie n .IP """$tlpdb\->collections""" 6
.el .IP "\f(CW$tlpdb\->collections\fR" 6
.IX Item "$tlpdb->collections"
The \f(CW\*(C`collections\*(C'\fR function returns the list of all collections.
.ie n .IP """$tlpdb\->schemes""" 6
.el .IP "\f(CW$tlpdb\->schemes\fR" 6
.IX Item "$tlpdb->schemes"
The \f(CW\*(C`collections\*(C'\fR function returns the list of all schemes.
.ie n .IP """$tlpdb\->package_revision(""packagename"")""" 6
.el .IP "\f(CW$tlpdb\->package_revision(``packagename'')\fR" 6
.IX Item "$tlpdb->package_revision(""packagename"")"
The \f(CW\*(C`package_revision\*(C'\fR function returns the revision number of the
package named in the first argument.
.ie n .IP """$tlpdb\->generate_packagelist""" 6
.el .IP "\f(CW$tlpdb\->generate_packagelist\fR" 6
.IX Item "$tlpdb->generate_packagelist"
The \f(CW\*(C`generate_packagelist\*(C'\fR prints TeX Live package names in the object
database, together with their revisions, to the file handle given in the
first (optional) argument, or \f(CW\*(C`STDOUT\*(C'\fR by default.  It also outputs all
available architectures as packages with revision number \-1.
.ie n .IP """$tlpdb\->generate_listfiles""" 6
.el .IP "\f(CW$tlpdb\->generate_listfiles\fR" 6
.IX Item "$tlpdb->generate_listfiles"
.PD 0
.ie n .IP """$tlpdb\->generate_listfiles($destdir)""" 6
.el .IP "\f(CW$tlpdb\->generate_listfiles($destdir)\fR" 6
.IX Item "$tlpdb->generate_listfiles($destdir)"
.PD
The \f(CW\*(C`generate_listfiles\*(C'\fR generates the list files for the old 
installers. This function will probably go away.
.ie n .IP """$tlpdb\->root([ ""/path/to/installation"" ])""" 6
.el .IP "\f(CW$tlpdb\->root([ ``/path/to/installation'' ])\fR" 6
.IX Item "$tlpdb->root([ ""/path/to/installation"" ])"
The function \f(CW\*(C`root\*(C'\fR allows to read and set the root of the
installation. 
.ie n .IP """$tlpdb\->location""" 6
.el .IP "\f(CW$tlpdb\->location\fR" 6
.IX Item "$tlpdb->location"
The function \f(CW\*(C`location\*(C'\fR returns the location of the actual \f(CW\*(C`texlive.tlpdb\*(C'\fR
file used. Note that this is a read-only function, you cannot change 
the root of the \s-1TLPDB\s0 using this function.
.ie n .IP """$tlpdb\->listdir""" 6
.el .IP "\f(CW$tlpdb\->listdir\fR" 6
.IX Item "$tlpdb->listdir"
The function \f(CW\*(C`listdir\*(C'\fR allows to read and set the packages variable
specifiying where generated list files are created.
.ie n .IP """$tlpdb\->config_src_container""" 6
.el .IP "\f(CW$tlpdb\->config_src_container\fR" 6
.IX Item "$tlpdb->config_src_container"
Returns 1 if the the texlive config option for src files splitting on 
container level is set. See Options below.
.ie n .IP """$tlpdb\->config_doc_container""" 6
.el .IP "\f(CW$tlpdb\->config_doc_container\fR" 6
.IX Item "$tlpdb->config_doc_container"
Returns 1 if the the texlive config option for doc files splitting on 
container level is set. See Options below.
.ie n .IP """$tlpdb\->config_doc_container""" 6
.el .IP "\f(CW$tlpdb\->config_doc_container\fR" 6
.IX Item "$tlpdb->config_doc_container"
Returns the currently set default container format. See Options below.
.ie n .IP """$tlpdb\->config_release""" 6
.el .IP "\f(CW$tlpdb\->config_release\fR" 6
.IX Item "$tlpdb->config_release"
Returns the currently set release. See Options below.
.ie n .IP """$tlpdb\->option_XXXXX""" 6
.el .IP "\f(CW$tlpdb\->option_XXXXX\fR" 6
.IX Item "$tlpdb->option_XXXXX"
Need to be documented
.ie n .IP """$tlpdb\->fmtutil_cnf_lines""" 6
.el .IP "\f(CW$tlpdb\->fmtutil_cnf_lines\fR" 6
.IX Item "$tlpdb->fmtutil_cnf_lines"
The function \f(CW\*(C`fmtutil_cnf_lines\*(C'\fR returns the list of a fmtutil.cnf file
containing only those formats present in the installation.
.ie n .IP """$tlpdb\->updmap_cfg_lines""" 6
.el .IP "\f(CW$tlpdb\->updmap_cfg_lines\fR" 6
.IX Item "$tlpdb->updmap_cfg_lines"
The function \f(CW\*(C`updmap_cfg_lines\*(C'\fR returns the list of a updmap.cfg file
containing only those maps present in the installation.
.ie n .IP """$tlpdb\->language_dat_lines""" 6
.el .IP "\f(CW$tlpdb\->language_dat_lines\fR" 6
.IX Item "$tlpdb->language_dat_lines"
The function \f(CW\*(C`language_dat_lines\*(C'\fR returns the concatenation of all
files specified in \f(CW\*(C`BuildLanguageDat execute\*(C'\fR directives in the present
\&\s-1TLPDB\s0.  Exception: the result always begins with the contents of
\&\f(CW\*(C`language.us\*(C'\fR file.  This and all the other files are looked for in
\&\f(CW\*(C`TLROOT/texmf/tex/generic/config\*(C'\fR.
.SH "OPTIONS"
.IX Header "OPTIONS"
Options regarding the full TeX Live installation to be described are saved
in a package \f(CW\*(C`00texlive.config\*(C'\fR as values of \f(CW\*(C`depend\*(C'\fR lines. This special
package \f(CW\*(C`00texlive.config\*(C'\fR does not contain any files, only depend lines
which set one or more of the following options:
.ie n .IP """container_split_src_files""" 6
.el .IP "\f(CWcontainer_split_src_files\fR" 6
.IX Item "container_split_src_files"
.PD 0
.ie n .IP """container_split_doc_files""" 6
.el .IP "\f(CWcontainer_split_doc_files\fR" 6
.IX Item "container_split_doc_files"
.PD
These options specify that at container generation time the source and
documentation files for a package have been put into a separate container
named \f(CW\*(C`package.source.extension\*(C'\fR and \f(CW\*(C`package.doc.extension\*(C'\fR.
.ie n .IP """container_format/\f(CIformat\f(CW""" 6
.el .IP "\f(CWcontainer_format/\f(CIformat\f(CW\fR" 6
.IX Item "container_format/format"
This option specifies a format for containers. The currently supported 
formats are \f(CW\*(C`lzma\*(C'\fR and \f(CW\*(C`zip\*(C'\fR. But note that \f(CW\*(C`zip\*(C'\fR is untested.
.PP
To set these options the respective lines should be added to
\&\f(CW\*(C`00texlive.config.tlpsrc\*(C'\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
The modules TeXLive::TLPSRC, TeXLive::TLPOBJ, 
TeXLive::TLTREE, TeXLive::TLUtils and the
document Perl\-API.txt and the specification in the TeX Live
repository trunk/Master/tlpkg/doc/.
.SH "AUTHORS AND COPYRIGHT"
.IX Header "AUTHORS AND COPYRIGHT"
This script and its documentation were written for the TeX Live
distribution (<http://tug.org/texlive>) and both are licensed under the
\&\s-1GNU\s0 General Public License Version 2 or later.