1l3build(1)                  General Commands Manual                 l3build(1)
2
3
4

NAME

6       l3build - Checking and building packages
7

SYNOPSIS

9       l3build <command> [<options>] [<names>]
10

DESCRIPTION

12       The l3build system is a Lua script for building TeX packages, with par‐
13       ticular emphasis on regression testing. It is written in cross-platform
14       Lua code, so can be used by any modern TeX distribution with the texlua
15       interpreter. A package for building with l3build can be written in  any
16       TeX  dialect; its defaults are set up for LaTeX packages written in the
17       DocStrip style.
18
19       The most commonly used l3build commands are:
20
21       check  Run all automated tests
22
23       clean  Clean out directory tree
24
25       doc    Typesets all documentation files
26
27       install
28              Installs files into the local texmf tree
29
30       save   Saves test validation log
31
32       tag    Update release tags in files
33
34       uninstall
35              Uninstalls files from the local texmf tree
36
37       unpack Unpacks the source files into the build tree
38

OPTIONS

40       Various options apply
41
42       --config|-c
43              Sets the config(s) used for running tests
44
45       --date Sets the date to insert into sources
46
47       --dry-run
48              Dry run for install
49
50       --engine|-e
51              Sets the engine(s) to use for running test
52
53       --epoch
54              Sets the epoch for tests and typesetting
55
56       --first
57              Name of first test to run
58
59       --force|-f
60              Force tests to run if engine is not set up
61
62       --halt-on-error|-H
63              Stops running tests after the first failure
64
65       --last Name of last test to run
66
67       --pdf|-p
68              Check/save PDF files
69
70       --quiet|-q
71              Suppresses TeX output when unpacking
72
73       --rerun
74              Skip setup: simply rerun tests
75
76       --shuffle
77              Shuffle order of tests
78
79       --texmfhome
80              Location of user texmf tree
81

BUGS

AUTHOR
84       The LaTeX Project (latex-team@latex-project.org)
85
86       Please  log  issues  on  the  GitHub  homepage:  https://github.com/la‐
87       tex3/l3build/issues.
88

SEE ALSO
90       See l3build.pdf for more details.
91
92
93
94                                  2023-03-08                        l3build(1)



        

    


            
        

        

            Impressum