From dc3c4dc9bdc8a6aa9408cb85039f7781659de7fd Mon Sep 17 00:00:00 2001 From: Lucas Schwiderski Date: Mon, 5 Feb 2024 16:08:08 +0100 Subject: [PATCH] Update CLI Reference --- CLI-Reference.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/CLI-Reference.md b/CLI-Reference.md index 7a0ff9c..93881ec 100644 --- a/CLI-Reference.md +++ b/CLI-Reference.md @@ -98,6 +98,16 @@ Therefore, the content of all of the game's bundles can be listed at once, using dtmt bundle list "\bundle" ``` +#### Specifying command line tools + +Certain operations, such as decompiling Lua, require external command line tools. By default, dtmt will attempt to use a binary named like the corresponding flag (e.g. for `--ljd`, the binary name is `ljd`) and expects that to be made available via PATH. + +Alternatively, the flag can be used to point to a different executable. It accepts any of the following forms: + +* A single file name: A binary with that name must be available via PATH +* A relative or absolute path to a file: Use the binary as-is + * Special case: If the file is named `main.py`, a binary called `python` is expected to be available via PATH +* A command string: A single string with executable and arguments separated by whitespace. See [shlex](https://docs.rs/shlex/latest/shlex/index.html) for information on parsing and compatibility. #### Bundle Decompress