TeX Live

https://tug.org/texlive
Admin
TeX Live is a comprehensive TeX document production system providing major TeX-related programs,...
Tokens:1,662,268
Snippets:13,260
Trust Score:9.7
Update:10 months ago
Show doc for...
Tokens:
Raw
### Start Graphical TeX Live Installer

Source: https://tug.org/texlive/portable

Invokes the graphical installer for TeX Live. This command initiates the visual setup process, offering a more user-friendly experience compared to the text-based installer. This is the default method on non-Unix systems.

```bash
install-tl -gui

```

--------------------------------

### TeX Live Profile: Platform Options Example

Source: https://tug.org/texlive/doc/tlbuild

Demonstrates how to specify platform-specific binary installations in a TeX Live profile. This example enables the installation of binaries for the 'x86_64-linux' platform.

```plaintext
binary_x86_64-linux 1
```

--------------------------------

### Start TeX Live Installer on Unix

Source: https://tug.org/texlive/portable

This snippet shows how to initiate the TeX Live installer script on Unix-compatible systems using the Perl interpreter. It requires the installer script to be present at the specified path. The output is the successful execution of the installer.

```bash
> perl /path/to/installer/install-tl
/path/to/installer/install-tl
cd
2
```

--------------------------------

### TeX Live Text Installer Screen (GNU/Linux)

Source: https://tug.org/texlive/doc/texlive-en/texlive-en

An example of the interactive text mode installer screen for TeX Live on GNU/Linux. It shows options for selecting installation schemes, customizing collections, setting directories, configuring options, and starting the installation. This interface is designed to be primitive for broad compatibility.

```text
Installing TeX Live 2025 from: ... 
Platform: x86_64-linux => ’GNU/Linux on x86_64’ 
Distribution: inst (compressed) 
Directory for temporary files: /tmp 
... 
 Detected platform: GNU/Linux on Intel x86_64 
 
 <B> binary platforms: 1 out of 16 
 
 <S> set installation scheme: scheme-full 
 
 <C> customizing installation collections 
     40 collections out of 41, disk space required: 8648 MB (free: 138718 MB) 
 
 <D> directories: 
  TEXDIR (the main TeX directory): 
   /usr/local/texlive/2025 
   ... 
 
 <O> options: 
  [ ] use letter size instead of A4 by default 
  ... 
 
 <V> set up for portable installation 
 
Actions: 
 <I> start installation to hard disk 
 <P> save installation profile to ’texlive.profile’ and exit 
 <H> help 
 <Q> quit
```

--------------------------------

### TeX Live Profile: Installer Options Examples

Source: https://tug.org/texlive/doc/tlbuild

Illustrates common installer options within a TeX Live profile file. These options control aspects like PATH adjustment, repository settings, paper size, portable installations, and \write18 execution.

```plaintext
instopt_adjustpath
instopt_adjustrepo
instopt_letter
instopt_portable
instopt_write18_restricted
```

--------------------------------

### Interactive TeX Live Installation (Unix)

Source: https://tug.org/texlive/quickinstall

Starts an interactive installation process for TeX Live on Unix-like systems. After unpacking the archive, this command initiates a menu-driven setup where users can configure various installation options.

```shell
cd /your/unpacked/directory
perl install-tl
# Follow prompts, e.g., enter 'i' to install
```

--------------------------------

### TeX Live Configuration Example

Source: https://tug.org/texlive/devsrc/Master/texmf-dist/doc/texlive/texlive-en/texlive-en

Example lines from the principal TeX Live configuration file ($TEXMFDIST/web2c/texmf.cnf) demonstrating directory layout for shared-user installations. These settings define relative paths for TeX Live components.

```shell
TEXMFROOT = $SELFAUTOPARENT
...
TEXMFDIST = $TEXMFROOT/texmf-dist
...
TEXMFLOCAL = $SELFAUTOGRANDPARENT/texmf-local
```

--------------------------------

### Convert HTML Quickstart to PDF using Shell Script

Source: https://tug.org/texlive/devsrc/Master/texmf-dist/doc/support/arara

