From d78671b834cc3819f5822260d1faa415ecec0867 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Mon, 31 Mar 2008 18:51:12 +0000 Subject: handle mkjobtexmf through our script mechanism instead of building git-svn-id: svn://tug.org/texlive/trunk@7262 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/generic/mkjobtexmf/README | 48 + .../doc/generic/mkjobtexmf/mkjobtexmf.html | 385 ++++ .../doc/generic/mkjobtexmf/mkjobtexmf.ltx | 52 + .../doc/generic/mkjobtexmf/mkjobtexmf.man | 407 ++++ .../doc/generic/mkjobtexmf/mkjobtexmf.pdf | Bin 0 -> 107050 bytes .../doc/generic/mkjobtexmf/mkjobtexmf.txt | 255 +++ Master/texmf-dist/scripts/mkjobtexmf/mkjobtexmf.pl | 799 +++++++ .../source/generic/mkjobtexmf/Makefile.in | 96 + .../texmf-dist/source/generic/mkjobtexmf/configure | 2179 ++++++++++++++++++++ .../source/generic/mkjobtexmf/configure.ac | 16 + .../source/generic/mkjobtexmf/install-sh | 294 +++ Master/tlpkg/bin/ctan2tds | 5 +- Master/tlpkg/bin/tlpkg-ctan-check | 2 +- Master/tlpkg/tlpsrc/bin-mkjobtexmf.tlpsrc | 4 - Master/tlpkg/tlpsrc/collection-binextra.tlpsrc | 2 +- Master/tlpkg/tlpsrc/mkjobtexmf.tlpsrc | 4 + TODO | 1 + 17 files changed, 4542 insertions(+), 7 deletions(-) create mode 100644 Master/texmf-dist/doc/generic/mkjobtexmf/README create mode 100644 Master/texmf-dist/doc/generic/mkjobtexmf/mkjobtexmf.html create mode 100644 Master/texmf-dist/doc/generic/mkjobtexmf/mkjobtexmf.ltx create mode 100644 Master/texmf-dist/doc/generic/mkjobtexmf/mkjobtexmf.man create mode 100644 Master/texmf-dist/doc/generic/mkjobtexmf/mkjobtexmf.pdf create mode 100644 Master/texmf-dist/doc/generic/mkjobtexmf/mkjobtexmf.txt create mode 100644 Master/texmf-dist/scripts/mkjobtexmf/mkjobtexmf.pl create mode 100644 Master/texmf-dist/source/generic/mkjobtexmf/Makefile.in create mode 100644 Master/texmf-dist/source/generic/mkjobtexmf/configure create mode 100644 Master/texmf-dist/source/generic/mkjobtexmf/configure.ac create mode 100644 Master/texmf-dist/source/generic/mkjobtexmf/install-sh delete mode 100644 Master/tlpkg/tlpsrc/bin-mkjobtexmf.tlpsrc create mode 100644 Master/tlpkg/tlpsrc/mkjobtexmf.tlpsrc diff --git a/Master/texmf-dist/doc/generic/mkjobtexmf/README b/Master/texmf-dist/doc/generic/mkjobtexmf/README new file mode 100644 index 00000000000..022057eff50 --- /dev/null +++ b/Master/texmf-dist/doc/generic/mkjobtexmf/README @@ -0,0 +1,48 @@ +README for mkjobtexmf 2007/09/06 v0.5 + +Copyright 2007 by Heiko Oberdiek + +License +======= +The file is part of project mkjobtexmf. +It's free software; you may redistribute it and/or +modify it under the same terms as Perl itself +(Perl Artistic License/GNU General Public License, version 2). + +Requirements +============ +* Perl + +Documentation +============= +The source of the documentation is embedded as POD data +in the Perl script mkjobtexmf.pl. The documentation is +available in various formats: +* Manual page: mkjobtexmf.man +* PDF file: mkjobtexmf.pdf +* HTML file: mkjobtexmf.html +* Text file: mkjobtexmf.txt +And program option --man displays the documentation on +the screen. + +Installation +============ +* Unix: + GNU autoconf was used, thus you can try: + ./configure + make install + It should install the script and manual page. + The other documentation files can be installed manually. + +* Manually: + * mkjobtexmf.pl: Install the file as `mkjobtexmf' in a directory + that is listed in environment variable `PATH', e.g. + /usr/local/bin/mkjobtexmf + * mkjobtexmf.man: Install the manual page as `mkjobtexmf.1' + in the appropriate directory, e.g.: + /usr/local/man/man1/mkjobtexmf.1 + * mkjobtexmf.pdf, mkjobtexmf.html, mkjobtexmf.html, README: + Install them where you find them, for example in directory: + /usr/local/share/doc/mkjobtexmf/ + +See the documentation for further information. diff --git a/Master/texmf-dist/doc/generic/mkjobtexmf/mkjobtexmf.html b/Master/texmf-dist/doc/generic/mkjobtexmf/mkjobtexmf.html new file mode 100644 index 00000000000..18ba07e8b89 --- /dev/null +++ b/Master/texmf-dist/doc/generic/mkjobtexmf/mkjobtexmf.html @@ -0,0 +1,385 @@ + + + +mkjobtexmf -- Generate a texmf tree for a particular job + + + + + +

