2022-07-18 11:58:35 -06:00
|
|
|
ls
|
2022-07-20 00:01:25 -06:00
|
|
|
==
|
sync tags spreadsheet to git
spreadsheet - https://docs.google.com/spreadsheets/d/1hiDlo8M_bB_1jE-5HRs2RrrA_VZ4cRu9VXaTctX_nwk/edit#gid=170388995
sync command - for fname in *rst; do name=$(echo $fname | sed 's/[.]rst//'); tagline=$(egrep ",$name," ~/Downloads/DFHack\ taxonomy\ -\ Tool\ tags.csv | ~/Downloads/csvtotags.sh); sed -ri "s;[*]*Tags:.*;$tagline;" $fname; done
contents of csvtotags.sh -
fgrep . | sed -r 's/^[^,]+,([^,]+),[^.]+[.]"?,/\1,/' | awk -F, '
function tag(idx, tagname) {
if ($idx == "TRUE") {
if (hastag == 1) {printf(", ")}
printf("`tag/%s`", tagname)
hastag = 1
}
}
{
printf("%s", "**Tags:** ")
hastag = 0
tag(2, "adventure")
tag(3, "fort")
tag(4, "legends")
tag(5, "embark")
tag(6, "system")
tag(7, "dev")
tag(8, "auto")
tag(9, "productivity")
tag(10, "inspection")
tag(11, "design")
tag(12, "quickfort")
tag(13, "interface")
tag(14, "fps")
tag(15, "fix")
tag(16, "mod")
tag(17, "armok")
tag(18, "animals")
tag(19, "buildings")
tag(20, "items")
tag(21, "jobs")
tag(22, "map")
tag(23, "labors")
tag(24, "units")
tag(25, "stockpiles")
tag(26, "trees")
printf("\n")
}
'
2022-08-05 18:55:33 -06:00
|
|
|
**Tags:** `tag/system`
|
2022-07-20 00:01:25 -06:00
|
|
|
:dfhack-keybind:`ls`
|
2022-07-18 11:58:35 -06:00
|
|
|
|
2022-07-22 00:21:56 -06:00
|
|
|
:index:`List available DFHack commands. <ls; List available DFHack commands.>`
|
|
|
|
In order to group related commands, each command is associated with a list of
|
|
|
|
tags. You can filter the listed commands by a tag or a substring of the
|
|
|
|
command name. Can also be invoked as ``dir``.
|
2022-07-18 11:58:35 -06:00
|
|
|
|
|
|
|
Usage:
|
|
|
|
|
2022-07-23 17:03:40 -06:00
|
|
|
``ls [<options>]``
|
2022-07-18 12:16:05 -06:00
|
|
|
Lists all available commands and the tags associated with them.
|
2022-07-23 17:03:40 -06:00
|
|
|
``ls <tag> [<options>]``
|
2022-07-18 12:16:05 -06:00
|
|
|
Shows only commands that have the given tag. Use the `tags` command to see
|
|
|
|
the list of available tags.
|
2022-07-23 17:03:40 -06:00
|
|
|
``ls <string> [<options>]``
|
2022-07-18 12:16:05 -06:00
|
|
|
Shows commands that include the given string. E.g. ``ls quick`` will show
|
|
|
|
all the commands with "quick" in their names. If the string is also the
|
|
|
|
name of a tag, then it will be interpreted as a tag name.
|
2022-07-18 11:58:35 -06:00
|
|
|
|
2022-07-20 00:01:25 -06:00
|
|
|
Examples
|
|
|
|
--------
|
2022-07-18 11:58:35 -06:00
|
|
|
|
|
|
|
- ``ls adventure``
|
2022-07-18 12:16:05 -06:00
|
|
|
Lists all commands with the ``adventure`` tag.
|
2022-07-18 11:58:35 -06:00
|
|
|
- ``ls --dev trigger``
|
2022-07-18 12:16:05 -06:00
|
|
|
Lists all commands, including developer and modding commands, that match the
|
|
|
|
substring "trigger"
|
2022-07-23 17:03:40 -06:00
|
|
|
|
|
|
|
Options
|
|
|
|
-------
|
|
|
|
|
|
|
|
``--notags``
|
|
|
|
Don't print out the tags associated with each command.
|
|
|
|
``--dev``
|
|
|
|
Include commands intended for developers and modders.
|