From a4384a9e98f092ad6acf5df4578890567f3b2d8b Mon Sep 17 00:00:00 2001 From: lethosor Date: Tue, 3 Jul 2018 00:02:53 -0400 Subject: [PATCH] Core.rst: add dfhack-run anchor, use more sensible example --- docs/Core.rst | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/Core.rst b/docs/Core.rst index b15305fa9..4e65f4dda 100644 --- a/docs/Core.rst +++ b/docs/Core.rst @@ -74,6 +74,11 @@ Note that the ``:foo`` syntax for whitespace in arguments is not compatible \ with '+ args'. +.. _dfhack-run: + +dfhack-run +.......... + If DF and DFHack are already running, calling ``dfhack-run my command`` in an external terminal is equivalent to calling ``my command`` in the DFHack console. Direct use of the DFhack console is generally easier, @@ -90,10 +95,10 @@ but ``dfhack-run`` can be useful in a variety of circumstances: Examples:: ./dfhack-run cursecheck - dfhack-run multicmd kill-lua; die + dfhack-run kill-lua The first (\*nix) example `checks for vampires `; the -second (Windows) example uses `kill-lua` to cancel a script and exits. +second (Windows) example uses `kill-lua` to stop a Lua script. Built-in Commands