+ + + + + +
+

+

+

NAME

+

mkjobtexmf -- Generate a texmf tree for a particular job

+

+

+
+

SYNOPSIS

+

The progam mkjobtexmf runs a program and tries to +find the used file names. Two methods are available, +option -recorder of TeX (Web2C) or the program strace.

+

Then it generates a directory with a texmf tree. It checks +the found files and tries sort them in this texmf tree.

+

It can be used for archiving purposes or to speed up +following TeX runs.

+
+    mkjobtexmf [options]
+

This runs TeX that can be configured by options. +Both methods for getting the used file names are available.

+
+    mkjobtexmf [options] -- <cmd> [args]
+

The latter form runs program cmd with arguments args +instead of TeX. As method only program strace is available.

+

Options:

+
+    --jobname <name>       Name of the job (mandatory).
+                              Usually this is the TeX file
+                              without extension
+    --texname <file>       Input file for TeX. Default is the
+                              job name with extension '.tex'
+    --texopt <option>      Option for TeX run
+    --destdir <directory>  Destination directory,
+                              default is `<jobname>.mjt'
+    --output               Add also output files
+    --strace               Use strace instead of TeX's
+                              option -recorder
+    --copy                 Copy files instead of creating
+                              symbol links
+    --flat                 Junk paths, do not make directories
+                              inside the destination directory
+    --cmd-tex <cmd>        Command for the TeX compiler
+    --cmd-kpsewhich <cmd>  Command for kpsewhich
+    --cmd-texhash <cmd>    Command for texhash
+    --cmd-strace <cmd>     Command for strace
+    --verbose              Verbose output
+    --help                 Brief help message
+    --man                  Full documentation
+

+

+
+

DESCRIPTION

+

+

+

Running the program

+

First mkjobtexmf runs a program, usually TeX. The TeX compiler +is configured by option --cmd-tex. Option --texname can +be used, if the file name extension differs from .tex:

+
+    mkjobtexmf --jobname foo --texname foo.ltx
+

Even more complicate cases are possible:

+
+    mkjobtexmf --jobname foo --texname '\def\abc{...}\input{foo}'
+

If another program than TeX should be used (dvips, ...), +then this program can be given after --:

+
+    mkjobtexmf --jobname foo -- dvips foo
+

+

+

File recording

+

Two methods are available to get the used file names:

+
+
Recorder of TeX
+
+
+Some TeX distributions (e.g. Web2C) support the option -recorder +for its TeX compilers. Then the TeX compiler generates a file with +extension .fls that records the used input and output files. +
+

+
Program strace
+
+
+This program traces system calls and signals. It is used here +to log the used files. +
+

+

+

+

Analyze and link/copy found files

+

The result directory jobname.mjt is generated. Inside the +result TEXMF tree is created. Each found file is compared against +a list of paths of TEXMF trees. If a match is found, the file is +linked/copied into the TEXMF tree. The list of paths is generated by +program kpsewhich.

+

If the file cannot be mapped to a TEXMF tree and the file is +a relative file name, then it is directly linked/copied into the +result directory jobname.mjt. Absolute file names +are not supported and neither paths with links to parent directories.

+

Symbolic links are created by default. The files are copied +if option --copy is given or symbolic linking is not available.

+

+

+
+

OPTIONS

+
+
--jobname=jobname
+
+
+It is the name of the job. `<jobname>.tex' serves as default for +the TeX file and <jobname> is used for naming various directories +and files. See section FILES. +
+

