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.

@ -53,4 +53,3 @@ Examples:
- ``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.

@ -14,9 +14,9 @@ Usage:
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:

@ -16,5 +16,5 @@ Usage:
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.