path: root/Master/tlpkg/man/TeXLive-TLUtils.1

.\" 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 "TeXLive::TLUtils 3"
.TH TeXLive::TLUtils 3 "2008-01-10" "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
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use TeXLive::TLUtils;
.Ve
.Sh "Platform Detection"
.IX Subsection "Platform Detection"
.Vb 4
\&  TeXLive::TLUtils::platform;
\&  TeXLive::TLUtils::platform_desc($platform);
\&  TeXLive::TLUtils::win32;
\&  TeXLive::TLUtils::unix;
.Ve
.Sh "System Tools"
.IX Subsection "System Tools"
.Vb 4
\&  TeXLive::TLUtils::getenv($string);
\&  TeXLive::TLUtils::which($string);
\&  TeXLive::TLUtils::program_exists($program);
\&  TeXLive::TLUtils::get_system_tmpdir;
.Ve
.Sh "File Utulities"
.IX Subsection "File Utulities"
.Vb 5
\&  TeXLive::TLUtils::dirname($path);
\&  TeXLive::TLUtils::basename($path);
\&  TeXLive::TLUtils::dirname_and_basename($path);
\&  TeXLive::TLUtils::mkdirhier($path);
\&  TeXLive::TLUtils::copy($file, $target_dir);
.Ve
.Sh "Installer Functions"
.IX Subsection "Installer Functions"
.Vb 11
\&  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_package($what, $filelistref, $target, $platform);
.Ve
.Sh "Miscellaneous"
.IX Subsection "Miscellaneous"
.Vb 5
\&  TeXLive::TLUtils::sort_uniq(@list);
\&  TeXLive::TLUtils::push_uniq(\e@list, @items);
\&  TeXLive::TLUtils::member($item, @list);
\&  TeXLive::TLUtils::tllog($level, $string);
\&  TeXLive::TLUtils::kpsewhich;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
.Sh "Platform Detection"
.IX Subsection "Platform Detection"
.ie n .IP """platform""" 6
.el .IP "\f(CWplatform\fR" 6
.IX Item "platform"
If \f(CW\*(C`$^O=~/MSWin(32|64)$/i\*(C'\fR is true we know that we're on
Windows and we set the global variable \f(CW$::_platform_\fR to \f(CW\*(C`win32\*(C'\fR.
Otherwise we call \f(CW\*(C`config.guess\*(C'\fR.  The output of \f(CW\*(C`config.guess\*(C'\fR
is filtered as described below.
.Sp
\&\s-1CPU\s0 type is determined by a regexp.  And it's necessary to
\&\f(CW\*(C`s/i.86/i386/\*(C'\fR.
.Sp
For \s-1OS\s0 we need a list because we probably have something like
\&\f(CW\*(C`linux\-gnu\*(C'\fR but we need \f(CW\*(C`linux\*(C'\fR.  This list might/should contain OSs
which are not currently supported.  The list currently supports all
platforms supported by TeX Live 2007 plus Cygwin.
.Sp
If a particular platform is not found in this list we use the regexp
\&\f(CW\*(C`/.*\-(.*$)/\*(C'\fR as a last resort and hope it provides something useful.
.Sp
The result is stored in a global variable \f(CW$::_platform_\fR.  If you call
\&\f(CW\*(C`platform\*(C'\fR repeatedly, only the first call of \f(CW\*(C`platform\*(C'\fR will access
the \s-1HD/CD/DVD\s0.
.ie n .IP """platform_desc($platform)""" 6
.el .IP "\f(CWplatform_desc($platform)\fR" 6
.IX Item "platform_desc($platform)"
Return a string which describes a particular platform.  Same as in TeX
Live 2007 but NetBSD added.
.ie n .IP """win32""" 6
.el .IP "\f(CWwin32\fR" 6
.IX Item "win32"
Return \f(CW1\fR if platform is Windows and \f(CW0\fR otherwise.
.ie n .IP """unix""" 6
.el .IP "\f(CWunix\fR" 6
.IX Item "unix"
Return \f(CW1\fR if platform is \s-1UNIX\s0 and \f(CW0\fR otherwise.
.Sh "System Tools"
.IX Subsection "System Tools"
.ie n .IP """getenv($string)""" 6
.el .IP "\f(CWgetenv($string)\fR" 6
.IX Item "getenv($string)"
Get an environment variable.  It is assumed that the environment
variable contains a path.  On Windows all backslashes are replaced by
forward slashes as required by Perl.  If this behavior is not desired,
use \f(CW$ENV{"$variable"}\fR instead.  \f(CW0\fR is returned if the
environment variable is not set.
.ie n .IP """which($string)""" 6
.el .IP "\f(CWwhich($string)\fR" 6
.IX Item "which($string)"
\&\f(CW\*(C`which\*(C'\fR does the same as the \s-1UNIX\s0 command \f(CWwhich(1)\fR, but it is
supposed to work on Windows too.  On Windows we have to try all the
extensions given in the \f(CW\*(C`PATHEXT\*(C'\fR environment variable.  We also try
without appending an extension because if \f(CW$string\fR comes from an
environment variable, an extension might aleady be present.
.ie n .IP """program_exists($program)""" 6
.el .IP "\f(CWprogram_exists($program)\fR" 6
.IX Item "program_exists($program)"
Return \f(CW1\fR if \f(CW$program\fR is in \f(CW\*(C`PATH\*(C'\fR and \f(CW0\fR otherwise.
.ie n .IP """get_system_tmpdir""" 6
.el .IP "\f(CWget_system_tmpdir\fR" 6
.IX Item "get_system_tmpdir"
Evaluate the environment variables \f(CW\*(C`TMPDIR\*(C'\fR, \f(CW\*(C`TMP\*(C'\fR, and \f(CW\*(C`TEMP\*(C'\fR in
order to find the system temporary directory.
.Sh "File Utulities"
.IX Subsection "File Utulities"
.ie n .IP """dirname($path)""" 6
.el .IP "\f(CWdirname($path)\fR" 6
.IX Item "dirname($path)"
Return \f(CW$path\fR with its trailing \f(CW\*(C`/component\*(C'\fR removed.
.ie n .IP """basename($path)""" 6
.el .IP "\f(CWbasename($path)\fR" 6
.IX Item "basename($path)"
Return \f(CW$path\fR with any leading directory components removed.
.ie n .IP """dirname_and_basename($path)""" 6
.el .IP "\f(CWdirname_and_basename($path)\fR" 6
.IX Item "dirname_and_basename($path)"
Return both \f(CW\*(C`dirname\*(C'\fR and \f(CW\*(C`basename\*(C'\fR.  Example:
.Sp
.Vb 1
\&  ($dirpart,$filepart) = dirname_and_basename ($path);
.Ve
.ie n .IP """mkdirhier($path, [$mode])""" 6
.el .IP "\f(CWmkdirhier($path, [$mode])\fR" 6
.IX Item "mkdirhier($path, [$mode])"
The function \f(CW\*(C`mkdirhier\*(C'\fR does the same as the \s-1UNIX\s0 command \f(CW\*(C`mkdir \-p\*(C'\fR.
The optional parameter sets the permission flags.
.ie n .IP """copy($file, $target_dir)""" 6
.el .IP "\f(CWcopy($file, $target_dir)\fR" 6
.IX Item "copy($file, $target_dir)"
Copy file \f(CW$file\fR to directory \f(CW$target_dir\fR.  No external programs
are involved.  Since we need \f(CW\*(C`sysopen()\*(C'\fR, the Perl module \f(CW\*(C`Fcntl.pm\*(C'\fR
is required.  The time stamps are preserved and symlinks are created
on \s-1UNIX\s0 systems.  On Windows, \f(CW\*(C`(\-l $file)\*(C'\fR will certainly never
return '\f(CW\*(C`true\*(C'\fR' and symlinks will be copied as regular files.
.Sp
\&\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 
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 
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
.IX Item "install_package($what, $filelistref, $target, $platform)"
This function installs the files given in @$filelistref from \f(CW$what\fR
into \f(CW$target\fR.
.Sp
If \f(CW$what\fR is a reference to a list of files then these files are
assumed to be readable and are copied to \f(CW$target\fR, creating dirs on
the way. In this case the list \f(CW@$filelistref\fR is not taken into
account.
.Sp
If \f(CW$what\fR starts with \f(CW\*(C`http://\*(C'\fR or \f(CW\*(C`ftp://\*(C'\fR then \f(CW$what\fR is
downloaded from the net and piped through c<lzmadec> and \f(CW\*(C`tar\*(C'\fR.
.Sp
If \f(CW$what\fR ends with \f(CW\*(C`.tar.lzma\*(C'\fR (but does not start with \f(CW\*(C`http://\*(C'\fR or
\&\f(CW\*(C`ftp://\*(C'\fR) it is assumed to be a readable file on the system and is
piped through \f(CW\*(C`lzmadec\*(C'\fR and \f(CW\*(C`tar\*(C'\fR in the very same way.
.Sp
In both of the last cases currently the list \f(CW$@filelistref\fR currently
is not taken into account (should be fixed!).
.Sh "Installer Functions"
.IX Subsection "Installer Functions"
.ie n .IP """media""" 6
.el .IP "\f(CWmedia\fR" 6
.IX Item "media"
Return media type.  Either \f(CW\*(C`CD\*(C'\fR, \f(CW\*(C`DVD\*(C'\fR, or \f(CW\*(C`NET\*(C'\fR.
.Sp
The result is stored in a global variable \f(CW$::_media_\fR.  If you call
\&\f(CW\*(C`media\*(C'\fR repeatedly, only the first call of \f(CW\*(C`media\*(C'\fR will access the
\&\s-1CD/DVD\s0.
.ie n .IP """initialize_installer""" 6
.el .IP "\f(CWinitialize_installer\fR" 6
.IX Item "initialize_installer"
The function \f(CW\*(C`initialize_installer\*(C'\fR calls \f(CW\*(C`media\*(C'\fR and \f(CW\*(C`platform\*(C'\fR in
order to set the variables \f(CW$::_media_\fR and \f(CW$::_platform_\fR.
.Sp
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)"
Generate a skeleton of empty directories in the \f(CW\*(C`TEXMFSYSVAR\*(C'\fR tree.
.ie n .IP """make_local_skeleton($prefix)""" 6
.el .IP "\f(CWmake_local_skeleton($prefix)\fR" 6
.IX Item "make_local_skeleton($prefix)"
Generate a skeleton of empty directories in the \f(CW\*(C`TEXMFLOCAL\*(C'\fR tree.
.ie n .IP """create_fmtutil($tlpdb, $dest, $localconf)""" 6
.el .IP "\f(CWcreate_fmtutil($tlpdb, $dest, $localconf)\fR" 6
.IX Item "create_fmtutil($tlpdb, $dest, $localconf)"
.PD 0
.ie n .IP """create_updmap($tlpdb, $dest, $localconf)""" 6
.el .IP "\f(CWcreate_updmap($tlpdb, $dest, $localconf)\fR" 6
.IX Item "create_updmap($tlpdb, $dest, $localconf)"
.ie n .IP """create_language($tlpdb, $dest, $localconf)""" 6
.el .IP "\f(CWcreate_language($tlpdb, $dest, $localconf)\fR" 6
.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$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
improved (checking for duplicates).
.Sh "Miscellaneous"
.IX Subsection "Miscellaneous"
Ideas from Fabrice Popineau's \f(CW\*(C`FileUtils.pm\*(C'\fR.
.ie n .IP """sort_uniq(@list)""" 6
.el .IP "\f(CWsort_uniq(@list)\fR" 6
.IX Item "sort_uniq(@list)"
The \f(CW\*(C`sort_uniq\*(C'\fR function sorts the given array and throws away multiple
occurrences of elements. It returns a sorted and unified array.
.ie n .IP """push_uniq(\e@list, @items)""" 6
.el .IP "\f(CWpush_uniq(\e@list, @items)\fR" 6
.IX Item "push_uniq(@list, @items)"
The \f(CW\*(C`push_uniq\*(C'\fR function pushes the last elements on the list referenced
by the first argument.
.ie n .IP """member($item, @list)""" 6
.el .IP "\f(CWmember($item, @list)\fR" 6
.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 """tllog($type, $rest, ...)""" 6
.el .IP "\f(CWtllog($type, $rest, ...)\fR" 6
.IX Item "tllog($type, $rest, ...)"
Debugging output is controlled by 2 global variables: \f(CW$::LOGLEVELTERMINAL\fR
for the output to the terminal, and \f(CW$::LOGLEVELFILE\fR for the output to
the log file (whose filehandle should be saved in \f(CW$::LOGFILE\fR).
.Sp
If the first argument of \f(CW\*(C`tllog\*(C'\fR is less or equal to the respective
threshold the message is issued to \s-1STDERR\s0 and log file, respectively.
.Sp
If \f(CW$::LOGFILE\fR is not defined logging to a log file is completely disabled.
.Sp
Predefined levels of debugging are: \f(CW$::LOG_NORMAL\fR, \f(CW$::LOG_DEBUG\fR, \f(CW$::LOG_DDEBUG\fR,
and \f(CW$::LOG_DDDEBUG\fR with increasing level of detailedness.
.Sp
Note that all TeXLive modules to logging with \f(CW$::LOG_DDDEBUG\fR!
.Sp
By default the threshold for logging to the log file is \f(CW$::LOG_DEBUG\fR, and
the one for the terminal \f(CW$::LOG_NORMAL\fR.
.Sp
If you want to disable logging set the respective thershold to \f(CW$::LOG_ZERO\fR.
.ie n .IP """kpsewhich($varname)""" 6
.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 
the path.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
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/.
.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.