summaryrefslogtreecommitdiff
path: root/support/texlab/docs/custom_commands.md
diff options
context:
space:
mode:
Diffstat (limited to 'support/texlab/docs/custom_commands.md')
-rw-r--r--support/texlab/docs/custom_commands.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/support/texlab/docs/custom_commands.md b/support/texlab/docs/custom_commands.md
new file mode 100644
index 0000000000..2b85787f35
--- /dev/null
+++ b/support/texlab/docs/custom_commands.md
@@ -0,0 +1,21 @@
+# Custom Commands
+
+The server provides the following commands through the `workspace/executeCommand` request:
+
+## texlab.cleanAuxiliary
+
+Removes the auxiliary files produced by compiling the specified LaTeX document.
+At the moment, this command simply calls `latexmk -c` with the currently configured output directory.
+
+Parameters:
+
+- `document`: `TextDocumentIdentifier` (_Required_)
+
+## texlab.cleanArtifacts
+
+Removes the auxiliary files and the artifacts produced by compiling the specified LaTeX document.
+At the moment, this command simply calls `latexmk -C` with the currently configured output directory.
+
+Parameters:
+
+- `document`: `TextDocumentIdentifier` (_Required_)