This shell script is designed to convert the HTML version of the Arara quick start guide into a PDF file. It relies on the availability of appropriate command-line utilities for the conversion process.

```shell
#!/bin/bash

# Script to convert HTML quickstart guide to PDF
# Requires command-line HTML to PDF conversion tools

HTML_FILE="arara-quickstart.html"
PDF_FILE="arara-quickstart.pdf"

if [ -f "$HTML_FILE" ]; then
    echo "Converting $HTML_FILE to $PDF_FILE..."
    # Placeholder for the actual conversion command
    # e.g., wkhtmltopdf "$HTML_FILE" "$PDF_FILE"
    echo "Conversion command would execute here."
    echo "Quickstart PDF generated (simulated)."
else
    echo "Error: $HTML_FILE not found."
fi
```

--------------------------------

### TeX Live Text Installer Interface (GNU/Linux)

Source: https://tug.org/texlive/portable

This is a representation of the main screen for the TeX Live text-based installer on GNU/Linux. It displays installation progress, detected platform, and options for setting the installation scheme, customizing collections, defining directories, and other settings before starting the installation.

```text
Installing TeX Live 2025 from: ...
Platform: x86_64-linux => ’GNU/Linux on x86_64’
Distribution: inst (compressed)
Directory for temporary files: /tmp
...
Detected platform: GNU/Linux on Intel x86_64

<B> binary platforms: 1 out of 16

<S> set installation scheme: scheme-full

<C> customizing installation collections
    40 collections out of 41, disk space required: 8648 MB (free: 138718 MB)

<D> directories:
  TEXDIR (the main TeX directory):
    /usr/local/texlive/2025
  ...

<O> options:
  [ ] use letter size instead of A4 by default
  ...

<V> set up for portable installation

Actions:
  <I> start installation to hard disk
  <P> save installation profile to ’texlive.profile’ and exit
  <H> help
  <Q> quit

```

--------------------------------

### TeX Live Profile: tlpdb Options Examples

Source: https://tug.org/texlive/doc/tlbuild

Shows examples of tlpdb (TeX Live Package Database) options that can be set in a profile file. These control various aspects of package management and installation behavior.

```plaintext
tlpdbopt_autobackup
tlpdbopt_backupdir
tlpdbopt_create_formats
tlpdbopt_desktop_integration
tlpdbopt_file_assocs
tlpdbopt_generate_updmap
tlpdbopt_install_docfiles
tlpdbopt_install_srcfiles
tlpdbopt_post_code
tlpdbopt_sys_bin
tlpdbopt_sys_info
tlpdbopt_sys_man
tlpdbopt_w32_multi_user
```

--------------------------------

### Example of 'selected_scheme' in TeX Live Profile

Source: https://tug.org/texlive/doc/tlbuild

Demonstrates how to specify a TeX Live installation scheme using the 'selected_scheme' variable in a profile file. This line, along with path definitions, installs the 'small' scheme.

```plaintext
selected_scheme scheme-small
```

--------------------------------

### TeX Live Configuration Example (texmf.cnf)

Source: https://tug.org/texlive/doc/texlive-en/texlive-en

This snippet shows example lines from the principal TeX Live configuration file, $TEXMFDIST/web2c/texmf.cnf. These lines define key directory variables like TEXMFROOT, TEXMFDIST, and TEXMFLOCAL, which are crucial for shared-user and network installations by allowing programs to find files relative to their location.

```plaintext
TEXMFROOT = $SELFAUTOPARENT 
...
TEXMFDIST = $TEXMFROOT/texmf-dist 
...
TEXMFLOCAL = $SELFAUTOGRANDPARENT/texmf-local
```

--------------------------------

### Build Individual Package: `dvipdfm-x` Example

Source: https://tug.org/texlive/devsrc/Master/texmf-dist/doc/texlive/tlbuild/tlbuild

This example provides a comprehensive guide to building a single TeX Live package, specifically `dvipdfm-x`. It includes steps for setting up the build environment, configuring the build with `--disable-all-pkgs` and `--enable-dvipdfm-x`, compiling the package, running checks, and executing the built binary with correct environment variables for finding support files.

