summaryrefslogtreecommitdiff
path: root/Build/source/README.config
diff options
context:
space:
mode:
Diffstat (limited to 'Build/source/README.config')
-rw-r--r--Build/source/README.config133
1 files changed, 133 insertions, 0 deletions
diff --git a/Build/source/README.config b/Build/source/README.config
new file mode 100644
index 00000000000..59447eedb6e
--- /dev/null
+++ b/Build/source/README.config
@@ -0,0 +1,133 @@
+Copyright (C) 2009 Peter Breitenlohner <tex-live@tug.org>
+You may freely use, modify and/or distribute this file.
+
+ Configure options for the TeX Live (TL) build system
+ =====================================================
+
+The TL 2009 build system contains a collection of program packages, i.e.,
+subdirectories texk/Prog/ (where `Prog' is web2c, afm2pl, bibtex8, etc.) and
+utils/Util/ (where `Util' is dialog, pdfopen, etc.) as well as library
+packages, i.e., subdirectories texk/kpathsea/ and libs/Lib/ (where `Lib' is
+zlib, libpng, t1lib, etc.) for most of the libraries required by the program
+packages. Correspondingly there are plenty of configure options, most of
+them described below. See 'configure --help' (at the top-level) for an
+exhaustive list of all global options and a few important package specific
+ones or run, e.g., 'texk/lcdf-typetools/configure --help' to also see
+lcdf-typetools specific options not shown at the top-level.
+
+1. Global configure options
+===========================
+
+1.1. --disable-native-texlive-build
+-----------------------------------
+
+If enabled (by default) build for a TeX Live binary distribution such as
+the TL2009 DVD-Rom; this implies '--enable-multiplatform' and
+'--enable-cxx-runtime-hack' unless they are explicitly disabled.
+
+Building TL for a Linux or other distribution, this would be disabled and
+system versions of most libraries would be used (see below).
+
+1.2. --enable-multiplatform
+---------------------------
+
+If enabled, install executables and libraries in platform dependent
+subdirectories of EPREFIX/bin and EPREFIX/lib (unless '--bindir=DIR' or
+'--libdir=DIR' is specified). This option automatically propagates the
+values for bindir and libdir to all subdirectories to be configured, and
+thus need not be used explicitly in any program or library package.
+
+1.3. --enable-cxx-runtime-hack
+------------------------------
+
+If enabled and when using gcc, try to statically link with libstc++,
+somewhat improving portability.
+
+1.4. --disable-largefile
+------------------------
+
+Omit support for large files (>=2GB).
+
+2. Configure options for program packages
+=========================================
+
+2.1. --disable-Prog and --disable-Util
+--------------------------------------
+
+Do not build and install the program(s) of the package `Prog' or `Util'.
+
+2.2. --disable-all-pkgs
+-----------------------
+
+Do not build any program packages, except those explicitly enabled. Without
+this options all packages are built except those explicitly disabled (except
+for utils/xindy/ which is disabled by default due to its requirement for
+clisp and others).
+
+2.3. Configure options for texk/web2c/
+--------------------------------------
+
+2.3.1. --enable-auto-core
+
+This option causes TeX & MF to produce a core dump when a particular
+filename is encountered.
+
+2.3.2. --disable-dump-share
+
+Make the fmt/base/mem dump files architecture dependend (somewhat increasing
+performance on little-endian systems).
+
+2.3.3. --enable-ipc
+
+If enabled (by default) allow TeX's '--ipc' option.
+
+2.3.4. --disable-tex, --enable-etex, --disable-aleph, --disable-pdftex,
+ --disable-luatex, --disable-xetex, --disable-mf, --disable-mp
+
+Do or do not build the various TeX, METAFONT, and MetaPost engines.
+
+2.3.5. --with-mf-x-toolkit
+
+Use the X toolkit (libXt) for METAFONT (default is yes).
+
+2.3.6. --enable-*win
+
+Include various types of window support for METAFONT.
+
+2.3.7. --enable-mf-nowin
+
+Build a separate non-windows-capable METAFONT.
+
+2.3.8. --disable-web-progs
+
+Do not build the WEB programs bibtex ... weave, e.g., when you just have to
+rebuid some engines.
+
+2.4. Configure options for texk/xdvik/
+--------------------------------------
+
+2.4.1. --with-gs=PATH
+
+Hardwire the location of GhostScript (gs).
+
+2.4.2. --with-xdvi-x-toolkit=KIT
+
+Use toolkit KIT (motif/xaw/xaw3d/neXtaw) for xdvi, default: Motif if
+available, else Xaw.
+
+3. Configure options for libraries
+==================================
+
+3.1. --with-system-Lib
+----------------------
+
+Use an installed (system) version of the library `Lib'; this option exists
+for most but not all libraries.
+
+For many libraries there are in addition '--with-Lib-includes=DIR' and
+'--with-Lib-libdir=DIR' to indicate that the library is installed in an
+unusual location.
+
+When a system version of a required library is chosen, the top-level configure script
+performs a consistency check and bails out early if this fails.
+