NAME¶

l3build - Checking and building packages

SYNOPSIS¶

l3build <target> [<options>] [<names>]

DESCRIPTION¶

The l3build system is a Lua script for building TeX packages, with particular emphasis on regression testing. It is written in cross-platform Lua code, so can be used by any modern TeX distribution with the texlua interpreter. A package for building with l3build can be written in any TeX dialect; its defaults are set up for LaTeX packages written in the DocStrip style.

The standard l3build targets are:

check

Runs all automated tests

clean

Cleans out directory tree

ctan

Creates CTAN-ready archive

doc

Typesets all documentation files

install

Installs files into the local texmf tree

manifest

Creates a manifest file

save

Saves test validation log

tag

Updates release tags in files

uninstall

Uninstalls files from the local texmf tree

unpack

Unpacks the source files into the build tree

upload

Sends archive to CTAN for public release

OPTIONS¶

Various options apply

--config|-c

Sets the config(s) used for running tests

--date

Sets the date to insert into sources

--debug

Runs target in debug mode

--dirty

Skips cleaning up the test area

--dry-run

Dry run for install or upload

--email

Email address of CTAN uploader

--engine|-e

Sets the engine(s) to use for running test

--epoch

Sets the epoch for tests and typesetting

--file|-F

Takes the upload announcement from the given file

--first

Name of first test to run

--full

Installs all files

--halt-on-error|-H

Stops running tests after the first failure

--help|-h

Prints help message and exits

--last

Name of last test to run

--message|-m

Text for upload announcement message

--quiet|-q

Suppresses TeX output when unpacking

--rerun

Skips setup: simply reruns tests

--show-log-on-error

Shows the full log of the failure with 'halt-on-error'

--show-saves|-S

Shows the invocation to update failing .tlg files

--shuffle

Shuffles order of tests

--stdengine|-s

Run tests with the std engine (config dependent)

--texmfhome

Location of user texmf tree

--version

Prints version information and exits

BUGS¶

AUTHOR¶

The LaTeX Project (latex-team@latex-project.org)

Please log issues on the GitHub homepage: https://github.com/latex3/l3build/issues.

SEE ALSO¶

See l3build.pdf for more details.