TEXLIVE-COMMON.ECLASS

Section: eclass-manpages (5)
Updated: Apr 2025
Index Return to Main Contents

NAME

texlive-common.eclass - Provide various functions used by both texlive-core and texlive modules

DESCRIPTION

Purpose: Provide various functions used by both texlive-core and texlive modules.

Note that this eclass *must* not assume the presence of any standard tex too

SUPPORTED EAPIS

7 8

FUNCTIONS

texlive-common_handle_config_files: Has to be called in src_install after having installed the files in ${D} This function will move the relevant files to /etc/texmf and symlink them from their original location. This is to allow easy update of texlive's configuration. Called by app-text/texlive-core and texlive-module.eclass.
texlive-common_is_file_present_in_texmf: Return if a file is present in the texmf tree Call it from the directory containing texmf and texmf-dist Called by app-text/texlive-core.
texlive-common_do_symlinks <src> <dest>: Mimic the install_link function of texlinks
Should have the same behavior as the one in /usr/bin/texlinks except that it is under the control of the package manager Note that $1 corresponds to $src and $2 to $dest in this function ( Arguments are switched because texlinks main function sends them switched ) This function should not be called from an ebuild, prefer etexlinks that will also do the fmtutil file parsing. Called by texlive-common.eclass and texlive-module.eclass.
etexlinks <file>: Mimic texlinks on a fmtutil format file
$1 has to be a fmtutil format file like fmtutil.cnf etexlinks foo will install the symlinks that texlinks --cnffile foo would have created. We cannot use texlinks with portage as it is not DESTDIR aware. (It would not fail but will not create the symlinks if the target is not in the same dir as the source) Also, as this eclass must not depend on a tex distribution to be installed we cannot use texlinks from here. Called by texlive-module.eclass.
dobin_texmf_scripts <file1> [file2] ...: Symlinks a script from the texmf tree to /usr/bin. Requires permissions to be correctly set for the file that it will point to. Called by app-text/epspdf and texlive-module.eclass.
etexmf-update: Runs texmf-update if it is available and prints a warning otherwise. This function helps in factorizing some code. Useful in ebuilds' pkg_postinst and pkg_postrm phases. Called by app-text/dvipsk, app-text/texlive-core, dev-libs/kpathsea, and texlive-module.eclass.
efmtutil-sys: Runs fmtutil-sys if it is available and prints a warning otherwise. This function helps in factorizing some code. Used in ebuilds' pkg_postinst to force a rebuild of TeX formats.
texlive-common_append_to_src_uri: Takes the name of a variable as input. The variable must contain a list of texlive packages. Every texlive package in the variable is transformed to an URL and appended to SRC_URI.
texlive-common_update_tlpdb: Update the TexLive package database at /usr/share/tlpkg/texlive.tlpdb.

ECLASS VARIABLES

CTAN_MIRROR_URL ?= "https://mirrors.ctan.org" (USER VARIABLE)

This variable can be used to set the CTAN mirror that will be used to fetch CTAN artifacts. Note that this mirror is usually only used as fallback in case the Gentoo mirrors do not hold the requested files.

Only Gentoo TeX developers may want to set this.

Example: CTAN_MIRROR_URL='https://ftp.fau.de/ctan/' emerge -1v app-text/texlive-core

TEXLIVE_SCRIPTS_W_FILE_EXT

If set, contains a space separated list of script names that should be linked including their file extensions, i.e., without stripping potentially existing filename extensions from the link's name.

AUTHORS

Original Author: Alexis Ballier <aballier@gentoo.org>

MAINTAINERS

tex@gentoo.org

REPORTING BUGS

Please report bugs via https://bugs.gentoo.org/

FILES

texlive-common.eclass

This document was created by man2html, using the manual pages.
Time: 03:27:01 GMT, April 19, 2025