2022-07-18 11:58:35 -06:00
|
|
|
help
|
2022-07-20 00:01:25 -06:00
|
|
|
====
|
2022-07-18 11:58:35 -06:00
|
|
|
|
2022-08-09 23:37:24 -06:00
|
|
|
.. dfhack-tool::
|
|
|
|
|
:summary: Display help about a command or plugin.
|
2022-08-12 00:34:37 -06:00
|
|
|
:tags: dfhack
|
2022-08-09 23:37:24 -06:00
|
|
|
|
|
|
|
|
Can also be invoked as ``?`` or ``man`` (short for "manual").
|
2022-07-18 11:58:35 -06:00
|
|
|
|
2022-08-17 23:42:02 -06:00
|
|
|
Usage
|
|
|
|
|
-----
|
|
|
|
|
|
|
|
|
|
::
|
2022-07-18 11:58:35 -06:00
|
|
|
|
|
|
|
|
help|?|man
|
|
|
|
|
help|?|man <command or plugin>
|
|
|
|
|
|
2022-07-20 00:01:25 -06:00
|
|
|
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
|
2022-07-20 00:01:25 -06:00
|
|
|
for the same effect -- e.g. ``blueprint help``.
|
