diff options
author | Norbert Preining <preining@logic.at> | 2008-04-19 10:44:26 +0000 |
---|---|---|
committer | Norbert Preining <preining@logic.at> | 2008-04-19 10:44:26 +0000 |
commit | fc979df0e433f21832edd93905a474192ea128c4 (patch) | |
tree | f087aa137d8bd9142d099a4e57c755de8af076b7 | |
parent | 94cd3fa88070dc2efc09c3e48f4a69cabf785e19 (diff) |
update the man pages
git-svn-id: svn://tug.org/texlive/trunk@7514 c570f23f-e606-0410-a88d-b1316a301751
-rw-r--r-- | Master/tlpkg/man/TeXLive-TLPDB.1 | 162 | ||||
-rw-r--r-- | Master/tlpkg/man/TeXLive-TLUtils.1 | 92 |
2 files changed, 200 insertions, 54 deletions
diff --git a/Master/tlpkg/man/TeXLive-TLPDB.1 b/Master/tlpkg/man/TeXLive-TLPDB.1 index c8bbb500470..cdb4f23d25b 100644 --- a/Master/tlpkg/man/TeXLive-TLPDB.1 +++ b/Master/tlpkg/man/TeXLive-TLPDB.1 @@ -128,8 +128,8 @@ .rm #[ #] #H #V #F C .\" ======================================================================== .\" -.IX Title "TeXLive::TLPDB 3" -.TH TeXLive::TLPDB 3 "2007-11-03" "perl v5.8.8" "User Contributed Perl Documentation" +.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" @@ -140,20 +140,34 @@ .PP .Vb 2 \& TeXLive::TLPDB\->new (); -\& TeXLive::TLPDB\->new (location => "/path/to/texlive.tlpdb"); +\& TeXLive::TLPDB\->new (root => "/path/to/texlive/installation/root"); .Ve .PP -.Vb 10 -\& $tlpdb\->location("/path/to/texlive.tlpdb"); +.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_objpkg($tlpobj); +\& $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 @@ -166,24 +180,33 @@ .el .IP "\f(CWTeXLive::TLPDB\->new\fR" 6 .IX Item "TeXLive::TLPDB->new" .PD 0 -.ie n .IP """TeXLive::TLPDB\->new(location => ""$filename"")""" 6 -.el .IP "\f(CWTeXLive::TLPDB\->new(location => ``$filename'')\fR" 6 -.IX Item "TeXLive::TLPDB->new(location => ""$filename"")" +.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`location\*(C'\fR is given it will be initialized from this -location. \f(CW$filename\fR is usually \f(CW\*(C`/path/to/texlive.tlpdb\*(C'\fR. 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 +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 -location was not given at generation time. If \f(CW$filename\fR begins +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 @@ -207,6 +230,18 @@ as location. If the location is undefined, die. 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"")" @@ -216,6 +251,19 @@ in case its name the the argument name coincide. .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"")" @@ -224,8 +272,10 @@ 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 lists all available \s-1TL\s0 Packages together -with their revisions. +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" @@ -236,17 +286,89 @@ with their revisions. .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\->location(""/path/to/texlive.tlpdb"")""" 6 -.el .IP "\f(CW$tlpdb\->location(``/path/to/texlive.tlpdb'')\fR" 6 -.IX Item "$tlpdb->location(""/path/to/texlive.tlpdb"")" -The function \f(CW\*(C`location\*(C'\fR allows to read and set the location of the -text file of the TeX Live database, by default named \f(CW\*(C`texlive.tlpdb\*(C'\fR. +.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 diff --git a/Master/tlpkg/man/TeXLive-TLUtils.1 b/Master/tlpkg/man/TeXLive-TLUtils.1 index 95689741589..cf57150e10b 100644 --- a/Master/tlpkg/man/TeXLive-TLUtils.1 +++ b/Master/tlpkg/man/TeXLive-TLUtils.1 @@ -128,10 +128,10 @@ .rm #[ #] #H #V #F C .\" ======================================================================== .\" -.IX Title "TeXLive::TLUtils 3" -.TH TeXLive::TLUtils 3 "2008-01-10" "perl v5.8.8" "User Contributed Perl Documentation" +.IX Title "tlpkg::TeXLive::TLUtils 3" +.TH tlpkg::TeXLive::TLUtils 3 "2008-04-19" "perl v5.8.8" "User Contributed Perl Documentation" .SH "NAME" -\&\f(CW\*(C`TeXLive::TLUtils\*(C'\fR \-\- Utilities used in the TeX Live Infrastructure Modules +\&\f(CW\*(C`TeXLive::TLUtils\*(C'\fR \-\- utilities used in the TeX Live infrastructure .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 @@ -155,36 +155,38 @@ .Ve .Sh "File Utulities" .IX Subsection "File Utulities" -.Vb 5 +.Vb 7 \& TeXLive::TLUtils::dirname($path); \& TeXLive::TLUtils::basename($path); \& TeXLive::TLUtils::dirname_and_basename($path); \& TeXLive::TLUtils::mkdirhier($path); \& TeXLive::TLUtils::copy($file, $target_dir); +\& TeXLive::TLUtils::download_file( $path, $destination [, $progs ] ); +\& TeXLive::TLUtils::setup_programs( $bindir, $platform); .Ve .Sh "Installer Functions" .IX Subsection "Installer Functions" -.Vb 11 +.Vb 9 \& TeXLive::TLUtils::media; \& TeXLive::TLUtils::initialze_installer; -\& TeXLive::TLUtils::architectures_available; -\& TeXLive::TLUtils::additional_architectures_available_from_net; \& TeXLive::TLUtils::make_var_skeleton($path); \& TeXLive::TLUtils::make_local_skeleton($path); \& TeXLive::TLUtils::create_fmtutil($tlpdb,$dest,$localconf); \& TeXLive::TLUtils::create_updmap($tlpdb,$dest,$localconf); \& TeXLive::TLUtils::create_language($tlpdb,$dest,$localconf); -\& TeXLive::TLUtils::install_packages($from_tlpdb,$to_tlpdb,@list); +\& TeXLive::TLUtils::install_packages($from_tlpdb,$to_tlpdb,$what,$opt_src, $opt_doc)>); \& TeXLive::TLUtils::install_package($what, $filelistref, $target, $platform); .Ve .Sh "Miscellaneous" .IX Subsection "Miscellaneous" -.Vb 5 +.Vb 7 \& TeXLive::TLUtils::sort_uniq(@list); \& TeXLive::TLUtils::push_uniq(\e@list, @items); \& TeXLive::TLUtils::member($item, @list); \& TeXLive::TLUtils::tllog($level, $string); +\& TeXLive::TLUtils::texdir_check($texdir); \& TeXLive::TLUtils::kpsewhich; +\& TeXLive::TLUtils::conv_to_win_path($path); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" @@ -287,17 +289,14 @@ return '\f(CW\*(C`true\*(C'\fR' and symlinks will be copied as regular files. \&\f(CW\*(C`copy\*(C'\fR invokes \f(CW\*(C`mkdirhier\*(C'\fR if target directories do not exist. Files have mode \f(CW0777\fR\-\fIumask\fR if they are executable and \&\f(CW0666\fR\-\fIumask\fR otherwise. -.ie n .IP """install_packages($from_tlpdb, $to_tlpdb, $what, $netarchsref, $opt_src, $opt_doc)""" 6 -.el .IP "\f(CWinstall_packages($from_tlpdb, $to_tlpdb, $what, $netarchsref, $opt_src, $opt_doc)\fR" 6 -.IX Item "install_packages($from_tlpdb, $to_tlpdb, $what, $netarchsref, $opt_src, $opt_doc)" -Installs the list of packages found in \f(CW@$what\fR (a ref to a list) into +.ie n .IP """install_packages($from_tlpdb, $to_tlpdb, $what, $opt_src, $opt_doc)""" 6 +.el .IP "\f(CWinstall_packages($from_tlpdb, $to_tlpdb, $what, $opt_src, $opt_doc)\fR" 6 +.IX Item "install_packages($from_tlpdb, $to_tlpdb, $what, $opt_src, $opt_doc)" +Installs the list of packages found in \f(CW@$what\fR (a ref to a list) into the \s-1TLPDB\s0 given by \f(CW$to_tlpdb\fR. Information on files are taken from the \s-1TLPDB\s0 \f(CW$from_tlpdb\fR. .Sp -\&\f(CW$netarchrefs\fR is a reference to a list of arch/os combination which should -be installed from the network. -.Sp -\&\f(CW$opt_src\fR and \f(CW$opt_doc\fR specify whether srcfiles and docfiles should be +\&\f(CW$opt_src\fR and \f(CW$opt_doc\fR specify whether srcfiles and docfiles should be installed (currently implemented only for installation from \s-1DVD\s0). .ie n .IP """install_package($what, $filelistref, $target, $platform)""" 6 .el .IP "\f(CWinstall_package($what, $filelistref, $target, $platform)\fR" 6 @@ -319,6 +318,32 @@ piped through \f(CW\*(C`lzmadec\*(C'\fR and \f(CW\*(C`tar\*(C'\fR in the very sa .Sp In both of the last cases currently the list \f(CW$@filelistref\fR currently is not taken into account (should be fixed!). +.ie n .IP """setup_programs( $bindir, $platform )""" 6 +.el .IP "\f(CWsetup_programs( $bindir, $platform )\fR" 6 +.IX Item "setup_programs( $bindir, $platform )" +Sets up the global \f(CW$::progs\fR hash containing the pathes to the +programs \f(CW\*(C`wget\*(C'\fR, \f(CW\*(C`tar\*(C'\fR, \f(CW\*(C`lzmadec\*(C'\fR. The \f(CW$bindir\fR argument specifies +the path to the location of the \f(CW\*(C`lzmadec\*(C'\fR binaries, the \f(CW$platform\fR +gives the extension for the \f(CW\*(C`lzmadec\*(C'\fR binary. +.ie n .IP """download_file( $path, $destination [, $progs ] )""" 6 +.el .IP "\f(CWdownload_file( $path, $destination [, $progs ] )\fR" 6 +.IX Item "download_file( $path, $destination [, $progs ] )" +Try to download the file given in \f(CW$relpath\fR from either \f(CW$TeXLiveURL\fR +or \f(CW\*(C`TeXLiveAlternativeURL\*(C'\fR into \f(CW$destination\fR, which can be either +a filename of simply \f(CW\*(C`|\*(C'\fR. In the latter case a file handle is returned. +.Sp +The optional argument \f(CW$progs\fR is a reference to a hash giving full pathes +to the respective programs, at least \f(CW\*(C`wget\*(C'\fR. In case that \f(CW$progs\fR is not +given the \f(CW%::progs\fR is consulted, and if this also does not exist we +try \*(L"wget\*(R". +.Sp +Downloading honors two environment variables \f(CW\*(C`TL_DOWNLOAD_PROGRAM\*(C'\fR and +\&\f(CW\*(C`TL_DOWNLOAD_ARGS\*(C'\fR. The former overrides \f(CW\*(C`wget\*(C'\fR (or what is given in the +\&\f(CW$progs\fR argument, the latter overrides the default wget arguments +given in \f(CW$TeXLive::TLConfig::DefaultWgetArgs\fR. +.Sp +\&\f(CW\*(C`TL_DOWNLOAD_ARGS\*(C'\fR must be set up in a way that the place the output should +go to is the first argument after the \f(CW\*(C`TL_DOWNLOAD_ARGS\*(C'\fR. Use with care. .Sh "Installer Functions" .IX Subsection "Installer Functions" .ie n .IP """media""" 6 @@ -339,19 +364,6 @@ Note that \f(CW$0\fR contains backslashes as path separators on Windows. .Sp Repeatedly calls to \f(CW\*(C`media\*(C'\fR or \f(CW\*(C`platform\*(C'\fR do not access the \s-1CD/DVD\s0 again. -.ie n .IP """architectures_available""" 6 -.el .IP "\f(CWarchitectures_available\fR" 6 -.IX Item "architectures_available" -The function \f(CW\*(C`architectures_available\*(C'\fR returns a list of -supported platforms. -.ie n .IP """additional_architectures_available_from_net (\e%vars)""" 6 -.el .IP "\f(CWadditional_architectures_available_from_net (\e%vars)\fR" 6 -.IX Item "additional_architectures_available_from_net (%vars)" -The function \f(CW\*(C`additional_architectures_available_from_net\*(C'\fR returns a -list of additional platforms supported by the TeX Live server. It -downloads the file \f(CW\*(C`$::texlive_url/$::netarchive/texlive.pkgver\*(C'\fR and -creates a new object c<$::tlpdb_netbin>. The argument is a reference of -the global \f(CW%vars\fR hash. .ie n .IP """make_var_skeleton($prefix)""" 6 .el .IP "\f(CWmake_var_skeleton($prefix)\fR" 6 .IX Item "make_var_skeleton($prefix)" @@ -372,13 +384,13 @@ Generate a skeleton of empty directories in the \f(CW\*(C`TEXMFLOCAL\*(C'\fR tre .IX Item "create_language($tlpdb, $dest, $localconf)" .PD These three functions create \f(CW\*(C`fmtutil.cnf\*(C'\fR, \f(CW\*(C`updmap.cfg\*(C'\fR, and -\&\f(CW\*(C`language.dat\*(C'\fR in in \f(CW$dest\fR (which by default is below +\&\f(CW\*(C`language.dat\*(C'\fR, respectively, in \f(CW$dest\fR (which by default is below \&\f(CW$TEXMFSYSVAR\fR). These functions merge the information present in the \&\s-1TLPDB\s0 \f(CW$tlpdb\fR (formats, maps, hyphenations) with local configuration additions: \f(CW$localconf\fR. .Sp Currently the \*(L"merging\*(R" is done trivially by appending the content of -the local configuration files at the end of the file. This could be +the local configuration files at the end of the file. This should be improved (checking for duplicates). .Sh "Miscellaneous" .IX Subsection "Miscellaneous" @@ -398,6 +410,11 @@ by the first argument. .IX Item "member($item, @list)" The \f(CW\*(C`member\*(C'\fR function returns true if the the first argument is contained in the list of the remaining arguments. +.ie n .IP """texdir_check($texdir)""" 6 +.el .IP "\f(CWtexdir_check($texdir)\fR" 6 +.IX Item "texdir_check($texdir)" +Test whether installation with \s-1TEXDIR\s0 set to \f(CW$texdir\fR would succeed due to +writing permissions. .ie n .IP """tllog($type, $rest, ...)""" 6 .el .IP "\f(CWtllog($type, $rest, ...)\fR" 6 .IX Item "tllog($type, $rest, ...)" @@ -423,11 +440,18 @@ If you want to disable logging set the respective thershold to \f(CW$::LOG_ZERO\ .el .IP "\f(CWkpsewhich($varname)\fR" 6 .IX Item "kpsewhich($varname)" This function expands the variable name using kpsewhich. The variable -name should not have a leading $. The kpsewhich binary has to be in +name should not have a leading $. The kpsewhich binary has to be in the path. +.ie n .IP """conv_to_win_path($path)""" 6 +.el .IP "\f(CWconv_to_win_path($path)\fR" 6 +.IX Item "conv_to_win_path($path)" +This function returns a \*(L"windowsified\*(R" path, i.e., replacing all forward +slashes to backslashes, and adding additional " around (in case of spaces +in \f(CW$path\fR). Furthermore it makes the path absolute. So if \f(CW$path\fR does not +start with an arbitrary char followed by : we add the output of `cd`. .SH "SEE ALSO" .IX Header "SEE ALSO" -The modules TeXLive::TLPSRC, TeXLive::TLPOBJ, +The modules TeXLive::TLPSRC, TeXLive::TLPOBJ, TeXLive::TLPDB, TeXLive::TLTREE, and the document Perl\-API.txt and the specification in the TeX Live repository trunk/Master/tlpkg/doc/. |