summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNorbert Preining <preining@logic.at>2007-12-03 17:37:32 +0000
committerNorbert Preining <preining@logic.at>2007-12-03 17:37:32 +0000
commit3ed5636a793068e1f84c62c087fcdeb8998033bf (patch)
treec2ee64627715a8e5ead7524bcc65d00112b23ece
parent73c5ccf1eacaaf6057e330055ffa1b9965077f39 (diff)
add pod documentation for install_package(s)
git-svn-id: svn://tug.org/texlive/trunk@5701 c570f23f-e606-0410-a88d-b1316a301751
-rw-r--r--Master/tlpkg/TeXLive/TLUtils.pm39
1 files changed, 39 insertions, 0 deletions
diff --git a/Master/tlpkg/TeXLive/TLUtils.pm b/Master/tlpkg/TeXLive/TLUtils.pm
index 710b99fc91b..c7c7d7f553d 100644
--- a/Master/tlpkg/TeXLive/TLUtils.pm
+++ b/Master/tlpkg/TeXLive/TLUtils.pm
@@ -480,6 +480,22 @@ sub copy {
}
}
+=pod
+
+=item C<install_packages($from_tlpdb,$to_tlpdb,$what,$netarchsref,$opt_src,$opt_doc);>
+
+Installs the list of packages found in @$what (a ref to a list) into
+the TLPDB given by $to_tlpdb. Information on files are taken from
+the TLPDB $from_tlpdb.
+
+$netarchrefs is a reference to a list of arch/os combination which should
+be installed from the network.
+
+$opt_src and $opt_doc specify whether srcfiles and docfiles should be
+installed (currently implemented only for installation from DVD).
+
+=cut
+
sub install_packages {
my ($fromtlpdb,$totlpdb,$what,$netarchs,$opt_src,$opt_doc) = @_;
foreach my $package (@$what) {
@@ -528,6 +544,29 @@ sub install_packages {
$totlpdb->save;
}
+=pod
+
+=item C<install_package($what, $filelistref, $target, $platform);>
+
+This function installs the files given in @$filelistref from $what
+into $target.
+
+If $what is a reference to a list of files then these files are assumed
+to be readable and are copied to $target, creating dirs on the way. In this
+case the list @$filelistref is not taken into account.
+
+If $what starts with http:// of ftp:// then $what is downloaded from the
+net and piped through lzmadec and tar.
+
+If $what ends with .tar.lzma (but does not start with http:// or ftp://)
+it is assumed to be a readable file on the system and is piped through
+lzmadec and tar in the very same way.
+
+In both of the last cases currently the list $@filelistref currently
+is not taken into account (should be fixed!).
+
+=cut
+
sub install_package {
my ($what, $filelistref, $target, $platform) = @_;
my $buffer;