MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
dfhack/docs/builtins/ls.rst

45 lines
1.3 KiB
ReStructuredText
Raw Normal View History Unescape Escape

move builtin docs to individual files
2022-07-18 11:58:35 -06:00
ls
reformat builtins and properly read tags
2022-07-20 00:01:25 -06:00
==
move builtin docs to individual files
2022-07-18 11:58:35 -06:00
migrate all docs to the new directives add a summary option for tools and commands so we can output them with their tags and keybindings at the top of the file.
2022-08-09 23:37:24 -06:00
.. dfhack-tool::
:summary: List available DFHack commands.
revise tag list and assignments
2022-08-12 00:34:37 -06:00
:tags: dfhack
migrate all docs to the new directives add a summary option for tools and commands so we can output them with their tags and keybindings at the top of the file.
2022-08-09 23:37:24 -06:00
enable index building and update builtin docs
2022-07-22 00:21:56 -06:00
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``.
move builtin docs to individual files
2022-07-18 11:58:35 -06:00
make Usage a proper header
2022-08-17 23:42:02 -06:00
Usage
-----
move builtin docs to individual files
2022-07-18 11:58:35 -06:00
update all docs I've done so far to new standards
2022-07-23 17:03:40 -06:00
``ls [<options>]``
spacing is important otherwise the usage and examples lists don't put the explanations on the next line
2022-07-18 12:16:05 -06:00
Lists all available commands and the tags associated with them.
update all docs I've done so far to new standards
2022-07-23 17:03:40 -06:00
``ls <tag> [<options>]``
spacing is important otherwise the usage and examples lists don't put the explanations on the next line
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.
update all docs I've done so far to new standards
2022-07-23 17:03:40 -06:00
``ls <string> [<options>]``
spacing is important otherwise the usage and examples lists don't put the explanations on the next line
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.
move builtin docs to individual files
2022-07-18 11:58:35 -06:00
reformat builtins and properly read tags
2022-07-20 00:01:25 -06:00
Examples
--------
move builtin docs to individual files
2022-07-18 11:58:35 -06:00
fix reference to old ls param in Lua API docs also add another example to the ls example commands
2022-09-11 15:06:21 -06:00
``ls quick``
List all commands that match the substring "quick".
``ls adventure``
List all commands with the ``adventure`` tag.
``ls --dev trigger``
List all commands, including developer and modding commands, that match the
substring "trigger".
update all docs I've done so far to new standards
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.
add --exclude option for ls
2022-10-05 14:30:14 -06:00
``--exclude <string>[,<string>...]``
Exclude commands that match any of the given strings.