diff --git a/docs/Core.rst b/docs/Core.rst index 196b12918..c5d5670af 100644 --- a/docs/Core.rst +++ b/docs/Core.rst @@ -82,7 +82,7 @@ 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, +DFHack console. Direct use of the DFHack console is generally easier, but ``dfhack-run`` can be useful in a variety of circumstances: - if the console is unavailable @@ -101,6 +101,14 @@ Examples:: The first (\*nix) example `checks for vampires `; the second (Windows) example uses `kill-lua` to stop a Lua script. +.. note:: + + ``dfhack-run`` attempts to connect to a server on TCP port 5000. If DFHack + was unable to start this server, ``dfhack-run`` will not be able to connect. + This could happen if you have other software listening on port 5000, or if + you have multiple copies of DF running simultaneously. To assign a different + port, see `remote-server-config`. + Built-in Commands ================= diff --git a/docs/Remote.rst b/docs/Remote.rst index 5fa556ef2..24426c819 100644 --- a/docs/Remote.rst +++ b/docs/Remote.rst @@ -16,6 +16,8 @@ available are not comprehensive, but can be extended with plugins. :local: +.. _remote-server-config: + Server configuration ====================