From 022d9ebeeb627bb2c250ab92fb3a4c45db173bde Mon Sep 17 00:00:00 2001 From: Vincenzo Mantova <1962985+xworld21@users.noreply.github.com> Date: Sat, 23 May 2026 13:42:25 +0100 Subject: [PATCH] doc: remove texlive.combine from the TeX Live documentation --- doc/languages-frameworks/texlive.section.md | 59 +++------------------ doc/redirects.json | 6 +-- 2 files changed, 8 insertions(+), 57 deletions(-) diff --git a/doc/languages-frameworks/texlive.section.md b/doc/languages-frameworks/texlive.section.md index 4a378fee2d9b..f380cc4c5a92 100644 --- a/doc/languages-frameworks/texlive.section.md +++ b/doc/languages-frameworks/texlive.section.md @@ -2,9 +2,7 @@ There is a TeX Live packaging that lives entirely under attribute `texlive`. -## User's guide (experimental new interface) {#sec-language-texlive-user-guide-experimental} - -Release 23.11 ships with a new interface that will eventually replace `texlive.combine`. +## User's guide {#sec-language-texlive-user-guide} - For basic usage, use some of the prebuilt environments available at the top level, such as `texliveBasic`, `texliveSmall`. For the full list of prebuilt environments, inspect `texlive.schemes`. @@ -24,7 +22,7 @@ Release 23.11 ships with a new interface that will eventually replace `texlive.c - `texlive.withPackages` uses the same logic as `buildEnv`. Only parts of a package are installed in an environment: its 'runtime' files (`tex` output), binaries (`out` output), and support files (`tlpkg` output). Moreover, man and info pages are assembled into separate `man` and `info` outputs. To add only the TeX files of a package, or its documentation (`texdoc` output), just specify the outputs: ```nix - texlive.withPackages ( + texliveBasic.withPackages ( ps: with ps; [ texdoc # recommended package to navigate the documentation perlPackages.LaTeXML.tex # tex files of LaTeXML, omit binaries @@ -34,62 +32,19 @@ Release 23.11 ships with a new interface that will eventually replace `texlive.c ) ``` -- All packages distributed by TeX Live, which contains most of CTAN, are available and can be found under `texlive.pkgs`: - ```ShellSession - $ nix repl - nix-repl> :l - nix-repl> texlive.pkgs.[TAB] - ``` - Note that the packages in `texlive.pkgs` are only provided for search purposes and must not be used directly. - - To add the documentation for all packages in the environment, use ```nix texliveSmall.overrideAttrs { withDocs = true; } ``` This can be applied before or after calling `withPackages`. The parameter `withSources` adds all source containers. -## User's guide {#sec-language-texlive-user-guide} - -- For basic usage just pull `texlive.combined.scheme-basic` for an environment with basic LaTeX support. - -- It typically won't work to use separately installed packages together. Instead, you can build a custom set of packages like this. Most CTAN packages should be available: - - ```nix - texlive.combine { - inherit (texlive) - scheme-small - collection-langkorean - algorithms - cm-super - ; - } - ``` - -- There are all the schemes, collections and a few thousand packages, as defined upstream (perhaps with tiny differences). - -- By default you only get executables and files needed during runtime, and a little documentation for the core packages. To change that, you need to add `pkgFilter` function to `combine`. - - ```nix - texlive.combine { - # inherit (texlive) whatever-you-want; - pkgFilter = - pkg: pkg.tlType == "run" || pkg.tlType == "bin" || pkg.hasManpages || pkg.pname == "cm-super"; - # elem tlType [ "run" "bin" "doc" "source" ] - # there are also other attributes: version, name - } - ``` - -- You can list packages e.g. by `nix repl`. - +- All packages distributed by TeX Live, which contains most of CTAN, are available and can be found under `texlive.pkgs`: ```ShellSession $ nix repl nix-repl> :l - nix-repl> texlive.collection-[TAB] + nix-repl> texlive.pkgs.[TAB] ``` - -- Note that the wrapper assumes that the result has a chance to be useful. For example, the core executables should be present, as well as some core data files. The supported way of ensuring this is by including some scheme, for example, `scheme-basic`, into the combination. - -- TeX Live packages are also available under `texlive.pkgs` as derivations with outputs `out`, `tex`, `texdoc`, `texsource`, `tlpkg`, `man`, `info`. They cannot be installed outside of `texlive.combine` but are available for other uses. To repackage a font, for instance, use + These are derivations with outputs `out`, `tex`, `texdoc`, `texsource`, `tlpkg`, `man`, `info`. They cannot be installed outside of `texlive.withPackages` but are available for other uses. To repackage a font, for instance, use ```nix stdenvNoCC.mkDerivation (finalAttrs: { @@ -112,7 +67,7 @@ Release 23.11 ships with a new interface that will eventually replace `texlive.c You may find that you need to use an external TeX package. A derivation for such package has to provide the contents of the "texmf" directory in its `"tex"` output, according to the [TeX Directory Structure](https://tug.ctan.org/tds/tds.html). Dependencies on other TeX packages can be listed in the attribute `passthru.tlDeps`, which is a function taking a package set and returning a list of packages. -The functions `texlive.combine` and `texlive.withPackages` recognise the following outputs: +The function `texlive.withPackages` recognise the following outputs: - `"out"`: contents are linked in the TeX Live environment, and binaries in the `$out/bin` folder are wrapped; - `"tex"`: linked in `$TEXMFDIST`; files should follow the TDS (for instance `$tex/tex/latex/foiltex/foiltex.cls`); @@ -120,8 +75,6 @@ The functions `texlive.combine` and `texlive.withPackages` recognise the followi - `"tlpkg"`: linked in `$TEXMFROOT/tlpkg`; - `"man"`, `"info"`, ...: the other outputs are combined into separate outputs. -When using `pkgFilter`, `texlive.combine` will assign `tlType` respectively `"bin"`, `"run"`, `"doc"`, `"source"`, `"tlpkg"` to the above outputs. - Here is a (very verbose) example. See also the packages `auctex`, `eukleides`, `mftrace` for more examples. ```nix diff --git a/doc/redirects.json b/doc/redirects.json index 646b12a5a077..d06728e02abd 100644 --- a/doc/redirects.json +++ b/doc/redirects.json @@ -4428,11 +4428,9 @@ "sec-language-texlive": [ "index.html#sec-language-texlive" ], - "sec-language-texlive-user-guide-experimental": [ - "index.html#sec-language-texlive-user-guide-experimental" - ], "sec-language-texlive-user-guide": [ - "index.html#sec-language-texlive-user-guide" + "index.html#sec-language-texlive-user-guide", + "index.html#sec-language-texlive-user-guide-experimental" ], "sec-language-texlive-custom-packages": [ "index.html#sec-language-texlive-custom-packages"