MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Core.rst: add dfhack-run anchor, use more sensible example

develop
lethosor 2018-07-03 00:02:53 -04:00
parent c543a17250
commit a4384a9e98
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/Core.rst
Unescape Escape View File

@ -74,6 +74,11 @@ Note that the ``:foo`` syntax for whitespace in arguments is not compatible \
with '+ args'. with '+ args'.
.. _dfhack-run:
dfhack-run
..........
If DF and DFHack are already running, calling ``dfhack-run my command`` If DF and DFHack are already running, calling ``dfhack-run my command``
in an external terminal is equivalent to calling ``my command`` in the in an external terminal is equivalent to calling ``my command`` in the
DFHack console. Direct use of the DFhack console is generally easier, 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:: Examples::
./dfhack-run cursecheck ./dfhack-run cursecheck
dfhack-run multicmd kill-lua; die dfhack-run kill-lua
The first (\*nix) example `checks for vampires <cursecheck>`; the The first (\*nix) example `checks for vampires <cursecheck>`; 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 Built-in Commands