```bash
mkdir mydir && cd mydir

# Get sources (https://tug.org/texlive/svn), e.g.:
rsync -a --delete --exclude=.svn --exclude=Work \
      tug.org::tldevsrc/Build/source/ .

# Create build directory:
mkdir Work && cd Work

# Do the configure:
../configure --disable-all-pkgs --enable-dvipdfm-x \
  -C CFLAGS=-g CXXFLAGS=-g >&outc || echo fail

# Do the make:
make >&outm || echo fail

# Run the tests:
cd texk/dvipdfm-x
make check

# Run the new binary in the build tree, finding support files
# in a separate tree for a TeX Live release YYYY
# (Bourne shell syntax):
TEXMFROOT=/usr/local/texlive/YYYY \
TEXMFCNF=$TEXMFROOT/texmf-dist/web2c \
./xdvipdfmx ...
```

--------------------------------

### TeX Example: Basic Citation and Bibliography Setup

Source: https://tug.org/texlive/Contents/live/texmf-dist/doc/eplain/eplain

This snippet demonstrates a minimal TeX input file using Eplain to include citations and set up a bibliography. It shows the necessary input commands, citation usage with \cite, and specifies the bibliography file and style.

```TeX
\input eplain                    % Reads the .aux file.
Two citations to Knuthian works:
  \cite[note]{surreal,concrete-math}.
\beginsection{References.}\par   % Title for the bibliography.
\bibliography{knuth}             % Use knuth.bib for the labels.
\bibliographystyle{plain}        % Number the references.
\end                             % End of the document.

```

--------------------------------

### Get Programs Menu Path (Perl)

Source: https://tug.org/texlive/doc/tlpkgdoc/TLWinGoo

Retrieves the system path for the current user's programs menu or the common programs menu, based on administrative privileges. This path is used for installing application shortcuts into the Start Menu.

```perl
sub menu_path() {
  return Win32::GetFolderPath(
    (admin() ? Win32::CSIDL_COMMON_PROGRAMS : Win32::CSIDL_PROGRAMS), CREATE);
}
```

--------------------------------

### Build and Install dvipng

Source: https://tug.org/texlive/Contents/live/texmf-dist/doc/dvipng/dvipng

Compiles the dvipng source code and installs the resulting binaries and documentation. The 'make' command builds the project, and 'make install' places the files in the configured locations. Administrative privileges may be required for installation.

```shell
make

```

```shell
make install

```

--------------------------------

### Makefile Example with Library Flags

Source: https://tug.org/texlive/devsrc/Master/texmf-dist/doc/texlive/tlbuild/tlbuild

An example Makefile.am snippet demonstrating how to use the generated library include, library, and dependency variables for programs linked against zlib and libpng.

```makefile
bin_PROGRAMS = foo
AM_CPPFLAGS = ${LIBPNG_INCLUDES} ${ZLIB_INCLUDES}
foo_LDADD = ${LIBPNG_LIBS} ${ZLIB_LIBS}
foo_DEPENDENCIES = ${ZLIB_DEPEND} ${LIBPNG_DEPEND}
## Rebuild libz
@ZLIB_RULE@
## Rebuild libpng
@LIBPNG_RULE@

```

--------------------------------

### TeX Live Manager (tlmgr) Examples

Source: https://tug.org/texlive/devsrc/Master/texmf-dist/doc/texlive/tlbuild/tlbuild

Demonstrates common operations for the TeX Live Manager (tlmgr) script, such as setting repositories, updating packages, and retrieving information. These commands are essential for managing a TeX Live installation after initial setup.

```shell
tlmgr option repository ctan
tlmgr option repository https://mirror.ctan.org/systems/texlive/tlnet
tlmgr update --list
tlmgr update --all
tlmgr info <what>
tlmgr bug <what>
```

--------------------------------

### Setting up xindy tutorial directory and files

Source: https://tug.org/texlive/devsrc/Master/texmf-dist/doc/xindy/style-tutorial-2

Copies necessary raw and TeX files from the distribution's style-tutorial directory to a new 'tutorial' directory. This prepares the environment for running xindy examples.

