summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/l3experimental/l3sys-shell.dtx
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2021-05-28 03:01:17 +0000
committerNorbert Preining <norbert@preining.info>2021-05-28 03:01:17 +0000
commitfd03eb3aab9edb9b15484a1130509cebe187d8bd (patch)
tree9e07ef2b8a29d7aaf170e72d934d3e9ecee6452c /macros/latex/contrib/l3experimental/l3sys-shell.dtx
parent5f1cfa686748068fedb95d8dafda3dc7f999c948 (diff)
CTAN sync 202105280301
Diffstat (limited to 'macros/latex/contrib/l3experimental/l3sys-shell.dtx')
-rw-r--r--macros/latex/contrib/l3experimental/l3sys-shell.dtx20
1 files changed, 18 insertions, 2 deletions
diff --git a/macros/latex/contrib/l3experimental/l3sys-shell.dtx b/macros/latex/contrib/l3experimental/l3sys-shell.dtx
index 9a7920fe3f..cf3e3f1405 100644
--- a/macros/latex/contrib/l3experimental/l3sys-shell.dtx
+++ b/macros/latex/contrib/l3experimental/l3sys-shell.dtx
@@ -46,12 +46,28 @@
% }^^A
% }
%
-% \date{Released 2021-02-18}
+% \date{Released 2021-05-27}
%
% \maketitle
%
% \begin{documentation}
%
+% This module provides platform-neutral interfaces to system shell commands.
+% These functions can only access the shell if a document is proceeded using
+% \texttt{--shell-escape}, which allows \emph{unrestricted} access to command
+% line functions.
+%
+% In general, arbitrary documents should \emph{not} be processed in this way,
+% as shell escape could either accidentally or deliberately lead to unexpected
+% side-effects. In that sense, they should be treated like any other arbitrary
+% script: with caution. No attempt is made by the functions here to avoid
+% injection of additional commands into the arguments.
+%
+% With the above security caveats in mind, these functions are provided for
+% authors where a workflow scripting \emph{within} a \LaTeX{} document is
+% preferable to using an external script. The latter would of course also have
+% the ability to run arbitrary code.
+%
% \begin{function}[added = 2018-07-28]{\sys_shell_cp:nn}
% \begin{syntax}
% \cs{sys_shell_cp:nn} \Arg{source} \Arg{dest}
@@ -135,7 +151,7 @@
% \end{macrocode}
%
% \begin{macrocode}
-\ProvidesExplPackage{l3sys-shell}{2021-02-18}{}
+\ProvidesExplPackage{l3sys-shell}{2021-05-27}{}
{L3 Experimental system shell functions}
% \end{macrocode}
%