summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/scripts/l3build/l3build-help.lua
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2018-03-08 23:45:11 +0000
committerKarl Berry <karl@freefriends.org>2018-03-08 23:45:11 +0000
commit64ee185d962cd13195e329ab4ac8a9da6535b677 (patch)
tree652f96f04e1826a75ef1c3a38ab3d2a72ff9c067 /Master/texmf-dist/scripts/l3build/l3build-help.lua
parenta502f321bf373ab83e239389e55d622e6c6980e2 (diff)
l3build now cmdline script (9mar18)
git-svn-id: svn://tug.org/texlive/trunk@46894 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/scripts/l3build/l3build-help.lua')
-rw-r--r--Master/texmf-dist/scripts/l3build/l3build-help.lua79
1 files changed, 79 insertions, 0 deletions
diff --git a/Master/texmf-dist/scripts/l3build/l3build-help.lua b/Master/texmf-dist/scripts/l3build/l3build-help.lua
new file mode 100644
index 00000000000..770022f254d
--- /dev/null
+++ b/Master/texmf-dist/scripts/l3build/l3build-help.lua
@@ -0,0 +1,79 @@
+--[[
+
+File l3build-help.lua Copyright (C) 2018 The LaTeX3 Project
+
+It may be distributed and/or modified under the conditions of the
+LaTeX Project Public License (LPPL), either version 1.3c of this
+license or (at your option) any later version. The latest version
+of this license is in the file
+
+ http://www.latex-project.org/lppl.txt
+
+This file is part of the "l3build bundle" (The Work in LPPL)
+and all files in that bundle must be distributed together.
+
+-----------------------------------------------------------------------
+
+The development version of the bundle can be found at
+
+ https://github.com/latex3/l3build
+
+for those people who are interested.
+
+--]]
+
+function version()
+ print(
+ "\n" ..
+ "l3build: A testing and building system for LaTeX\n\n" ..
+ "Release " .. release_date
+ )
+end
+
+function help()
+ print("usage: " .. arg[0] .. " <command> [<options>] [<names>]")
+ print("")
+ print("The most commonly used l3build commands are:")
+ if testfiledir ~= "" then
+ print(" check Run all automated tests")
+ end
+ print(" clean Clean out directory tree")
+ if module == "" or bundle == "" then
+ print(" ctan Create CTAN-ready archive")
+ end
+ print(" doc Typesets all documentation files")
+ print(" install Installs files into the local texmf tree")
+ if module ~= "" and testfiledir ~= "" then
+ print(" save Saves test validation log")
+ end
+ print(" tag Update release tags in files")
+ print(" uninstall Uninstalls files from the local texmf tree")
+ print(" unpack Unpacks the source files into the build tree")
+ print("")
+ print("Valid options are:")
+ local longest = 0
+ for k,v in pairs(option_list) do
+ if k:len() > longest then
+ longest = k:len()
+ end
+ end
+ -- Sort the options
+ local t = { }
+ for k,_ in pairs(option_list) do
+ table.insert(t, k)
+ end
+ table.sort(t)
+ for _,k in ipairs(t) do
+ local opt = option_list[k]
+ local filler = string.rep(" ", longest - k:len() + 1)
+ if opt["desc"] then -- Skip --help as it has no desc
+ if opt["short"] then
+ print(" --" .. k .. "|-" .. opt["short"] .. filler .. opt["desc"])
+ else
+ print(" --" .. k .. " " .. filler .. opt["desc"])
+ end
+ end
+ end
+ print("")
+ print("See l3build.pdf for further details.")
+end