```bash
eg$ mkdir tutorial
eg$ cd tutorial
eg$ cp <distrib-dir>/doc/style-tutorial/*.raw .
eg$ cp <distrib-dir>/doc/style-tutorial/*.tex .
```

--------------------------------

### Example of Static Frame Label and ID Retrieval

Source: https://tug.org/texlive/devsrc/Master/texmf-dist/doc/latex/flowfram/ffuserguide

An example demonstrating how to use \getstaticlabel to get the label of the first static frame and \getstaticid to get the IDN of a static frame by its label.

```latex
The label for the first static frame 
is ``\getstaticlabel{1}''.
The static frame labelled ``backleft'' has IDN
\getstaticid{\myid}{backleft}\myid.
```

--------------------------------

### Demonstrate Hybrid Option in ConTeXt

Source: https://tug.org/texlive/Contents/live/texmf-dist/doc/generic/markdown/markdown

This example shows how to enable the 'hybrid' option in ConTeXt using `\setupmarkdown[hybrid = yes]` before a `\startmarkdown` block.

```context
\usemodule[t][markdown]
\starttext

\startmarkdown
$\sqrt{-1}$ *equals* $i$.
\stopmarkdown

\setupmarkdown[hybrid = yes]
\startmarkdown
$\sqrt{-1}$ *equals* $i$.
\stopmarkdown

\stoptext
```

--------------------------------

### Run TeX Live Installer in GUI Mode on Unix

Source: https://tug.org/texlive/devsrc/Master/texmf-dist/doc/texlive/texlive-en/texlive-en

This command launches the TeX Live installer in graphical user interface (GUI) mode on Unix-like systems, provided Tcl/Tk is installed. This offers a visual way to configure and start the installation.

```shell
> perl install-tl -gui
```

--------------------------------

### Access polexpr-examples documentation

Source: https://tug.org/texlive/devsrc/Master/texmf-dist/doc/generic/polexpr/polexpr

This command is used to access the \`polexpr-examples.pdf\` document, which contains examples of root localization and their corresponding TeX code and output. This is useful for understanding the practical application of polexpr's features.

```bash
texdoc polexpr-examples

```

--------------------------------

### Install ConTeXt Modules using mtxrun

Source: https://tug.org/texlive/Contents/live/texmf-dist/doc/context/scripts/mkiv/mtx-install-modules

These examples demonstrate how to install specific ConTeXt modules or all available modules using the 'mtxrun' command-line tool. The '--install' flag is used, optionally with module names or '--all'.

```bash
mtxrun --script install-modules --install filter letter
```

```bash
mtxrun --script install-modules --install tikz
```

```bash
mtxrun --script install-modules --install --all
```

--------------------------------

### TeX Live Graphical Installer Invocation

Source: https://tug.org/texlive/doc/texlive-en/texlive-en

Command to start the TeX Live graphical installer. This provides a more user-friendly interface compared to the text mode installer, offering options like 'perltk/expert' and 'wizard' GUIs.

```bash
> install-tl -gui
```

--------------------------------

### Implement See/See Also Hyperlinks with \sidx

Source: https://tug.org/texlive/Contents/live/texmf-dist/doc/eplain/eplain

This example demonstrates implementing hyperlinks for 'see' and 'see also' index entries using \`\sidx\`, \`\hldest\`, \`\hlstart\`, and \`\hlend\`. This is necessary as Eplain does not automatically support these due to insufficient information.

```tex
\sidx{semantic theory of truth@%\\
      \leavevmode\hldest{}{}{idx:theo truth}semantic theory of truth}
...
\sidx[seealso]{truth}[definition of]%\\
      {\hlstart{}{}{idx:theo truth}semantic theory of truth\hlend}
