summaryrefslogtreecommitdiff
path: root/support/l3sys-query/README.md
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2024-03-15 03:06:35 +0000
committerNorbert Preining <norbert@preining.info>2024-03-15 03:06:35 +0000
commit12679ab7d3c2a210f4123163671b532b8b55d5f9 (patch)
tree0060d13467186ad977f4e73488ee20dd6c0017ab /support/l3sys-query/README.md
parent62170822e034fdd3f81de7274835d0d3b0467100 (diff)
CTAN sync 202403150306
Diffstat (limited to 'support/l3sys-query/README.md')
-rw-r--r--support/l3sys-query/README.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/support/l3sys-query/README.md b/support/l3sys-query/README.md
new file mode 100644
index 0000000000..2091f11c8d
--- /dev/null
+++ b/support/l3sys-query/README.md
@@ -0,0 +1,36 @@
+# `l3sys-query`: System queries for LaTeX using Lua
+
+Release 2024-03-04
+
+## Overview
+
+The `l3sys-query` script provides a method for TeX runs to obtain system
+information _via_ shell escape to Lua. The facilities are more limited than the
+similar Java script `texosquery`, but since it uses Lua, `l3sys-query` can be
+used 'out of the box' with any install TeX system. The script is written taking
+account of TeX Live security requirement; it is therefore suitable for use with
+restricted shell escape, the standard setting when installing a TeX system.
+
+The supported queries are
+- `ls`: Directory listing supporting a range of options
+- `pwd`: Obtaining details of the current working directory
+
+## Issues
+
+The issue tracker for LaTeX is currently located
+[on GitHub](https://github.com/latex3/l3sys-query/issues).
+
+## Development team
+
+This code is developed by [The LaTeX Project](https://latex-project.org).
+
+## License
+
+This project licensed under the same terms as Lua (MIT): see LICENSE or the top
+of source files for the legal text.
+
+-----
+
+<p>Copyright (C) 2024 The LaTeX Project <br />
+<a href="https://latex-project.org/">https://latex-project.org/</a> <br />
+All rights reserved.</p>