spacing is important

otherwise the usage and examples lists don't put the explanations on the
next line
develop
myk002 2022-07-18 11:16:05 -07:00
parent 019856883b
commit d27def7128
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
8 changed files with 38 additions and 39 deletions

@ -9,14 +9,14 @@ script.
Usage: Usage:
- ``alias list`` - ``alias list``
lists all configured aliases Lists all configured aliases
- ``alias add <name> <command> [arguments...]`` - ``alias add <name> <command> [arguments...]``
adds an alias Adds an alias
- ``alias replace <name> <command> [arguments...]`` - ``alias replace <name> <command> [arguments...]``
replaces an existing alias with a new command, or adds the alias if it does Replaces an existing alias with a new command, or adds the alias if it does
not already exist not already exist
- ``alias delete <name>`` - ``alias delete <name>``
removes the specified alias Removes the specified alias
Aliases can be given additional arguments when created and invoked, which will Aliases can be given additional arguments when created and invoked, which will
be passed to the underlying command in order. be passed to the underlying command in order.

@ -13,8 +13,8 @@ and disabled plugins, and shows whether that can be changed through the same
commands. Passing plugin names to these commands will enable or disable the commands. Passing plugin names to these commands will enable or disable the
specified plugins. For example, to disable the `manipulator` plugin:: specified plugins. For example, to disable the `manipulator` plugin::
disable manipulator disable manipulator
It is also possible to enable or disable multiple plugins at once:: It is also possible to enable or disable multiple plugins at once::
disable manipulator search disable manipulator search

@ -13,8 +13,8 @@ and disabled plugins, and shows whether that can be changed through the same
commands. Passing plugin names to these commands will enable or disable the commands. Passing plugin names to these commands will enable or disable the
specified plugins. For example, to enable the `manipulator` plugin:: specified plugins. For example, to enable the `manipulator` plugin::
enable manipulator enable manipulator
It is also possible to enable or disable multiple plugins at once:: It is also possible to enable or disable multiple plugins at once::
enable manipulator search enable manipulator search

@ -11,15 +11,15 @@ Hotkeys can be any combinations of Ctrl/Alt/Shift with A-Z, 0-9, F1-F12, or
Usage: Usage:
- ``keybinding`` - ``keybinding``
Show some useful information, including the current game context. Show some useful information, including the current game context.
- ``keybinding list <key>`` - ``keybinding list <key>``
List bindings active for the key combination. List bindings active for the key combination.
- ``keybinding clear <key> [<key>...]`` - ``keybinding clear <key> [<key>...]``
Remove bindings for the specified keys. Remove bindings for the specified keys.
- ``keybinding add <key> "cmdline" ["cmdline"...]`` - ``keybinding add <key> "cmdline" ["cmdline"...]``
Add bindings for the specified key. Add bindings for the specified key.
- ``keybinding set <key> "cmdline" ["cmdline"...]`` - ``keybinding set <key> "cmdline" ["cmdline"...]``
Clear, and then add bindings for the specified key. Clear, and then add bindings for the specified key.
The ``<key>`` parameter above has the following **case-sensitive** syntax:: The ``<key>`` parameter above has the following **case-sensitive** syntax::
@ -49,8 +49,7 @@ Interactive commands like `liquids` cannot be used as hotkeys.
Examples: Examples:
- ``keybinding add Alt-F1 hotkeys`` - ``keybinding add Alt-F1 hotkeys``
Bind Alt-F1 to run the `hotkeys` command on any screen at any time. Bind Alt-F1 to run the `hotkeys` command on any screen at any time.
- ``keybinding add Alt-F@dwarfmode gui/quickfort`` - ``keybinding add Alt-F@dwarfmode gui/quickfort``
Bind Alt-F to run `gui/quickfort`, but only when on a screen that shows the Bind Alt-F to run `gui/quickfort`, but only when on a screen that shows the
main map. main map.

@ -9,26 +9,26 @@ command.
Usage: Usage:
- ``ls [<options>]`` - ``ls [<options>]``
Lists all available commands and the tags associated with them. Lists all available commands and the tags associated with them.
- ``ls <tag> [<options>]`` - ``ls <tag> [<options>]``
Shows only commands that have the given tag. Use the `tags` command to see Shows only commands that have the given tag. Use the `tags` command to see
the list of available tags. the list of available tags.
- ``ls <string> [<options>]`` - ``ls <string> [<options>]``
Shows commands that include the given string. E.g. ``ls quick`` will show all Shows commands that include the given string. E.g. ``ls quick`` will show
the commands with "quick" in their names. If the string is also the name of a all the commands with "quick" in their names. If the string is also the
tag, then it will be interpreted as a tag name. name of a tag, then it will be interpreted as a tag name.
You can also pass some optional parameters to change how ``ls`` behaves: You can also pass some optional parameters to change how ``ls`` behaves:
- ``--notags`` - ``--notags``
Don't print out the tags associated with each command. Don't print out the tags associated with each command.
- ``--dev`` - ``--dev``
Include commands intended for developers and modders. Include commands intended for developers and modders.
Examples: Examples:
- ``ls adventure`` - ``ls adventure``
Lists all commands with the ``adventure`` tag. Lists all commands with the ``adventure`` tag.
- ``ls --dev trigger`` - ``ls --dev trigger``
Lists all commands, including developer and modding commands, that match the Lists all commands, including developer and modding commands, that match the
substring "trigger" substring "trigger"

@ -6,7 +6,7 @@ Lists available plugins and whether they are enabled.
Usage: Usage:
- ``plug`` - ``plug``
Lists available plugins and whether they are enabled. Lists available plugins and whether they are enabled.
- ``plug <plugin> [<plugin> ...]`` - ``plug <plugin> [<plugin> ...]``
Shows the commands implemented by the named plugins and whether the plugins Shows the commands implemented by the named plugins and whether the plugins
are enabled. are enabled.

@ -7,14 +7,14 @@ Runs commands when game state changes occur. This is similar to the static
Usage: Usage:
- ``sc-script [help]`` - ``sc-script [help]``
Show the list of valid event names. Show the list of valid event names.
- ``sc-script list [<event>]`` - ``sc-script list [<event>]``
List the currently registered files for all events or the specified event. List the currently registered files for all events or the specified event.
- ``sc-script add|remove <event> <file> [<file> ...]`` - ``sc-script add|remove <event> <file> [<file> ...]``
Register or unregister a file to be run for the specified event. Register or unregister a file to be run for the specified event.
Examples: Examples:
- ``sc-script add SC_MAP_LOADED spawn_extra_monsters.init`` - ``sc-script add SC_MAP_LOADED spawn_extra_monsters.init``
Registers the ``spawn_extra_monsters.init`` file to be run whenever a new map Registers the ``spawn_extra_monsters.init`` file to be run whenever a new
is loaded. map is loaded.

@ -15,5 +15,5 @@ Usage::
Examples: Examples:
- ``script startup.txt`` - ``script startup.txt``
Executes the commands in ``startup.txt``, which exists in your DF game Executes the commands in ``startup.txt``, which exists in your DF game
directory. directory.