```

--------------------------------

### Example Usage of \phantomsection and \addcontentsline

Source: https://tug.org/texlive/devsrc/Master/texmf-dist/doc/latex/hyperref/hyperref-doc

This example demonstrates how \phantomsection can be used with \addcontentsline to correctly link the table of contents entry for the index to the start of the index page.

```latex
\cleardoublepage
\phantomsection
\addcontentsline{toc}{chapter}{\indexname}
\printindex
```

--------------------------------

### Install JadeTex and PdfJadeTex Formats

Source: https://tug.org/texlive/devsrc/Master/texmf-dist/doc/otherformats/jadetex/base

This section details the installation of `jadetex.fmt` and `pdfjadetex.fmt`. It involves navigating to the OpenJade DSSSL directory, running `make install` as root, and then creating symbolic links for the executables and updating the TeX file database.

```shell
cd /path/to/OpenJade/dsssl
make install
ln -s /usr/bin/tex /usr/bin/jadetex
ln -s /usr/bin/pdftex /usr/bin/pdfjadetex
mktexlsr
```

--------------------------------

### Get TLPDB Location and Platform Info

Source: https://tug.org/texlive/doc/tlpkgdoc/TLPDB

Retrieves the installation location, platform information, and verification status of the TeX Live installation.

```perl
use TeXLive::TLPDB;

my $tlpdb = TeXLive::TLPDB->new();

print "Location: " . $tlpdb->location . "\n";
print "Platform: " . $tlpdb->platform . "\n";
print "Is Verified: " . $tlpdb->is_verified . "\n";
print "Verification Status: " . $tlpdb->verification_status . "\n";
```

--------------------------------

### Basic LaTeX Hello World Example

Source: https://tug.org/texlive/devsrc/Master/texmf-dist/doc/texlive/texlive-en/texlive-en

This is a minimal LaTeX document used as an example for demonstrating dvips debugging. It includes the basic structure of a LaTeX file.

```tex
\documentclass{article}
\begin{document}
Hello World!
\end{document}
```

--------------------------------

### texmf.cnf Comment and Value Syntax Example

Source: https://tug.org/texlive/Contents/live/texmf-dist/doc/kpathsea/kpathsea

Illustrates how comments are handled in texmf.cnf files, starting with '%' or '#'. It also shows that '%' within a value does not start a comment, preserving the literal character.

```plaintext
% this is a comment
var = a%b  % but the value of var will be "a%b"
```

--------------------------------

### Get Media Information

Source: https://tug.org/texlive/doc/tlpkgdoc/TLPDB

Retrieves information about the media (e.g., installation source) associated with the TeX Live installation managed by the TLPDB object.

```perl
use TeXLive::TLPDB;

my $tlpdb = TeXLive::TLPDB->new();
my $media_info = $tlpdb->media();
print "Media Info: $media_info\n";
```

--------------------------------

### Display TeX Live Installer Help on Unix

Source: https://tug.org/texlive/devsrc/Master/texmf-dist/doc/texlive/texlive-en/texlive-en

This command displays a comprehensive list of available options and arguments for the TeX Live installer script on Unix-compatible systems. It's useful for understanding advanced configuration and usage.

```shell
> perl install-tl -help
```

--------------------------------

### Install 'wish' and Prepare TeX Live Directory

Source: https://tug.org/texlive/chromeos

These commands are executed in the ChromeOS Linux terminal to install the 'wish' package, which is required for the GUI installer, and to create and set ownership for the TeX Live installation directory. 'yourusername' should be replaced with the actual user's login name.

```bash
sudo apt-get install wish
sudo mkdir /usr/local/texlive
sudo chown yourusername:yourusername /usr/local/texlive
```

--------------------------------

### Control TeX Live Installation Options (Doc, Source, Postcode)

Source: https://tug.org/texlive/doc/tlmgr

Toggles the installation of documentation files (`docfiles`), source files (`srcfiles`), and the execution of per-package postinstallation code (`postcode`). Setting these to 0 disables the respective features.

```bash
tlmgr option docfiles 0
tlmgr option srcfiles 0
tlmgr option postcode 0
```

--------------------------------

### Install TeX Live using a profile file

Source: https://tug.org/texlive/devsrc/Master/texmf-dist/doc/texlive/tlbuild/tlbuild

Installs TeX Live non-interactively based on settings defined in a specified TL profile file. Adding '--init-from-profile' will load settings from the profile and then enter the interactive menu for further customization.

```bash
install-tl --profile=texlive.profile
```

--------------------------------

### TeX Live Installer Interface Options

Source: https://tug.org/texlive/quickinstall

Demonstrates the different command-line options for invoking the TeX Live installer with various interfaces: text mode, graphical mode, and batch mode using a profile.

```bash
install-tl -gui text
install-tl -gui
install-tl --profile=_profile_
```

--------------------------------

### Handling Special Characters in Glossary Labels (Working Example)

Source: https://tug.org/texlive/devsrc/Master/texmf-dist/doc/latex/glossaries/glossariesbegin

This LaTeX example demonstrates a working scenario for defining a glossary entry with a colon in its label. It uses the glossaries package and a standard document setup.

```latex
\documentclass{article}
\usepackage{glossaries}
\newglossaryentry{sym:set}{name={\ensuremath{\mathcal{S}}},
 description={a set}}
