diff options
Diffstat (limited to 'macros/latex/contrib/l3build/l3build.1')
-rw-r--r-- | macros/latex/contrib/l3build/l3build.1 | 154 |
1 files changed, 67 insertions, 87 deletions
diff --git a/macros/latex/contrib/l3build/l3build.1 b/macros/latex/contrib/l3build/l3build.1 index b983494b73..d42e486f3c 100644 --- a/macros/latex/contrib/l3build/l3build.1 +++ b/macros/latex/contrib/l3build/l3build.1 @@ -1,91 +1,71 @@ -.TH l3build 1 "2024-02-08" +.TH L3BUILD 1 "2024-05-27" "LaTeX" + .SH NAME -l3build \- Checking and building packages +l3build + .SH SYNOPSIS -l3build <target> [<options>] [<names>] + Usage l3build <target> [<options>] [<names>] + .SH 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. -.PP -The standard l3build targets are: -.IP check -Runs all automated tests -.IP clean -Cleans out directory tree -.IP ctan -Creates CTAN-ready archive -.IP doc -Typesets all documentation files -.IP install -Installs files into the local texmf tree -.IP manifest -Creates a manifest file -.IP save -Saves test validation log -.IP tag -Updates release tags in files -.IP uninstall -Uninstalls files from the local texmf tree -.IP unpack -Unpacks the source files into the build tree -.IP upload -Sends archive to CTAN for public release +------ + +The l3build module is designed to support the development of +high-quality LaTeX code by providing: +* A unit testing system +* Automated typesetting of code sources +* A reliable packaging system for CTAN releases + +The bundle consists of a Lua script to run the tasks and a +.tex file which provides the testing environment. These were +originally developed for supporting LaTeX development but +are designed such that they can be readily used by others. Full +documentation is provided. + +.SH COMMANDS +Valid 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 + .SH OPTIONS -Various options apply -.IP --config|-c -Sets the config(s) used for running tests -.IP --date -Sets the date to insert into sources -.IP --debug -Runs target in debug mode -.IP --dirty -Skips cleaning up the test area -.IP --dry-run -Dry run for install or upload -.IP --email -Email address of CTAN uploader -.IP --engine|-e -Sets the engine(s) to use for running test -.IP --epoch -Sets the epoch for tests and typesetting -.IP --file|-F -Takes the upload announcement from the given file -.IP --first -Name of first test to run -.IP --full -Installs all files -.IP --halt-on-error|-H -Stops running tests after the first failure -.IP --help|-h -Prints help message and exits -.IP --last -Name of last test to run -.IP --message|-m -Text for upload announcement message -.IP --quiet|-q -Suppresses TeX output when unpacking -.IP --rerun -Skips setup: simply reruns tests -.IP --show-log-on-error -Shows the full log of the failure with 'halt-on-error' -.IP --show-saves|-S -Shows the invocation to update failing .tlg files -.IP --shuffle -Shuffles order of tests -.IP --stdengine|-s -Run tests with the std engine (config dependent) -.IP --texmfhome -Location of user texmf tree -.IP --version -Prints version information and exits -.SH BUGS -.SH AUTHOR -The LaTeX Project (latex-team@latex-project.org) -.PP -Please log issues on the GitHub homepage: -https://github.com/latex3/l3build/issues. -.SH SEE ALSO -See l3build.pdf for more details. +Valid options are: + --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 this 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 + +.SH "SEE ALSO" +Full manual available via 'texdoc l3build'. + +Repository : https://github.com/latex3/l3build + +Bug tracker : https://github.com/latex3/l3build/issues +.SH AUTHORS +Copyright (C) 2014-2024 The LaTeX Project |