+
--texname=name
+
+
+The name of the TeX input file, if it differs from <jobname>.tex. +
+

+
--texopt=opt
+
+
+Additional option for the TeX compiler, examples are --ini or +--shell-escape. This option can be given more than once. +
+

+
--destdir=directory
+
+
+Specifies the name of the destination directory where the result +is collected. As default a directory is generated in the current +directory with the job name and extension `.mjt'. +
+

+
--output
+
+
+Also add output files. +
+

+
--strace
+
+
+Use method with program strace, see DESCRIPTION. +
+

+
--copy
+
+
+Files are copied instead of creating symbolic links. +
+

+
--flat
+
+
+Files are linked or copied without path elements. +The destination directory will contain a flat list of +files or links without directory. +
+
+

The files `ls-R' and `aliases' are ignored.

+
+

+
--cmd-tex=cmd
+
+
+Command for the TeX compiler. Default is pdflatex. +
+

+
--cmd-kpsewhich=cmd
+
+
+Command for kpsewhich. +
+

+
--cmd-texhash=cmd
+
+
+Command for updating the file name database of the generated +texmf tree. Default is texmf. +
+

+
--cmd-strace=cmd
+
+
+Command for strace. +
+

+
--verbose
+
+
+Verbose messages. +
+

+
--help
+
+
+Display help screen. +
+

+

+

+
+

EXAMPLES

+

TeX file test.tex using TeX's recorder method:

+
+    mkjobtexmf --jobname test
+

TeX file test.tex using LaTeX:

+
+    mkjobtexmf --jobname test --cmd-tex latex
+

Format generation:

+
+    mkjobtexmf --jobname test --texopt -ini --texname pdflatex.ini
+

Example, how the new texmf tree (Linux/bash) can be used:

+
+    TEXMF=!!test.mjt/texmf pdflatex test
+

Example for generating a zip archive (Linux/bash):

+
+    (cd test.mjt && zip -9r ../test .)
+

Example for generating a tar archive:

+
+    tar cjhvf test.tar.bz2 -C test.mjt .
+

+

+
+

UNSOLVED ISSUES, CAVEATS, TODOS

+
+
Experimental software
+
+
+Options, defaults, how the program works might change in +future versions. +
+

+
texmf.cnf
+
+
+Currently the method with strace records this files. +TeX's recorder does not. Useful are texmf.cnf files for +variable settings. Because we have just one TEXMF tree, +the path sections should probably rewritten. +
+

+
Settings in environment variables
+
+
+They are not stored at all. +
+

+
Collisions
+
+
+The program uses one destination directory and at most +one TEXMF tree for the result. However, the source files +can come from different directories and TEXMF trees. +Therefore name collisions are possible. +
+
+

The program follows the strategy not to delete files +in the destination directory. That allows to collect files +from differnt runs. Thus collisions are resolved +in the manner that the first entry that is made in +the destination directory wins.

+
+

+
Configuration file
+
+
+It would save the user from retyping the same options again and again. +
+

+
Uncomplete recording
+
+
+Bugs in TeX's file recording might result in incomplete +file recording (e.g. pdfTeX 1.40.3 does not record .pfb and +.pk files). +
+

+
...
+
+
+

+

+
+

FILES

+
+
<jobname>.mjt/
+
+
+Directory where the resulting texmf tree and symbol links +are stored. It can be changed by option --destdir. +
+

+
<jobname>.fls
+
+
+Name of TeX's recorder file. +
+

+
<jobname>.strace
+
+
+Log file where the result of strace is stored. +
+

+

+

+
+

AUTHOR

+

Heiko Oberdiek, email: oberdiek at uni-freiburg.de

+

+

+
+

COPYRIGHT AND LICENSE

+

Copyright 2007 by Heiko Oberdiek.

+

