dfhack/docs/builtins/help.rst

28 lines
531 B
ReStructuredText

2022-07-18 11:58:35 -06:00
help
====
Tags: system
:dfhack-keybind:`help`
2022-07-18 11:58:35 -06:00
:index:`Display help about a command or plugin.
<help; Display help about a command or plugin.>` Can also be invoked as ``?``
or ``man`` (short for "manual").
2022-07-18 11:58:35 -06:00
Usage::
help|?|man
help|?|man <command or plugin>
Examples
--------
::
2022-07-18 11:58:35 -06:00
help blueprint
man blueprint
Both examples above will display the help text for the `blueprint` command.
Some commands also take ``help`` or ``?`` as an option on their command line
for the same effect -- e.g. ``blueprint help``.