From 7a4e8ea18ef0f4b2fde767c36add8f2fade839a0 Mon Sep 17 00:00:00 2001 From: myk002 Date: Fri, 29 Jul 2022 16:05:49 -0700 Subject: [PATCH] some plugins can't be directly enabled by the user --- docs/plugins/RemoteFortressReader.rst | 2 -- docs/plugins/autoclothing.rst | 9 +++++---- docs/plugins/autogems.rst | 3 ++- docs/plugins/burrows.rst | 6 +----- docs/plugins/power-meter.rst | 13 +++---------- 5 files changed, 11 insertions(+), 22 deletions(-) diff --git a/docs/plugins/RemoteFortressReader.rst b/docs/plugins/RemoteFortressReader.rst index 103c904db..f3bf505ac 100644 --- a/docs/plugins/RemoteFortressReader.rst +++ b/docs/plugins/RemoteFortressReader.rst @@ -10,8 +10,6 @@ remote fortress visualization. See :forums:`Armok Vision <146473>`. Usage: -``enable RemoteFortressReader`` - Enable the plugin. ``RemoteFortressReader_version`` Print the loaded RemoteFortressReader version. ``load-art-image-chunk `` diff --git a/docs/plugins/autoclothing.rst b/docs/plugins/autoclothing.rst index bbfe14cc9..2e0d03ec1 100644 --- a/docs/plugins/autoclothing.rst +++ b/docs/plugins/autoclothing.rst @@ -9,14 +9,15 @@ set how many of each clothing type every citizen should have. Usage:: - enable autoclothing - autoclothing [number] + autoclothing + autoclothing [quantity] ``material`` can be "cloth", "silk", "yarn", or "leather". The ``item`` can be anything your civilization can produce, such as "dress" or "mitten". -When invoked without a number, it shows the current configuration for that -material and item. +When invoked without parameters, it shows a summary of all managed clothing +orders. When invoked with a material and item, but without a quantity, it shows +the current configuration for that material and item. Examples -------- diff --git a/docs/plugins/autogems.rst b/docs/plugins/autogems.rst index 72b850754..ee1bc8be6 100644 --- a/docs/plugins/autogems.rst +++ b/docs/plugins/autogems.rst @@ -10,7 +10,8 @@ orders for cutting them at a Jeweler's Workshop. Usage: ``enable autogems`` - Enables the plugin + Enables the plugin and starts autocutting gems according to its + configuration. ``autogems-reload`` :index:`Reloads the autogems configuration file. ` You might need diff --git a/docs/plugins/burrows.rst b/docs/plugins/burrows.rst index 733f784d0..29b81330d 100644 --- a/docs/plugins/burrows.rst +++ b/docs/plugins/burrows.rst @@ -15,15 +15,11 @@ You can also use the ``burrow`` command to Usage: -``enable burrows`` - Enable the plugin for the auto-grow feature (see - ``burrow enable auto-grow`` below) ``burrow enable auto-grow`` When a wall inside a burrow with a name ending in '+' is dug out, the burrow will be extended to newly-revealed adjacent walls. This final '+' may be omitted in burrow name args of other ``burrows`` commands. Note that digging - 1-wide corridors with the miner inside the burrow is SLOW. Be sure to also - run ``enable burrows`` for this feature to work. + 1-wide corridors with the miner inside the burrow is SLOW. ``burrow disable auto-grow`` Disables auto-grow processing. ``burrow clear-unit [ ...]`` diff --git a/docs/plugins/power-meter.rst b/docs/plugins/power-meter.rst index 9443f2a93..e099a7903 100644 --- a/docs/plugins/power-meter.rst +++ b/docs/plugins/power-meter.rst @@ -2,13 +2,6 @@ power-meter =========== Tags: -Provides the backend for `gui/power-meter`. - -Usage:: - - enable power-meter - -The power-meter plugin implements a modified pressure plate that detects power being -supplied to gear boxes built in the four adjacent N/S/W/E tiles. - -The configuration front-end is implemented by `gui/power-meter`. +Allows presure plates to measure power. If you run `gui/power-meter` while +building a pressure plate, the pressure plate can be modified to detects power +being supplied to gear boxes built in the four adjacent N/S/W/E tiles.