From d27def7128f598a933edbbdf5342e44486414632 Mon Sep 17 00:00:00 2001 From: myk002 Date: Mon, 18 Jul 2022 11:16:05 -0700 Subject: [PATCH] spacing is important otherwise the usage and examples lists don't put the explanations on the next line --- docs/builtins/alias.rst | 10 +++++----- docs/builtins/disable.rst | 4 ++-- docs/builtins/enable.rst | 4 ++-- docs/builtins/keybinding.rst | 17 ++++++++--------- docs/builtins/ls.rst | 22 +++++++++++----------- docs/builtins/plug.rst | 6 +++--- docs/builtins/sc-script.rst | 10 +++++----- docs/builtins/script.rst | 4 ++-- 8 files changed, 38 insertions(+), 39 deletions(-) diff --git a/docs/builtins/alias.rst b/docs/builtins/alias.rst index 8ca1f014c..034d0f33a 100644 --- a/docs/builtins/alias.rst +++ b/docs/builtins/alias.rst @@ -9,14 +9,14 @@ script. Usage: - ``alias list`` - lists all configured aliases + Lists all configured aliases - ``alias add [arguments...]`` - adds an alias + Adds an alias - ``alias replace [arguments...]`` - replaces an existing alias with a new command, or adds the alias if it does - not already exist + Replaces an existing alias with a new command, or adds the alias if it does + not already exist - ``alias delete `` - removes the specified alias + Removes the specified alias Aliases can be given additional arguments when created and invoked, which will be passed to the underlying command in order. diff --git a/docs/builtins/disable.rst b/docs/builtins/disable.rst index 11077c883..d871ff06e 100644 --- a/docs/builtins/disable.rst +++ b/docs/builtins/disable.rst @@ -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 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:: - disable manipulator search + disable manipulator search diff --git a/docs/builtins/enable.rst b/docs/builtins/enable.rst index eef76c45d..8338cc7f4 100644 --- a/docs/builtins/enable.rst +++ b/docs/builtins/enable.rst @@ -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 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:: - enable manipulator search + enable manipulator search diff --git a/docs/builtins/keybinding.rst b/docs/builtins/keybinding.rst index bce450e46..7ab92c206 100644 --- a/docs/builtins/keybinding.rst +++ b/docs/builtins/keybinding.rst @@ -11,15 +11,15 @@ Hotkeys can be any combinations of Ctrl/Alt/Shift with A-Z, 0-9, F1-F12, or Usage: - ``keybinding`` - Show some useful information, including the current game context. + Show some useful information, including the current game context. - ``keybinding list `` - List bindings active for the key combination. + List bindings active for the key combination. - ``keybinding clear [...]`` - Remove bindings for the specified keys. + Remove bindings for the specified keys. - ``keybinding add "cmdline" ["cmdline"...]`` - Add bindings for the specified key. + Add bindings for the specified key. - ``keybinding set "cmdline" ["cmdline"...]`` - Clear, and then add bindings for the specified key. + Clear, and then add bindings for the specified key. The ```` parameter above has the following **case-sensitive** syntax:: @@ -49,8 +49,7 @@ Interactive commands like `liquids` cannot be used as hotkeys. Examples: - ``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`` - Bind Alt-F to run `gui/quickfort`, but only when on a screen that shows the - main map. - + Bind Alt-F to run `gui/quickfort`, but only when on a screen that shows the + main map. diff --git a/docs/builtins/ls.rst b/docs/builtins/ls.rst index 5eaa9dc01..fd2e532ed 100644 --- a/docs/builtins/ls.rst +++ b/docs/builtins/ls.rst @@ -9,26 +9,26 @@ command. Usage: - ``ls []`` - Lists all available commands and the tags associated with them. + Lists all available commands and the tags associated with them. - ``ls []`` - Shows only commands that have the given tag. Use the `tags` command to see - the list of available tags. + Shows only commands that have the given tag. Use the `tags` command to see + the list of available tags. - ``ls []`` - 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. + 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. You can also pass some optional parameters to change how ``ls`` behaves: - ``--notags`` - Don't print out the tags associated with each command. + Don't print out the tags associated with each command. - ``--dev`` - Include commands intended for developers and modders. + Include commands intended for developers and modders. Examples: - ``ls adventure`` - Lists all commands with the ``adventure`` tag. + Lists all commands with the ``adventure`` tag. - ``ls --dev trigger`` - Lists all commands, including developer and modding commands, that match the - substring "trigger" + Lists all commands, including developer and modding commands, that match the + substring "trigger" diff --git a/docs/builtins/plug.rst b/docs/builtins/plug.rst index da0adb657..93bd452a7 100644 --- a/docs/builtins/plug.rst +++ b/docs/builtins/plug.rst @@ -6,7 +6,7 @@ Lists available plugins and whether they are enabled. Usage: - ``plug`` - Lists available plugins and whether they are enabled. + Lists available plugins and whether they are enabled. - ``plug [ ...]`` - Shows the commands implemented by the named plugins and whether the plugins - are enabled. + Shows the commands implemented by the named plugins and whether the plugins + are enabled. diff --git a/docs/builtins/sc-script.rst b/docs/builtins/sc-script.rst index 4c99f3225..20a0e9497 100644 --- a/docs/builtins/sc-script.rst +++ b/docs/builtins/sc-script.rst @@ -7,14 +7,14 @@ Runs commands when game state changes occur. This is similar to the static Usage: - ``sc-script [help]`` - Show the list of valid event names. + Show the list of valid event names. - ``sc-script list []`` - 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 [ ...]`` - 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: - ``sc-script add SC_MAP_LOADED spawn_extra_monsters.init`` - Registers the ``spawn_extra_monsters.init`` file to be run whenever a new map - is loaded. + Registers the ``spawn_extra_monsters.init`` file to be run whenever a new + map is loaded. diff --git a/docs/builtins/script.rst b/docs/builtins/script.rst index ae2b9f0f4..ae4017ca7 100644 --- a/docs/builtins/script.rst +++ b/docs/builtins/script.rst @@ -15,5 +15,5 @@ Usage:: Examples: - ``script startup.txt`` - Executes the commands in ``startup.txt``, which exists in your DF game - directory. + Executes the commands in ``startup.txt``, which exists in your DF game + directory.