This library is free software; you may redistribute it and/or +modify it under the same terms as Perl itself +(Perl Artistic License/GNU General Public License, version 2).

+

+

+
+

HISTORY

+
    +
  1. /04/16 v0.1
    +
  2. +* First experimental version. +

    +
  3. /05/09 v0.2
    +
  4. +* Typo in option name fixed. +

    +
  5. /09/03 v0.3
    +
  6. +* New options: --copy, --flat, --destdir +

    +
  7. /09/04 v0.4
    +
  8. +* Bug fix in map_files_texmf. +

    +
  9. /09/06 v0.5
    +
  10. +* Support for `configure' added. + (Thanks to Norbert Preining for writing a first version of + the configure stuff.) +

+ + + + diff --git a/Master/texmf-dist/doc/generic/mkjobtexmf/mkjobtexmf.ltx b/Master/texmf-dist/doc/generic/mkjobtexmf/mkjobtexmf.ltx new file mode 100644 index 00000000000..ce4e37a6d0b --- /dev/null +++ b/Master/texmf-dist/doc/generic/mkjobtexmf/mkjobtexmf.ltx @@ -0,0 +1,52 @@ +% mkjobtexmf.ltx +% +% Copyright 2007 by Heiko Oberdiek. +% +% The file is part of project mkjobtexmf. +% It's free software; you may redistribute it and/or +% modify it under the same terms as Perl itself +% (Perl Artistic License/GNU General Public License, version 2). + +\documentclass[a4paper]{article} + +\providecommand*{\DATE}{2007/09/06} +\providecommand*{\VERSION}{0.5} + +\usepackage{makeidx} +\makeindex + +\usepackage{hyperref} +\hypersetup{ + colorlinks, + pdfauthor={Heiko Oberdiek}, + pdftitle={mkjobtexmf}, +} + +\usepackage{bookmark} +\bookmarksetup{ + open, +} + +\author{Heiko Oberdiek} +\title{Program \textsf{mkjobtexmf}} +\date{\DATE\space v\VERSION} + +\makeatletter +\let\org@section\section +\def\section{\@ifstar\org@section\org@section} +\makeatother + +% ignore minor overfull \hbox warnings +\setlength{\hfuzz}{1.5pt} + +\begin{document} + +\maketitle + +\tableofcontents + +\input{mkjobtexmf.tex} + +\printindex + +\end{document} diff --git a/Master/texmf-dist/doc/generic/mkjobtexmf/mkjobtexmf.man b/Master/texmf-dist/doc/generic/mkjobtexmf/mkjobtexmf.man new file mode 100644 index 00000000000..58086652c0e --- /dev/null +++ b/Master/texmf-dist/doc/generic/mkjobtexmf/mkjobtexmf.man @@ -0,0 +1,407 @@ +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.13 +.\" +.\" 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. | will give a +.\" real vertical bar. \*(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-|\(bv\*(Tr +.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 "MKJOBTEXMF 1" +.TH MKJOBTEXMF 1 "2007-09-06" "perl v5.8.1" "User Contributed Perl Documentation" +.SH "NAME" +mkjobtexmf \-\- Generate a texmf tree for a particular job +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +The progam \fBmkjobtexmf\fR runs a program and tries to +find the used file names. Two methods are available, +option \f(CW\*(C`\-recorder\*(C'\fR of TeX (Web2C) or the program \fBstrace\fR. +.PP +Then it generates a directory with a texmf tree. It checks +the found files and tries sort them in this texmf tree. +.PP +It can be used for archiving purposes or to speed up +following TeX runs. +.PP +.Vb 1 +\& mkjobtexmf [options] +.Ve +.PP +This runs TeX that can be configured by options. +Both methods for getting the used file names are available. +.PP +.Vb 1 +\& mkjobtexmf [options] -- [args] +.Ve +.PP +The latter form runs program \fIcmd\fR with arguments \fIargs\fR +instead of TeX. As method only program \fBstrace\fR is available. +.PP +Options: +.PP +.Vb 22 +\& --jobname Name of the job (mandatory). +\& Usually this is the TeX file +\& without extension +\& --texname Input file for TeX. Default is the +\& job name with extension '.tex' +\& --texopt