| 1 |
.TH L3BUILD 1 "2026-03-26" "LaTeX" |
| 2 |
|
| 3 |
.SH NAME |
| 4 |
l3build |
| 5 |
|
| 6 |
.SH SYNOPSIS |
| 7 |
Usage l3build <target> [<options>] [<names>] |
| 8 |
|
| 9 |
.SH DESCRIPTION |
| 10 |
|
| 11 |
|
| 12 |
The "l3build" module is designed to support the development of |
| 13 |
high-quality LaTeX code by providing: |
| 14 |
|
| 15 |
* A unit testing system |
| 16 |
|
| 17 |
* Automated typesetting of code sources |
| 18 |
|
| 19 |
* A reliable packaging system for CTAN releases |
| 20 |
|
| 21 |
The bundle consists of a Lua script to run the tasks and a |
| 22 |
".tex" file which provides the testing environment. These were |
| 23 |
originally developed for supporting LaTeX development but |
| 24 |
are designed such that they can be readily used by others. Full |
| 25 |
documentation is provided. |
| 26 |
|
| 27 |
.SH COMMANDS |
| 28 |
Valid targets are: |
| 29 |
check Runs all automated tests |
| 30 |
clean Cleans out directory tree |
| 31 |
ctan Creates CTAN-ready archive |
| 32 |
doc Typesets all documentation files |
| 33 |
install Installs files into the local texmf tree |
| 34 |
manifest Creates a manifest file |
| 35 |
save Saves test validation log |
| 36 |
tag Updates release tags in files |
| 37 |
uninstall Uninstalls files from the local texmf tree |
| 38 |
unpack Unpacks the source files into the build tree |
| 39 |
upload Sends archive to CTAN for public release |
| 40 |
|
| 41 |
.SH OPTIONS |
| 42 |
Valid options are: |
| 43 |
--config|-c Sets the config(s) used for running tests |
| 44 |
--date|-d Sets the date to insert into sources |
| 45 |
--debug Runs target in debug mode |
| 46 |
--dev Use the development LaTeX format |
| 47 |
--dirty Skips cleaning up the test area |
| 48 |
--dry-run Dry run for install or upload |
| 49 |
--email Email address of CTAN uploader |
| 50 |
--engine|-e Sets the engine(s) to use for running test |
| 51 |
--epoch Sets the epoch for tests and typesetting |
| 52 |
--file|-F Takes the upload announcement from the given file |
| 53 |
--first Name of first test to run |
| 54 |
--full Installs all files |
| 55 |
--halt-on-error|-H Stops running tests after the first failure |
| 56 |
--help|-h Prints this message and exits |
| 57 |
--last Name of last test to run |
| 58 |
--message|-m Text for upload announcement message |
| 59 |
--quiet|-q Suppresses TeX output when unpacking |
| 60 |
--rerun Skips setup: simply reruns tests |
| 61 |
--show-log-on-error Shows the full log of the failure with 'halt-on-error' |
| 62 |
--show-saves|-S Shows the invocation to update failing .tlg files |
| 63 |
--shuffle Shuffles order of tests |
| 64 |
--stdengine|-s Run tests with the std engine (config dependent) |
| 65 |
--texmfhome Location of user texmf tree |
| 66 |
--version Prints version information and exits |
| 67 |
|
| 68 |
.SH "SEE ALSO" |
| 69 |
Full manual available via 'texdoc l3build'. |
| 70 |
|
| 71 |
Repository : https://github.com/latex3/l3build |
| 72 |
|
| 73 |
Bug tracker : https://github.com/latex3/l3build/issues |
| 74 |
.SH AUTHORS |
| 75 |
Copyright (C) 2014-2026 The LaTeX Project |