From beecf3581db48212d3001b8158c53125225654a7 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Sun, 3 Feb 2019 00:00:35 +0000 Subject: review and update tlbuild doc git-svn-id: svn://tug.org/texlive/trunk@49914 c570f23f-e606-0410-a88d-b1316a301751 --- Build/source/doc/build-tools.txt | 2 +- Build/source/doc/tlbuild.info | 1569 ++++++++++++++++++++------------------ Build/source/doc/tlbuild.texi | 789 ++++++++++--------- 3 files changed, 1234 insertions(+), 1126 deletions(-) diff --git a/Build/source/doc/build-tools.txt b/Build/source/doc/build-tools.txt index b2609cab0fd..c457421fb17 100644 --- a/Build/source/doc/build-tools.txt +++ b/Build/source/doc/build-tools.txt @@ -1,6 +1,6 @@ autoconf (GNU Autoconf) 2.69 automake (GNU automake) 1.16.1 -bison (GNU Bison) 3.2.3 +bison (GNU Bison) 3.3.1 flex 2.6.0 ltmain.sh (GNU libtool) 2.4.6 m4 (GNU M4) 1.4.18 diff --git a/Build/source/doc/tlbuild.info b/Build/source/doc/tlbuild.info index 29161b26577..f94c76f34b1 100644 --- a/Build/source/doc/tlbuild.info +++ b/Build/source/doc/tlbuild.info @@ -3,7 +3,7 @@ tlbuild.texi. This file documents the TeX Live build system and more. -Copyright (C) 2016-2018 Karl Berry. +Copyright (C) 2016-2019 Karl Berry. Copyright (C) 2013-2015 Karl Berry & Peter Breitenlohner. Permission is granted to make and distribute verbatim copies of this @@ -33,7 +33,7 @@ END-INFO-DIR-ENTRY  File: tlbuild.info, Node: Top, Next: Introduction, Up: (dir) -Building TeX Live (2018) +Building TeX Live (2019) ************************ For an overview of this manual, *note Introduction::. @@ -59,7 +59,7 @@ File: tlbuild.info, Node: Introduction, Next: Overview of build system, Prev: 1 Introduction ************** -This manual (dated August 2018) corresponds to the TeX Live 2018 +This manual (dated February 2019) corresponds to the TeX Live 2019 release. This manual is aimed at system installers and programmers, and @@ -67,38 +67,39 @@ focuses on how to configure, build, and develop the TeX Live (TL) sources. It is also available as plain text files in the source tree: 'source/README.*'. - The 'source/README' file in the TL source tree provides the + The main 'source/README' file in the TL source tree provides maximally-terse information for doing a build, and portability information for different systems, along with 'source/doc/README.solaris'. For information on acquiring the TL sources, see -. +. The canonical source repository uses +Subversion, and we have no plans to change this. This manual does not duplicate the information found in other TL documentation resources, such as: - * The TeX Live web pages: . + * The TeX Live web pages: . * The web page describing how to build the binaries which are - distributed with TeX Live: . + distributed with TeX Live: . - * The TeX Live user manual: , or run - 'texdoc texlive'. + * The TeX Live user manual: , or + run 'texdoc texlive'. * Other TeX-related Texinfo manuals (*note (web2c)::, *note - (kpathsea)::, etc.): , or check the + (kpathsea)::, etc.): , or check the 'TeX' category in the GNU Info system. * Package documentation: - , or the 'doc.html' + , or the 'doc.html' file at the top level of the installed TL. As an exception, the full documentation for 'install-tl' and 'tlmgr' -is included here, just because it is convenient to do so. The same text -is available online (linked from , or -by invoking the program with '--help' (or look at the end of the -source). +is included here as appendices, simply because it is easy to do so. The +same text is available online (linked from +, or by invoking the program with +'--help' (or look at the end of the source).  File: tlbuild.info, Node: Overview of build system, Next: Prerequisites, Prev: Introduction, Up: Top @@ -106,10 +107,10 @@ File: tlbuild.info, Node: Overview of build system, Next: Prerequisites, Prev 2 Overview of build system ************************** -The TeX Live build system was redesigned in 2009, consistently using -Autoconf, Automake, and Libtool. Thus +The TeX Live build system was redesigned in 2009 to consistently use +Autoconf, Automake, and Libtool. Thus, running 'configure && make && make check && make install' -or the basically-equivalent top-level 'Build' script suffice to build +or the essentially-equivalent top-level 'Build' script suffices to build and install the TL programs. The 'make check' clause performs various tests of the generated programs--not strictly required but strongly recommended. Running 'configure --help' will display a comprehensive @@ -135,7 +136,7 @@ program and library module (or package) specifies its own requirements and properties, such as required libraries, whether an installed (system) version of a library can be used, 'configure' options to be seen at the top level, and more. An explicit list of all available -modules is kept in only one central place, namely 'm4/kpse-pkgs.m4'. +modules is kept in a single central place: 'm4/kpse-pkgs.m4'. A second, related goal is to configure and build each library before configuring any other (program or library) module which uses that @@ -148,8 +149,8 @@ independently. The corresponding modules use (most of) the distributed source tree and document any modifications of that source. All this is for the sake of simplifying both upgrading of modules and -integrating new modules into the TL build system. (Not to say that -either task is trivial.) +integrating new modules into the TL build system. (Despite all efforts, +neither task is easy.)  File: tlbuild.info, Node: Prerequisites, Next: Building, Prev: Overview of build system, Up: Top @@ -158,20 +159,21 @@ File: tlbuild.info, Node: Prerequisites, Next: Building, Prev: Overview of bu *************** Overall, building the TeX Live programs, when using all libraries from -the TL source tree, requires only C and C++ compilers and GNU 'make'. -(If 'make' from your 'PATH' is not GNU make, you can set 'MAKE' in the -environment to whatever is necessary.) +the TL source tree, requires C and C++11 compilers and GNU 'make'. If +'make' from your 'PATH' is not GNU make, you can set the 'MAKE' +environment variable to whatever is necessary. GNU 'make' is required only because of some third-party libraries, notably FreeType; all the TL-maintained directories (and -Automake/Autoconf output in general) should work with any reasonable -'make'. +Automake/Autoconf output in general) work with any reasonable 'make'. - However, a few programs in the tree have additional requirements: + A C++11 compiler is similarly required because of the third-party +libraries ICU and Poppler; the program 'dvisvgm' also requires C++11. +It is possible to build everything else with older compilers; + links to a build script for +doing this. -'dvisvgm' - requires a C++11 compiler, such as gcc 4.8.1 (or later) or clang - 3.3 (or later). + However, a few programs in the tree have additional requirements: 'web2c' requires 'perl' for some tests run by 'make check'. @@ -186,8 +188,9 @@ Automake/Autoconf output in general) should work with any reasonable MacOSX only, the 'ApplicationServices' and 'Cocoa' frameworks. 'xindy' - requires GNU 'clisp' and in addition 'perl', 'latex', and - 'pdflatex' to build the rules and/or documentation. + requires GNU 'clisp', 'libsigsegv', and 'libiconv'; additionally, + to build the rules and/or documentation: 'perl', 'latex', and + 'pdflatex' Lacking the required tools, building these programs must avoided, e.g., 'configure --without-x --disable-xetex --disable-xindy' @@ -203,7 +206,10 @@ expect: * Modification of any part of the build system (M4 macros, 'configure.ac', 'Makefile.am', or their fragments) requires GNU M4, GNU Autoconf, GNU Automake, and GNU Libtool to update the generated - files. *Note Build system tools::. + files. Furthermore, to reliably reproduce the build files, the + original GNU releases of these tools must be used, not any distro + packaging of them. *Note Build system tools::, for more + discussion. If you haven't modified any source files, and infrastructure tools such as 'autoconf' or 'makeinfo' are still being run, check your @@ -211,11 +217,6 @@ timestamps--notably, 'use-commit-times' must be set to 'yes' in your Subversion configuration (*note Build system tools::). Barring buggy commits, no infrastructure tools are needed to do a normal build. - As an example, on Debian systems the necessary build dependencies can -be installed via: - - apt-get install libfontconfig-dev libx11-dev libxmu-dev libxaw7-dev -  File: tlbuild.info, Node: Building, Next: Installing, Prev: Prerequisites, Up: Top @@ -224,26 +225,27 @@ File: tlbuild.info, Node: Building, Next: Installing, Prev: Prerequisites, U The top-level 'Build' script is intended to simplify building the binaries distributed with TeX Live itself--we call this the "native" TL -build. It configures and makes everything in a subdirectory of the main -build tree (default 'Work/'), installs everything in another -subdirectory (default 'inst/'), and finally runs 'make check'. The -exact directory and command names can be specified via environment -variables and a few leading options. All remaining arguments -(assignments or options) are passed to the 'configure' script. Please -take a look at the './Build' source file itself for more information; it +build. It runs 'configure && make world', which builds everything in a +subdirectory of the main source tree (default 'Work/'), installs +everything in another subdirectory (default 'inst/'), and finally runs +'make check'. The exact directory and command names can be specified +via environment variables and a few leading options. All remaining +arguments (assignments or options) are passed to the 'configure' script. +Please take a look at the './Build' source file for more information; it is a straightforward shell script. An alternative, and the one we will mainly discuss here, is to run -'configure' and 'make' oneself in a suitable empty subdirectory. -Building in the source directory itself is not supported (sorry). +'configure' and 'make' in a suitable empty subdirectory. Building in +the source directory itself is not supported (sorry). * Menu: -* Build iteration:: What 'configure' and 'make' do. +* Build iteration:: What 'configure' and 'make' do in TL. * Build problems:: If the build fails. * Build in parallel:: Simultaneous 'make' processes. * Build distribution:: Making a distribution tarball. * Build one package:: Example of working on just one program. +* Build one engine:: Example of building just one TeX engine. * Cross compilation:: Building on host X for target Y.  @@ -254,10 +256,10 @@ File: tlbuild.info, Node: Build iteration, Next: Build problems, Up: Building Running the top-level 'configure' script configures the top level and the subdirectories 'libs', 'utils', and 'texk'. Running 'make' at the -top-level first iterates over all TeX-specific libraries, and then runs -'make' in 'libs', 'utils', and 'texk' to iterate over all generic -libraries, utility programs, and TeX-specific programs. These -iterations consist of two steps: +top level first iterates over the TeX-specific libraries, and then runs +'make' in 'libs', 'utils', and 'texk' to iterate over the generic +libraries, utility programs, and TeX-specific programs, respectively. +These iterations consist of two steps: 1. For each library or program module not yet configured, run 'configure', adding the configure option '--disable-build' if the @@ -268,8 +270,8 @@ iterations consist of two steps: 'check' to run tests, 'install', etc. Running the top-level 'make' a second time iterates again over all -the library and program modules, but finds (should find) nothing to be -done unless some source files have been modified. +the library and program modules, and finds (should find) nothing to be +done.  File: tlbuild.info, Node: Build problems, Next: Build in parallel, Prev: Build iteration, Up: Building @@ -277,10 +279,11 @@ File: tlbuild.info, Node: Build problems, Next: Build in parallel, Prev: Buil 4.2 Build problems ================== -If configuring or building a module fails, you should first find and fix -the problem, then perhaps remove the subdirectory for that module from -the build tree, and finally rerun the top level 'make' (or 'Build' with -'--no-clean' as its first argument). +If configuring or building a module fails, you should first try to find +and fix the problem. Failing that, a possible workaround is to remove +the subdirectory for that module from the build tree (so 'configure' +won't try to run there, and finally rerun the top level 'make' (or +'./Build' '--no-clean').  File: tlbuild.info, Node: Build in parallel, Next: Build distribution, Prev: Build problems, Up: Building @@ -289,13 +292,13 @@ File: tlbuild.info, Node: Build in parallel, Next: Build distribution, Prev: ===================== The TL build system carefully formulates dependencies as well as 'make' -rules when a tool (such as 'tangle', 'ctangle', or 'convert') creates +rules when a tool (such as 'tangle', 'ctangle', and 'convert') creates several output files. This allows for parallel builds ('make -j N' with N>1 or even 'make -j') that can considerably speed up the TL build. - Incidentally, a noticeable speed-up can also be (independently) -gained by using a configure cache file, i.e., with the option '-C' -(recommended). + Incidentally, a noticeable speed-up can be independently gained by +using a configure cache file, i.e., specifying the 'configure' option +'-C' (recommended).  File: tlbuild.info, Node: Build distribution, Next: Build one package, Prev: Build in parallel, Up: Building @@ -310,10 +313,11 @@ all of TL. This is useful for checking consistency of the source tree and Makefiles, but the result is not a complete or even usable TeX system, -since all the support files are lacking; *note Installing::. +since all the support files are lacking; *note Installing::. We do not +actually distribute any such tarball, and have no plans to do so.  -File: tlbuild.info, Node: Build one package, Next: Cross compilation, Prev: Build distribution, Up: Building +File: tlbuild.info, Node: Build one package, Next: Build one engine, Prev: Build distribution, Up: Building 4.5 Build one package ===================== @@ -322,15 +326,15 @@ To build one package, the basic idea is to use the 'configure' option '--disable-all-pkgs' (*note --disable-all-pkgs::). Then all program and library modules are configured but none are made. However, the 'Makefile's still contain all build rules and dependencies and can be -invoked to build an individual program or library and causes to first -build any required libraries. +invoked to build an individual program or library, first building any +required libraries. This "build-on-demand" procedure is used, e.g., in the upstream -LuaTeX repository to build LuaTeX, essentially from a subset of the -complete TeX Live tree. Similarly, when, e.g., building the original +LuaTeX repository to build LuaTeX, from a subset of the complete +TeX Live source tree. As another example, when building the original e-TeX has been disabled (as it is by default), one can run 'make etex' (or 'make etex.exe') in 'texk/web2c/' to build e-TeX (although there is -no comparably simple way to install e-TeX). +no comparably simple way to _install_ e-TeX). If you want to work on a single program within the TL sources, this is the recommended way to do it. Here is an example from start to @@ -338,7 +342,7 @@ finish for working on 'dvipdfm-x'. mkdir mydir && cd mydir # new working directory - # Get sources (), e.g.: + # Get sources (), e.g.: rsync -a --delete --exclude=.svn --exclude=Work \ tug.org::tldevsrc/Build/source/ . @@ -347,28 +351,30 @@ finish for working on 'dvipdfm-x'. # Do the configure: ../configure --disable-all-pkgs --enable-dvipdfm-x \ - -C CFLAGS=-g CXXFLAGS=-g >&outc + -C CFLAGS=-g CXXFLAGS=-g >&outc || echo fail # Do the make: - make >&outm + make >&outm || echo fail # Test: cd texk/dvipdfm-x make check - Then you modify source files in 'mydir/texk/dvipdfm-x' and rerun -'make' in 'mydir/Work/texk/dvipdfm-x' to rebuild (that build directory -is where the binaries end up). + Then you can modify source files in 'mydir/texk/dvipdfm-x' and rerun +'make' in 'mydir/Work/texk/dvipdfm-x' to rebuild; that build directory +is where the binary ends up and where you can run a debugger, etc. The second line of the 'configure' invocation shows examples of extra things you likely want to specify if you intend to hack the sources (and -not just build binaries): the '-C' speeds up 'configure', and the -'CFLAGS' and 'CXXFLAGS' settings eliminate compiler optimization for -debugging purposes. +not just build binaries): the '-C' speeds 'configure' by enabling a +cache file, and the 'CFLAGS' and 'CXXFLAGS' settings eliminate compiler +optimization for debugging purposes. - Of course, one should actually look at the output and check that + Of course, you need to actually look at the output and check that things are working. There are many 'configure' options you can tweak as -desired; check the output from 'configure --help'. +desired; check the output from 'configure --help'. It is also a good +idea to run 'make check' after making any changes, to ensure that +whatever tests have been written still pass. Finally, the above retrieves the entire TL source tree (several hundred megabytes). It is natural to ask if this is really necessary. @@ -376,12 +382,13 @@ Strictly speaking, the answer is no, but it is vastly more convenient to do so. If you cut down the source tree, you must also give additional 'configure' flags to individually disable using system versions of libraries, or the intricacies of the dependencies (such as 'teckit' -requiring 'zlib') will have undesired side effects. For an example, see -the 'build-pdftex.sh' script in the 'pdftex' development source (details -at ), which is indeed a cut-down TL source tree. +requiring 'zlib') will have undesired side effects. For an example of +this approach, see the 'build-pdftex.sh' script in the 'pdftex' +development source (details at ), which is indeed +such a cut-down TL source tree. Even with '--disable-all-pkgs', dependencies will be checked. For -instance, if a non-MacOSX system does not have 'fontconfig', XeTeX +instance, if a (non-MacOSX) system does not have 'fontconfig', XeTeX cannot be built (*note Prerequisites::) and 'configure' will terminate. To proceed without such dependencies, specify '--enable-missing' also. @@ -391,9 +398,34 @@ specify the compilers to be used with the environment variables 'CC', 'CXX', and 'OBJCXX'.  -File: tlbuild.info, Node: Cross compilation, Prev: Build one package, Up: Building +File: tlbuild.info, Node: Build one engine, Next: Cross compilation, Prev: Build one package, Up: Building + +4.6 Build one engine +==================== + +Unfortunately, there is one common case where the steps in the preceding +section to build one package (*note Build one package::) do not suffice: +wanting to build one, or a subset, of the TeX engines (or other Web2c +programs). -4.6 Cross compilation + The simplest way to do this is to disable everything and then +explicitly specify what to make. For example, to build only LuaTeX: + + ./configure --disable-all-pkgs # or ./Build + cd Work/texk/web2c # build directory + make luatex # specify target + + This works because the 'make' automatically runs 'configure' as +necessary for the dependencies and target. Furthermore, the source tree +can be cut down to just what is needed for the given engine (as the +separate pdfTeX and LuaTeX source repositories do). + + We hope to improve the situation in the future. Patches are welcome. + + +File: tlbuild.info, Node: Cross compilation, Prev: Build one engine, Up: Building + +4.7 Cross compilation ===================== In a cross compilation a "build" system is used to create binaries to be @@ -426,7 +458,7 @@ MacOSX system one could use:  File: tlbuild.info, Node: Cross configuring, Next: Cross problems, Up: Cross compilation -4.6.1 Cross configuring +4.7.1 Cross configuring ----------------------- In a standard cross compilation, binaries for the host system cannot @@ -475,7 +507,7 @@ C and C++ programs required for the build process as configure arguments  File: tlbuild.info, Node: Cross problems, Prev: Cross configuring, Up: Cross compilation -4.6.2 Cross problems +4.7.2 Cross problems -------------------- The fact that binaries for the host system cannot be executed on the @@ -501,7 +533,7 @@ during the cross compilation. This approach would also be possible for the tools such as 'tangle' used in the module 'texk/web2c' to build the WEB programs, but that would require first building a native 'kpathsea' library. To avoid this -complication, cross compilation of the WEB or CWEB programs requires +complication, cross compilation of programs written in (C)WEB requires sufficiently recent installed versions of 'tangle', 'ctangle', 'otangle', and 'tie'. @@ -522,10 +554,10 @@ support files are needed; just as a first example, 'plain.tex' is not in the source tree. These support files are maintained completely independently and are -not present in the source tree. The best basis for dealing with them is -the TeX Live (plain text) database in 'Master/tlpkg/texlive.tlpdb', +not present in the TL source tree. The best basis for dealing with them +is the TeX Live (plain text) database in 'Master/tlpkg/texlive.tlpdb', and/or the TeX Live installer, 'install-tl'. More information is under -'Master/tlpkg' and at . +'Master/tlpkg' and at . * Menu: @@ -573,7 +605,7 @@ except possibly modified as follows: The top-level 'configure' script displays all these installation paths. For the native TL build, the 'Build' script leaves the binaries in -'./inst/bin/STD-PLATFORM-NAME'. The new binaries are not directly +'./inst/bin/STD-SYSTEM-TRIPLET'. The new binaries are not directly usable from that location; they need to be copied to 'Master/bin/TL-PLATFORM'. The other files and directories that end up in './inst/' are ignored. @@ -593,8 +625,9 @@ elsewhere with copies under 'texk/texlive/linked_scripts'. 'DATAROOTDIR/texmf-dist/scripts'; for Unix-like systems a symbolic link is made in 'BINDIR'. For example, a symlink points from 'BINDIR/ps2eps' to 'DATAROOTDIR/texmf-dist/scripts/ps2eps/ps2eps.pl'. For Windows, a -standard wrapper binary (e.g., 'BINDIR/ps2eps.exe') serves the same -purpose. (The source for the wrapper is in 'texk/texlive/w32_wrapper'.) +standard wrapper binary (copied to, e.g., 'BINDIR/ps2eps.exe') serves +the same purpose. The source for the wrapper is in +'texk/texlive/w32_wrapper'. One reason for this is to avoid having many copies of the same script; a more important reason is that it guarantees the scripts will @@ -604,9 +637,9 @@ stay in sync across the different supported operating systems. to be as close as possible to what is in the TL distribution. At present, there are a few exceptions--Asymptote, Biber, Xindy--and each one creates considerable extra work. We don't want to add more. (See - for information about building those -exceptions, as well as the 'xz' and 'wget' programs that are used in the -TL infrastructure.) + for information about building +those exceptions, as well as the 'xz' and 'wget' programs that are used +in the TL infrastructure.)  File: tlbuild.info, Node: Distro builds, Prev: Linked scripts, Up: Installing @@ -620,12 +653,12 @@ different from a "distro" build needed by, e.g., a full GNU/Linux or BSD operating system distribution. The native TL distribution uses shared libraries only when absolutely -necessary ('libc', 'libm', X11 libraries, and 'libfontconfig'). -However, a distro typically wants to use as many shared libraries as +necessary ('libc', 'libm', X11 libraries, and 'libfontconfig'). In +constrast, a distro typically wants to use as many shared libraries as possible from elsewhere on the system, including TeX-specific libraries such as 'libkpathsea' (even though Kpathsea has never officially been -released as a shared library, but we digress). In addition, the -installation paths will, in general, be completely different. +released as a shared library). In addition, the installation paths +will, in general, be completely different. Here are the 'configure' options that distro builds are likely to find most relevant: @@ -646,8 +679,8 @@ find most relevant: Do not build the static versions of the TeX-specific libraries. '--with-system-LIB' - Use system versions for as many libraries LIB as possible. - 'configure --help' will give you the list of possibilities. + Look for and use a system version of the library LIB. 'configure + --help' will give you the list of possibilities. '--with-LIB-includes=DIR' '--with-LIB-libdir=DIR' @@ -666,7 +699,7 @@ find most relevant: (*note Installing::), and many other issues, such as font maps, languages, and formats, independently of the build. Norbert Preining has written a detailed article on adapting TL for distros: -. (If the +. (If the article needs updating in the future, perhaps we will merge it into this document.) @@ -696,8 +729,8 @@ File: tlbuild.info, Node: Build system tools, Next: Top-level directories, Up 6.1 Build system tools ====================== -As mentioned above (*note Prerequisites::), a normal build requires very -little. On the other hand, if you want to modify the TeX Live +As mentioned above (*note Prerequisites::), a normal build has few +requirements. On the other hand, if you want to modify the TeX Live infrastructure sources, such as 'configure.ac' or 'Makefile.am' files, you will need to have several additional tools installed. @@ -712,7 +745,7 @@ many extra hassles, so don't do that, tempting as it may be. autoconf (GNU Autoconf) 2.69 automake (GNU automake) 1.16.1 - bison (GNU Bison) 3.2.3 + bison (GNU Bison) 3.3.1 flex 2.6.0 ltmain.sh (GNU libtool) 2.4.6 m4 (GNU M4) 1.4.18 @@ -724,16 +757,21 @@ dependencies have been changed. This can be done explicitly with the top-level 'reautoconf' script or implicitly by using the configure option '--enable-maintainer-mode'. + It has often turned out that the bison and flex versions are not +critical; however, the autotools versions are. If you don't have the +given versions, get them before modifying the build infrastructure. + The files in the Subversion repository (see -) are all up to date, but unfortunately this -may not be reflected by their timestamps. (For starters, be sure to set -'use-commit-times=yes' in '~/.subversion/config' or the equivalent.) +) are all up to date (barring bugs). For +this to be reflected by their timestamps in your checkout, be sure to +set 'use-commit-times=yes' in '~/.subversion/config' or the equivalent. - To avoid unnecessary runs of 'bison', 'flex', or 'makeinfo' it may be -necessary to 'touch' the generated ('.c', '.h', or '.info') files. With -'--enable-maintainer-mode' it may also be necessary to 'touch' first -'aclocal.m4', then 'configure' and 'config.h.in' (or 'c-auto.in'), and -finally all 'Makefile.in' files. Perhaps 'make -t' will help. + If timestamps are wrong, you may also be able to avoid unnecessary +runs of 'bison', 'flex', or 'makeinfo' with 'touch' of the generated +('.c', '.h', or '.info') files. With '--enable-maintainer-mode' it may +also be necessary to 'touch' first 'aclocal.m4', then 'configure' and +'config.h.in' (or 'c-auto.in'), and finally all 'Makefile.in' files. +Perhaps 'make -t' will help.  File: tlbuild.info, Node: Top-level directories, Next: Autoconf macros, Prev: Build system tools, Up: Layout and infrastructure @@ -767,22 +805,18 @@ configured for the benefit of 'make' targets such as 'dist' or The top-level 'build-aux/' directory contains the common files 'compile', 'config.guess', 'config.sub', 'depcomp', etc. used by most -packages. These are from the GNU Gnulib sources -(), which in turn synchronizes with -the appropriate ultimate upstream repository. There are, however, -independent copies in, e.g., 'libs/freetype2/freetype-*/builds/unix/', -and a few other places. The 'reautoconf' script does not touch those, -but a TL cron job keeps them in sync (nightly). - - The directory 'extra/' contains things which are not part of the TL -build, but are present just for (someone's) convenience, e.g., is -'epstopdf' development source is here. +packages. These are taken from the GNU Gnulib sources +(), which in turn synchronizes with +any ultimate upstream repository. There are independent copies of some +of these in a few other places, e.g., +'libs/freetype2/freetype-*/builds/unix/'. The 'reautoconf' script does +not touch those, but a TL cron job keeps them in sync (nightly). When the top-level './Build' script is used to build TL, two more two more top-level directories appear: 'Work/' for the build tree, and 'inst/' for the install tree (from 'make install'). These names (and everything else about 'Build''s operation) can be changed by setting -environment variables before running it; see the script file. +environment variables before running it; see the script source.  File: tlbuild.info, Node: Autoconf macros, Next: Library modules, Prev: Top-level directories, Up: Layout and infrastructure @@ -790,11 +824,12 @@ File: tlbuild.info, Node: Autoconf macros, Next: Library modules, Prev: Top-l 6.3 Autoconf macros =================== -Here we describe some of the Autoconf macros used in several modules-not -a complete list, by any means. These general macros are supplemented by -module-specific macros in directories such as 'texk/dvipng/m4/'; some of -those are described in *note Library modules:: and *note Program -modules::. +Here we describe a few of the Autoconf macros used in several +modules--many more are defined in the sources; see the top-level 'm4/' +directory. These general macros are supplemented by module-specific +macros in directories such as 'texk/dvipng/m4/'; some of those are +described in following sections (*note Library modules:: and *note +Program modules::). * Menu: @@ -827,8 +862,8 @@ The TL sources use two general setup macros: 'LT_INIT([win32-dll])' 'AC_SYS_LARGEFILE' 'AC_FUNC_FSEEKO' - and check for frequently used functions, headers, types, and - structures. This is used for TeX-specific modules. + along with checks for frequently used functions, headers, types, + and structures. This is used for TeX-specific modules.  File: tlbuild.info, Node: Macros for programs, Next: Macros for compilers, Prev: General setup macros, Up: Autoconf macros @@ -839,11 +874,11 @@ File: tlbuild.info, Node: Macros for programs, Next: Macros for compilers, Pr Macros for program checks: -- Macro: KPSE_CHECK_LATEX - Set 'LATEX' to the name of the first of 'latex', 'elatex', or - 'lambda' which exists in 'PATH', or to 'no' if none of them exists. - Call 'AC_SUBST' for 'LATEX'. The result of this test can be - overridden by setting the 'LATEX' environment variable or the cache - variable 'ac_cv_prog_LATEX'. + Set 'LATEX' to the first of 'latex', 'elatex', or 'lambda' which + exists in 'PATH', or to 'no' if none of them exists. Call + 'AC_SUBST' for 'LATEX'. The result of this test can be overridden + by setting the 'LATEX' environment variable or the cache variable + 'ac_cv_prog_LATEX'. -- Macro: KPSE_CHECK_PDFLATEX Check for 'pdflatex' in 'PATH' and set 'PDFLATEX'. @@ -866,8 +901,8 @@ Macros for compiler-related checks: When using the (Objective) C/C++ compiler, set 'WARNING_[OBJ]C[XX]FLAGS' to suitable warning flags (depending on the value given to or implied for '--enable-compiler-warnings'). - Call 'AC_SUBST' for them. At the moment this only works for GNU - compilers, but could be extended to others if necessary. + Call 'AC_SUBST' for them. At present this assumes GNU compiler + warning options, but could be extended to others if necessary. This macro caches its results in the 'kpse_cv_warning_cflags', ... variables. @@ -875,9 +910,9 @@ Macros for compiler-related checks: -- Macro: KPSE_COMPILER_VISIBILITY When using the C or C++ compiler, try to set 'VISIBILITY_C[XX]FLAGS' to flags to hide external symbols. Call - 'AC_SUBST' for this variable. At the moment this only tests for - the compiler option '-fvisibility=hidden', but that could be - extended with more checks if necessary. + 'AC_SUBST' for this variable. At present this only tests for the + compiler option '-fvisibility=hidden', but could be extended if + necessary. This macro caches its results in the 'kpse_cv_visibility_cflags' or 'kpse_cv_visibility_cxxflags' variable. @@ -885,8 +920,7 @@ Macros for compiler-related checks: -- Macro: KPSE_CXX_HACK Provide the configure option '--enable-cxx-runtime-hack'. If enabled and when using 'g++', try to statically link with - 'libstdc++', somewhat improving portability of the resulting - binary. + 'libstdc++', notably improving portability of the resulting binary. This macro caches its result in the 'kpse_cv_cxx_hack' variable. @@ -915,10 +949,12 @@ library. E.g., for 'libs/libpng': -- Macro: KPSE_LIBPNG_FLAGS Provide the configure option '--with-system-libpng'. Set and 'AC_SUBST' 'make' variables for modules using this library (either - an installed version or from the TeX Live tree): 'LIBPNG_INCLUDES' - for use in 'CPPFLAGS', 'LIBPNG_LIBS' for use in 'LDADD', - 'LIBPNG_DEPEND' for use as dependency, and 'LIBPNG_RULE' defining - 'make' rules to rebuild the library. + an installed version or from the TeX Live tree): + + 'LIBPNG_INCLUDES' for use in 'CPPFLAGS', + 'LIBPNG_LIBS' for use in 'LDADD', + 'LIBPNG_DEPEND' for use as a Makefile dependency, + 'LIBPNG_RULE' for the 'make' rules to rebuild the library. -- Macro: KPSE_ADD_FLAGS (NAME) Temporarily extend 'CPPFLAGS' and 'LIBS' with the values required @@ -942,7 +978,7 @@ and its 'Makefile.am' would be along these lines: ## Rebuild libpng @LIBPNG_RULE@ - If it was necessary to examine whether certain 'zlib' or 'libpng' + If it were necessary to examine whether certain 'zlib' or 'libpng' features were available, 'configure.ac' should be continued this way: KPSE_ADD_FLAGS([zlib]) ... # tests for 'zlib' features, if any @@ -960,10 +996,10 @@ Windows differs in several aspects from Unix-like systems, many of them due to the lack of symbolic links. -- Macro: KPSE_CHECK_WIN32 - Check if compiling for a Windows system. The result is 'no' for - Unix-like systems (including Cygwin), 'mingw32' for Windows with - GCC, or 'native' for Windows with MSVC. The result is cached in the - 'kpse_cv_have_win32' variable. + Check if compiling for a Windows system. The result is either 'no' + for Unix-like systems (including Cygwin), 'mingw32' for Windows + with GCC, or 'native' for Windows with MSVC. The result is cached + in the 'kpse_cv_have_win32' variable. -- Macro: KPSE_COND_WIN32 Call 'KPSE_CHECK_WIN32' and define the Automake conditional 'WIN32' @@ -982,7 +1018,7 @@ due to the lack of symbolic links. Linked scripts::). -- Macro: KPSE_WIN32_CALL - Call 'KPSE_COND_WIN32', check if the file + Call 'KPSE_COND_WIN32' and check if the file 'texk/texlive/w32_wrapper/callexe.c' exists; if it does, create a symlink in the build tree. Compiling 'callexe.c' with '-DEXEPROG='"FOO.exe"'' and installing 'callexe.exe' as 'BAR.exe' @@ -1012,14 +1048,14 @@ File: tlbuild.info, Node: png library, Next: zlib library, Up: Library module 6.4.1 The 'png' library in 'libs/libpng' ---------------------------------------- -This generic library uses the source tree in, e.g., the subdirectory -'libpng-src/' with all modifications for TL recorded in 'TLpatches/*'. +The "generic" 'png' library uses the source tree in the subdirectory +'libpng-src/', with all modifications for TL recorded in 'TLpatches/*'. The 'configure.ac' fragment 'ac/withenable.ac' contains KPSE_WITH_LIB([libpng], [zlib]) -specifying the module name, and indicating the dependency on 'zlib'. A -third literal argument 'tree' would specify that the library from the +to specify the module name and indicate the dependency on 'zlib'. A +third literal argument ''tree'' would specify that the library from the TeX Live tree cannot be replaced by a system version. That not being the case here, a second fragment 'ac/libpng.ac' contains @@ -1037,27 +1073,30 @@ thus providing the simple C code return 0; } which Autoconf uses to verify the usability of a system version with C -code. The analogous macro 'KPSE_TRY_LIBXX' would check using C++ code. -These fragments are included by 'configure.ac' at the top level. +code. The analogous macro 'KPSE_TRY_LIBXX' would check using C++. +These fragments are included by the 'configure.ac' at the top level of +TL ('Build/source/configure.ac'). + + For this library, like many other modules, a proxy build system for +TL is used, consisting of our own 'configure.ac', 'Makefile.am', +'include/Makefile.am'; the distributed build system is not used. +(Consequently, a few generated files and auxiliary scripts are removed +from the distributed source tree.) - For this library, among many other modules, a proxy build system for -TL is used ('configure.ac', 'Makefile.am', and 'include/Makefile.am'), -ignoring the distributed one. Consequently, a few generated files and -auxiliary scripts are removed from the distributed source tree. The -public headers 'png.h', 'pngconf.h', and 'pnglibconf.h' are "installed" -(as symlinks) under 'include/' in the build tree exactly as they are for -a system version under, e.g., '/usr/include/'. + The public headers 'png.h', 'pngconf.h', and 'pnglibconf.h' are +"installed" (as symlinks) under 'include/' in the build tree exactly as +they are for a system version under, e.g., '/usr/include/'. The module is supplemented by the file 'm4/kpse-libpng-flags.m4' that defines the M4 macro 'KPSE_LIBPNG_FLAGS' used by all modules depending on this library in their 'configure.ac' to generate the 'make' variables 'LIBPNG_INCLUDES' for use in 'CPPFLAGS', 'LIBPNG_LIBS' for use in -'LDADD', 'LIBPNG_DEPEND' for use as dependencies, and 'LIBPNG_RULE' -defining 'make' rules to rebuild the library. +'LDADD', 'LIBPNG_DEPEND' for use as dependencies, and 'LIBPNG_RULE' for +the 'make' rules to rebuild the library. 'm4/kpse-libpng-flags.m4' also supplies the configure option -'--with-system-libpng' and uses 'pkg-config' to determine the flags -required for the system library. +'--with-system-libpng', which then uses 'pkg-config' to determine the +flags required for the system library.  File: tlbuild.info, Node: zlib library, Next: freetype library, Prev: png library, Up: Library modules @@ -1077,11 +1116,15 @@ File: tlbuild.info, Node: freetype library, Next: kpathsea library, Prev: zli 6.4.3 The 'freetype' library in 'libs/freetype2' ------------------------------------------------ -This module uses a wrapper build system with an almost trivial -'configure.ac' and with a 'Makefile.am' that invokes 'configure' and -'make' for the distributed source, followed by 'make install' with the -build tree as destination. The flags required for the system library -are obtained through 'freetype-config'. +This module uses a wrapper build system. In contrast to the proxy build +described earlier, the wrapper build has an almost trivial +'configure.ac' and a 'Makefile.am' which invokes the 'configure' and +'make' in the distributed source, followed by 'make install' with the TL +build tree as destination. In other words, this actually uses the build +system provided by upstream (possibly patched). + + The flags required for the system library are obtained through +'freetype-config'.  File: tlbuild.info, Node: kpathsea library, Prev: freetype library, Up: Library modules @@ -1090,26 +1133,26 @@ File: tlbuild.info, Node: kpathsea library, Prev: freetype library, Up: Libra ----------------------------------------------- This is one of the TeX-specific libraries that are maintained as part of -TeX Live (*note (kpathsea)::). Despite being a core part of the TeX -system, it is not a terribly special case in the infrastructure. The -TeX libraries are Libtool libraries (static and/or shared) and are -installed by 'make install' together with the programs. They are, -however, not part of the TL DVD as distributed by TeX user groups, and -have never been officially released for standalone use. - - It is possible, and perhaps even useful for distro builds (*note -Distro builds::), to specify the configure option -'--with-system-kpathsea' in order to use a system version of the -library. Programs outside the TL tree should use 'pkg-config' for the -required flags. - - In addition to 'ac/withenable.ac' and 'ac/kpathsea.ac' there is a -third fragment 'ac/mktex.ac' included by both 'ac/withenable.ac' and -'configure.ac' that supplies configure options such as -'--enable-mktextfm-default', which determine the compile time default of -whether or not to run 'mktextfm' to generate a missing '.tfm' file. In -any case, however, the command line options '-mktex=tfm' or -'-no-mktex=tfm' for the TeX-like engines override this default. +TeX Live (*note (kpathsea)::); the other is 'ptexenc'. These TeX +libraries are Libtool libraries (static and/or shared) and are installed +by 'make install' together with the programs. They are, however, not +part of the TL DVD as distributed by TeX user groups, and have never +been officially released for standalone use. + + It is possible, and probably useful for distro builds (*note Distro +builds::), to specify the configure option '--with-system-kpathsea' in +order to use a system version of the library. Programs outside the TL +tree should use 'pkg-config' for the required flags. + + In addition to 'kpathsea/ac/withenable.ac' and +'kpathsea/ac/kpathsea.ac' here there is a third fragment +'kpathsea.ac/mktex.ac', included by both 'withenable.ac' and +'configure.ac', which supplies configure options such as +'--enable-mktextfm-default'. These determine the compile time default +of whether or not to run 'mktextfm' (and similar) to generate a missing +'.tfm' (or whatever) file. In any case, however, the command line +options '-mktex=tfm' or '-no-mktex=tfm' for the TeX-like engines +override this default.  File: tlbuild.info, Node: Program modules, Next: Extending TeX Live, Prev: Library modules, Up: Layout and infrastructure @@ -1133,10 +1176,10 @@ File: tlbuild.info, Node: t1utils package, Next: xindy package, Up: Program m 6.5.1 The 't1utils' package in 'utils/t1utils' ---------------------------------------------- -Once again we use the distributed source tree 't1utils-src' with -modifications documented in 'TLpatches/*' and a proxy build system -consisting of 'configure.ac' and 'Makefile.am'. The fragment -'ac/withenable.ac' contains +Here we use the distributed source tree 't1utils-src' with modifications +documented in 'TLpatches/*' and a proxy build system consisting of +'configure.ac' and 'Makefile.am'. The fragment 'ac/withenable.ac' +contains KPSE_ENABLE_PROG([t1utils]) @@ -1150,11 +1193,12 @@ File: tlbuild.info, Node: xindy package, Next: xdvik package, Prev: t1utils p ------------------------------------------ This module uses the distributed source tree 'xindy-src/' with -modifications documented in 'TLpatches/*', a proxy 'configure.ac', and a -wrapper 'Makefile.am' that descends into 'xindy-src'. The 'xindy' build -requires a 'make' that supports a 'VPATH' build, can handle all targets, -and do not refer to '${top_srcdir}' or '${top_builddir}'. The fragment -'ac/withenable.ac' contains +modifications documented in 'TLpatches/*', and a wrapper 'configure.ac' +and 'Makefile.am' that descends into 'xindy-src'. + + The 'xindy' build requires a 'make' that supports a 'VPATH' build, +can handle all targets, and do not refer to '${top_srcdir}' or +'${top_builddir}'. The fragment 'xindy/ac/withenable.ac' contains KPSE_ENABLE_PROG([xindy], , [disable native]) m4_include(kpse_TL[utils/xindy/ac/xindy.ac]) @@ -1165,7 +1209,7 @@ built if explicitly enabled by the user with 'configure --enable-xindy' (the need for 'clisp' is too painful to require by default), and 'native' disallows cross compilation. The additional fragments 'ac/xindy.ac' and 'ac/clisp.ac' specify more 'configure' options to be -seen at the top level with 'ac/xindy.ac' also included by +seen at the top level, with 'ac/xindy.ac' also included by 'configure.ac'.  @@ -1175,23 +1219,23 @@ File: tlbuild.info, Node: xdvik package, Next: asymptote, Prev: xindy package ----------------------------------------- This package is maintained as part of the TeX Live tree with sources in -its top level directory and the subdirectory 'gui'. The fragment -'ac/withenable.ac' contains +its own directory ('texk/xdvik/'). The fragment +'xdvik/ac/withenable.ac' contains dnl extra_dirs = texk/xdvik/squeeze KPSE_ENABLE_PROG([xdvik], [kpathsea freetype2], [x]) m4_include(kpse_TL[texk/xdvik/ac/xdvik.ac]) -thus specifying the dependency on the 'kpathsea', 'freetype', and X11 +thus specifying dependencies on the 'kpathsea', 'freetype', and X11 libraries. The M4 comment (following 'dnl') signals the subsidiary 'squeeze/configure.ac'. This is needed because the main executable 'xdvi-bin' (to be installed as, e.g., 'xdvi-xaw') is for the 'host' system whereas the auxiliary program 'squeeze/squeeze' has to run on the -'build' system and in a cross compilation they differ. +'build' system; in a cross compilation, these differ. The additional fragment 'ac/xdvik.ac' is also included by 'configure.ac' and supplies the configure option '--with-xdvi-x-toolkit' -also seen at the top-level. +also seen at the top level.  File: tlbuild.info, Node: asymptote, Prev: xdvik package, Up: Program modules @@ -1202,7 +1246,8 @@ File: tlbuild.info, Node: asymptote, Prev: xdvik package, Up: Program modules This subdirectory contains the sources for 'asy' and 'xasy' but due to its complexity and prerequisites (e.g., OpenGL) it is not part of the TL build system. These programs must be built and installed independently, -but are included on the TL DVD together with their support files. +but are included on the TL DVD together with their support files. See +.  File: tlbuild.info, Node: Extending TeX Live, Prev: Program modules, Up: Layout and infrastructure @@ -1214,11 +1259,11 @@ This section outlines the basic process for adding new packages to the TL build system. In any case, a new package directory 'foo' should contain the -original sources, as modified for TL, in 'foo/foo-src', and the changes -should be documented in 'foo/TLpatches/*'; changes should also be -submitted upstream whenever reasonable, of course. In addition, 'foo/' +original sources, modified only with changes necessary for TL, in +'foo/foo-src'. The changes should be documented in 'foo/TLpatches/*', +and also be submitted upstream whenever reasonable. In addition, 'foo/' will need the usual Automake build-related files ('configure.ac', -'Makefile.am', etc. Please keep a 'ChangeLog' for all TL changes. +'Makefile.am', etc. Please maintain 'foo/ChangeLog' for all TL changes. * Menu: @@ -1247,25 +1292,25 @@ mandatory first argument and three optional arguments: 1. a list of required libraries from the TL tree; - 2. a list of options ('disable' if this module is not to be built + 2. a list of options: 'disable' if this module is not to be built without the configure option '--enable-PROG', 'native' if cross compilation is not possible, 'x' if the program requires X11 - libraries); + libraries; 3. a comment added to the help text for the 'configure' option '--enable-PROG' or '--disable-PROG'. - If the module requires specific configure options to be seen at the + If the module requires specific 'configure' options to be seen at the top level, they should be defined in an additional fragment 'ac/PROG.ac' included from 'ac/withenable.ac' and 'configure.ac'. Usually, the new program is maintained somewhere outside of TeX Live. -In that case, we put the upstream sources into a subdirectory 'PROG-src' -(e.g., 'utils/newprog/newprog-src'). We do not run 'configure' in this -original '...-src' directory, only in our own directory, but we do -compile using the source files in '...-src'. +In that case, as above, we put the upstream sources into a subdirectory +'PROG-src' (e.g., 'utils/newprog/newprog-src'). We do not typically run +'configure' in this original '...-src' directory, but only in our own +directory; but we do compile using the source files in '...-src'. - So, these are the files that we must generally create: + So, to summarize the files that we must (usually) create: 'ac/withenable.ac' The 'KPSE_ENABLE_PROG' call just explained. @@ -1290,10 +1335,11 @@ compile using the source files in '...-src'. Record all TL-specific changes, now and in the future. Then, run GNU 'autoreconf' in the new directory (*note Build system -tools::). After that works, 'svn add' the necessary files, notably -'Makefile.in aclocal.m4 configure', and 'svn:ignore' the Automake cache -'autom4te.cache'. (This is so people checking out the TL source tree do -not have to run any autotools, but can simply run 'configure'.) +tools::). After that works, 'svn add' the necessary files, including +the generated 'Makefile.in aclocal.m4 configure', and 'svn:ignore' the +Automake cache 'autom4te.cache'. (This is so people checking out the TL +source tree do not have to run any autotools, but can simply run +'configure'.) Then, run the TL tool 'reautoconf' in the top-level TL 'source/' directory, to incorporate the new program into the build tree. @@ -1312,7 +1358,7 @@ File: tlbuild.info, Node: Adding a new generic library module, Next: Adding a A generic library module in a subdirectory 'libs/LIB' must not depend on TeX-specific libraries, by definition. It is included by adding its -name 'LIB' to the M4 list 'kpse_libs_pkgs' in 'm4/kpse-pkgs.m4'--before +name 'LIB' to the M4 macro 'kpse_libs_pkgs' in 'm4/kpse-pkgs.m4'--before any other libraries from the TeX Live tree on which it depends. As with program modules, the subdirectory 'libs/LIB' must contain the @@ -1320,9 +1366,9 @@ sources and build system for the library (and any installable support programs) and a fragment 'ac/withenable.ac' that contains the M4 macro 'KPSE_WITH_LIB' defined in 'm4/kpse-setup.m4' with 'LIB' as the mandatory first argument and two optional arguments: a list of required -libraries from the TL tree, and a list of options (currently there is -only one: specify 'tree' if this library cannot be replaced by a system -version). +libraries from the TL tree, and a list of options: for libraries, +currently there is only one--specify 'tree' if this library cannot be +replaced by a system version. If a system version can be used, a second fragment 'ac/LIB.ac' is needed, containing the M4 macro 'KPSE_TRY_LIB' (or 'KPSE_TRY_LIBXX') @@ -1341,7 +1387,7 @@ system version. If a system library is allowed, 'KPSE_LIB_FLAGS' also provides the configure option '--with-system-LIB' and uses the additional M4 macro 'KPSE_LIB_SYSTEM_FLAGS' to generate the 'make' variables for a system -library. Furthermore the definition of the M4 macro +library. In addition, the definition of the M4 macro 'KPSE_ALL_SYSTEM_FLAGS' in 'm4/kpse-pkgs.m4' must be extended by the line: 'AC_REQUIRE([KPSE_LIB_SYSTEM_FLAGS])' @@ -1357,8 +1403,8 @@ other TeX-specific libraries but must not depend on any generic library from the TL tree. It is included in the same general ways as a generic library (see the previous section), with these modifications: - * The library name 'LIB' is added to the M4 list 'kpse_texlibs_pkgs' - also in 'm4/kpse-pkgs.m4'. + * The library name 'LIB' is added to the M4 macro + 'kpse_texlibs_pkgs', which is also in 'm4/kpse-pkgs.m4'. * The fragment 'ac/withenable.ac' must use 'KPSE_WITH_TEXLIB'. @@ -1376,7 +1422,7 @@ at the top level gives an exhaustive list of all global options and a few important module-specific ones, whereas, e.g., 'texk/lcdf-typetools/configure --help' also displays the 'lcdf-typetools' specific options, which are not shown -at the top-level. +at the top level. The help text also mentions several influential environment variables, but for TeX Live it is better to specify them as assigments @@ -1385,8 +1431,8 @@ on the command line. The './Build' script used to make the binaries shipped with TeX Live invokes the top-level 'configure' with a few additional options (*note Building::). The defaults discussed below are those for the actual -'configure' script; invoking 'configure' via './Build' may yield -different results. +'configure' script; invoking 'configure' via './Build' yields different +results. Defaults for most options are set at the top level and propagated explicitly to all subdirectories. Options specified on the command line @@ -1434,15 +1480,14 @@ by the TeX user groups. This requires GNU 'make' and implies are explicitly disabled), and enforces '--disable-shared'. If building TL for a GNU/Linux or other distribution, this should be -disabled and system versions of most libraries would be used (*note -Distro builds::). This may fail without GNU 'make', but will be tried -regardless. +disabled and system versions of most libraries should be used (*note +Distro builds::). A related option, '--enable-texlive-build', is automatically passed to all subdirectories (and cannot be disabled). Subdirectories that can also be built independently from the TL tree (such as 'utils/xindy' and -'texk/dvipng') can use this option, e.g., to choose TL-specific -installation paths. +'texk/dvipng') but cooperate with TL can use this option to enable +TL-specific adaptations, such as installation paths.  File: tlbuild.info, Node: --prefix --bindir ..., Next: --disable-largefile, Prev: --disable-native-texlive-build, Up: Global configure options @@ -1463,9 +1508,10 @@ File: tlbuild.info, Node: --disable-largefile, Next: --disable-missing, Prev: 7.1.3 '--disable-largefile' --------------------------- -Omit large file support (LFS), needed on most 32-bit Unix systems for -files with 2GB or more. Regardless of this, the size of 'DVI' and 'GF' -files must always be <2GB, due to the file format specifications. +Omit large file support (LFS), which is needed on most 32-bit Unix +systems for files with 2GB or more. Regardless of this option, the size +of 'DVI' and 'GF' files must always be <2GB, due to the file format +specifications. With LFS, there is no fixed limit on the size of PDF files created by 'pdftex' or PostScript files created by 'dvips'. The size of PDF images @@ -1488,15 +1534,12 @@ File: tlbuild.info, Node: --enable-compiler-warnings=LEVEL, Next: --enable-cxx 7.1.5 '--enable-compiler-warnings='LEVEL ---------------------------------------- -Enable various levels of compiler warnings for (Objective) C and C++: -the LEVEL value can be one of: 'no min yes max all'. The default is -'yes' in 'maintainer-mode' (see below) and 'min' otherwise. This option -defines 'WARNING_[OBJ]C[XX]FLAGS' but these flags are not used in all -library and program modules. Using them should help to resolve -portability problems. - - At present, these warning flags are only defined for the GNU -compilers but flags for other compilers could be added when needed. +Enable various levels of compiler warnings for C, C++, and/or +Objective C: the LEVEL value can be one of: 'no min yes max all'. The +default is 'yes' in 'maintainer-mode' (see below) and 'min' otherwise. +This option defines the variables 'WARNING_[OBJ]C[XX]FLAGS', but these +variables are not consistently used in all library and program modules. +At present, these warning flags assume options from the GNU compilers.  File: tlbuild.info, Node: --enable-cxx-runtime-hack, Next: --enable-maintainer-mode, Prev: --enable-compiler-warnings=LEVEL, Up: Global configure options @@ -1504,9 +1547,9 @@ File: tlbuild.info, Node: --enable-cxx-runtime-hack, Next: --enable-maintainer 7.1.6 '--enable-cxx-runtime-hack' --------------------------------- -If enabled (as it is for the native TL build) and when using 'g++', try -to statically link with 'libstdc++', somewhat improving portability of -the resulting binary. *Note Macros for compilers::. +If enabled (as it is for the native TL build), when using 'g++', try to +statically link with 'libstdc++', thus improving portability of the +resulting binary. *Note Macros for compilers::.  File: tlbuild.info, Node: --enable-maintainer-mode, Next: --enable-multiplatform, Prev: --enable-cxx-runtime-hack, Up: Global configure options @@ -1526,11 +1569,12 @@ File: tlbuild.info, Node: --enable-multiplatform, Next: --enable-shared, Prev 7.1.8 '--enable-multiplatform' ------------------------------ -If enabled and '--bindir=DIR' or '--libdir=DIR' are not specified, -install executables and libraries in per-platform subdirectories of -'EPREFIX/bin' and 'EPREFIX/lib' where EPREFIX is the value given or -implied for 'exec_prefix'. In any case, the values for 'bindir' and -'libdir' are automatically propagated to all subdirectories. +If enabled (as it is for the native TL build) and '--bindir=DIR' or +'--libdir=DIR' are not specified, install executables and libraries in +per-platform subdirectories of 'EPREFIX/bin' and 'EPREFIX/lib' where +EPREFIX is the value given or implied for 'exec_prefix'. In any case, +the values for 'bindir' and 'libdir' are automatically propagated to all +subdirectories.  File: tlbuild.info, Node: --enable-shared, Next: --enable-silent-rules, Prev: --enable-multiplatform, Up: Global configure options @@ -1549,9 +1593,9 @@ File: tlbuild.info, Node: --enable-silent-rules, Next: --without-ln-s, Prev: ------------------------------ Enable the use of less verbose build rules. When using GNU 'make' (or -another 'make' implementation supporting nested variable expansions), -you can specify 'V=1' on the 'make' command line to get more verbosity, -or 'V=0' to get less, regardless of this option. +any 'make' implementation supporting nested variable expansions), you +can specify 'V=1' on the 'make' command line to get more verbosity, or +'V=0' to get less, regardless of this option.  File: tlbuild.info, Node: --without-ln-s, Next: --without-x, Prev: --enable-silent-rules, Up: Global configure options @@ -1561,7 +1605,7 @@ File: tlbuild.info, Node: --without-ln-s, Next: --without-x, Prev: --enable-s Required when using a system without a working 'ln -s' to build binaries for a Unix-like system. However, 'make install' will not create -anything useful and might even fail. +anything useful, and might fail.  File: tlbuild.info, Node: --without-x, Prev: --without-ln-s, Up: Global configure options @@ -1597,7 +1641,7 @@ File: tlbuild.info, Node: --enable-PROG --disable-PROG, Next: --disable-all-pk 7.2.1 '--enable-PROG', '--disable-PROG' --------------------------------------- -Do or do not build and install the program(s) of the module 'PROG'. +Do or do not build and install the program(s) of module 'PROG'.  File: tlbuild.info, Node: --disable-all-pkgs, Next: Configure options for texk/web2c, Prev: --enable-PROG --disable-PROG, Up: Program-specific configure options @@ -1610,10 +1654,7 @@ enabled. This is useful when one wants to work on only a single program, which is specified with an additional '--enable' option, e.g., '--enable-dvipdfm-x'. It's still simplest to check out and configure the whole source tree, but at least only the program you are interested -in, and its dependencies, are built. The 'configure' will generally -take less than a minute with everything disabled. (It is a good idea to -run 'make check' after doing this, and after making any changes, to -ensure that whatever tests have been written still pass.) +in, and its dependencies, are built. *Note Build one package::. Without this option, all modules are built except those that are explicitly disabled or specify 'disable' in their 'ac/withenable.ac' @@ -1626,13 +1667,13 @@ File: tlbuild.info, Node: Configure options for texk/web2c, Next: Configure op ---------------------------------------- '--with-banner-add=STR' -Add 'STR' to the default version string ('TeX Live YEAR' or 'Web2C -YEAR') appended to banner lines. This is ignored for a native TL build, -but distro builds should specify, e.g., '/SOMEDISTRO'. +Add 'STR' to the default version string (which is ''TeX Live YEAR'' or +''Web2C YEAR'') appended to banner lines. This is ignored for a native +TL build, but distro builds should specify, e.g., '/SOMEDISTRO'. '--with-editor=CMD' -Specify the command 'CMD' to invoke from the 'e' option of TeX-like -engines, replacing the default 'vi +%d '%s'' for Unix or 'texworks +Specify the command 'CMD' to invoke from the 'e' option of TeX and +friends, replacing the default 'vi +%d '%s'' for Unix or 'texworks --position=%d "%s"' for Windows. '--with-fontconfig-includes=DIR', '--with-fontconfig-libdir=DIR' @@ -1661,8 +1702,8 @@ Do not or do build the various TeX, Metafont, and MetaPost engines (defaults are defined in the fragment 'texk/web2c/ac/web2c.ac'). '--disable-web-progs' -Do not build the core WEB programs 'bibtex', ..., 'weave'. Useful if, -e.g., you only want to (re)build some engines. +Do not build the original WEB programs 'bibtex', ..., 'weave'. Useful +if, e.g., you only want to (re)build some engines. '--enable-auto-core' This option causes TeX and Metafont to produce a core dump when a @@ -1675,12 +1716,12 @@ from linking explicitly with dependencies of 'libfontconfig' such as 'libexpat'. '--enable-*win' -Include various types of other window support for Metafont (EPSF output, -'mftalk', old terminals, ...). +Include various types of non-X window support for Metafont (EPSF output, +'mftalk', old graphics terminals, ...). '--enable-tex-synctex', '--disable-etex-synctex', ... Build the TeX engines with or without 'SyncTeX' support; ignored for a -native TeX Live build, defaults are again defined in +native TeX Live build. Defaults are defined in 'texk/web2c/ac/web2c.ac'. '--disable-synctex' @@ -1715,7 +1756,7 @@ created by default. In addition, 'dvipdfm' is created as a symlink to 'dvipdfmx', with backward-compatible (very slightly different) behavior. '--disable-dvipdfmx' -Do not build the 'dvipdfmx' program with the 'dvipdfm' symlink. +Do not build the 'dvipdfmx' program or make the 'dvipdfm' symlink. '--disable-xdvipdfmx' Do not build the 'xdvipdfmx' program. @@ -1729,8 +1770,8 @@ File: tlbuild.info, Node: Configure options for texk/dvisvgm, Next: Configure '--with-system-libgs' Build 'dvisvgm' using installed Ghostscript ('gs') headers and library (not allowed for a native TL build). The default is to load the 'gs' -library at runtime if possible, or otherwise disable support for -PostScript specials. +library at runtime if possible, else to disable support for PostScript +specials. '--without-libgs' Build 'dvisvgm' without PostScript support at all. Because the dynamic @@ -1757,15 +1798,15 @@ File: tlbuild.info, Node: Configure options for texk/xdvik, Next: Configure op ---------------------------------------- '--with-gs=FILENAME' -Hardwire the location of Ghostscript ('gs'). +Hardwire the location of Ghostscript ('gs') as called by Xdvik. '--with-xdvi-x-toolkit=KIT' Use toolkit 'KIT' for 'xdvik', one of: 'motif xaw xaw3d neXtaw'. The default is 'motif' if available, else 'xaw'. '--enable-xi2-scrolling' -Use XInput 2.1 "smooth scrolling" if available. (default: yes, except -for a native TL build). +Use XInput 2.1 "smooth scrolling" if available (default: yes, except for +a native TL build).  File: tlbuild.info, Node: Configure options for utils/xindy, Prev: Configure options for texk/xdvik, Up: Program-specific configure options @@ -1782,13 +1823,12 @@ Build and install 'xindy' documentation (default: yes, except for a native TL build). '--with-clisp-runtime=FILENAME' -Specifies the Full path for the CLISP runtime file ('lisp.run' or +Specifies the full path for the Clisp runtime file ('lisp.run' or 'lisp.exe') to be installed. When specified as 'default' (the default -for a native TL build) the path is determined by the CLISP executable; +for a native TL build) the path is determined by the Clisp executable; the value 'system' (not allowed for a native TL build, but the default -for a non-native one) indicates that 'xindy' will use the installed -version of 'clisp' (which must be identical to the one used to build -'xindy'). +otherwise) indicates that 'xindy' will use the installed version of +'clisp' (which must be identical to the one used to build 'xindy').  File: tlbuild.info, Node: Library-specific configure options, Next: Variables for configure, Prev: Program-specific configure options, Up: Configure options @@ -1804,7 +1844,7 @@ with this generic one: Use an installed (system) version of the library 'LIB'; this option exists for most libraries, but is not allowed for a native TL build. Using a system version implies also using the system versions of all -libraries (if any) that LIB depends on. +libraries that LIB depends on. For many libraries '--with-LIB-includes=DIR' and '--with-LIB-libdir=DIR' can specify non-standard search locations; @@ -1825,7 +1865,8 @@ File: tlbuild.info, Node: Configure options for kpathsea, Next: Configure opti -------------------------------------- '--enable-CMD-default', '--disable-CMD-default' -Determine the compile time default whether or not to run CMD, one of: +Determine the compile time default for whether or not to run CMD, which +is one of: 'mkocp' (Omega compiled translation process file) 'mkofm' @@ -1842,7 +1883,7 @@ Determine the compile time default whether or not to run CMD, one of: (TFM file) to generate the specified type of file dynamically. The default can be -overridden by the user in any case. +overridden by the user in any case (*note kpathsea library::).  File: tlbuild.info, Node: Configure options for system poppler, Prev: Configure options for kpathsea, Up: Library-specific configure options @@ -1850,19 +1891,17 @@ File: tlbuild.info, Node: Configure options for system poppler, Prev: Configur 7.3.2 Configure options for system 'poppler' -------------------------------------------- -Building LuaTeX (or LuaJITTeX) and XeTeX requires 'poppler', either from -the TL tree or system headers and library. Building pdfTeX requires -either 'xpdf' from the TeX Live tree or system 'poppler' headers and -library. +Building XeTeX requires 'poppler', either from the TL tree or system +headers and library. Building pdfTeX requires either 'xpdf' from the +TeX Live tree or system 'poppler' headers and library. '--with-system-poppler' Use a system version (0.18 or newer) of 'poppler' for LuaTeX (or LuaJITTeX) and XeTeX, and use 'pkg-config' to obtain the required flags. '--with-system-xpdf' -Use a system version (0.12 or better) of 'poppler' (and 'pkg-config') -for pdfTeX instead of 'xpdf' from the TL tree. *Note ---disable-largefile::. +Use a system version (0.12 or newer) of 'poppler' (and 'pkg-config') for +pdfTeX instead of 'xpdf' from the TL tree. *Note --disable-largefile::.  File: tlbuild.info, Node: Variables for configure, Prev: Library-specific configure options, Up: Configure options @@ -1879,7 +1918,7 @@ but that might not work for cross compilations. 'CPPFLAGS' And plenty more. As usual with Autoconf, these variables specify the name (or full path) of compilers, preprocessor flags, and - similar. *Note autoconf: (GNU Autoconf)Preset Output Variables. + similar. *Note (autoconf)Preset Output Variables::. 'CLISP' Name (or full path) of the 'clisp' executable, used to build @@ -1891,7 +1930,7 @@ but that might not work for cross compilations. These specify the name (or path) for the 'freetype-config', 'icu-config', and 'pkg-config' commands used to determine the flags required for system versions of 'libfreetype', the ICU libraries, - or many other libraries. + and other libraries, respectively. 'KPSEWHICH' Name (or path) of an installed 'kpsewhich' binary, used by 'make @@ -1920,9 +1959,9 @@ should produce no (GCC) compiler warnings at all. In spite of considerable efforts into that direction we are still far from that goal and there are reasons that we may never fully reach it. Below are some rules about declarations of functions or variables and the use of -'const'. These rules should be applied to most of the TeX Live tree, -the exception being code that is maintained independently and whose -maintainers don't want to accept patches. +'const'. These rules should be applied to the code maintained in the +TeX Live tree and for other packages whose maintainers are willing to +accept patches. * Menu: @@ -1943,7 +1982,7 @@ all function prototypes and definitions must conform to the ANSI C standard (including 'void' in the declaration of C functions with no parameters). On the other hand, TL is built for a wide variety of systems, not all of which support the C99 standard. Therefore using C99 -features should be avoided if that can easily be done. In particular C +features should be avoided if that can easily be done. In particular, C code must not contain declarations after statements or C++-style comments. @@ -1952,7 +1991,7 @@ verify that they are available and otherwise provide an alternative. For example, the module 'texk/chktex' uses the C99 function 'stpcpy()' that may or may not be available on a particular system. It uses 'AC_CHECK_DECLS([stpcpy])' in 'configure.ac' to test this, and provides -the perhaps slightly less efficient alternative +a perhaps less efficient alternative (in the file 'Utility.h'): #if !(defined HAVE_DECL_STPCPY && HAVE_DECL_STPCPY) static inline char *stpcpy(char *dest, const char *src) @@ -1961,13 +2000,11 @@ the perhaps slightly less efficient alternative } #endif -in the file 'Utility.h'. - Static functions ................ Functions used in only one file should be declared 'static'; they -require no prototype except as forward declaration. +require no prototype except in forward declarations. Extern functions ................ @@ -2011,8 +2048,8 @@ quantity supposed to be constant. Getting all 'const' qualifiers right can get quite involved but can almost always be done. There are only a couple notable exceptions: the X11 headers are full of declarations that ought to use 'const' but do -not, and the same is true to some extent for 'libfreetype' (but, -thankfully, not for 'zlib' nowadays). +not; at one time, 'libfreetype' also did not fully specify 'const', but +this has not been checked recently. What must be avoided with 'const' ................................. @@ -2020,7 +2057,7 @@ What must be avoided with 'const' The GCC compiler warnings "assignment discards qualifiers..." and analogous warnings for "initialization", "passing arg", or "return" must be strenously avoided in our own code. The only exception is when they -are caused by X11 headers or macros or other third party code. +are caused by X11 declarations or other third party code. What should be avoided with 'const' ................................... @@ -2037,10 +2074,9 @@ File: tlbuild.info, Node: Continuous integration, Next: install-tl, Prev: Cod 9 Continuous integration ************************ -Overview: the sources of TeX Live are subjected to continuous -integration testing on Travis-CI -() via a git-svn mirror -of the sources that is pushed to Github +The TeX Live sources are subjected to continuous integration testing on +Travis-CI () via a +git-svn mirror of the sources that is pushed to Github (). The git-svn mirror is updated (currently) at 30 minute intervals, and only the last commit pushed is tested on Travis-CI. @@ -2057,39 +2093,40 @@ File: tlbuild.info, Node: Transfer from Subversion to Github, Next: Automatic 9.1 Transfer from Subversion to Github ====================================== -git-svn () is used to check out the -subtree 'Build/source' of the Subversion repository. The author index -file used is not maintained in either Git or Subversion but can be -provided on request. +The git-svn program () is used to +check out the subtree 'Build/source' of the canonical Subversion +repository. The author index file used is not maintained in either Git +or Subversion but can be provided on request. The initial checkout was done by invoking - git svn --authors-file usermap clone svn://USER@tug.org/texlive/trunk/Build/source + git svn --authors-file usermap clone \ + svn://USER@tug.org/texlive/trunk/Build/source where the 'usermap' file maps Subversion user names to name and emails -of the authors. If no user account at is available, anonymous -checkout is possible, too: - git svn --authors-file usermap clone svn://tug.org/texlive/trunk/Build/source +of the authors. Anonymous checkout is also possible: + git svn --authors-file usermap clone \ + svn://tug.org/texlive/trunk/Build/source In the following, we will use _admin_ to refer to a user who has read/write access to the TeX Live subversion repository, and is also an -administrator of the 'TeX-Live' Team on Github. The above initial +administrator of the ''TeX-Live'' team at Github. The above initial checkout has been carried out by _admin_ on the server 'texlive.info'. - On Github (), a new git repository named -'texlive-source' was created by _admin_ within the 'TeX-Live' -"organization" (). The remote was added to -the checkout with 'git remote add origin -git@github.com:TeX-Live/texlive-source.git'. + On Github, a new git repository named 'texlive-source' was created by +_admin_ within the 'TeX-Live' "organization" +(). The remote was added to the checkout +with 'git remote add origin git@github.com:TeX-Live/texlive-source.git'. To automate the update on Github, a new ssh key was generated and added to the 'texlive-source' repository on Github as deployment key. -This way pushes using this key can only go to the 'texlive-source' +Thus, pushes using this key can only go to the 'texlive-source' repository and not anywhere else. The usage of 'git-svn' requires a strict discipline to keep a linear history in the master branch. Since we are aiming at a pure mirror -facility, we have decided to further restrict the 'master' branch of the -'texlive-source' repository on Github to changes by _admin_. +facility on Github, we have decided to further restrict the 'master' +branch of the 'texlive-source' repository on Github to changes by +_admin_. This setup allows other developers to branch off 'master' and push their branches to the Github repository, but all updates need to come @@ -2106,7 +2143,7 @@ _admin_ has installed a cron job on 'texlive.info' running every 30 minute which essentially runs 'git svn rebase' and 'git push' in the 'master' branch of the checkout. The first command fetches the changes from the Subversion repository and updates the 'master' branch with -them, the second one pushes changes (if available) to Github. +them, and the second pushes changes (if any) to Github.  File: tlbuild.info, Node: CI testing on Travis-CI, Prev: Automatic update of the Git mirror, Up: Continuous integration @@ -2116,7 +2153,7 @@ File: tlbuild.info, Node: CI testing on Travis-CI, Prev: Automatic update of t The 'source' tree of TeX Live contains a top-level file '.travis.yml' which controls the automatic testing on Travis-CI. _admin_ has -registered to Travis-CI and allowed access to the Github's 'TeX-Live' +registered with Travis-CI and allowed access to the Github's 'TeX-Live' organization's 'texlive-source' repository. The default settings are to build the last commit of each push. No further action is necessary on Travis-CI. @@ -5046,8 +5083,8 @@ Index * --enable-maintainer-mode: Build system tools. (line 28) * --enable-maintainer-mode <1>: --enable-maintainer-mode. (line 6) -* --enable-missing to ignore dependencies: Build one package. (line 68) -* --enable-mktextfm-default: kpathsea library. (line 20) +* --enable-missing to ignore dependencies: Build one package. (line 71) +* --enable-mktextfm-default: kpathsea library. (line 18) * --enable-multiplatform: --enable-multiplatform. (line 6) * --enable-PROG: --enable-PROG --disable-PROG. @@ -5058,7 +5095,7 @@ Index * --enable-tex-synctex: Configure options for texk/web2c. (line 59) * --enable-texlive-build: --disable-native-texlive-build. - (line 16) + (line 15) * --enable-xi2-scrolling: Configure options for texk/xdvik. (line 13) * --enable-xindy-docs: Configure options for utils/xindy. @@ -5087,7 +5124,7 @@ Index (line 16) * --with-libgs-includes, -libdir: Configure options for texk/dvisvgm. (line 17) -* --with-system-kpathsea: kpathsea library. (line 14) +* --with-system-kpathsea: kpathsea library. (line 13) * --with-system-LIB: Adding a new generic library module. (line 34) * --with-system-LIB <1>: Library-specific configure options. @@ -5107,8 +5144,6 @@ Index * --without-x: --without-x. (line 6) * -C configure option: Build in parallel. (line 11) * -j make option: Build in parallel. (line 6) -* .travis.yml: CI testing on Travis-CI. - (line 6) * adapting TeX Live for distros: Distro builds. (line 54) * adding a new generic library: Adding a new generic library module. (line 6) @@ -5122,15 +5157,15 @@ Index * ANSI C: Declarations and definitions. (line 6) * ApplicationServices Mac framework, required by xetex: Prerequisites. - (line 31) -* asymptote: Linked scripts. (line 22) + (line 32) +* asymptote: Linked scripts. (line 23) * asymptote <1>: asymptote. (line 6) * Autoconf: Overview of build system. (line 6) * autoconf macros: Autoconf macros. (line 6) * Automake: Overview of build system. (line 6) -* biber: Linked scripts. (line 22) +* biber: Linked scripts. (line 23) * bibtex-x: Configure options for texk/bibtex-x. (line 6) * bibtex8: Configure options for texk/bibtex-x. @@ -5141,6 +5176,7 @@ Index * build directory, required: Building. (line 17) * build iteration: Build iteration. (line 6) * build on demand: Build one package. (line 6) +* build one engine: Build one engine. (line 6) * build one package: Build one package. (line 6) * build problems: Build problems. (line 6) * Build script: Building. (line 6) @@ -5152,7 +5188,7 @@ Index * building: Building. (line 6) * building a distribution: Build distribution. (line 6) * building in parallel: Build in parallel. (line 6) -* C++11, required by dvisvgm: Prerequisites. (line 19) +* C++11, required: Prerequisites. (line 15) * C, ANSI, required: Declarations and definitions. (line 6) * C99, avoided: Declarations and definitions. @@ -5162,22 +5198,20 @@ Index * callexe.c: Macros for Windows. (line 32) * CC: Variables for configure. (line 10) -* CC=C-COMPILER: Build one package. (line 73) +* CC=C-COMPILER: Build one package. (line 76) * CC_BUILD: Cross problems. (line 13) * chktex: Declarations and definitions. (line 18) -* ci: Continuous integration. - (line 6) * clisp: Variables for configure. (line 18) * CLISP: Variables for configure. (line 17) * CLISP <1>: Configure options for utils/xindy. (line 14) -* clisp, required by xindy: Prerequisites. (line 35) -* Cocoa Mac framework, required by xetex: Prerequisites. (line 31) +* clisp, required by xindy: Prerequisites. (line 36) +* Cocoa Mac framework, required by xetex: Prerequisites. (line 32) * coding conventions: Coding conventions. (line 6) -* compilers, C and C++: Prerequisites. (line 6) +* compilers, C and C++11: Prerequisites. (line 6) * config.guess, config.sub, ...: Top-level directories. (line 30) * configure options: Configure options. (line 6) @@ -5221,10 +5255,11 @@ Index * ctangle: Cross problems. (line 26) * CXX: Variables for configure. (line 11) -* CXX=C++-COMPILER: Build one package. (line 73) -* Debian installation of build prerequisites: Prerequisites. (line 60) +* CXX=C++-COMPILER: Build one package. (line 76) * declarations and definitions, in source code: Declarations and definitions. (line 6) +* declarations before statements, avoiding: Declarations and definitions. + (line 6) * dependencies, with several output files: Build in parallel. (line 6) * DESTDIR: --prefix --bindir .... (line 9) @@ -5236,36 +5271,39 @@ Index * dist and distcheck targets for make: Build distribution. (line 6) * distribution tarball, making: Build distribution. (line 6) * distro, building for: Distro builds. (line 6) +* dvipdfm-x: Configure options for texk/dvipdfm-x. + (line 6) * dvipdfmx: Configure options for texk/dvipdfm-x. (line 6) * dvisvgm: Configure options for texk/dvisvgm. (line 6) -* dvisvgm requirement for C++11: Prerequisites. (line 19) +* engine, building one: Build one engine. (line 6) * environment variables, for configure: Configure options. (line 16) * exec_prefix: --enable-multiplatform. (line 6) * extending TeX Live: Extending TeX Live. (line 6) * extern functions: Declarations and definitions. - (line 43) -* extra/ top-level directory: Top-level directories. - (line 39) + (line 41) * failure to build: Build problems. (line 6) -* ffcall, required by xindy: Prerequisites. (line 35) * flags, macros for library and header: Macros for library and header flags. (line 6) -* fontconfig library, required by xetex: Prerequisites. (line 31) +* fontconfig library, required by xetex: Prerequisites. (line 32) * FreeType: Prerequisites. (line 11) * freetype cross compiling: Cross problems. (line 13) * freetype library: freetype library. (line 6) -* freetype-config: freetype library. (line 6) +* freetype-config: freetype library. (line 13) * freetype-config <1>: Variables for configure. (line 24) * FT2_CONFIG: Variables for configure. (line 21) -* gcc, default compilers: Build one package. (line 73) +* gcc, default compilers: Build one package. (line 76) * general setup macros: General setup macros. (line 6) * generic library module, adding: Adding a new generic library module. (line 6) +* Ghostscript location for Xdvik: Configure options for texk/xdvik. + (line 6) +* git-svn: Transfer from Subversion to Github. + (line 6) * global configure options: Global configure options. (line 6) * gmake, required: Prerequisites. (line 11) @@ -5283,7 +5321,7 @@ Index (line 22) * infrastructure, tools needed for: Build system tools. (line 6) * inst/ top-level directory: Top-level directories. - (line 43) + (line 39) * install-tl, TeX Live installer: Installing. (line 8) * installation directories: Installation directories. (line 6) @@ -5294,8 +5332,8 @@ Index * iteration through sources, by configure and make: Build iteration. (line 6) * kpathsea library: kpathsea library. (line 6) -* kpathsea.ac: kpathsea library. (line 20) -* kpse-libpng-flags.m4: png library. (line 43) +* kpathsea.ac: kpathsea library. (line 18) +* kpse-libpng-flags.m4: png library. (line 46) * kpse-pkgs.m4: Overview of build system. (line 30) * kpse-zlib-flags.m4: zlib library. (line 6) @@ -5304,7 +5342,7 @@ Index * KPSEWHICH: Variables for configure. (line 29) * KPSE_ADD_FLAGS: Macros for library and header flags. - (line 18) + (line 20) * KPSE_ALL_SYSTEM_FLAGS: Adding a new generic library module. (line 34) * KPSE_BASIC: General setup macros. (line 8) @@ -5318,7 +5356,7 @@ Index * KPSE_COND_MINGW32: Macros for Windows. (line 19) * KPSE_COND_WIN32: Macros for Windows. (line 15) * KPSE_COND_WIN32_WRAP: Macros for Windows. (line 24) -* kpse_cv_cxx_hack: Macros for compilers. (line 34) +* kpse_cv_cxx_hack: Macros for compilers. (line 33) * kpse_cv_have_win32: Macros for Windows. (line 10) * kpse_cv_visibility_c[xx]flags: Macros for compilers. (line 25) * kpse_cv_warning_cflags: Macros for compilers. (line 15) @@ -5328,7 +5366,7 @@ Index * KPSE_LARGEFILE: Macros for libraries. (line 8) * KPSE_LIBPNG_FLAGS: Macros for library and header flags. (line 10) -* KPSE_LIBPNG_FLAGS <1>: png library. (line 43) +* KPSE_LIBPNG_FLAGS <1>: png library. (line 46) * kpse_libs_pkgs: Adding a new generic library module. (line 6) * KPSE_LIB_FLAGS: Macros for library and header flags. @@ -5339,7 +5377,7 @@ Index (line 34) * KPSE_PROG_LEX: Macros for programs. (line 21) * KPSE_RESTORE_FLAGS: Macros for library and header flags. - (line 22) + (line 24) * kpse_texk_pkgs: Adding a new program module. (line 6) * kpse_texlibs_pkgs: Adding a new TeX-specific library module. @@ -5363,6 +5401,10 @@ Index * layout of sources: Layout and infrastructure. (line 6) * LFS (large file support): --disable-largefile. (line 6) +* libexpat, dependency of libfontconfig: Configure options for texk/web2c. + (line 50) +* libfontconfig, hack for avoiding linking dependencies: Configure options for texk/web2c. + (line 50) * libfreetype: Variables for configure. (line 24) * libfreetype, and const: Const. (line 21) @@ -5374,6 +5416,7 @@ Index * library modules: Library modules. (line 6) * library-specific configure options: Library-specific configure options. (line 6) +* libsigsegv, required by xindy: Prerequisites. (line 36) * libstc++, statically linking: Macros for compilers. (line 29) * Libtool: Overview of build system. (line 6) @@ -5398,19 +5441,22 @@ Index * macros, general setup: General setup macros. (line 6) * MAKE: Variables for configure. (line 33) -* make -t: Build system tools. (line 39) +* make -t: Build system tools. (line 43) +* make rules, verbose vs. silent: --enable-silent-rules. + (line 6) * mf-nowin: Configure options for texk/web2c. (line 34) * mingw32: Cross configuring. (line 27) * MINGW32, Automake conditional: Macros for Windows. (line 20) -* mktex.ac: kpathsea library. (line 20) -* mktextfm: kpathsea library. (line 20) +* mktex.ac: kpathsea library. (line 18) +* mktextfm: kpathsea library. (line 18) * modules, for libraries: Library modules. (line 6) * modules, for programs: Program modules. (line 6) * motif: Configure options for texk/xdvik. (line 9) * native cross compilation: Cross compilation. (line 10) -* OBJCXX=OBJC-COMPILER: Build one package. (line 73) +* OBJCXX=OBJC-COMPILER: Build one package. (line 76) +* one engine, building: Build one engine. (line 6) * one package, building: Build one package. (line 6) * OpenGL, required for Asymptote: asymptote. (line 6) * operating system distribution, building for: Distro builds. (line 6) @@ -5419,19 +5465,19 @@ Index * parallel build: Build in parallel. (line 6) * paths, for installation: Installation directories. (line 6) -* PDF files, size of: --disable-largefile. (line 10) +* PDF files, size of: --disable-largefile. (line 11) * PDFLATEX: Variables for configure. (line 41) * PERL: Variables for configure. (line 39) -* perl, required by web2c, etc.: Prerequisites. (line 23) +* perl, required by web2c, etc.: Prerequisites. (line 24) * PKG_CONFIG: Variables for configure. (line 23) * plain.tex, not in source tree: Installing. (line 8) * png library: png library. (line 6) * poppler: Configure options for system poppler. (line 6) -* PostScript files, size of: --disable-largefile. (line 10) +* PostScript files, size of: --disable-largefile. (line 11) * Preining, Norbert: Distro builds. (line 54) * preloaded binaries: Configure options for texk/web2c. (line 45) @@ -5442,18 +5488,19 @@ Index * program modules: Program modules. (line 6) * program-specific configure options: Program-specific configure options. (line 6) +* proxy build system: png library. (line 36) * reautoconf: Build system tools. (line 28) * requirements for building: Prerequisites. (line 6) * runscript.exe: Macros for Windows. (line 25) * scripts, linked and not maintained: Linked scripts. (line 6) -* scrolling: Configure options for texk/xdvik. +* scrolling, smooth: Configure options for texk/xdvik. (line 13) * SED: Variables for configure. (line 34) * setup macros, general: General setup macros. (line 6) * shared libraries, using vs. avoiding: Distro builds. (line 11) -* size of PDF and PS files: --disable-largefile. (line 10) -* size of source tree: Build one package. (line 58) +* size of PDF and PS files: --disable-largefile. (line 11) +* size of source tree: Build one package. (line 60) * source code declarations: Declarations and definitions. (line 6) * source directory building, not supported: Building. (line 17) @@ -5462,11 +5509,11 @@ Index * squeeze: Cross problems. (line 13) * squeeze/configure.ac: xdvik package. (line 14) * static functions: Declarations and definitions. - (line 37) + (line 35) * static linking for C++: Macros for compilers. (line 29) * stpcpy: Declarations and definitions. (line 18) -* Subversion repository: Build system tools. (line 34) +* Subversion repository: Build system tools. (line 38) * support files, separate from build: Installing. (line 8) * symlinks, used for scripts: Linked scripts. (line 6) * synctex: Configure options for texk/web2c. @@ -5482,17 +5529,19 @@ Index (line 6) * texlive.tlpdb, TeX Live database: Installing. (line 8) * tie: Cross problems. (line 26) -* timestamps, in repository: Build system tools. (line 34) +* timestamps, in repository: Build system tools. (line 38) * tools, for building: Build system tools. (line 6) * top-level directories: Top-level directories. (line 6) -* touching files to avoid rerunning: Build system tools. (line 39) +* touching files to avoid rerunning: Build system tools. (line 43) * Travis-CI: Continuous integration. (line 6) -* type cast, avoiding: Const. (line 38) -* use-commit-times, Subversion: Build system tools. (line 34) +* travis.yml: CI testing on Travis-CI. + (line 6) +* type cast from const, avoiding: Const. (line 38) +* use-commit-times, Subversion: Build system tools. (line 38) * variable declarations, in source code: Declarations and definitions. - (line 54) + (line 52) * variables for configure: Variables for configure. (line 6) * warning, discards qualifiers: Const. (line 30) @@ -5500,7 +5549,7 @@ Index * web2c program: Cross problems. (line 13) * web2c.ac: Configure options for texk/web2c. (line 37) -* wget: Linked scripts. (line 22) +* wget: Linked scripts. (line 23) * WIN32, Automake conditional: Macros for Windows. (line 16) * WIN32_WRAP, Automake conditional: Macros for Windows. (line 25) * Windows, invoking scripts on: Linked scripts. (line 6) @@ -5508,12 +5557,13 @@ Index * withenable.ac, for new modules: Adding a new program module. (line 14) * Work/ top-level directory: Top-level directories. - (line 43) + (line 39) * wrapper binary for scripts on Windows: Linked scripts. (line 6) +* wrapper build system: freetype library. (line 6) * X toolkit: Configure options for texk/web2c. (line 22) +* X11 development, required by X clients: Prerequisites. (line 28) * X11 headers, and const: Const. (line 21) -* X11, required by X clients: Prerequisites. (line 27) * xasy: asymptote. (line 6) * xaw: Configure options for texk/xdvik. (line 9) @@ -5522,7 +5572,7 @@ Index (line 6) * xdvipdfmx: Configure options for texk/dvipdfm-x. (line 6) -* xindy: Linked scripts. (line 22) +* xindy: Linked scripts. (line 23) * xindy <1>: xindy package. (line 6) * xindy <2>: Configure options for utils/xindy. (line 6) @@ -5533,7 +5583,7 @@ Index (line 22) * xpdf as library: Configure options for system poppler. (line 6) -* xz: Linked scripts. (line 22) +* xz: Linked scripts. (line 23) * zlib library: zlib library. (line 6) @@ -5541,368 +5591,369 @@ Index Tag Table: Node: Top1208 Node: Introduction2118 -Node: Overview of build system3839 -Node: Prerequisites5882 -Node: Building8280 -Node: Build iteration9585 -Node: Build problems10657 -Node: Build in parallel11060 -Node: Build distribution11652 -Node: Build one package12223 -Node: Cross compilation15626 -Node: Cross configuring16907 -Node: Cross problems18584 -Node: Installing20235 -Node: Installation directories21251 -Node: Linked scripts23067 -Node: Distro builds24548 -Node: Layout and infrastructure26938 -Node: Build system tools27766 -Node: Top-level directories29777 -Node: Autoconf macros32191 -Node: General setup macros32892 -Node: Macros for programs33759 -Node: Macros for compilers34571 -Node: Macros for libraries36005 -Node: Macros for library and header flags36431 -Node: Macros for Windows38311 -Node: Library modules39888 -Node: png library40377 -Node: zlib library42651 -Node: freetype library43166 -Node: kpathsea library43694 -Node: Program modules45093 -Node: t1utils package45521 -Node: xindy package46072 -Node: xdvik package47222 -Node: asymptote48295 -Node: Extending TeX Live48746 -Node: Adding a new program module49523 -Node: Adding a new generic library module52818 -Node: Adding a new TeX-specific library module55031 -Node: Configure options55718 -Node: Global configure options57101 -Node: --disable-native-texlive-build57643 -Node: --prefix --bindir ...58633 -Node: --disable-largefile59173 -Node: --disable-missing59858 -Node: --enable-compiler-warnings=LEVEL60259 -Node: --enable-cxx-runtime-hack60998 -Node: --enable-maintainer-mode61425 -Node: --enable-multiplatform61954 -Node: --enable-shared62492 -Node: --enable-silent-rules62863 -Node: --without-ln-s63319 -Node: --without-x63670 -Node: Program-specific configure options63858 -Node: --enable-PROG --disable-PROG64501 -Node: --disable-all-pkgs64778 -Node: Configure options for texk/web2c65764 -Node: Configure options for texk/bibtex-x68282 -Node: Configure options for texk/dvipdfm-x68825 -Node: Configure options for texk/dvisvgm69598 -Node: Configure options for texk/texlive70484 -Node: Configure options for texk/xdvik70905 -Node: Configure options for utils/xindy71509 -Node: Library-specific configure options72410 -Node: Configure options for kpathsea73421 -Node: Configure options for system poppler74130 -Node: Variables for configure74921 -Node: Coding conventions76349 -Node: Declarations and definitions77088 -Node: Const79270 -Node: Continuous integration81133 -Node: Transfer from Subversion to Github81787 -Node: Automatic update of the Git mirror83969 -Node: CI testing on Travis-CI84557 -Node: install-tl85237 -Node: install-tl NAME85606 -Node: install-tl SYNOPSIS85764 -Node: install-tl DESCRIPTION86022 -Node: install-tl REFERENCES87089 -Node: install-tl OPTIONS87615 -Ref: install-tl *-gui* [[=]_module_]87956 -Ref: install-tl text88166 -Ref: install-tl wizard88289 -Ref: install-tl perltk88443 -Ref: install-tl *-no-gui*88874 -Ref: install-tl *-lang* _llcode_88955 -Ref: install-tl *-repository* _url|path_89642 -Ref: install-tl *-select-repository*91522 -Ref: install-tl *-all-options*91958 -Ref: install-tl *-custom-bin* _path_92213 -Ref: install-tl *-debug-translation*93044 -Ref: install-tl *-force-platform* _platform_93263 -Ref: install-tl *-help*, *--help*, *-?*93507 -Ref: install-tl *-in-place*93914 -Ref: install-tl *-init-from-profile* _profile_file_94459 -Ref: install-tl *-logfile* _file_94679 -Ref: install-tl *-no-cls*95030 -Ref: install-tl *-non-admin*95164 -Ref: install-tl *-persistent-downloads*95269 -Ref: install-tl *-no-persistent-downloads*95297 -Ref: install-tl *-no-verify-downloads*95915 -Ref: install-tl *-portable*96276 -Ref: install-tl *-print-platform*96415 -Ref: install-tl *-profile* _profile_file_96613 -Ref: install-tl *-q*96793 -Ref: install-tl *-scheme* _scheme_96855 -Ref: install-tl *-v*97329 -Ref: install-tl *-version*, *--version*97484 -Node: install-tl PROFILES97615 -Ref: install-tl instopt_adjustpath (default 0 on Unix, 1 on Windows)100265 -Ref: install-tl instopt_adjustrepo (default 1)100341 -Ref: install-tl instopt_letter (default 0)100478 -Ref: install-tl instopt_portable (default 0)100569 -Ref: install-tl instopt_write18_restricted (default 1)100665 -Node: install-tl ENVIRONMENT VARIABLES101984 -Ref: install-tl TEXLIVE_INSTALL_ENV_NOCHECK102375 -Ref: install-tl TEXLIVE_INSTALL_NO_CONTEXT_CACHE102577 -Ref: install-tl TEXLIVE_INSTALL_NO_WELCOME102687 -Ref: install-tl TEXLIVE_INSTALL_PREFIX102808 -Ref: install-tl TEXLIVE_INSTALL_TEXDIR102834 -Ref: install-tl TEXLIVE_INSTALL_TEXMFCONFIG102865 -Ref: install-tl TEXLIVE_INSTALL_TEXMFVAR102893 -Ref: install-tl TEXLIVE_INSTALL_TEXMFHOME102922 -Ref: install-tl TEXLIVE_INSTALL_TEXMFLOCAL102952 -Ref: install-tl TEXLIVE_INSTALL_TEXMFSYSCONFIG102986 -Ref: install-tl TEXLIVE_INSTALL_TEXMFSYSVAR103017 -Ref: install-tl NOPERLDOC103388 -Node: install-tl AUTHORS AND COPYRIGHT103452 -Node: tlmgr103868 -Node: tlmgr NAME104321 -Node: tlmgr SYNOPSIS104453 -Node: tlmgr DESCRIPTION104643 -Node: tlmgr EXAMPLES105739 -Ref: tlmgr tlmgr option repository ctan105990 -Ref: tlmgr tlmgr option repository http://mirror.ctan.org/systems/texlive/tlnet106062 -Ref: tlmgr tlmgr update --list106514 -Ref: tlmgr tlmgr update --all106607 -Ref: tlmgr tlmgr info _what_106764 -Node: tlmgr OPTIONS107026 -Ref: tlmgr *--repository* _url|path_107546 -Ref: tlmgr *--gui* [_action_]108271 -Ref: tlmgr *--gui-lang* _llcode_108678 -Ref: tlmgr *--debug-translation*109361 -Ref: tlmgr *--machine-readable*109564 -Ref: tlmgr *--no-execute-actions*109832 -Ref: tlmgr *--package-logfile* _file_110025 -Ref: tlmgr *--pause*110279 -Ref: tlmgr *--persistent-downloads*110434 -Ref: tlmgr *--no-persistent-downloads*110462 -Ref: tlmgr *--pin-file*110956 -Ref: tlmgr *--usermode*111174 -Ref: tlmgr *--usertree* _dir_111294 -Ref: tlmgr *--verify-repo=[none|main|all]*111420 -Node: tlmgr ACTIONS112319 -Node: tlmgr help113171 -Node: tlmgr version113647 -Node: tlmgr backup113910 -Ref: tlmgr *backup [_option_...] --all*114081 -Ref: tlmgr *backup [_option_...] _pkg_...*114114 -Ref: tlmgr *--backupdir* _directory_114969 -Ref: tlmgr *--all*115186 -Ref: tlmgr *--clean*[=_N_]115438 -Ref: tlmgr *--dry-run*115765 -Node: tlmgr candidates _pkg_115895 -Node: tlmgr check [_option_...] [files|depends|executes|runfiles|all]116241 -Ref: tlmgr *files*116614 -Ref: tlmgr *depends*116749 -Ref: tlmgr *executes*117091 -Ref: tlmgr *runfiles*117209 -Ref: tlmgr *--use-svn*117330 -Node: tlmgr conf117447 -Ref: tlmgr *conf [texmf|tlmgr|updmap [--conffile _file_] [--delete] [_key_ [_value_]]]*117726 -Ref: tlmgr *conf auxtrees [--conffile _file_] [show|add|delete] [_value_]*117790 -Node: tlmgr dump-tlpdb [_option_...] [--json]120135 -Ref: tlmgr *--local*120568 -Ref: tlmgr *--remote*120607 -Ref: tlmgr *--json*120645 -Node: tlmgr generate121216 -Ref: tlmgr *generate [_option_...] language*121412 -Ref: tlmgr *generate [_option_...] language.dat*121451 -Ref: tlmgr *generate [_option_...] language.def*121490 -Ref: tlmgr *generate [_option_...] language.dat.lua*121533 -Ref: tlmgr *--dest* _output_file_123859 -Ref: tlmgr *--localcfg* _local_conf_file_124435 -Ref: tlmgr *--rebuild-sys*124558 -Node: tlmgr gui125373 -Node: tlmgr info125551 -Ref: tlmgr *info [_option_...] _pkg_...*125713 -Ref: tlmgr *info [_option_...] collections*125747 -Ref: tlmgr *info [_option_...] schemes*125777 -Ref: tlmgr *--list*127307 -Ref: tlmgr *--only-installed*127621 -Ref: tlmgr *--data item1,item2,...*127820 -Ref: tlmgr *--json* 1128401 -Node: tlmgr init-usertree128784 -Node: tlmgr install [_option_...] _pkg_...129165 -Ref: tlmgr *--dry-run* 1129675 -Ref: tlmgr *--file*129792 -Ref: tlmgr *--force*130014 -Ref: tlmgr *--no-depends*130234 -Ref: tlmgr *--no-depends-at-all*130393 -Ref: tlmgr *--reinstall*130793 -Ref: tlmgr *--with-doc*131171 -Ref: tlmgr *--with-src*131184 -Node: tlmgr key131706 -Ref: tlmgr *key list*131864 -Ref: tlmgr *key add _file_*131882 -Ref: tlmgr *key remove _keyid_*131904 -Node: tlmgr list132499 -Node: tlmgr option132661 -Ref: tlmgr *option [--json] [show]*132816 -Ref: tlmgr *option [--json] showall*132842 -Ref: tlmgr *option _key_ [_value_]*132868 -Node: tlmgr paper137265 -Ref: tlmgr *paper [a4|letter]*137414 -Ref: tlmgr *[xdvi|pdftex|dvips|dvipdfmx|context|psutils] paper [_papersize_|--list]*137488 -Ref: tlmgr *paper --json*137503 -Node: tlmgr path138718 -Ref: tlmgr *path [--w32mode=user|admin] add*138879 -Ref: tlmgr *path [--w32mode=user|admin] remove*138916 -Node: tlmgr pinning140256 -Ref: tlmgr pinning show140497 -Ref: tlmgr pinning add _repo_ _pkgglob_...140570 -Ref: tlmgr pinning remove _repo_ _pkgglob_...140689 -Ref: tlmgr pinning remove _repo_ --all140842 -Node: tlmgr platform140896 -Ref: tlmgr *platform list|add|remove _platform_...*141082 -Ref: tlmgr *platform set _platform_*141109 -Ref: tlmgr *platform set auto*141130 -Ref: tlmgr *--dry-run* 2142016 -Node: tlmgr postaction142135 -Ref: tlmgr *postaction [_option_...] install [shortcut|fileassoc|script] [_pkg_...]*142365 -Ref: tlmgr *postaction [_option_...] remove [shortcut|fileassoc|script] [_pkg_...]*142439 -Ref: tlmgr *--w32mode=[user|admin]*142754 -Ref: tlmgr *--fileassocmode=[1|2]*143170 -Ref: tlmgr *--all* 1143455 -Node: tlmgr print-platform143510 -Node: tlmgr print-platform-info143841 -Node: tlmgr remove [_option_...] _pkg_...144141 -Ref: tlmgr *--all* 2144625 -Ref: tlmgr *--backup*144735 -Ref: tlmgr *--backupdir* _directory_ 1144761 -Ref: tlmgr *--no-depends* 1145166 -Ref: tlmgr *--no-depends-at-all* 1145228 -Ref: tlmgr *--force* 1145331 -Ref: tlmgr *--dry-run* 3145804 -Node: tlmgr repository145911 -Ref: tlmgr *repository list*146099 -Ref: tlmgr *repository list _path|tag_*146129 -Ref: tlmgr *repository add _path_ [_tag_]*146162 -Ref: tlmgr *repository remove _path|tag_*146194 -Ref: tlmgr *repository set _path_[#_tag_] [_path_[#_tag_] ...]*146248 -Node: tlmgr restore147301 -Ref: tlmgr *restore [_option_...] _pkg_ [_rev_]*147480 -Ref: tlmgr *restore [_option_...] --all*147510 -Ref: tlmgr *--all* 3148210 -Ref: tlmgr *--backupdir* _directory_ 2148424 -Ref: tlmgr *--dry-run* 4148605 -Ref: tlmgr *--force* 2148737 -Ref: tlmgr *--json* 2148783 -Node: tlmgr search149110 -Ref: tlmgr *search [_option_...] _what_*149274 -Ref: tlmgr *search [_option_...] --file _what_*149311 -Ref: tlmgr *search [_option_...] --all _what_*149347 -Ref: tlmgr *--file* 1149567 -Ref: tlmgr *--all* 4149629 -Ref: tlmgr *--global*149718 -Ref: tlmgr *--word*149845 -Node: tlmgr shell150160 -Ref: tlmgr protocol150895 -Ref: tlmgr help 1150959 -Ref: tlmgr version 1151012 -Ref: tlmgr quit, end, bye, byebye, EOF151080 -Ref: tlmgr restart151101 -Ref: tlmgr load [local|remote]151224 -Ref: tlmgr save151294 -Ref: tlmgr get [_var_] =item set [_var_ [_val_]]151417 -Node: tlmgr show152018 -Node: tlmgr uninstall152185 -Node: tlmgr update [_option_...] [_pkg_...]152415 -Ref: tlmgr *--all* 5152786 -Ref: tlmgr *--self*154527 -Ref: tlmgr *--dry-run* 5155291 -Ref: tlmgr *--list* [_pkg_]155468 -Ref: tlmgr *--exclude* _pkg_156157 -Ref: tlmgr *--no-auto-remove* [_pkg_...]156957 -Ref: tlmgr *--no-auto-install* [_pkg_...]157408 -Ref: tlmgr *--reinstall-forcibly-removed*158064 -Ref: tlmgr *--backup* 1158599 -Ref: tlmgr *--backupdir* _directory_ 3158625 -Ref: tlmgr *--no-depends* 2159791 -Ref: tlmgr *--no-depends-at-all* 2159994 -Ref: tlmgr *--force* 3160097 -Node: tlmgr CONFIGURATION FILE FOR TLMGR160912 -Ref: tlmgr auto-remove, value 0 or 1 (default 1), same as command-line option.161925 -Ref: tlmgr gui-expertmode, value 0 or 1 (default 1). This switches between the full GUI and a simplified GUI with only the most common settings.162062 -Ref: tlmgr gui-lang _llcode_, with a language code value as with the command-line option.162144 -Ref: tlmgr no-checksums, value 0 or 1 (default 0, see below).162198 -Ref: tlmgr persistent-downloads, value 0 or 1 (default 1), same as command-line option.162278 -Ref: tlmgr require-verification, value 0 or 1 (default 0), same as command-line option.162358 -Ref: tlmgr update-exclude, value: comma-separated list of packages (no space allowed). Same as the command line option --exclude for the action update.162506 -Ref: tlmgr verify-downloads, value 0 or 1 (default 1), same as command-line option.162582 -Ref: tlmgr allowed-actions _action1_ [,_action_,...] The value is a comma-separated list of tlmgr actions which are allowed to be executed when tlmgr is invoked in system mode (that is, without --usermode).162851 -Node: tlmgr CRYPTOGRAPHIC VERIFICATION163937 -Node: tlmgr Configuration of GnuPG invocation166086 -Node: tlmgr USER MODE166724 -Node: tlmgr User mode install169570 -Node: tlmgr User mode backup, restore, remove, update170714 -Node: tlmgr User mode generate, option, paper171156 -Node: tlmgr MULTIPLE REPOSITORIES171532 -Node: tlmgr Pinning173261 -Node: tlmgr GUI FOR TLMGR175236 -Node: tlmgr Main display176576 -Node: tlmgr Display configuration area176828 -Ref: tlmgr Status177189 -Ref: tlmgr Category177353 -Ref: tlmgr Match177539 -Ref: tlmgr Selection177720 -Ref: tlmgr Display configuration buttons177924 -Node: tlmgr Package list area178107 -Ref: tlmgr a checkbox178691 -Ref: tlmgr package name178827 -Ref: tlmgr local revision (and version)178926 -Ref: tlmgr remote revision (and version)179301 -Ref: tlmgr short description179598 -Node: tlmgr Main display action buttons179643 -Ref: tlmgr Update all installed179909 -Ref: tlmgr Update180281 -Ref: tlmgr Install180331 -Ref: tlmgr Remove180517 -Ref: tlmgr Backup180695 -Node: tlmgr Menu bar180852 -Ref: tlmgr tlmgr menu181075 -Ref: tlmgr Options menu181383 -Ref: tlmgr Actions menu182466 -Ref: tlmgr Help menu182894 -Node: tlmgr GUI options183027 -Ref: tlmgr -background _color_183273 -Ref: tlmgr -font " _fontname_ _fontsize_ "183338 -Ref: tlmgr -foreground _color_183496 -Ref: tlmgr -geometry _geomspec_183548 -Ref: tlmgr -xrm _xresource_183740 -Node: tlmgr MACHINE-READABLE OUTPUT184008 -Node: tlmgr Machine-readable update and install output184818 -Ref: tlmgr location-url _location_186094 -Ref: tlmgr total-bytes _count_186310 -Ref: tlmgr _pkgname_186720 -Ref: tlmgr _status_186930 -Ref: tlmgr d187008 -Ref: tlmgr f187068 -Ref: tlmgr u187247 -Ref: tlmgr r187293 -Ref: tlmgr a187416 -Ref: tlmgr i187594 -Ref: tlmgr I187713 -Ref: tlmgr _localrev_187815 -Ref: tlmgr _serverrev_187922 -Ref: tlmgr _size_188034 -Ref: tlmgr _runtime_188203 -Ref: tlmgr _esttot_188273 -Node: tlmgr Machine-readable option output188306 -Node: tlmgr AUTHORS AND COPYRIGHT188818 -Node: Index189217 +Node: Overview of build system3946 +Node: Prerequisites5997 +Node: Building8618 +Node: Build iteration10004 +Node: Build problems11045 +Node: Build in parallel11499 +Node: Build distribution12103 +Node: Build one package12751 +Node: Build one engine16386 +Node: Cross compilation17401 +Node: Cross configuring18681 +Node: Cross problems20358 +Node: Installing22011 +Node: Installation directories23031 +Node: Linked scripts24848 +Node: Distro builds26339 +Node: Layout and infrastructure28716 +Node: Build system tools29544 +Node: Top-level directories31790 +Node: Autoconf macros34026 +Node: General setup macros34788 +Node: Macros for programs35663 +Node: Macros for compilers36464 +Node: Macros for libraries37872 +Node: Macros for library and header flags38298 +Node: Macros for Windows40209 +Node: Library modules41796 +Node: png library42285 +Node: zlib library44633 +Node: freetype library45148 +Node: kpathsea library45844 +Node: Program modules47223 +Node: t1utils package47651 +Node: xindy package48196 +Node: xdvik package49351 +Node: asymptote50410 +Node: Extending TeX Live50906 +Node: Adding a new program module51689 +Node: Adding a new generic library module55028 +Node: Adding a new TeX-specific library module57257 +Node: Configure options57955 +Node: Global configure options59335 +Node: --disable-native-texlive-build59877 +Node: --prefix --bindir ...60839 +Node: --disable-largefile61379 +Node: --disable-missing62080 +Node: --enable-compiler-warnings=LEVEL62481 +Node: --enable-cxx-runtime-hack63137 +Node: --enable-maintainer-mode63557 +Node: --enable-multiplatform64086 +Node: --enable-shared64659 +Node: --enable-silent-rules65030 +Node: --without-ln-s65482 +Node: --without-x65829 +Node: Program-specific configure options66017 +Node: --enable-PROG --disable-PROG66660 +Node: --disable-all-pkgs66933 +Node: Configure options for texk/web2c67716 +Node: Configure options for texk/bibtex-x70254 +Node: Configure options for texk/dvipdfm-x70797 +Node: Configure options for texk/dvisvgm71573 +Node: Configure options for texk/texlive72454 +Node: Configure options for texk/xdvik72875 +Node: Configure options for utils/xindy73496 +Node: Library-specific configure options74386 +Node: Configure options for kpathsea75388 +Node: Configure options for system poppler76137 +Node: Variables for configure76901 +Node: Coding conventions78327 +Node: Declarations and definitions79042 +Node: Const81216 +Node: Continuous integration83079 +Node: Transfer from Subversion to Github83720 +Node: Automatic update of the Git mirror85882 +Node: CI testing on Travis-CI86464 +Node: install-tl87146 +Node: install-tl NAME87515 +Node: install-tl SYNOPSIS87673 +Node: install-tl DESCRIPTION87931 +Node: install-tl REFERENCES88998 +Node: install-tl OPTIONS89524 +Ref: install-tl *-gui* [[=]_module_]89865 +Ref: install-tl text90075 +Ref: install-tl wizard90198 +Ref: install-tl perltk90352 +Ref: install-tl *-no-gui*90783 +Ref: install-tl *-lang* _llcode_90864 +Ref: install-tl *-repository* _url|path_91551 +Ref: install-tl *-select-repository*93431 +Ref: install-tl *-all-options*93867 +Ref: install-tl *-custom-bin* _path_94122 +Ref: install-tl *-debug-translation*94953 +Ref: install-tl *-force-platform* _platform_95172 +Ref: install-tl *-help*, *--help*, *-?*95416 +Ref: install-tl *-in-place*95823 +Ref: install-tl *-init-from-profile* _profile_file_96368 +Ref: install-tl *-logfile* _file_96588 +Ref: install-tl *-no-cls*96939 +Ref: install-tl *-non-admin*97073 +Ref: install-tl *-persistent-downloads*97178 +Ref: install-tl *-no-persistent-downloads*97206 +Ref: install-tl *-no-verify-downloads*97824 +Ref: install-tl *-portable*98185 +Ref: install-tl *-print-platform*98324 +Ref: install-tl *-profile* _profile_file_98522 +Ref: install-tl *-q*98702 +Ref: install-tl *-scheme* _scheme_98764 +Ref: install-tl *-v*99238 +Ref: install-tl *-version*, *--version*99393 +Node: install-tl PROFILES99524 +Ref: install-tl instopt_adjustpath (default 0 on Unix, 1 on Windows)102174 +Ref: install-tl instopt_adjustrepo (default 1)102250 +Ref: install-tl instopt_letter (default 0)102387 +Ref: install-tl instopt_portable (default 0)102478 +Ref: install-tl instopt_write18_restricted (default 1)102574 +Node: install-tl ENVIRONMENT VARIABLES103893 +Ref: install-tl TEXLIVE_INSTALL_ENV_NOCHECK104284 +Ref: install-tl TEXLIVE_INSTALL_NO_CONTEXT_CACHE104486 +Ref: install-tl TEXLIVE_INSTALL_NO_WELCOME104596 +Ref: install-tl TEXLIVE_INSTALL_PREFIX104717 +Ref: install-tl TEXLIVE_INSTALL_TEXDIR104743 +Ref: install-tl TEXLIVE_INSTALL_TEXMFCONFIG104774 +Ref: install-tl TEXLIVE_INSTALL_TEXMFVAR104802 +Ref: install-tl TEXLIVE_INSTALL_TEXMFHOME104831 +Ref: install-tl TEXLIVE_INSTALL_TEXMFLOCAL104861 +Ref: install-tl TEXLIVE_INSTALL_TEXMFSYSCONFIG104895 +Ref: install-tl TEXLIVE_INSTALL_TEXMFSYSVAR104926 +Ref: install-tl NOPERLDOC105297 +Node: install-tl AUTHORS AND COPYRIGHT105361 +Node: tlmgr105777 +Node: tlmgr NAME106230 +Node: tlmgr SYNOPSIS106362 +Node: tlmgr DESCRIPTION106552 +Node: tlmgr EXAMPLES107648 +Ref: tlmgr tlmgr option repository ctan107899 +Ref: tlmgr tlmgr option repository http://mirror.ctan.org/systems/texlive/tlnet107971 +Ref: tlmgr tlmgr update --list108423 +Ref: tlmgr tlmgr update --all108516 +Ref: tlmgr tlmgr info _what_108673 +Node: tlmgr OPTIONS108935 +Ref: tlmgr *--repository* _url|path_109455 +Ref: tlmgr *--gui* [_action_]110180 +Ref: tlmgr *--gui-lang* _llcode_110587 +Ref: tlmgr *--debug-translation*111270 +Ref: tlmgr *--machine-readable*111473 +Ref: tlmgr *--no-execute-actions*111741 +Ref: tlmgr *--package-logfile* _file_111934 +Ref: tlmgr *--pause*112188 +Ref: tlmgr *--persistent-downloads*112343 +Ref: tlmgr *--no-persistent-downloads*112371 +Ref: tlmgr *--pin-file*112865 +Ref: tlmgr *--usermode*113083 +Ref: tlmgr *--usertree* _dir_113203 +Ref: tlmgr *--verify-repo=[none|main|all]*113329 +Node: tlmgr ACTIONS114228 +Node: tlmgr help115080 +Node: tlmgr version115556 +Node: tlmgr backup115819 +Ref: tlmgr *backup [_option_...] --all*115990 +Ref: tlmgr *backup [_option_...] _pkg_...*116023 +Ref: tlmgr *--backupdir* _directory_116878 +Ref: tlmgr *--all*117095 +Ref: tlmgr *--clean*[=_N_]117347 +Ref: tlmgr *--dry-run*117674 +Node: tlmgr candidates _pkg_117804 +Node: tlmgr check [_option_...] [files|depends|executes|runfiles|all]118150 +Ref: tlmgr *files*118523 +Ref: tlmgr *depends*118658 +Ref: tlmgr *executes*119000 +Ref: tlmgr *runfiles*119118 +Ref: tlmgr *--use-svn*119239 +Node: tlmgr conf119356 +Ref: tlmgr *conf [texmf|tlmgr|updmap [--conffile _file_] [--delete] [_key_ [_value_]]]*119635 +Ref: tlmgr *conf auxtrees [--conffile _file_] [show|add|delete] [_value_]*119699 +Node: tlmgr dump-tlpdb [_option_...] [--json]122044 +Ref: tlmgr *--local*122477 +Ref: tlmgr *--remote*122516 +Ref: tlmgr *--json*122554 +Node: tlmgr generate123125 +Ref: tlmgr *generate [_option_...] language*123321 +Ref: tlmgr *generate [_option_...] language.dat*123360 +Ref: tlmgr *generate [_option_...] language.def*123399 +Ref: tlmgr *generate [_option_...] language.dat.lua*123442 +Ref: tlmgr *--dest* _output_file_125768 +Ref: tlmgr *--localcfg* _local_conf_file_126344 +Ref: tlmgr *--rebuild-sys*126467 +Node: tlmgr gui127282 +Node: tlmgr info127460 +Ref: tlmgr *info [_option_...] _pkg_...*127622 +Ref: tlmgr *info [_option_...] collections*127656 +Ref: tlmgr *info [_option_...] schemes*127686 +Ref: tlmgr *--list*129216 +Ref: tlmgr *--only-installed*129530 +Ref: tlmgr *--data item1,item2,...*129729 +Ref: tlmgr *--json* 1130310 +Node: tlmgr init-usertree130693 +Node: tlmgr install [_option_...] _pkg_...131074 +Ref: tlmgr *--dry-run* 1131584 +Ref: tlmgr *--file*131701 +Ref: tlmgr *--force*131923 +Ref: tlmgr *--no-depends*132143 +Ref: tlmgr *--no-depends-at-all*132302 +Ref: tlmgr *--reinstall*132702 +Ref: tlmgr *--with-doc*133080 +Ref: tlmgr *--with-src*133093 +Node: tlmgr key133615 +Ref: tlmgr *key list*133773 +Ref: tlmgr *key add _file_*133791 +Ref: tlmgr *key remove _keyid_*133813 +Node: tlmgr list134408 +Node: tlmgr option134570 +Ref: tlmgr *option [--json] [show]*134725 +Ref: tlmgr *option [--json] showall*134751 +Ref: tlmgr *option _key_ [_value_]*134777 +Node: tlmgr paper139174 +Ref: tlmgr *paper [a4|letter]*139323 +Ref: tlmgr *[xdvi|pdftex|dvips|dvipdfmx|context|psutils] paper [_papersize_|--list]*139397 +Ref: tlmgr *paper --json*139412 +Node: tlmgr path140627 +Ref: tlmgr *path [--w32mode=user|admin] add*140788 +Ref: tlmgr *path [--w32mode=user|admin] remove*140825 +Node: tlmgr pinning142165 +Ref: tlmgr pinning show142406 +Ref: tlmgr pinning add _repo_ _pkgglob_...142479 +Ref: tlmgr pinning remove _repo_ _pkgglob_...142598 +Ref: tlmgr pinning remove _repo_ --all142751 +Node: tlmgr platform142805 +Ref: tlmgr *platform list|add|remove _platform_...*142991 +Ref: tlmgr *platform set _platform_*143018 +Ref: tlmgr *platform set auto*143039 +Ref: tlmgr *--dry-run* 2143925 +Node: tlmgr postaction144044 +Ref: tlmgr *postaction [_option_...] install [shortcut|fileassoc|script] [_pkg_...]*144274 +Ref: tlmgr *postaction [_option_...] remove [shortcut|fileassoc|script] [_pkg_...]*144348 +Ref: tlmgr *--w32mode=[user|admin]*144663 +Ref: tlmgr *--fileassocmode=[1|2]*145079 +Ref: tlmgr *--all* 1145364 +Node: tlmgr print-platform145419 +Node: tlmgr print-platform-info145750 +Node: tlmgr remove [_option_...] _pkg_...146050 +Ref: tlmgr *--all* 2146534 +Ref: tlmgr *--backup*146644 +Ref: tlmgr *--backupdir* _directory_ 1146670 +Ref: tlmgr *--no-depends* 1147075 +Ref: tlmgr *--no-depends-at-all* 1147137 +Ref: tlmgr *--force* 1147240 +Ref: tlmgr *--dry-run* 3147713 +Node: tlmgr repository147820 +Ref: tlmgr *repository list*148008 +Ref: tlmgr *repository list _path|tag_*148038 +Ref: tlmgr *repository add _path_ [_tag_]*148071 +Ref: tlmgr *repository remove _path|tag_*148103 +Ref: tlmgr *repository set _path_[#_tag_] [_path_[#_tag_] ...]*148157 +Node: tlmgr restore149210 +Ref: tlmgr *restore [_option_...] _pkg_ [_rev_]*149389 +Ref: tlmgr *restore [_option_...] --all*149419 +Ref: tlmgr *--all* 3150119 +Ref: tlmgr *--backupdir* _directory_ 2150333 +Ref: tlmgr *--dry-run* 4150514 +Ref: tlmgr *--force* 2150646 +Ref: tlmgr *--json* 2150692 +Node: tlmgr search151019 +Ref: tlmgr *search [_option_...] _what_*151183 +Ref: tlmgr *search [_option_...] --file _what_*151220 +Ref: tlmgr *search [_option_...] --all _what_*151256 +Ref: tlmgr *--file* 1151476 +Ref: tlmgr *--all* 4151538 +Ref: tlmgr *--global*151627 +Ref: tlmgr *--word*151754 +Node: tlmgr shell152069 +Ref: tlmgr protocol152804 +Ref: tlmgr help 1152868 +Ref: tlmgr version 1152921 +Ref: tlmgr quit, end, bye, byebye, EOF152989 +Ref: tlmgr restart153010 +Ref: tlmgr load [local|remote]153133 +Ref: tlmgr save153203 +Ref: tlmgr get [_var_] =item set [_var_ [_val_]]153326 +Node: tlmgr show153927 +Node: tlmgr uninstall154094 +Node: tlmgr update [_option_...] [_pkg_...]154324 +Ref: tlmgr *--all* 5154695 +Ref: tlmgr *--self*156436 +Ref: tlmgr *--dry-run* 5157200 +Ref: tlmgr *--list* [_pkg_]157377 +Ref: tlmgr *--exclude* _pkg_158066 +Ref: tlmgr *--no-auto-remove* [_pkg_...]158866 +Ref: tlmgr *--no-auto-install* [_pkg_...]159317 +Ref: tlmgr *--reinstall-forcibly-removed*159973 +Ref: tlmgr *--backup* 1160508 +Ref: tlmgr *--backupdir* _directory_ 3160534 +Ref: tlmgr *--no-depends* 2161700 +Ref: tlmgr *--no-depends-at-all* 2161903 +Ref: tlmgr *--force* 3162006 +Node: tlmgr CONFIGURATION FILE FOR TLMGR162821 +Ref: tlmgr auto-remove, value 0 or 1 (default 1), same as command-line option.163834 +Ref: tlmgr gui-expertmode, value 0 or 1 (default 1). This switches between the full GUI and a simplified GUI with only the most common settings.163971 +Ref: tlmgr gui-lang _llcode_, with a language code value as with the command-line option.164053 +Ref: tlmgr no-checksums, value 0 or 1 (default 0, see below).164107 +Ref: tlmgr persistent-downloads, value 0 or 1 (default 1), same as command-line option.164187 +Ref: tlmgr require-verification, value 0 or 1 (default 0), same as command-line option.164267 +Ref: tlmgr update-exclude, value: comma-separated list of packages (no space allowed). Same as the command line option --exclude for the action update.164415 +Ref: tlmgr verify-downloads, value 0 or 1 (default 1), same as command-line option.164491 +Ref: tlmgr allowed-actions _action1_ [,_action_,...] The value is a comma-separated list of tlmgr actions which are allowed to be executed when tlmgr is invoked in system mode (that is, without --usermode).164760 +Node: tlmgr CRYPTOGRAPHIC VERIFICATION165846 +Node: tlmgr Configuration of GnuPG invocation167995 +Node: tlmgr USER MODE168633 +Node: tlmgr User mode install171479 +Node: tlmgr User mode backup, restore, remove, update172623 +Node: tlmgr User mode generate, option, paper173065 +Node: tlmgr MULTIPLE REPOSITORIES173441 +Node: tlmgr Pinning175170 +Node: tlmgr GUI FOR TLMGR177145 +Node: tlmgr Main display178485 +Node: tlmgr Display configuration area178737 +Ref: tlmgr Status179098 +Ref: tlmgr Category179262 +Ref: tlmgr Match179448 +Ref: tlmgr Selection179629 +Ref: tlmgr Display configuration buttons179833 +Node: tlmgr Package list area180016 +Ref: tlmgr a checkbox180600 +Ref: tlmgr package name180736 +Ref: tlmgr local revision (and version)180835 +Ref: tlmgr remote revision (and version)181210 +Ref: tlmgr short description181507 +Node: tlmgr Main display action buttons181552 +Ref: tlmgr Update all installed181818 +Ref: tlmgr Update182190 +Ref: tlmgr Install182240 +Ref: tlmgr Remove182426 +Ref: tlmgr Backup182604 +Node: tlmgr Menu bar182761 +Ref: tlmgr tlmgr menu182984 +Ref: tlmgr Options menu183292 +Ref: tlmgr Actions menu184375 +Ref: tlmgr Help menu184803 +Node: tlmgr GUI options184936 +Ref: tlmgr -background _color_185182 +Ref: tlmgr -font " _fontname_ _fontsize_ "185247 +Ref: tlmgr -foreground _color_185405 +Ref: tlmgr -geometry _geomspec_185457 +Ref: tlmgr -xrm _xresource_185649 +Node: tlmgr MACHINE-READABLE OUTPUT185917 +Node: tlmgr Machine-readable update and install output186727 +Ref: tlmgr location-url _location_188003 +Ref: tlmgr total-bytes _count_188219 +Ref: tlmgr _pkgname_188629 +Ref: tlmgr _status_188839 +Ref: tlmgr d188917 +Ref: tlmgr f188977 +Ref: tlmgr u189156 +Ref: tlmgr r189202 +Ref: tlmgr a189325 +Ref: tlmgr i189503 +Ref: tlmgr I189622 +Ref: tlmgr _localrev_189724 +Ref: tlmgr _serverrev_189831 +Ref: tlmgr _size_189943 +Ref: tlmgr _runtime_190112 +Ref: tlmgr _esttot_190182 +Node: tlmgr Machine-readable option output190215 +Node: tlmgr AUTHORS AND COPYRIGHT190727 +Node: Index191126  End Tag Table diff --git a/Build/source/doc/tlbuild.texi b/Build/source/doc/tlbuild.texi index 2d62db5f530..342bc6bd313 100644 --- a/Build/source/doc/tlbuild.texi +++ b/Build/source/doc/tlbuild.texi @@ -1,8 +1,8 @@ \input texinfo @setfilename tlbuild.info -@set version 2018 -@set month-year August 2018 +@set version 2019 +@set month-year February 2019 @set mytitle Building @TeX{} Live (@value{version}) @settitle @value{mytitle} @@ -15,7 +15,7 @@ This file documents the @TL{} build system and more. @noindent -Copyright @copyright{} 2016--2018 Karl Berry.@* +Copyright @copyright{} 2016--2019 Karl Berry.@* Copyright @copyright{} 2013--2015 Karl Berry & Peter Breitenlohner. Permission is granted to make and distribute verbatim copies of this @@ -64,7 +64,7 @@ approved by the @TeX{} Users Group. @subtitle @value{month-year} @author Peter Breitenlohner @author Karl Berry -@author @url{http://tug.org/texlive} +@author @url{https://tug.org/texlive} @page @vskip 0pt plus 1filll @@ -110,42 +110,43 @@ on how to configure, build, and develop the @TL{} (TL) sources. It is also available as plain text files in the source tree: @file{source/README.*}. -The @file{source/README} file in the TL source tree provides the +The main @file{source/README} file in the TL source tree provides maximally-terse information for doing a build, and portability information for different systems, along with @file{source/doc/README.solaris}. For information on acquiring the TL sources, see -@url{http://tug.org/texlive/svn}. +@url{https://tug.org/texlive/svn}. The canonical source repository +uses Subversion, and we have no plans to change this. This manual does not duplicate the information found in other TL documentation resources, such as: @itemize -@item The @TL{} web pages: @url{http://tug.org/texlive}. +@item The @TL{} web pages: @url{https://tug.org/texlive}. @item The web page describing how to build the binaries which -are distributed with @TL{}: @url{http://tug.org/texlive/build.html}. +are distributed with @TL{}: @url{https://tug.org/texlive/build.html}. -@item The @TL{} user manual: @url{http://tug.org/texlive/doc.html}, or +@item The @TL{} user manual: @url{https://tug.org/texlive/doc.html}, or run @code{texdoc texlive}. @item Other @TeX{}-related Texinfo manuals (@pxref{,,,web2c, Web2c}, @ref{,,,kpathsea, Kpathsea}, etc.): -@url{http://tug.org/texinfohtml/}, or check the @samp{TeX} category in +@url{https://tug.org/texinfohtml/}, or check the @samp{TeX} category in the GNU Info system. @item Package documentation: -@url{http://tug.org/texlive/Contents/live/doc.html}, or the +@url{https://tug.org/texlive/Contents/live/doc.html}, or the @file{doc.html} file at the top level of the installed TL. @end itemize As an exception, the full documentation for @code{install-tl} and -@code{tlmgr} is included here, just because it is convenient to do so. -The same text is available online (linked from -@url{http://tug.org/texlive/doc.html}, or by invoking the program with -@samp{--help} (or look at the end of the source). +@code{tlmgr} is included here as appendices, simply because it is easy +to do so. The same text is available online (linked from +@url{https://tug.org/texlive/doc.html}, or by invoking the program +with @samp{--help} (or look at the end of the source). @c The first word of the chapter/section title here is used to @@ -160,10 +161,10 @@ The same text is available online (linked from @cindex Automake @cindex Libtool @cindex tests, running -The @TL{} build system was redesigned in 2009, consistently using -Autoconf, Automake, and Libtool. Thus@*@ @ @ @code{configure && -make && make check && make install}@*or the basically-equivalent -top-level @code{Build} script suffice to build and install the TL +The @TL{} build system was redesigned in 2009 to consistently use +Autoconf, Automake, and Libtool. Thus, running@*@ @ @ @code{configure +&& make && make check && make install}@*or the essentially-equivalent +top-level @code{Build} script suffices to build and install the TL programs. The @code{make check} clause performs various tests of the generated programs---not strictly required but strongly recommended. Running @code{configure --help} will display a comprehensive list of @@ -193,7 +194,7 @@ program and library module (or package) specifies its own requirements and properties, such as required libraries, whether an installed (system) version of a library can be used, @code{configure} options to be seen at the top level, and more. An explicit list of all available -modules is kept in only one central place, namely @file{m4/kpse-pkgs.m4}. +modules is kept in a single central place: @file{m4/kpse-pkgs.m4}. A second, related goal is to configure and build each library before configuring any other (program or library) module which uses that @@ -206,8 +207,8 @@ independently. The corresponding modules use (most of) the distributed source tree and document any modifications of that source. All this is for the sake of simplifying both upgrading of modules and -integrating new modules into the TL build system. (Not to say that -either task is trivial.) +integrating new modules into the TL build system. (Despite all +efforts, neither task is easy.) @node Prerequisites @@ -216,36 +217,37 @@ either task is trivial.) @cindex prerequisites for building @cindex requirements for building -@cindex compilers, C and C++ +@cindex compilers, C and C++11 Overall, building the @TL{} programs, when using all libraries from -the TL source tree, requires only C and C++ compilers and GNU -@code{make}. (If @code{make} from your @code{PATH} is not GNU make, -you can set @code{MAKE} in the environment to whatever is necessary.) +the TL source tree, requires C and C++11 compilers and GNU +@code{make}. If @code{make} from your @code{PATH} is not GNU make, +you can set the @code{MAKE} environment variable to whatever is necessary. @cindex GNU @code{make}, required @cindex @code{gmake}, required @cindex FreeType GNU @code{make} is required only because of some third-party libraries, notably FreeType; all the TL-maintained directories (and -Automake/Autoconf output in general) should work with any reasonable +Automake/Autoconf output in general) work with any reasonable @code{make}. +@cindex C++11, required +A C++11 compiler is similarly required because of the third-party +libraries ICU and Poppler; the program @code{dvisvgm} also requires +C++11. It is possible to build everything else with older compilers; +@url{https://tug.org/texlive/custom-bin.html} links to a build script +for doing this. + However, a few programs in the tree have additional requirements: @table @file -@item dvisvgm -@cindex @code{dvisvgm} requirement for C++11 -@cindex C++11, required by @code{dvisvgm} -requires a C++11 compiler, such as gcc 4.8.1 (or later) or clang 3.3 -(or later). - @item web2c @cindex @code{perl}, required by @code{web2c}, etc. requires @code{perl} for some tests run by @code{make check}. @item xdvik @itemx xpdfopen -@cindex X11, required by X clients +@cindex X11 development, required by X clients require X11 headers and libraries, often in ``development'' packages that are not installed by default. @@ -259,9 +261,10 @@ frameworks. @item xindy @cindex @code{clisp}, required by @code{xindy} -@cindex @code{ffcall}, required by @code{xindy} -requires GNU @code{clisp} and in addition @code{perl}, @code{latex}, -and @code{pdflatex} to build the rules and/or documentation. +@cindex @code{libsigsegv}, required by @code{xindy} +requires GNU @code{clisp}, @code{libsigsegv}, and @code{libiconv}; +additionally, to build the rules and/or documentation: @code{perl}, +@code{latex}, and @code{pdflatex} @end table @@ -284,7 +287,9 @@ Modification of the sources for @code{.info} files requires Modification of any part of the build system (M4 macros, @file{configure.ac}, @file{Makefile.am}, or their fragments) requires GNU M4, GNU Autoconf, GNU Automake, and GNU Libtool to update the -generated files. @xref{Build system tools}. +generated files. Furthermore, to reliably reproduce the build files, +the original GNU releases of these tools must be used, not any distro +packaging of them. @xref{Build system tools}, for more discussion. @end itemize @@ -295,14 +300,6 @@ your timestamps---notably, @code{use-commit-times} must be set to tools}). Barring buggy commits, no infrastructure tools are needed to do a normal build. -@cindex Debian installation of build prerequisites -As an example, on Debian systems the necessary build dependencies can -be installed via: - -@example -apt-get install libfontconfig-dev libx11-dev libxmu-dev libxaw7-dev -@end example - @node Building @chapter Building @@ -313,28 +310,29 @@ apt-get install libfontconfig-dev libx11-dev libxmu-dev libxaw7-dev @pindex Build @r{script} The top-level @file{Build} script is intended to simplify building the binaries distributed with @TL{} itself---we call this the ``native'' -TL build. It configures and makes everything in a subdirectory of the -main build tree (default @file{Work/}), installs everything in another -subdirectory (default @file{inst/}), and finally runs @code{make -check}. The exact directory and command names can be specified via -environment variables and a few leading options. All remaining -arguments (assignments or options) are passed to the @file{configure} -script. Please take a look at the @file{./Build} source file itself -for more information; it is a straightforward shell script. +TL build. It runs @code{configure && make world}, which builds +everything in a subdirectory of the main source tree (default +@file{Work/}), installs everything in another subdirectory (default +@file{inst/}), and finally runs @code{make check}. The exact +directory and command names can be specified via environment variables +and a few leading options. All remaining arguments (assignments or +options) are passed to the @file{configure} script. Please take a +look at the @file{./Build} source file for more information; it is a +straightforward shell script. @cindex source directory building, not supported @cindex build directory, required An alternative, and the one we will mainly discuss here, is to run -@code{configure} and @code{make} oneself in a suitable empty -subdirectory. Building in the source directory itself is not -supported (sorry). +@code{configure} and @code{make} in a suitable empty subdirectory. +Building in the source directory itself is not supported (sorry). @menu -* Build iteration:: What @code{configure} and @code{make} do. +* Build iteration:: What @code{configure} and @code{make} do in TL. * Build problems:: If the build fails. * Build in parallel:: Simultaneous @code{make} processes. * Build distribution:: Making a distribution tarball. * Build one package:: Example of working on just one program. +* Build one engine:: Example of building just one @TeX{} engine. * Cross compilation:: Building on host X for target Y. @end menu @@ -347,10 +345,10 @@ supported (sorry). Running the top-level @file{configure} script configures the top level and the subdirectories @file{libs}, @file{utils}, and @file{texk}. -Running @code{make} at the top-level first iterates over all -@TeX{}-specific libraries, and then runs @code{make} in -@file{libs}, @file{utils}, and @file{texk} to iterate over all generic -libraries, utility programs, and @TeX{}-specific programs. These +Running @code{make} at the top level first iterates over the +@TeX{}-specific libraries, and then runs @code{make} in @file{libs}, +@file{utils}, and @file{texk} to iterate over the generic libraries, +utility programs, and @TeX{}-specific programs, respectively. These iterations consist of two steps: @enumerate @@ -368,8 +366,8 @@ etc. @end enumerate Running the top-level @code{make} a second time iterates again over -all the library and program modules, but finds (should find) nothing -to be done unless some source files have been modified. +all the library and program modules, and finds (should find) nothing +to be done. @node Build problems @@ -379,10 +377,11 @@ to be done unless some source files have been modified. @cindex problems with build @cindex failure to build @vindex --no-clean Build @r{option} -If configuring or building a module fails, you should first find and fix the -problem, then perhaps remove the subdirectory for that module from the build -tree, and finally rerun the top level @code{make} (or @file{Build} with -@code{--no-clean} as its first argument). +If configuring or building a module fails, you should first try to +find and fix the problem. Failing that, a possible workaround is to +remove the subdirectory for that module from the build tree (so +@code{configure} won't try to run there, and finally rerun the top +level @code{make} (or @file{./Build} @code{--no-clean}). @node Build in parallel @@ -396,15 +395,15 @@ tree, and finally rerun the top level @code{make} (or @file{Build} with @vindex -j make @r{option} The TL build system carefully formulates dependencies as well as @code{make} rules when a tool (such as @code{tangle}, @code{ctangle}, -or @code{convert}) creates several output files. This allows for +and @code{convert}) creates several output files. This allows for parallel builds (@code{make -j @var{n}} with @math{@var{n}>1} or even @code{make -j}) that can considerably speed up the TL build. @cindex cache file, for @code{configure} @vindex -C configure @r{option} -Incidentally, a noticeable speed-up can also be (independently) gained -by using a configure cache file, i.e., with the option @code{-C} -(recommended). +Incidentally, a noticeable speed-up can be independently gained by +using a configure cache file, i.e., specifying the @code{configure} +option @code{-C} (recommended). @node Build distribution @@ -422,6 +421,8 @@ suffices to build and install all of TL. This is useful for checking consistency of the source tree and Makefiles, but the result is not a complete or even usable @TeX{} system, since all the support files are lacking; @pxref{Installing}. +We do not actually distribute any such tarball, and have no plans to +do so. @node Build one package @@ -437,15 +438,15 @@ option @code{--disable-all-pkgs} (@pxref{@code{--disable-all-pkgs}}). Then all program and library modules are configured but none are made. However, the @file{Makefile}s still contain all build rules and dependencies and can be invoked to build an individual program or -library and causes to first build any required libraries. +library, first building any required libraries. This ``build-on-demand'' procedure is used, e.g., in the upstream -Lua@TeX{} repository to build Lua@TeX{}, essentially from a subset of -the complete @TL{} tree. Similarly, when, e.g., building the original +Lua@TeX{} repository to build Lua@TeX{}, from a subset of the complete +@TL{} source tree. As another example, when building the original e-@TeX{} has been disabled (as it is by default), one can run @code{make etex} (or @code{make etex.exe}) in @file{texk/web2c/} to -build e-@TeX{} (although there is no comparably simple way to install -e-@TeX{}). +build e-@TeX{} (although there is no comparably simple way to +@emph{install} e-@TeX{}). If you want to work on a single program within the TL sources, this is the recommended way to do it. Here is an example from start to @@ -454,7 +455,7 @@ finish for working on @code{dvipdfm-x}. @example mkdir mydir && cd mydir # new working directory -# Get sources (@url{http://tug.org/texlive/svn}), e.g.: +# Get sources (@url{https://tug.org/texlive/svn}), e.g.: rsync -a --delete --exclude=.svn --exclude=Work \ tug.org::tldevsrc/Build/source/ . @@ -463,29 +464,34 @@ mkdir Work && cd Work # Do the configure: ../configure --disable-all-pkgs --enable-dvipdfm-x \ - -C CFLAGS=-g CXXFLAGS=-g >&outc + -C CFLAGS=-g CXXFLAGS=-g >&outc || echo fail # Do the make: -make >&outm +make >&outm || echo fail # Test: cd texk/dvipdfm-x make check @end example -Then you modify source files in @file{mydir/texk/dvipdfm-x} and rerun -@code{make} in @file{mydir/Work/texk/dvipdfm-x} to rebuild (that -build directory is where the binaries end up). +Then you can modify source files in @file{mydir/texk/dvipdfm-x} and +rerun @code{make} in @file{mydir/Work/texk/dvipdfm-x} to rebuild; that +build directory is where the binary ends up and where you can run a +debugger, etc. The second line of the @code{configure} invocation shows examples of extra things you likely want to specify if you intend to hack the -sources (and not just build binaries): the @code{-C} speeds up -@code{configure}, and the @code{CFLAGS} and @code{CXXFLAGS} settings -eliminate compiler optimization for debugging purposes. +sources (and not just build binaries): the @code{-C} speeds +@code{configure} by enabling a cache file, and the @code{CFLAGS} and +@code{CXXFLAGS} settings eliminate compiler optimization for debugging +purposes. -Of course, one should actually look at the output and check that +Of course, you need to actually look at the output and check that things are working. There are many @code{configure} options you can -tweak as desired; check the output from @code{configure --help}. +tweak as desired; check the output from @code{configure --help}. It +is also a good idea to run @code{make check} after making any changes, +to ensure that whatever tests have been written still pass. + @cindex size of source tree Finally, the above retrieves the entire TL source tree (several @@ -495,16 +501,17 @@ to do so. If you cut down the source tree, you must also give additional @code{configure} flags to individually disable using system versions of libraries, or the intricacies of the dependencies (such as @code{teckit} requiring @code{zlib}) will have undesired side effects. -For an example, see the @code{build-pdftex.sh} script in the -@code{pdftex} development source (details at @url{http://pdftex.org}), -which is indeed a cut-down TL source tree. +For an example of this approach, see the @code{build-pdftex.sh} script +in the @code{pdftex} development source (details at +@url{http://pdftex.org}), which is indeed such a cut-down TL source +tree. @vindex --enable-missing @r{to ignore dependencies} Even with @code{--disable-all-pkgs}, dependencies will be checked. -For instance, if a non-MacOSX system does not have @code{fontconfig}, -Xe@TeX{} cannot be built (@pxref{Prerequisites}) and @code{configure} -will terminate. To proceed without such dependencies, specify -@code{--enable-missing} also. +For instance, if a (non-MacOSX) system does not have +@code{fontconfig}, Xe@TeX{} cannot be built (@pxref{Prerequisites}) +and @code{configure} will terminate. To proceed without such +dependencies, specify @code{--enable-missing} also. @vindex CC=@var{c-compiler} @vindex CXX=@var{c++-compiler} @@ -515,6 +522,36 @@ otherwise, individual packages may use something different. You can explicitly specify the compilers to be used with the environment variables @code{CC}, @code{CXX}, and @code{OBJCXX}. + +@node Build one engine +@section Build one engine + +@cindex build one engine +@cindex one engine, building +@cindex engine, building one + +Unfortunately, there is one common case where the steps in the +preceding section to build one package (@pxref{Build one package}) do +not suffice: wanting to build one, or a subset, of the @TeX{} engines +(or other Web2c programs). + +The simplest way to do this is to disable everything and then +explicitly specify what to make. For example, to build only Lua@TeX{}: + +@example +./configure --disable-all-pkgs # or ./Build +cd Work/texk/web2c # build directory +make luatex # specify target +@end example + +This works because the @code{make} automatically runs @code{configure} +as necessary for the dependencies and target. Furthermore, the source +tree can be cut down to just what is needed for the given engine (as +the separate pdf@TeX{} and Lua@TeX{} source repositories do). + +We hope to improve the situation in the future. Patches are welcome. + + @node Cross compilation @section Cross compilation @@ -655,7 +692,7 @@ This approach would also be possible for the tools such as @file{tangle} used in the module @file{texk/web2c} to build the WEB programs, but that would require first building a native @code{kpathsea} library. To avoid this complication, cross -compilation of the WEB or CWEB programs requires sufficiently recent +compilation of programs written in (C)WEB requires sufficiently recent installed versions of @file{tangle}, @file{ctangle}, @file{otangle}, and @file{tie}. @@ -680,11 +717,11 @@ make a usable @TeX{} installation. Beyond the compiled binaries, @file{plain.tex} is not in the source tree. These support files are maintained completely independently and are -not present in the source tree. The best basis for dealing with them +not present in the TL source tree. The best basis for dealing with them is the @TL{} (plain text) database in @file{Master/tlpkg/texlive.tlpdb}, and/or the @TL{} installer, @code{install-tl}. More information is under @file{Master/tlpkg} and -at @url{http://tug.org/texlive/distro.html}. +at @url{https://tug.org/texlive/distro.html}. @menu * Installation directories:: The prefix, @code{bindir}, etc., directories. @@ -747,7 +784,7 @@ directories used in the TL distribution. installation paths. For the native TL build, the @code{Build} script leaves the binaries -in @file{./inst/bin/@var{std-platform-name}}. The new binaries are +in @file{./inst/bin/@var{std-system-triplet}}. The new binaries are not directly usable from that location; they need to be copied to @file{Master/bin/@var{tl-platform}}. The other files and directories that end up in @file{./inst/} are ignored. @@ -772,9 +809,9 @@ These so-called @dfn{linked scripts} are installed under symbolic link is made in @code{@var{bindir}}. For example, a symlink points from @code{@var{bindir}/ps2eps} to @code{@var{datarootdir}/texmf-dist/scripts/ps2eps/ps2eps.pl}. For -Windows, a standard wrapper binary (e.g., -@code{@var{bindir}/ps2eps.exe}) serves the same purpose. (The source -for the wrapper is in @file{texk/texlive/w32_wrapper}.) +Windows, a standard wrapper binary (copied to, e.g., +@code{@var{bindir}/ps2eps.exe}) serves the same purpose. The source +for the wrapper is in @file{texk/texlive/w32_wrapper}. One reason for this is to avoid having many copies of the same script; a more important reason is that it guarantees the scripts will @@ -789,7 +826,7 @@ Most important of all, we want the @code{@var{bindir}} resulting from the build to be as close as possible to what is in the TL distribution. At present, there are a few exceptions---Asymptote, Biber, Xindy---and each one creates considerable extra work. We don't -want to add more. (See @url{http://tug.org/texlive/build.html} for +want to add more. (See @url{https://tug.org/texlive/build.html} for information about building those exceptions, as well as the @code{xz} and @code{wget} programs that are used in the TL infrastructure.) @@ -811,12 +848,12 @@ BSD operating system distribution. @cindex shared libraries, using vs.@: avoiding The native TL distribution uses shared libraries only when absolutely necessary (@file{libc}, @file{libm}, X11 libraries, and -@file{libfontconfig}). However, a distro typically wants to use as -many shared libraries as possible from elsewhere on the system, +@file{libfontconfig}). In constrast, a distro typically wants to use +as many shared libraries as possible from elsewhere on the system, including @TeX{}-specific libraries such as @file{libkpathsea} (even though Kpathsea has never officially been released as a shared -library, but we digress). In addition, the installation paths will, -in general, be completely different. +library). In addition, the installation paths will, in general, be +completely different. Here are the @code{configure} options that distro builds are likely to find most relevant: @@ -838,7 +875,7 @@ Build shared versions of the @TeX{}-specific libraries (uses Do not build the static versions of the @TeX{}-specific libraries. @item --with-system-@var{lib} -Use system versions for as many libraries @var{lib} as possible. +Look for and use a system version of the library @var{lib}. @code{configure --help} will give you the list of possibilities. @item --with-@var{lib}-includes=@var{dir} @@ -862,7 +899,7 @@ You will need to take care of the support files mentioned above (@pxref{Installing}), and many other issues, such as font maps, languages, and formats, independently of the build. Norbert Preining has written a detailed article on adapting TL for distros: -@url{http://tug.org/TUGboat/tb34-3/tb108preining-distro.pdf}. (If the +@url{https://tug.org/TUGboat/tb34-3/tb108preining-distro.pdf}. (If the article needs updating in the future, perhaps we will merge it into this document.) @@ -896,8 +933,8 @@ files. @cindex GNU tools, needed for building @cindex infrastructure, tools needed for -As mentioned above (@pxref{Prerequisites}), a normal build requires -very little. On the other hand, if you want to modify the @TL{} +As mentioned above (@pxref{Prerequisites}), a normal build has few +requirements. On the other hand, if you want to modify the @TL{} infrastructure sources, such as @file{configure.ac} or @file{Makefile.am} files, you will need to have several additional tools installed. @@ -924,22 +961,27 @@ after their dependencies have been changed. This can be done explicitly with the top-level @code{reautoconf} script or implicitly by using the configure option @code{--enable-maintainer-mode}. +It has often turned out that the bison and flex versions are not +critical; however, the autotools versions are. If you don't have the +given versions, get them before modifying the build infrastructure. + @cindex Subversion repository @cindex timestamps, in repository @vindex use-commit-times@r{, Subversion} The files in the Subversion repository (see -@url{http://tug.org/texlive/svn}) are all up to date, but -unfortunately this may not be reflected by their timestamps. (For -starters, be sure to set @file{use-commit-times=yes} in -@file{~/.subversion/config} or the equivalent.) +@url{https://tug.org/texlive/svn}) are all up to date (barring +bugs). For this to be reflected by their timestamps in your checkout, +be sure to set @file{use-commit-times=yes} in +@file{~/.subversion/config} or the equivalent. + @cindex touching files to avoid rerunning @pindex make -t -To avoid unnecessary runs of @code{bison}, @code{flex}, or -@code{makeinfo} it may be necessary to @code{touch} the generated -(@file{.c}, @file{.h}, or @file{.info}) files. With -@code{--enable-maintainer-mode} it may also be necessary to -@code{touch} first @file{aclocal.m4}, then @file{configure} and +If timestamps are wrong, you may also be able to avoid unnecessary +runs of @code{bison}, @code{flex}, or @code{makeinfo} with +@code{touch} of the generated (@file{.c}, @file{.h}, or @file{.info}) +files. With @code{--enable-maintainer-mode} it may also be necessary +to @code{touch} first @file{aclocal.m4}, then @file{configure} and @file{config.h.in} (or @file{c-auto.in}), and finally all @file{Makefile.in} files. Perhaps @code{make -t} will help. @@ -982,18 +1024,13 @@ be built---although all modules must be configured for the benefit of @cindex Gnulib, used for common files The top-level @file{build-aux/} directory contains the common files @file{compile}, @file{config.guess}, @file{config.sub}, -@file{depcomp}, etc.@ used by most packages. These are from the GNU -Gnulib sources (@url{http://www.gnu.org/software/gnulib}), which in -turn synchronizes with the appropriate ultimate upstream repository. -There are, however, independent copies in, e.g., -@file{libs/freetype2/freetype-*/builds/unix/}, and a few other places. -The @code{reautoconf} script does not touch those, but a TL cron job -keeps them in sync (nightly). - -@cindex @file{extra/} top-level directory -The directory @file{extra/} contains things which are not part of the -TL build, but are present just for (someone's) convenience, e.g., -is @file{epstopdf} development source is here. +@file{depcomp}, etc.@ used by most packages. These are taken from the +GNU Gnulib sources (@url{https://www.gnu.org/software/gnulib}), which +in turn synchronizes with any ultimate upstream repository. There are +independent copies of some of these in a few other places, e.g., +@file{libs/freetype2/freetype-*/builds/unix/}. The @code{reautoconf} +script does not touch those, but a TL cron job keeps them in sync +(nightly). @cindex @file{Work/} top-level directory @cindex @file{inst/} top-level directory @@ -1002,7 +1039,7 @@ two more top-level directories appear: @file{Work/} for the build tree, and @file{inst/} for the install tree (from @code{make install}). These names (and everything else about @file{Build}'s operation) can be changed by setting environment variables before running it; see the -script file. +script source. @node Autoconf macros @@ -1026,11 +1063,12 @@ script file. @c @r{[}@var{\varname\} = @samp{\default\}@r{]} @c @end macro -Here we describe some of the Autoconf macros used in several -modules--not a complete list, by any means. These general macros are -supplemented by module-specific macros in directories such as -@file{texk/dvipng/m4/}; some of those are described in @ref{Library -modules} and @pxref{Program modules}. +Here we describe a few of the Autoconf macros used in several +modules---many more are defined in the sources; see the top-level +@code{m4/} directory. These general macros are supplemented by +module-specific macros in directories such as @file{texk/dvipng/m4/}; +some of those are described in following sections (@pxref{Library +modules} and @ref{Program modules}). @menu * Setup: General setup macros. @@ -1060,7 +1098,7 @@ used for all generic library and program modules. @defmac KPSE_COMMON (@var{name}, @ovar{more-options}) Like @code{KPSE_BASIC} but add:@*@ @ @ @code{LT_PREREQ([2.2.6])}@*@ @ @ @code{LT_INIT([win32-dll])}@*@ @ @ @code{AC_SYS_LARGEFILE}@*@ @ @ -@code{AC_FUNC_FSEEKO}@*and check for frequently used functions, +@code{AC_FUNC_FSEEKO}@*along with checks for frequently used functions, headers, types, and structures. This is used for @TeX{}-specific modules. @end defmac @@ -1073,12 +1111,11 @@ modules. Macros for program checks: @defmac KPSE_CHECK_LATEX -Set @code{LATEX} to the name of the first of @code{latex}, -@code{elatex}, or @code{lambda} which exists in @code{PATH}, or to -@code{no} if none of them exists. Call @code{AC_SUBST} for -@code{LATEX}. The result of this test can be overridden by setting -the @code{LATEX} environment variable or the cache variable -@code{ac_cv_prog_LATEX}. +Set @code{LATEX} to the first of @code{latex}, @code{elatex}, or +@code{lambda} which exists in @code{PATH}, or to @code{no} if none of +them exists. Call @code{AC_SUBST} for @code{LATEX}. The result of +this test can be overridden by setting the @code{LATEX} environment +variable or the cache variable @code{ac_cv_prog_LATEX}. @end defmac @defmac KPSE_CHECK_PDFLATEX @@ -1107,8 +1144,8 @@ Macros for compiler-related checks: When using the (Objective) C/C++ compiler, set @code{WARNING_[OBJ]C[XX]FLAGS} to suitable warning flags (depending on the value given to or implied for @code{--enable-compiler-warnings}). -Call @code{AC_SUBST} for them. At the moment this only works for GNU -compilers, but could be extended to others if necessary. +Call @code{AC_SUBST} for them. At present this assumes GNU compiler +warning options, but could be extended to others if necessary. @vindex kpse_cv_warning_cflags This macro caches its results in the @code{kpse_cv_warning_cflags}, @@ -1118,9 +1155,9 @@ This macro caches its results in the @code{kpse_cv_warning_cflags}, @defmac KPSE_COMPILER_VISIBILITY When using the C or C++ compiler, try to set @code{VISIBILITY_C[XX]FLAGS} to flags to hide external symbols. Call -@code{AC_SUBST} for this variable. At the moment this only tests for -the compiler option @code{-fvisibility=hidden}, but that could be -extended with more checks if necessary. +@code{AC_SUBST} for this variable. At present this only tests for +the compiler option @code{-fvisibility=hidden}, but could be +extended if necessary. @vindex kpse_cv_visibility_c[xx]flags This macro caches its results in the @code{kpse_cv_visibility_cflags} @@ -1134,7 +1171,7 @@ or @code{kpse_cv_visibility_cxxflags} variable. @pindex libstc++@r{, statically linking} Provide the configure option @code{--enable-cxx-runtime-hack}. If enabled and when using @code{g++}, try to statically link with -@file{libstdc++}, somewhat improving portability of the resulting +@file{libstdc++}, notably improving portability of the resulting binary. @vindex kpse_cv_cxx_hack @@ -1169,10 +1206,18 @@ that provides make variables for that library. E.g., for @defmac KPSE_LIBPNG_FLAGS Provide the configure option @code{--with-system-libpng}. Set and @code{AC_SUBST} @code{make} variables for modules using this library (either -an installed version or from the @TL{} tree): @code{LIBPNG_INCLUDES} for use -in @code{CPPFLAGS}, @code{LIBPNG_LIBS} for use in @code{LDADD}, -@code{LIBPNG_DEPEND} for use as dependency, and @code{LIBPNG_RULE} defining -@code{make} rules to rebuild the library. +an installed version or from the @TL{} tree): + +@multitable {@code{LIBPNG_INCLUDES}} {for the @code{make} rules to rebuild the library.} +@item @code{LIBPNG_INCLUDES} +@tab for use in @code{CPPFLAGS}, +@item @code{LIBPNG_LIBS} +@tab for use in @code{LDADD}, +@item @code{LIBPNG_DEPEND} +@tab for use as a Makefile dependency, +@item @code{LIBPNG_RULE} +@tab for the @code{make} rules to rebuild the library. +@end multitable @end defmac @defmac KPSE_ADD_FLAGS (@var{name}) @@ -1204,7 +1249,7 @@ foo_DEPENDENCIES = $@{ZLIB_DEPEND@} $@{LIBPNG_DEPEND@} @@LIBPNG_RULE@@ @end example -If it was necessary to examine whether certain @file{zlib} or +If it were necessary to examine whether certain @file{zlib} or @file{libpng} features were available, @file{configure.ac} should be continued this way: @example @@ -1226,10 +1271,10 @@ them due to the lack of symbolic links. @defmac KPSE_CHECK_WIN32 @vindex kpse_cv_have_win32 -Check if compiling for a Windows system. The result is @code{no} for -Unix-like systems (including Cygwin), @code{mingw32} for Windows with -GCC, or @code{native} for Windows with MSVC. The result is cached in -the @code{kpse_cv_have_win32} variable. +Check if compiling for a Windows system. The result is either +@code{no} for Unix-like systems (including Cygwin), @code{mingw32} for +Windows with GCC, or @code{native} for Windows with MSVC. The result +is cached in the @code{kpse_cv_have_win32} variable. @end defmac @defmac KPSE_COND_WIN32 @@ -1258,7 +1303,7 @@ is used on Windows instead of symlinks for the ``linked scripts'' @defmac KPSE_WIN32_CALL @pindex callexe.c -Call @code{KPSE_COND_WIN32}, check if the file +Call @code{KPSE_COND_WIN32} and check if the file @file{texk/texlive/w32_wrapper/callexe.c} exists; if it does, create a symlink in the build tree. Compiling @file{callexe.c} with @code{-DEXEPROG='"@var{foo}.exe"'} and installing @file{callexe.exe} @@ -1288,17 +1333,17 @@ structure and variation. @pindex png @r{library} @pindex libpng @r{library} -This generic library uses the source tree in, e.g., the subdirectory -@file{libpng-src/} with all modifications for TL recorded in -@file{TLpatches/*}. The @file{configure.ac} fragment +The ``generic'' @code{png} library uses the source tree in the +subdirectory @file{libpng-src/}, with all modifications for TL +recorded in @file{TLpatches/*}. The @file{configure.ac} fragment @file{ac/withenable.ac} contains @example KPSE_WITH_LIB([libpng], [zlib]) @end example -@noindent specifying the module name, and indicating the dependency on -@code{zlib}. A third literal argument @code{tree} would specify that +@noindent to specify the module name and indicate the dependency on +@code{zlib}. A third literal argument `@code{tree}' would specify that the library from the @TL{} tree cannot be replaced by a system version. That not being the case here, a second fragment @file{ac/libpng.ac} contains @@ -1324,17 +1369,21 @@ int main () @findex KPSE_TRY_LIBXX @noindent which Autoconf uses to verify the usability of a system version with C code. The analogous macro @code{KPSE_TRY_LIBXX} would -check using C++ code. These fragments are included by -@file{configure.ac} at the top level. - -For this library, among many other modules, a proxy build system for -TL is used (@file{configure.ac}, @file{Makefile.am}, and -@file{include/Makefile.am}), ignoring the distributed one. -Consequently, a few generated files and auxiliary scripts are removed -from the distributed source tree. The public headers @file{png.h}, -@file{pngconf.h}, and @file{pnglibconf.h} are ``installed'' (as -symlinks) under @file{include/} in the build tree exactly as they are -for a system version under, e.g., @file{/usr/include/}. +check using C++. These fragments are included by the +@file{configure.ac} at the top level of TL +(@code{Build/source/configure.ac}). + +@cindex proxy build system +For this library, like many other modules, a proxy build system for TL +is used, consisting of our own @file{configure.ac}, +@file{Makefile.am}, @file{include/Makefile.am}; the distributed build +system is not used. (Consequently, a few generated files and +auxiliary scripts are removed from the distributed source tree.) + +The public headers @file{png.h}, @file{pngconf.h}, and +@file{pnglibconf.h} are ``installed'' (as symlinks) under +@file{include/} in the build tree exactly as they are for a system +version under, e.g., @file{/usr/include/}. @pindex kpse-libpng-flags.m4 @vindex KPSE_LIBPNG_FLAGS @@ -1344,11 +1393,11 @@ depending on this library in their @file{configure.ac} to generate the @code{make} variables @code{LIBPNG_INCLUDES} for use in @code{CPPFLAGS}, @code{LIBPNG_LIBS} for use in @code{LDADD}, @code{LIBPNG_DEPEND} for use as dependencies, and @code{LIBPNG_RULE} -defining @code{make} rules to rebuild the library. +for the @code{make} rules to rebuild the library. @file{m4/kpse-libpng-flags.m4} also supplies the configure option -@code{--with-system-libpng} and uses @code{pkg-config} to determine -the flags required for the system library. +@code{--with-system-libpng}, which then uses @code{pkg-config} to +determine the flags required for the system library. @node @code{zlib} library @@ -1369,13 +1418,18 @@ without the dependency on any other library. The file @subsection The @code{freetype} library in @file{libs/freetype2} @pindex freetype @r{library} +@cindex wrapper build system + +This module uses a wrapper build system. In contrast to the proxy +build described earlier, the wrapper build has an almost trivial +@file{configure.ac} and a @file{Makefile.am} which invokes the +@code{configure} and @code{make} in the distributed source, followed +by @code{make install} with the TL build tree as destination. In +other words, this actually uses the build system provided by upstream +(possibly patched). @pindex freetype-config -This module uses a wrapper build system with an almost trivial -@file{configure.ac} and with a @file{Makefile.am} that invokes -@code{configure} and @code{make} for the distributed source, followed -by @code{make install} with the build tree as destination. The flags -required for the system library are obtained through +The flags required for the system library are obtained through @code{freetype-config}. @@ -1385,32 +1439,34 @@ required for the system library are obtained through @pindex kpathsea @r{library} This is one of the @TeX{}-specific libraries that are maintained as -part of @TL{} (@pxref{,,, kpathsea, Kpathsea}). Despite being a core -part of the @TeX{} system, it is not a terribly special case in the -infrastructure. The @TeX{} libraries are Libtool libraries (static -and/or shared) and are installed by @code{make install} together with -the programs. They are, however, not part of the TL DVD as -distributed by @TeX{} user groups, and have never been officially -released for standalone use. +part of @TL{} (@pxref{,,, kpathsea, Kpathsea +@r{(@url{tug.org/kpathsea})}}); the other is @code{ptexenc}. These +@TeX{} libraries are Libtool libraries (static and/or shared) and are +installed by @code{make install} together with the programs. They +are, however, not part of the TL DVD as distributed by @TeX{} user +groups, and have never been officially released for standalone use. @pindex --with-system-kpathsea -It is possible, and perhaps even useful for distro builds (@pxref{Distro -builds}), to specify the configure option @code{--with-system-kpathsea} in -order to use a system version of the library. Programs outside the TL tree -should use @code{pkg-config} for the required flags. +It is possible, and probably useful for distro builds (@pxref{Distro +builds}), to specify the configure option +@code{--with-system-kpathsea} in order to use a system version of the +library. Programs outside the TL tree should use @code{pkg-config} +for the required flags. @pindex kpathsea.ac @pindex mktex.ac @vindex --enable-mktextfm-default @pindex mktextfm -In addition to @file{ac/withenable.ac} and @file{ac/kpathsea.ac} there -is a third fragment @file{ac/mktex.ac} included by both -@file{ac/withenable.ac} and @file{configure.ac} that supplies -configure options such as @code{--enable-mktextfm-default}, which -determine the compile time default of whether or not to run -@code{mktextfm} to generate a missing @file{.tfm} file. In any case, +In addition to @file{kpathsea/ac/withenable.ac} and +@file{kpathsea/ac/kpathsea.ac} here there is a third fragment +@file{kpathsea.ac/mktex.ac}, included by both @file{withenable.ac} and +@file{configure.ac}, which supplies configure options such as +@code{--enable-mktextfm-default}. These determine the compile time +default of whether or not to run @code{mktextfm} (and similar) to +generate a missing @file{.tfm} (or whatever) file. In any case, however, the command line options @code{-mktex=tfm} or -@code{-no-mktex=tfm} for the @TeX{}-like engines override this default. +@code{-no-mktex=tfm} for the @TeX{}-like engines override this +default. @node Program modules @@ -1434,10 +1490,10 @@ details for a few of the programs in TL. @pindex t1utils @r{package} -Once again we use the distributed source tree @file{t1utils-src} -with modifications documented in @file{TLpatches/*} and -a proxy build system consisting of @file{configure.ac} and -@file{Makefile.am}. The fragment @file{ac/withenable.ac} contains +Here we use the distributed source tree @file{t1utils-src} with +modifications documented in @file{TLpatches/*} and a proxy build +system consisting of @file{configure.ac} and @file{Makefile.am}. The +fragment @file{ac/withenable.ac} contains @example KPSE_ENABLE_PROG([t1utils]) @@ -1453,12 +1509,14 @@ supplies the configure option @code{--disable-t1utils}. @pindex xindy This module uses the distributed source tree @file{xindy-src/} with -modifications documented in @file{TLpatches/*}, a proxy -@file{configure.ac}, and a wrapper @file{Makefile.am} that descends -into @file{xindy-src}. The @code{xindy} build requires a @file{make} -that supports a @code{VPATH} build, can handle all targets, and do not -refer to @code{$@{top_srcdir@}} or @code{$@{top_builddir@}}. The -fragment @code{ac/withenable.ac} contains +modifications documented in @file{TLpatches/*}, and a wrapper +@file{configure.ac} and @file{Makefile.am} that descends into +@file{xindy-src}. + +The @code{xindy} build requires a @file{make} that supports a +@code{VPATH} build, can handle all targets, and do not refer to +@code{$@{top_srcdir@}} or @code{$@{top_builddir@}}. The fragment +@code{xindy/ac/withenable.ac} contains @example KPSE_ENABLE_PROG([xindy], , [disable native]) @@ -1472,7 +1530,7 @@ m4_include(kpse_TL[utils/xindy/ac/clisp.ac]) painful to require by default), and @code{native} disallows cross compilation. The additional fragments @file{ac/xindy.ac} and @file{ac/clisp.ac} specify more @code{configure} options to be seen at -the top level with @file{ac/xindy.ac} also included by +the top level, with @file{ac/xindy.ac} also included by @file{configure.ac}. @@ -1482,8 +1540,8 @@ the top level with @file{ac/xindy.ac} also included by @pindex xdvik This package is maintained as part of the @TL{} tree with sources in -its top level directory and the subdirectory @file{gui}. The fragment -@code{ac/withenable.ac} contains +its own directory (@file{texk/xdvik/}). The fragment +@code{xdvik/ac/withenable.ac} contains @example dnl extra_dirs = texk/xdvik/squeeze @@ -1493,18 +1551,18 @@ m4_include(kpse_TL[texk/xdvik/ac/xdvik.ac]) @pindex squeeze/configure.ac @cindex cross compilation, with host binary -@noindent thus specifying the dependency on the @code{kpathsea}, +@noindent thus specifying dependencies on the @code{kpathsea}, @code{freetype}, and X11 libraries. The M4 comment (following @code{dnl}) signals the subsidiary @file{squeeze/configure.ac}. This is needed because the main executable @file{xdvi-bin} (to be installed as, e.g., @file{xdvi-xaw}) is for the @code{host} system whereas the auxiliary program @file{squeeze/squeeze} has to run on the -@code{build} system and in a cross compilation they differ. +@code{build} system; in a cross compilation, these differ. @vindex --with-xdvi-x-toolkit The additional fragment @code{ac/xdvik.ac} is also included by @file{configure.ac} and supplies the configure option -@code{--with-xdvi-x-toolkit} also seen at the top-level. +@code{--with-xdvi-x-toolkit} also seen at the top level. @node @code{asymptote} @@ -1518,7 +1576,7 @@ This subdirectory contains the sources for @file{asy} and @file{xasy} but due to its complexity and prerequisites (e.g., OpenGL) it is not part of the TL build system. These programs must be built and installed independently, but are included on the TL DVD together with -their support files. +their support files. See @url{https://tug.org/build.html#asymptote}. @node Extending @TL{} @@ -1531,12 +1589,12 @@ This section outlines the basic process for adding new packages to the TL build system. In any case, a new package directory @file{foo} should contain the -original sources, as modified for TL, in @file{foo/foo-src}, and the -changes should be documented in @file{foo/TLpatches/*}; changes should -also be submitted upstream whenever reasonable, of course. In -addition, @file{foo/} will need the usual Automake build-related files -(@file{configure.ac}, @file{Makefile.am}, etc. Please keep a -@file{ChangeLog} for all TL changes. +original sources, modified only with changes necessary for TL, in +@file{foo/foo-src}. The changes should be documented in +@file{foo/TLpatches/*}, and also be submitted upstream whenever +reasonable. In addition, @file{foo/} will need the usual Automake +build-related files (@file{configure.ac}, @file{Makefile.am}, etc. +Please maintain @file{foo/ChangeLog} for all TL changes. @menu * Adding a new program module:: @@ -1575,28 +1633,28 @@ arguments: @enumerate @item a list of required libraries from the TL tree; -@item a list of options (@code{disable} if this module is not to be +@item a list of options: @code{disable} if this module is not to be built without the configure option @code{--enable-@var{prog}}, @code{native} if cross compilation is not possible, @code{x} if the -program requires X11 libraries); +program requires X11 libraries; @item a comment added to the help text for the @code{configure} option @code{--enable-@var{prog}} or @code{--disable-@var{prog}}. @end enumerate -If the module requires specific configure options to be seen at the -top level, they should be defined in an additional fragment +If the module requires specific @code{configure} options to be seen at +the top level, they should be defined in an additional fragment @file{ac/@var{prog}.ac} included from @file{ac/withenable.ac} and @file{configure.ac}. Usually, the new program is maintained somewhere outside of @TL{}. In -that case, we put the upstream sources into a subdirectory +that case, as above, we put the upstream sources into a subdirectory @file{@var{prog}-src} (e.g., @file{utils/newprog/newprog-src}). We do -not run @code{configure} in this original @code{...-src} directory, -only in our own directory, but we do compile using the source files in -@code{...-src}. +not typically run @code{configure} in this original @code{...-src} +directory, but only in our own directory; but we do compile using the +source files in @code{...-src}. -So, these are the files that we must generally create: +So, to summarize the files that we must (usually) create: @table @file @item ac/withenable.ac @@ -1625,10 +1683,10 @@ Record all TL-specific changes, now and in the future. Then, run GNU @code{autoreconf} in the new directory (@pxref{Build system tools}). After that works, @code{svn add} the necessary files, -notably @file{Makefile.in aclocal.m4 configure}, and @code{svn:ignore} -the Automake cache @file{autom4te.cache}. (This is so people checking -out the TL source tree do not have to run any autotools, but can -simply run @code{configure}.) +including the generated @file{Makefile.in aclocal.m4 configure}, and +@code{svn:ignore} the Automake cache @file{autom4te.cache}. (This is +so people checking out the TL source tree do not have to run any +autotools, but can simply run @code{configure}.) Then, run the TL tool @code{reautoconf} in the top-level TL @code{source/} directory, to incorporate the new program into the @@ -1651,7 +1709,7 @@ After final success, don't forget to commit. @vindex kpse_libs_pkgs A generic library module in a subdirectory @file{libs/@var{lib}} must not depend on @TeX{}-specific libraries, by definition. It is -included by adding its name @file{@var{lib}} to the M4 list +included by adding its name @file{@var{lib}} to the M4 macro @code{kpse_libs_pkgs} in @file{m4/kpse-pkgs.m4}---before any other libraries from the @TL{} tree on which it depends. @@ -1662,9 +1720,9 @@ installable support programs) and a fragment @file{ac/withenable.ac} that contains the M4 macro @code{KPSE_WITH_LIB} defined in @file{m4/kpse-setup.m4} with @code{@var{lib}} as the mandatory first argument and two optional arguments: a list of required libraries from -the TL tree, and a list of options (currently there is only one: -specify @code{tree} if this library cannot be replaced by a system -version). +the TL tree, and a list of options: for libraries, currently there is +only one---specify @code{tree} if this library cannot be replaced by a +system version. @findex KPSE_TRY_LIB @findex KPSE_TRY_LIBXX @@ -1691,7 +1749,7 @@ library from the TL tree and, if supported, for a system version. If a system library is allowed, @code{KPSE_@var{LIB}_FLAGS} also provides the configure option @code{--with-system-@var{lib}} and uses the additional M4 macro @code{KPSE_@var{LIB}_SYSTEM_FLAGS} to generate -the @code{make} variables for a system library. Furthermore the +the @code{make} variables for a system library. In addition, the definition of the M4 macro @code{KPSE_ALL_SYSTEM_FLAGS} in @file{m4/kpse-pkgs.m4} must be extended by the line:@*@ @ @ @code{AC_REQUIRE([KPSE_@var{LIB}_SYSTEM_FLAGS])} @@ -1713,8 +1771,8 @@ previous section), with these modifications: @itemize @bullet @item @vindex kpse_texlibs_pkgs -The library name @code{@var{lib}} is added to the M4 list -@code{kpse_texlibs_pkgs} also in @file{m4/kpse-pkgs.m4}. +The library name @code{@var{lib}} is added to the M4 macro +@code{kpse_texlibs_pkgs}, which is also in @file{m4/kpse-pkgs.m4}. @item @findex KPSE_WITH_TEXLIB @@ -1734,7 +1792,7 @@ top level gives an exhaustive list of all global options and a few important module-specific ones, whereas, e.g.,@*@ @ @ @code{texk/lcdf-typetools/configure --help}@* also displays the @code{lcdf-typetools} specific options, which are not shown at the -top-level. +top level. @cindex environment variables, for @code{configure} The help text also mentions several influential environment variables, @@ -1745,7 +1803,7 @@ The @file{./Build} script used to make the binaries shipped with @TL{} invokes the top-level @code{configure} with a few additional options (@pxref{Building}). The defaults discussed below are those for the actual @code{configure} script; invoking @code{configure} via -@file{./Build} may yield different results. +@file{./Build} yields different results. Defaults for most options are set at the top level and propagated explicitly to all subdirectories. Options specified on the command @@ -1793,16 +1851,16 @@ implies @code{--enable-multiplatform} and and enforces @code{--disable-shared}. If building TL for a GNU/Linux or other distribution, this should be -disabled and system versions of most libraries would be used -(@pxref{Distro builds}). This may fail without GNU @code{make}, but -will be tried regardless. +disabled and system versions of most libraries should be used +(@pxref{Distro builds}). @vindex --enable-texlive-build A related option, @code{--enable-texlive-build}, is automatically passed to all subdirectories (and cannot be disabled). Subdirectories that can also be built independently from the TL tree (such as -@file{utils/xindy} and @file{texk/dvipng}) can use this option, e.g., -to choose TL-specific installation paths. +@file{utils/xindy} and @file{texk/dvipng}) but cooperate with TL can +use this option to enable TL-specific adaptations, such as +installation paths. @node @code{--prefix} @code{--bindir} @dots{} @@ -1826,10 +1884,10 @@ Installation in a temporary location, automake, GNU Automake}). @vindex --disable-largefile @cindex large file support @cindex LFS (large file support) -Omit large file support (LFS), needed on most 32-bit Unix systems for -files with 2GB or more. Regardless of this, the size of @code{DVI} -and @code{GF} files must always be @math{<2}GB, due to the file format -specifications. +Omit large file support (LFS), which is needed on most 32-bit Unix +systems for files with 2GB or more. Regardless of this option, the +size of @code{DVI} and @code{GF} files must always be @math{<2}GB, due +to the file format specifications. @cindex size of PDF and PS files @cindex PDF files, size of @@ -1854,25 +1912,21 @@ figuring out a specific (sub)set of modules to enable. @subsection @code{--enable-compiler-warnings=}@var{level} @vindex --enable-compiler-warnings=@var{level} -Enable various levels of compiler warnings for (Objective) C and C++: -the @var{level} value can be one of: @code{no min yes max all}. -The default is @code{yes} in @code{maintainer-mode} (see below) and -@code{min} otherwise. This option defines -@code{WARNING_[OBJ]C[XX]FLAGS} but these flags are not used in all -library and program modules. Using them should help to resolve -portability problems. - -At present, these warning flags are only defined for the GNU compilers -but flags for other compilers could be added when needed. +Enable various levels of compiler warnings for C, C++, and/or +Objective@tie{}C: the @var{level} value can be one of: @code{no min +yes max all}. The default is @code{yes} in @code{maintainer-mode} +(see below) and @code{min} otherwise. This option defines the +variables @code{WARNING_[OBJ]C[XX]FLAGS}, but these variables are not +consistently used in all library and program modules. At present, +these warning flags assume options from the GNU compilers. @node @code{--enable-cxx-runtime-hack} @subsection @code{--enable-cxx-runtime-hack} -If enabled (as it is for the native TL build) and when using -@code{g++}, try to statically link with @code{libstdc++}, somewhat -improving portability of the resulting binary. @xref{Macros for -compilers}. +If enabled (as it is for the native TL build), when using @code{g++}, +try to statically link with @code{libstdc++}, thus improving +portability of the resulting binary. @xref{Macros for compilers}. @node @code{--enable-maintainer-mode} @@ -1893,8 +1947,9 @@ rebuilds infrastructure files as needed. @xref{maintainer-mode,, @vindex exec_prefix @vindex --bindir configure @r{option} @vindex --libdir configure @r{option} -If enabled and @code{--bindir=@var{dir}} or @code{--libdir=@var{dir}} -are not specified, install executables and libraries in per-platform +If enabled (as it is for the native TL build) and +@code{--bindir=@var{dir}} or @code{--libdir=@var{dir}} are not +specified, install executables and libraries in per-platform subdirectories of @file{@var{eprefix}/bin} and @file{@var{eprefix}/lib} where @var{eprefix} is the value given or implied for @code{exec_prefix}. In any case, the values for @@ -1915,11 +1970,12 @@ Build shared versions of the @TeX{}-specific libraries such as @subsection @code{--enable-silent-rules} @vindex --enable-silent-rules +@cindex @code{make} rules, verbose vs.@: silent Enable the use of less verbose build rules. When using GNU -@code{make} (or another @code{make} implementation supporting nested -variable expansions), you can specify @code{V=1} on the @code{make} command -line to get more verbosity, or @code{V=0} to get less, regardless of -this option. +@code{make} (or any @code{make} implementation supporting nested +variable expansions), you can specify @code{V=1} on the @code{make} +command line to get more verbosity, or @code{V=0} to get less, +regardless of this option. @node @code{--without-ln-s} @@ -1928,7 +1984,7 @@ this option. @vindex --without-ln-s Required when using a system without a working @code{ln -s} to build binaries for a Unix-like system. However, @code{make install} will -not create anything useful and might even fail. +not create anything useful, and might fail. @node @code{--without-x} @@ -1963,7 +2019,7 @@ Here are (some of) the program-specific @code{configure} options. @vindex --enable-@var{prog} @vindex --disable-@var{prog} -Do or do not build and install the program(s) of the module @code{@var{prog}}. +Do or do not build and install the program(s) of module @code{@var{prog}}. @node @code{--disable-all-pkgs} @@ -1975,11 +2031,7 @@ enabled. This is useful when one wants to work on only a single program, which is specified with an additional @code{--enable} option, e.g., @code{--enable-dvipdfm-x}. It's still simplest to check out and configure the whole source tree, but at least only the program you are -interested in, and its dependencies, are built. The @code{configure} -will generally take less than a minute with everything disabled. (It -is a good idea to run @code{make check} after doing this, and after -making any changes, to ensure that whatever tests have been written -still pass.) +interested in, and its dependencies, are built. @xref{Build one package}. Without this option, all modules are built except those that are explicitly disabled or specify @code{disable} in their @@ -1993,14 +2045,14 @@ explicitly disabled or specify @code{disable} in their @vindex --with-banner-add=@var{str} @noindent @code{--with-banner-add=@var{str}}@*Add @code{@var{str}} to the -default version string (@code{TeX Live @var{year}} or @code{Web2C -@var{year}}) appended to banner lines. This is ignored for a native -TL build, but distro builds should specify, e.g., +default version string (which is `@code{TeX Live @var{year}}' or +`@code{Web2C @var{year}}') appended to banner lines. This is ignored +for a native TL build, but distro builds should specify, e.g., @code{/@var{SomeDistro}}. @vindex --with-editor=@var{cmd} @noindent @code{--with-editor=@var{cmd}}@*Specify the command -@code{@var{cmd}} to invoke from the @code{e} option of @TeX{}-like engines, +@code{@var{cmd}} to invoke from the @code{e} option of @TeX{} and friends, replacing the default @code{vi +%d '%s'} for Unix or @code{texworks --position=%d "%s"} for Windows. @@ -2044,7 +2096,7 @@ do build the various @TeX{}, Metafont, and MetaPost engines (defaults are defined in the fragment @file{texk/web2c/ac/web2c.ac}). @vindex --disable-web-progs -@noindent @code{--disable-web-progs}@*Do not build the core WEB programs +@noindent @code{--disable-web-progs}@*Do not build the original WEB programs @file{bibtex}, @dots{}, @file{weave}. Useful if, e.g., you only want to (re)build some engines. @@ -2057,22 +2109,25 @@ done nowadays. @vindex --enable-libtool-hack @pindex libtool@r{, hack for avoiding excessive linking} +@pindex libfontconfig@r{, hack for avoiding linking dependencies} +@pindex libexpat@r{, dependency of @code{libfontconfig}} @noindent @code{--enable-libtool-hack}@* If enabled (which is the default for all platforms), prevents @code{libtool} from linking explicitly with dependencies of @file{libfontconfig} such as @file{libexpat}. @vindex --enable-*win @r{for Metafont window support} -@noindent @code{--enable-*win}@*Include various types of other window -support for Metafont (EPSF output, @code{mftalk}, old terminals, @dots{}). +@noindent @code{--enable-*win}@*Include various types of non-X window +support for Metafont (EPSF output, @code{mftalk}, old graphics +terminals, @dots{}). @vindex --enable-tex-synctex @vindex --disable-etex-synctex @cindex synctex @noindent @code{--enable-tex-synctex}, @code{--disable-etex-synctex}, @dots{}@*Build the @TeX{} engines with or without @code{SyncTeX} -support; ignored for a native @TL{} build, defaults are again defined -in @file{texk/web2c/ac/web2c.ac}. +support; ignored for a native @TL{} build. Defaults are defined in +@file{texk/web2c/ac/web2c.ac}. @vindex --disable-synctex @cindex synctex @@ -2102,6 +2157,7 @@ module @code{bibtex-x} (extended Bib@TeX{}). @subsection Configure options for @file{texk/dvipdfm-x} @cindex @code{configure} options, for @code{dvipdfm-x} +@pindex dvipdfm-x @pindex dvipdfmx @pindex xdvipdfmx @@ -2114,7 +2170,7 @@ different) behavior. @vindex --disable-dvipdfmx @noindent @code{--disable-dvipdfmx}@*Do not build the @file{dvipdfmx} -program with the @file{dvipdfm} symlink. +program or make the @file{dvipdfm} symlink. @vindex --disable-xdvipdfmx @noindent @code{--disable-xdvipdfmx}@*Do not build the @file{xdvipdfmx} @@ -2131,7 +2187,7 @@ program. @noindent @code{--with-system-libgs}@*Build @file{dvisvgm} using installed Ghostscript (@code{gs}) headers and library (not allowed for a native TL build). The default is to load the @code{gs} library at runtime if -possible, or otherwise disable support for PostScript specials. +possible, else to disable support for PostScript specials. @vindex --without-libgs @noindent @code{--without-libgs}@*Build @file{dvisvgm} without PostScript @@ -2162,8 +2218,9 @@ to run @code{texlinks}. @pindex xdvik @vindex --with-gs=@var{filename} +@cindex Ghostscript location for Xdvik @noindent @code{--with-gs=@var{filename}}@*Hardwire the location of Ghostscript -(@file{gs}). +(@file{gs}) as called by Xdvik. @vindex --with-xdvi-x-toolkit=@var{kit} @pindex motif @@ -2174,9 +2231,9 @@ neXtaw}. The default is @code{motif} if available, else @code{xaw}. @vindex --enable-xi2-scrolling @pindex XInput -@pindex scrolling +@pindex scrolling, smooth @noindent @code{--enable-xi2-scrolling}@*Use XInput 2.1 ``smooth scrolling'' -if available. (default: yes, except for a native TL build). +if available (default: yes, except for a native TL build). @node Configure options for @file{utils/xindy} @@ -2197,13 +2254,13 @@ documentation (default: yes, except for a native TL build). @pindex lisp.run@r{,} lisp.exe @cindex CLISP @noindent @code{--with-clisp-runtime=@var{filename}}@*Specifies the -Full path for the CLISP runtime file (@file{lisp.run} or +full path for the Clisp runtime file (@file{lisp.run} or @file{lisp.exe}) to be installed. When specified as @code{default} (the default for a native TL build) the path is determined by the -CLISP executable; the value @code{system} (not allowed for a native TL -build, but the default for a non-native one) indicates that -@file{xindy} will use the installed version of @file{clisp} (which -must be identical to the one used to build @file{xindy}). +Clisp executable; the value @code{system} (not allowed for a native TL +build, but the default otherwise) indicates that @file{xindy} will use +the installed version of @file{clisp} (which must be identical to the +one used to build @file{xindy}). @node Library-specific configure options @@ -2220,7 +2277,7 @@ starting with this generic one: Use an installed (system) version of the library @code{@var{lib}}; this option exists for most libraries, but is not allowed for a native TL build. Using a system version implies also using the system -versions of all libraries (if any) that @var{lib} depends on. +versions of all libraries that @var{lib} depends on. @vindex --with-@var{lib}-includes=@var{dir}@r{,} -libdir For many libraries @code{--with-@var{lib}-includes=@var{dir}} and @@ -2244,7 +2301,7 @@ required system libraries and bails out if tests fail. @noindent @code{--enable-@var{cmd}-default}, @code{--disable-@var{cmd}-default}@*Determine the compile time default -whether or not to run @var{cmd}, one of: +for whether or not to run @var{cmd}, which is one of: @table @code @item mkocp (Omega compiled translation process file) @@ -2263,8 +2320,8 @@ whether or not to run @var{cmd}, one of: @end table @noindent to generate the specified type of file dynamically. -The default can be overridden by the user in any case. - +The default can be overridden by the user in any case +(@pxref{@code{kpathsea} library}). @node Configure options for system @code{poppler} @subsection Configure options for system @code{poppler} @@ -2273,10 +2330,10 @@ The default can be overridden by the user in any case. @pindex poppler @pindex xpdf @r{as library} -Building Lua@TeX{} (or LuaJIT@TeX{}) and Xe@TeX{} requires -@code{poppler}, either from the TL tree or system headers and -library. Building pdf@TeX{} requires either @code{xpdf} from -the @TL{} tree or system @code{poppler} headers and library. +Building Xe@TeX{} requires @code{poppler}, either from the TL tree or +system headers and library. Building pdf@TeX{} requires either +@code{xpdf} from the @TL{} tree or system @code{poppler} headers and +library. @vindex --with-system-poppler @noindent @code{--with-system-poppler}@*Use a system version (0.18 or @@ -2284,7 +2341,7 @@ newer) of @code{poppler} for Lua@TeX{} (or LuaJIT@TeX{}) and Xe@TeX{}, and use @file{pkg-config} to obtain the required flags. @vindex --with-system-xpdf -@noindent @code{--with-system-xpdf}@*Use a system version (0.12 or better) +@noindent @code{--with-system-xpdf}@*Use a system version (0.12 or newer) of @code{poppler} (and @file{pkg-config}) for pdf@TeX{} instead of @code{xpdf} from the TL tree. @xref{@code{--disable-largefile}}. @@ -2305,7 +2362,7 @@ compilations. @itemx CPPFLAGS And plenty more. As usual with Autoconf, these variables specify the name (or full path) of compilers, preprocessor flags, and similar. -@xref{Preset Output Variables,, autoconf, GNU Autoconf}. +@xref{Preset Output Variables,,, autoconf, GNU Autoconf}. @item CLISP @pindex clisp @@ -2322,7 +2379,7 @@ Name (or full path) of the @file{clisp} executable, used to build These specify the name (or path) for the @file{freetype-config}, @file{icu-config}, and @file{pkg-config} commands used to determine the flags required for system versions of @file{libfreetype}, the ICU -libraries, or many other libraries. +libraries, and other libraries, respectively. @item KPSEWHICH @pindex kpsewhich @@ -2350,14 +2407,14 @@ commands used, e.g., to build the @code{xindy} documentation. @cindex coding conventions @cindex conventions, coding -Ideally, building all of @TL{} with @code{--enable-compiler-warnings=max} -should produce no (GCC) compiler warnings at all. In spite of -considerable efforts into that direction we are still far from that goal and -there are reasons that we may never fully reach it. Below are some rules -about declarations of functions or variables and the use of @code{const}. -These rules should be applied to most of the @TL{} tree, the exception -being code that is maintained independently and whose maintainers -don't want to accept patches. +Ideally, building all of @TL{} with +@code{--enable-compiler-warnings=max} should produce no (GCC) compiler +warnings at all. In spite of considerable efforts into that direction +we are still far from that goal and there are reasons that we may +never fully reach it. Below are some rules about declarations of +functions or variables and the use of @code{const}. These rules +should be applied to the code maintained in the @TL{} tree and for +other packages whose maintainers are willing to accept patches. @menu * Declarations and definitions:: @@ -2371,6 +2428,7 @@ don't want to accept patches. @cindex declarations and definitions, in source code @cindex source code declarations @cindex ANSI C +@cindex declarations before statements, avoiding @cindex C, ANSI, required @cindex C99, avoided @@ -2382,7 +2440,7 @@ standard (including @code{void} in the declaration of C functions with no parameters). On the other hand, TL is built for a wide variety of systems, not all of which support the C99 standard. Therefore using C99 features should be avoided if that can easily be done. In -particular C code must not contain declarations after statements or +particular, C code must not contain declarations after statements or C++-style comments. @pindex chktex @@ -2392,8 +2450,8 @@ verify that they are available and otherwise provide an alternative. For example, the module @file{texk/chktex} uses the C99 function @code{stpcpy()} that may or may not be available on a particular system. It uses @code{AC_CHECK_DECLS([stpcpy])} in -@file{configure.ac} to test this, and provides the perhaps slightly -less efficient alternative +@file{configure.ac} to test this, and provides a perhaps +less efficient alternative (in the file @file{Utility.h}): @example #if !(defined HAVE_DECL_STPCPY && HAVE_DECL_STPCPY) @@ -2404,14 +2462,11 @@ static inline char *stpcpy(char *dest, const char *src) #endif @end example -@noindent in the file @file{Utility.h}. - - @subsubheading Static functions @cindex @code{static} functions Functions used in only one file should be declared @code{static}; they -require no prototype except as forward declaration. +require no prototype except in forward declarations. @subsubheading Extern functions @@ -2457,8 +2512,8 @@ constant. Getting all @code{const} qualifiers right can get quite involved but can almost always be done. There are only a couple notable exceptions: the X11 headers are full of declarations that ought to use -@code{const} but do not, and the same is true to some extent for -@file{libfreetype} (but, thankfully, not for @code{zlib} nowadays). +@code{const} but do not; at one time, @file{libfreetype} also did not +fully specify @code{const}, but this has not been checked recently. @subsubheading What must be avoided with @code{const} @@ -2467,12 +2522,12 @@ exceptions: the X11 headers are full of declarations that ought to use The GCC compiler warnings ``assignment discards qualifiers@dots{}'' and analogous warnings for ``initialization'', ``passing arg'', or ``return'' must be strenously avoided in our own code. The only -exception is when they are caused by X11 headers or macros or other -third party code. +exception is when they are caused by X11 declarations or other third +party code. @subsubheading What should be avoided with @code{const} -@cindex type cast, avoiding +@cindex type cast from const, avoiding A type cast, e.g., from @code{const char*} to @code{char*} does not solve any problems; depending on warning options, it may only hide them. Therefore such casts should be avoided whenever possible and @@ -2483,14 +2538,12 @@ cause the modification of quantities supposed to be constant. @node Continuous integration @chapter Continuous integration -@cindex ci @cindex continuous integration @cindex Travis-CI -Overview: the sources of @TL{} are subjected to continuous integration -testing on Travis-CI -(@url{https://travis-ci.org/TeX-Live/texlive-source}) via a git-svn -mirror of the sources that is pushed to Github +The @TL{} sources are subjected to continuous integration testing on +Travis-CI (@url{https://travis-ci.org/TeX-Live/texlive-source}) via a +git-svn mirror of the sources that is pushed to Github (@url{https://github.com/TeX-Live/texlive-source}). The git-svn mirror is updated (currently) at 30 minute intervals, and only the last commit pushed is tested on Travis-CI. @@ -2501,51 +2554,54 @@ commit pushed is tested on Travis-CI. * CI testing on Travis-CI:: @end menu + @node Transfer from Subversion to Github @section Transfer from Subversion to Github -git-svn (@url{https://git-scm.com/docs/git-svn}) is used to check out -the subtree @code{Build/source} of the Subversion repository. The -author index file used is not maintained in either Git or Subversion -but can be provided on request. +@pindex git-svn +The git-svn program (@url{https://git-scm.com/docs/git-svn}) is used +to check out the subtree @code{Build/source} of the canonical +Subversion repository. The author index file used is not maintained +in either Git or Subversion but can be provided on request. @c TODO what should we do here with the author index file? It contains a @c mapping from subversion names to name/email as shown in git. The initial checkout was done by invoking @example -git svn --authors-file usermap clone svn://USER@@tug.org/texlive/trunk/Build/source +git svn --authors-file usermap clone \ + svn://@var{user}@@tug.org/texlive/trunk/Build/source @end example @noindent where the @code{usermap} file maps Subversion user names to -name and emails of the authors. If no user account at @url{tug.org} is -available, anonymous checkout is possible, too: +name and emails of the authors. Anonymous checkout is also possible: @example -git svn --authors-file usermap clone svn://tug.org/texlive/trunk/Build/source +git svn --authors-file usermap clone \ + svn://tug.org/texlive/trunk/Build/source @end example In the following, we will use @emph{admin} to refer to a user who has read/write access to the @TL{} subversion repository, and is also an -administrator of the @code{TeX-Live} Team on Github. The above initial -checkout has been carried out by @emph{admin} on the server +administrator of the `@code{TeX-Live}' team at Github. The above +initial checkout has been carried out by @emph{admin} on the server @code{texlive.info}. -On Github (@url{https://github.com}), a new git repository named -@code{texlive-source} was created by @emph{admin} within the -@code{TeX-Live} ``organization'' (@url{https://github.com/TeX-Live}). -The remote was added to the checkout with @code{git remote add origin +On Github, a new git repository named @code{texlive-source} was +created by @emph{admin} within the @code{TeX-Live} ``organization'' +(@url{https://github.com/TeX-Live}). The remote was added to the +checkout with @code{git remote add origin git@@github.com:TeX-Live/texlive-source.git}. -To automate the update on Github, a new ssh key was generated and added -to the @code{texlive-source} repository on Github as deployment -key. This way pushes using this key can only go to the +To automate the update on Github, a new ssh key was generated and +added to the @code{texlive-source} repository on Github as deployment +key. Thus, pushes using this key can only go to the @code{texlive-source} repository and not anywhere else. The usage of @code{git-svn} requires a strict discipline to keep a linear history in the master branch. Since we are aiming at a pure -mirror facility, we have decided to further restrict the @code{master} -branch of the @code{texlive-source} repository on Github to changes by -@emph{admin}. +mirror facility on Github, we have decided to further restrict the +@code{master} branch of the @code{texlive-source} repository on Github +to changes by @emph{admin}. This setup allows other developers to branch off @code{master} and push their branches to the Github repository, but all updates need to @@ -2560,19 +2616,20 @@ there to Github. every 30 minute which essentially runs @code{git svn rebase} and @code{git push} in the @code{master} branch of the checkout. The first command fetches the changes from the Subversion repository and updates -the @code{master} branch with them, the second one pushes changes (if -available) to Github. +the @code{master} branch with them, and the second pushes changes (if +any) to Github. @node CI testing on Travis-CI @section CI testing on Travis-CI -@pindex .travis.yml +@pindex travis.yml The @code{source} tree of @TL{} contains a top-level file @code{.travis.yml} which controls the automatic testing on -Travis-CI. @emph{admin} has registered to Travis-CI and allowed access -to the Github's @code{TeX-Live} organization's @code{texlive-source} -repository. The default settings are to build the last commit of each -push. No further action is necessary on Travis-CI. +Travis-CI. @emph{admin} has registered with Travis-CI and allowed +access to the Github's @code{TeX-Live} organization's +@code{texlive-source} repository. The default settings are to build +the last commit of each push. No further action is necessary on +Travis-CI. If changes have been pushed via the cron job above, Travis-CI will automatically checkout the last pushed commit and try building it. -- cgit v1.2.3