\begin{document}
\gls{sym:set}
\end{document}
```

--------------------------------

### Install TeX Live with Custom Binaries

Source: https://tug.org/texlive/custom-bin

This snippet demonstrates how to install TeX Live using a custom set of binaries. It involves acquiring the binaries, unpacking them, running the `install-tl` command with the `--custom-bin` option, and updating the system's PATH environment variable. Ensure the custom binaries are unpacked in a designated directory before execution.

```bash
mkdir /tmp/foobin && cd /tmp/foobin
tar xf ...tar.gz
install-tl --custom-bin=/tmp/foobin
export PATH=TLROOT/bin/custom:$PATH
```

--------------------------------

### Initialize TeX Live Pretest from Current Installation (Shell)

Source: https://tug.org/texlive/pretest

This snippet demonstrates how to initialize a new TeX Live pretest installation by copying an existing, up-to-date TeX Live installation. It involves creating a new directory, copying files while preserving symlinks, setting up the PATH, downloading the latest update script, and then updating the pretest installation using tlmgr. Ensure to replace PRETEST-URL with the actual pretest repository URL.

```shell
cd /usr/local/texlive  # adjust path as needed if not default
mkdir pretest
ls pretest  # check that you're starting with an empty dir

cd 2024     # cd to directory of your current/up-to-date TL installation

# do the big copy, preserving symlinks:
nice -19 cp -ar *.* bin/ README install-tl texmf-{dist,local} tlpkg ../pretest/

cd /usr/local/texlive/pretest
PATH=$(pwd)/bin/x86_64-linux:$PATH       # or whatever current platform
wget PRETEST-URL/update-tlmgr-latest.sh # or curl, whatever
sh update-tlmgr-latest.sh
tlmgr option repo PRETEST-URL
tlmgr update --self && tlmgr update --all

```

--------------------------------

### Verbatim Environment Example

Source: https://tug.org/texlive/devsrc/Master/texmf-dist/doc/support/latex2man/latex2man

Demonstrates the usage of a verbatim environment, showing how content within it is preserved exactly as written, including spacing and special characters, without interpretation as HTML or TexInfo commands.

```text
This
    {is}
        \texttt{a}
                  $test$
                         _of_
verbatim
<this is no HTML tag> and no @* TexInfo command
```

--------------------------------

### ConTeXt Example for `codeSpans` Option

Source: https://tug.org/texlive/Contents/live/texmf-dist/doc/generic/markdown/markdown

This ConTeXt example showcases the markdown module. It demonstrates how to start and stop markdown environments and configure the `codeSpans` option using `\setupmarkdown[codeSpans = no]`.

```context
\usemodule[t][markdown]
\starttext

\startmarkdown
``This is a code span.'' 
``This is no longer a code span.'' 
\stopmarkdown

\setupmarkdown[codeSpans = no]
\startmarkdown
``This is a quote.'' 
``This is another quote.'' 
\stopmarkdown

\stoptext
```

--------------------------------

### Control TeX Live File Installation Options

Source: https://tug.org/texlive/doc/tlbuild

Enables or disables the installation of documentation (`docfiles`) and source files (`srcfiles`) per package. Setting these to 0 can save disk space.

```bash
tlmgr option docfiles <0|1>
tlmgr option srcfiles <0|1>
```
Tokens:
Raw