aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAlbert Krewinkel <albert@zeitkraut.de>2020-10-11 12:58:52 +0200
committerAlbert Krewinkel <albert@zeitkraut.de>2020-10-11 13:05:27 +0200
commit3bad78ca9623ad3e496de7c29cf1a6e8dded1026 (patch)
tree64f9bdb66102463042ca84b3ce905cfe239a398a /doc
parentce13579f8d80f90cc7bee37e46be82140423ffe7 (diff)
downloadpandoc-3bad78ca9623ad3e496de7c29cf1a6e8dded1026.tar.gz
doc/lua-filters.md: describe parameters to `pandoc.pipe`
Diffstat (limited to 'doc')
-rw-r--r--doc/lua-filters.md14
1 files changed, 13 insertions, 1 deletions
diff --git a/doc/lua-filters.md b/doc/lua-filters.md
index 8ce427a5d..175a83fe5 100644
--- a/doc/lua-filters.md
+++ b/doc/lua-filters.md
@@ -2738,9 +2738,21 @@ format, and functions to filter and modify a subtree.
Runs command with arguments, passing it some input, and returns
the output.
+Parameters:
+
+`command`
+: program to run; the executable will be resolved using default
+ system methods (string).
+
+`args`
+: list of arguments to pass to the program (list of strings).
+
+`input`
+: data which is piped into the program via stdin (string).
+
Returns:
-- Output of command.
+- Output of command, i.e. data printed to stdout (string)
Raises: