diff --git a/docs/builtins/alias.rst b/docs/builtins/alias.rst index a9f44386a..69ca42ba0 100644 --- a/docs/builtins/alias.rst +++ b/docs/builtins/alias.rst @@ -9,7 +9,8 @@ Aliases are resolved immediately after built-in commands, which means that an alias cannot override a built-in command, but can override a command implemented by a plugin or script. -Usage: +Usage +----- ``alias list`` Lists all configured aliases diff --git a/docs/builtins/cls.rst b/docs/builtins/cls.rst index 515235a93..a5fc391cd 100644 --- a/docs/builtins/cls.rst +++ b/docs/builtins/cls.rst @@ -8,6 +8,9 @@ cls Can also be invoked as ``clear``. Note that this command does not delete command history. It just clears the text on the screen. -Usage:: +Usage +----- + +:: cls diff --git a/docs/builtins/devel/dump-rpc.rst b/docs/builtins/devel/dump-rpc.rst index 977b6e33c..957233b62 100644 --- a/docs/builtins/devel/dump-rpc.rst +++ b/docs/builtins/devel/dump-rpc.rst @@ -7,6 +7,9 @@ devel/dump-rpc Write RPC endpoint information to the specified file. -Usage:: +Usage +----- + +:: devel/dump-rpc diff --git a/docs/builtins/die.rst b/docs/builtins/die.rst index 25a34504d..3b9a08380 100644 --- a/docs/builtins/die.rst +++ b/docs/builtins/die.rst @@ -7,6 +7,9 @@ die Use to exit DF quickly and safely. -Usage:: +Usage +----- + +:: die diff --git a/docs/builtins/disable.rst b/docs/builtins/disable.rst index 73d267ccf..7c64f4b39 100644 --- a/docs/builtins/disable.rst +++ b/docs/builtins/disable.rst @@ -7,6 +7,9 @@ disable See the `enable` command for more info. -Usage:: +Usage +----- + +:: disable [ ...] diff --git a/docs/builtins/enable.rst b/docs/builtins/enable.rst index 19f98a122..7af10a9f3 100644 --- a/docs/builtins/enable.rst +++ b/docs/builtins/enable.rst @@ -16,7 +16,10 @@ 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. -Usage:: +Usage +----- + +:: enable enable [ ...] diff --git a/docs/builtins/fpause.rst b/docs/builtins/fpause.rst index 5379caec0..ed5a40cad 100644 --- a/docs/builtins/fpause.rst +++ b/docs/builtins/fpause.rst @@ -7,6 +7,9 @@ fpause This is useful when your FPS drops below 1 and you lose control of the game. -Usage:: +Usage +----- + +:: fpause diff --git a/docs/builtins/help.rst b/docs/builtins/help.rst index 95dadefd9..a744e8d69 100644 --- a/docs/builtins/help.rst +++ b/docs/builtins/help.rst @@ -7,7 +7,10 @@ help Can also be invoked as ``?`` or ``man`` (short for "manual"). -Usage:: +Usage +----- + +:: help|?|man help|?|man diff --git a/docs/builtins/hide.rst b/docs/builtins/hide.rst index b23738860..037679d69 100644 --- a/docs/builtins/hide.rst +++ b/docs/builtins/hide.rst @@ -10,6 +10,9 @@ a `keybinding` set beforehand or the in-game `command-prompt`. Only available on Windows. -Usage:: +Usage +----- + +:: hide diff --git a/docs/builtins/keybinding.rst b/docs/builtins/keybinding.rst index ae51d7a37..e7e738bc8 100644 --- a/docs/builtins/keybinding.rst +++ b/docs/builtins/keybinding.rst @@ -12,7 +12,8 @@ bindings are not remembered between runs of the game unless re-created in Hotkeys can be any combinations of Ctrl/Alt/Shift with A-Z, 0-9, F1-F12, or ``\``` (the key below the ``Esc`` key. -Usage: +Usage +----- ``keybinding`` Show some useful information, including the current game context. diff --git a/docs/builtins/kill-lua.rst b/docs/builtins/kill-lua.rst index 3334b3b2b..4cb3e203c 100644 --- a/docs/builtins/kill-lua.rst +++ b/docs/builtins/kill-lua.rst @@ -7,7 +7,10 @@ kill-lua Use this command to stop a misbehaving script that appears to be stuck. -Usage:: +Usage +----- + +:: kill-lua kill-lua force diff --git a/docs/builtins/load.rst b/docs/builtins/load.rst index 0c199ae3d..a91316262 100644 --- a/docs/builtins/load.rst +++ b/docs/builtins/load.rst @@ -7,7 +7,10 @@ load Also see `unload` and `reload` for related actions. -Usage:: +Usage +----- + +:: load [ ...] load -a|--all diff --git a/docs/builtins/ls.rst b/docs/builtins/ls.rst index 6ef09d236..6b21e4b53 100644 --- a/docs/builtins/ls.rst +++ b/docs/builtins/ls.rst @@ -9,7 +9,8 @@ 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``. -Usage: +Usage +----- ``ls []`` Lists all available commands and the tags associated with them. diff --git a/docs/builtins/plug.rst b/docs/builtins/plug.rst index a1b136306..8df378d3c 100644 --- a/docs/builtins/plug.rst +++ b/docs/builtins/plug.rst @@ -5,7 +5,10 @@ plug :summary: List available plugins and whether they are enabled. :tags: dfhack -Usage:: +Usage +----- + +:: plug [ [ ...]] diff --git a/docs/builtins/reload.rst b/docs/builtins/reload.rst index 17efffb2c..9ee9061a2 100644 --- a/docs/builtins/reload.rst +++ b/docs/builtins/reload.rst @@ -8,7 +8,10 @@ reload Developers use this command to reload a plugin that they are actively modifying. Also see `load` and `unload` for related actions. -Usage:: +Usage +----- + +:: reload [ ...] reload -a|--all diff --git a/docs/builtins/sc-script.rst b/docs/builtins/sc-script.rst index 5203f1aff..f66aeb412 100644 --- a/docs/builtins/sc-script.rst +++ b/docs/builtins/sc-script.rst @@ -8,7 +8,8 @@ sc-script This is similar to the static `init-files` but is slightly more flexible since it can be set dynamically. -Usage: +Usage +----- ``sc-script [help]`` Show the list of valid event names. diff --git a/docs/builtins/script.rst b/docs/builtins/script.rst index 0f40df5df..0c4ca8c3d 100644 --- a/docs/builtins/script.rst +++ b/docs/builtins/script.rst @@ -11,7 +11,10 @@ typed in by the user -- treating the input like `an init file `. Some other tools, such as `autobutcher` and `workflow`, export their settings as the commands to create them - which can later be reloaded with ``script``. -Usage:: +Usage +----- + +:: script diff --git a/docs/builtins/show.rst b/docs/builtins/show.rst index c59f4e519..cbfa3a386 100644 --- a/docs/builtins/show.rst +++ b/docs/builtins/show.rst @@ -11,6 +11,9 @@ it from a `keybinding` set beforehand or the in-game `command-prompt`. Only available on Windows. -Usage:: +Usage +----- + +:: show diff --git a/docs/builtins/tags.rst b/docs/builtins/tags.rst index 3823a9924..985943647 100644 --- a/docs/builtins/tags.rst +++ b/docs/builtins/tags.rst @@ -8,6 +8,9 @@ tags You can find groups of related tools by passing the tag name to the `ls` command. -Usage:: +Usage +----- + +:: tags diff --git a/docs/builtins/type.rst b/docs/builtins/type.rst index dfcb493f9..1bf86e588 100644 --- a/docs/builtins/type.rst +++ b/docs/builtins/type.rst @@ -9,6 +9,9 @@ DFHack commands can be provided by plugins, scripts, or by the core library itself. The ``type`` command can tell you which is the source of a particular command. -Usage:: +Usage +----- + +:: type diff --git a/docs/builtins/unload.rst b/docs/builtins/unload.rst index fd9e11a46..6fa52ea9e 100644 --- a/docs/builtins/unload.rst +++ b/docs/builtins/unload.rst @@ -7,7 +7,10 @@ unload Also see `load` and `reload` for related actions. -Usage:: +Usage +----- + +:: unload [ ...] unload -a|--all diff --git a/docs/plugins/3dveins.rst b/docs/plugins/3dveins.rst index b22ac81e5..f71a14343 100644 --- a/docs/plugins/3dveins.rst +++ b/docs/plugins/3dveins.rst @@ -9,7 +9,10 @@ Existing, flat veins are removed and new 3D veins that naturally span z-levels are generated in their place. The transformation preserves the mineral counts reported by `prospect`. -Usage:: +Usage +----- + +:: 3dveins [verbose] diff --git a/docs/plugins/RemoteFortressReader.rst b/docs/plugins/RemoteFortressReader.rst index 9a925d0fd..c70adc608 100644 --- a/docs/plugins/RemoteFortressReader.rst +++ b/docs/plugins/RemoteFortressReader.rst @@ -15,7 +15,8 @@ RemoteFortressReader This plugin provides an API for realtime remote fortress visualization. See :forums:`Armok Vision <146473>`. -Usage: +Usage +----- ``RemoteFortressReader_version`` Print the loaded RemoteFortressReader version. diff --git a/docs/plugins/autobutcher.rst b/docs/plugins/autobutcher.rst index 9379ae9c1..83c99271a 100644 --- a/docs/plugins/autobutcher.rst +++ b/docs/plugins/autobutcher.rst @@ -23,7 +23,8 @@ is above the target (defaults are: 1 male kid, 5 female kids, 1 male adult, reliable breeding population due to asexuality etc. See `fix-ster` if this is a problem. -Usage: +Usage +----- ``enable autobutcher`` Start processing livestock according to the configuration. Note that diff --git a/docs/plugins/autochop.rst b/docs/plugins/autochop.rst index f0f7932fd..6b51b85cb 100644 --- a/docs/plugins/autochop.rst +++ b/docs/plugins/autochop.rst @@ -8,7 +8,10 @@ autochop This plugin can designate trees for chopping when your stocks are low on logs. -Usage:: +Usage +----- + +:: enable autochop diff --git a/docs/plugins/autoclothing.rst b/docs/plugins/autoclothing.rst index ed4f2160d..40fd4d996 100644 --- a/docs/plugins/autoclothing.rst +++ b/docs/plugins/autoclothing.rst @@ -8,7 +8,10 @@ autoclothing This command allows you to set how many of each clothing type every citizen should have. -Usage:: +Usage +----- + +:: autoclothing autoclothing [quantity] diff --git a/docs/plugins/autodump.rst b/docs/plugins/autodump.rst index f9aad09d6..03e10db9c 100644 --- a/docs/plugins/autodump.rst +++ b/docs/plugins/autodump.rst @@ -27,7 +27,10 @@ come and move the item to your dump zone. The cursor must be placed on a floor tile so the items can be dumped there. -Usage:: +Usage +----- + +:: enable autodump autodump [] diff --git a/docs/plugins/autofarm.rst b/docs/plugins/autofarm.rst index 026a2ad61..8896c3117 100644 --- a/docs/plugins/autofarm.rst +++ b/docs/plugins/autofarm.rst @@ -9,7 +9,8 @@ Periodically scan your plant stocks and assign crops to your farm plots based on which plant stocks are low (as long as you have the appropriate seeds). The target threshold for each crop type is configurable. -Usage: +Usage +----- ``enable autofarm`` Enable the plugin and start managing crop assignment. diff --git a/docs/plugins/autogems.rst b/docs/plugins/autogems.rst index 9efa33499..d4112c6c0 100644 --- a/docs/plugins/autogems.rst +++ b/docs/plugins/autogems.rst @@ -12,7 +12,8 @@ autogems Automatically cut rough gems. This plugin periodically scans your stocks of rough gems and creates manager orders for cutting them at a Jeweler's Workshop. -Usage: +Usage +----- ``enable autogems`` Enables the plugin and starts autocutting gems according to its diff --git a/docs/plugins/autohauler.rst b/docs/plugins/autohauler.rst index 1a4a96c8f..a71d3ed02 100644 --- a/docs/plugins/autohauler.rst +++ b/docs/plugins/autohauler.rst @@ -22,7 +22,8 @@ Autohauler allows a skill to be used as a flag to exempt a dwarf from ``autohauler``'s effects. By default, this is the unused ALCHEMIST labor, but it can be changed by the user. -Usage: +Usage +----- ``enable autohauler`` Start managing hauling labors. This is normally all you need to do. diff --git a/docs/plugins/autolabor.rst b/docs/plugins/autolabor.rst index d2fe49e87..ed39c2666 100644 --- a/docs/plugins/autolabor.rst +++ b/docs/plugins/autolabor.rst @@ -21,7 +21,10 @@ untouched by autolabor. autolabor will override any manual changes you make to labors while it is enabled, including through other tools such as Dwarf Therapist. -Usage:: +Usage +----- + +:: enable autolabor diff --git a/docs/plugins/automaterial.rst b/docs/plugins/automaterial.rst index e18fe4b72..068664638 100644 --- a/docs/plugins/automaterial.rst +++ b/docs/plugins/automaterial.rst @@ -17,7 +17,10 @@ regardless of distance (it only does this in "grouped" mode, as individual item lists could be huge). This means you can place most constructions without having to search for your preferred material type. -Usage:: +Usage +----- + +:: enable automaterial diff --git a/docs/plugins/automelt.rst b/docs/plugins/automelt.rst index 047297d83..12e3412e2 100644 --- a/docs/plugins/automelt.rst +++ b/docs/plugins/automelt.rst @@ -10,6 +10,9 @@ When `enabled `, this plugin adds an option to the :kbd:`q` menu for stockpiles. When the ``automelt`` option is selected for the stockpile, any items placed in the stockpile will automatically be designated to be melted. -Usage:: +Usage +----- + +:: enable automelt diff --git a/docs/plugins/autonestbox.rst b/docs/plugins/autonestbox.rst index b82a1a207..9d5683f2b 100644 --- a/docs/plugins/autonestbox.rst +++ b/docs/plugins/autonestbox.rst @@ -17,7 +17,8 @@ Note that the age of the units is not checked, so you might get some egg-laying kids assigned to the nestbox zones. Most birds grow up quite fast, though, so they should be adults and laying eggs soon enough. -Usage: +Usage +----- ``enable autonestbox`` Start checking for unpastured egg-layers and assigning them to nestbox diff --git a/docs/plugins/autotrade.rst b/docs/plugins/autotrade.rst index adff6eade..f355d40ef 100644 --- a/docs/plugins/autotrade.rst +++ b/docs/plugins/autotrade.rst @@ -10,6 +10,9 @@ When `enabled `, this plugin adds an option to the :kbd:`q` menu for stockpiles. When the ``autotrade`` option is selected for the stockpile, any items placed in the stockpile will automatically be designated to be traded. -Usage:: +Usage +----- + +:: enable autotrade diff --git a/docs/plugins/blueprint.rst b/docs/plugins/blueprint.rst index 64fb3d556..9d7d7ef8d 100644 --- a/docs/plugins/blueprint.rst +++ b/docs/plugins/blueprint.rst @@ -15,7 +15,10 @@ selected interactively with the ``blueprint gui`` command or, if the GUI is not used, starts at the active cursor location and extends right and down for the requested width and height. -Usage:: +Usage +----- + +:: blueprint [] [ []] [] blueprint gui [ []] [] diff --git a/docs/plugins/buildingplan.rst b/docs/plugins/buildingplan.rst index 4e96e3349..ef159443d 100644 --- a/docs/plugins/buildingplan.rst +++ b/docs/plugins/buildingplan.rst @@ -17,7 +17,10 @@ available, and place as many as you like. Materials are used to build the planned buildings as they are produced, with minimal space dedicated to stockpiles. -Usage:: +Usage +----- + +:: enable buildingplan buildingplan set diff --git a/docs/plugins/burrows.rst b/docs/plugins/burrows.rst index 601fdb6b8..50d736b95 100644 --- a/docs/plugins/burrows.rst +++ b/docs/plugins/burrows.rst @@ -12,7 +12,8 @@ burrows When a wall inside a burrow with a name ending in ``+`` is dug out, the burrow will be extended to newly-revealed adjacent walls. -Usage: +Usage +----- ``burrow enable auto-grow`` When a wall inside a burrow with a name ending in '+' is dug out, the burrow diff --git a/docs/plugins/changeitem.rst b/docs/plugins/changeitem.rst index e49698822..f7418238a 100644 --- a/docs/plugins/changeitem.rst +++ b/docs/plugins/changeitem.rst @@ -11,7 +11,8 @@ since some transformations work pretty well and may be desired you can override this with ``force``. Note that forced changes can possibly result in items that crafters and haulers refuse to touch. -Usage: +Usage +----- ``changeitem info`` Show details about the selected item. Does not change the item. You can use diff --git a/docs/plugins/changelayer.rst b/docs/plugins/changelayer.rst index e44d6f317..f9467315f 100644 --- a/docs/plugins/changelayer.rst +++ b/docs/plugins/changelayer.rst @@ -13,7 +13,10 @@ those. tl;dr: You will end up with changing large areas in one go, especially if you use it in lower z levels. Use this command with care! -Usage:: +Usage +----- + +:: changelayer [] diff --git a/docs/plugins/changevein.rst b/docs/plugins/changevein.rst index 4811c416c..f033a4a6a 100644 --- a/docs/plugins/changevein.rst +++ b/docs/plugins/changevein.rst @@ -12,7 +12,10 @@ clusters, you will need to use this command multiple times. You can use the `probe` command to discover the material RAW ids for existing veins that you want to duplicate. -Usage:: +Usage +----- + +:: changevein diff --git a/docs/plugins/cleanconst.rst b/docs/plugins/cleanconst.rst index 9417bd539..12b1db0e5 100644 --- a/docs/plugins/cleanconst.rst +++ b/docs/plugins/cleanconst.rst @@ -10,6 +10,9 @@ component when they are disassembled, allowing their actual build items to be safely deleted. This can improve FPS when you have many constructions on the map. -Usage:: +Usage +----- + +:: cleanconst diff --git a/docs/plugins/cleaners.rst b/docs/plugins/cleaners.rst index 8cc5e20ca..14a25d62f 100644 --- a/docs/plugins/cleaners.rst +++ b/docs/plugins/cleaners.rst @@ -20,7 +20,10 @@ over the map and that clings to your items and units. In an old fortress, cleaning with this tool can significantly reduce FPS lag! It can also spoil your !!FUN!!, so think before you use it. -Usage:: +Usage +----- + +:: clean all|map|items|units|plants [] spotclean diff --git a/docs/plugins/cleanowned.rst b/docs/plugins/cleanowned.rst index 7271ce402..57094d14b 100644 --- a/docs/plugins/cleanowned.rst +++ b/docs/plugins/cleanowned.rst @@ -10,7 +10,10 @@ heavy wear and then marks those items for dumping. Now you can finally get your dwarves to give up their rotten food and tattered loincloths and go get new ones! -Usage:: +Usage +----- + +:: cleanowned [] [dryrun] diff --git a/docs/plugins/command-prompt.rst b/docs/plugins/command-prompt.rst index 802a1898e..7ccad6c71 100644 --- a/docs/plugins/command-prompt.rst +++ b/docs/plugins/command-prompt.rst @@ -5,7 +5,10 @@ command-prompt :summary: An in-game DFHack terminal where you can run other commands. :tags: dfhack -Usage:: +Usage +----- + +:: command-prompt [entry] diff --git a/docs/plugins/confirm.rst b/docs/plugins/confirm.rst index aef18c9c0..6679cf4e3 100644 --- a/docs/plugins/confirm.rst +++ b/docs/plugins/confirm.rst @@ -8,7 +8,8 @@ confirm Now you can get the chance to avoid seizing goods from traders or deleting a hauling route in case you hit the key accidentally. -Usage: +Usage +----- ``enable confirm``, ``confirm enable all`` Enable all confirmation options. Replace with ``disable`` to disable all. diff --git a/docs/plugins/createitem.rst b/docs/plugins/createitem.rst index dfd286395..b29e41521 100644 --- a/docs/plugins/createitem.rst +++ b/docs/plugins/createitem.rst @@ -21,7 +21,8 @@ reaction raws, with the following differences: Corpses, body parts, and prepared meals cannot be created using this tool. -Usage: +Usage +----- ``createitem []`` Create copies (default is 1) of the specified item made out of the diff --git a/docs/plugins/cursecheck.rst b/docs/plugins/cursecheck.rst index 6cf74106e..2d623241c 100644 --- a/docs/plugins/cursecheck.rst +++ b/docs/plugins/cursecheck.rst @@ -18,7 +18,10 @@ ignored. Undead skeletons, corpses, bodyparts and the like are all thrown into the curse category "zombie". Anonymous zombies and resurrected body parts will show as "unnamed creature". -Usage:: +Usage +----- + +:: cursecheck [] diff --git a/docs/plugins/debug.rst b/docs/plugins/debug.rst index a9e601c77..0e184595f 100644 --- a/docs/plugins/debug.rst +++ b/docs/plugins/debug.rst @@ -38,7 +38,8 @@ Persistent filters are stored in ``dfhack-config/runtime-debug.json``. Oldest filters are applied first. That means a newer filter can override the older printing level selection. -Usage: +Usage +----- ``debugfilter category [] []`` List available debug plugin and category names. If filters aren't givenm diff --git a/docs/plugins/deramp.rst b/docs/plugins/deramp.rst index 4bb96ef0a..fdc0f7619 100644 --- a/docs/plugins/deramp.rst +++ b/docs/plugins/deramp.rst @@ -7,6 +7,9 @@ deramp It also removes any "floating" down ramps that can remain after a cave-in. -Usage:: +Usage +----- + +:: deramp diff --git a/docs/plugins/dig-now.rst b/docs/plugins/dig-now.rst index 0562e000a..43ed6ce8f 100644 --- a/docs/plugins/dig-now.rst +++ b/docs/plugins/dig-now.rst @@ -18,7 +18,10 @@ Requests for engravings are also skipped since they would depend on the skill and creative choices of individual engravers. Other types of engraving (i.e. smoothing and track carving) are handled. -Usage:: +Usage +----- + +:: dig-now [ []] [] diff --git a/docs/plugins/dig.rst b/docs/plugins/dig.rst index 4d096e8b1..4384ade65 100644 --- a/docs/plugins/dig.rst +++ b/docs/plugins/dig.rst @@ -32,7 +32,8 @@ dig This plugin provides commands to make complicated dig patterns easy. -Usage: +Usage +----- ``digv [x] [-p]`` Designate all of the selected vein for digging. diff --git a/docs/plugins/digFlood.rst b/docs/plugins/digFlood.rst index 60bbc9423..57d4584a8 100644 --- a/docs/plugins/digFlood.rst +++ b/docs/plugins/digFlood.rst @@ -12,7 +12,8 @@ just-finished dig job, so if you want to autodig a vein that has already been discovered, you may need to manually designate one tile of the tile for digging to get started. -Usage: +Usage +----- ``enable digflood`` Enable the plugin. diff --git a/docs/plugins/diggingInvaders.rst b/docs/plugins/diggingInvaders.rst index bdb65b490..ace04e9fc 100644 --- a/docs/plugins/diggingInvaders.rst +++ b/docs/plugins/diggingInvaders.rst @@ -5,7 +5,8 @@ diggingInvaders :summary: Invaders dig and destroy to get to your dwarves. :tags: fort gameplay military units -Usage: +Usage +----- ``enable diggingInvaders`` Enable the plugin. diff --git a/docs/plugins/dwarfmonitor.rst b/docs/plugins/dwarfmonitor.rst index 1c499639f..bfdbd13b5 100644 --- a/docs/plugins/dwarfmonitor.rst +++ b/docs/plugins/dwarfmonitor.rst @@ -7,7 +7,8 @@ dwarfmonitor It can also show heads-up display widgets with live fort statistics. -Usage: +Usage +----- ``enable dwarfmonitor`` Enable the plugin. diff --git a/docs/plugins/dwarfvet.rst b/docs/plugins/dwarfvet.rst index fc8f84659..e7ddf73d6 100644 --- a/docs/plugins/dwarfvet.rst +++ b/docs/plugins/dwarfvet.rst @@ -12,7 +12,8 @@ enabled will come to the hospital to treat animals. Normal medical skills are used (and trained), but no experience is given to the Animal Caretaker skill itself. -Usage: +Usage +----- ``enable dwarfvet`` Enables the plugin. diff --git a/docs/plugins/embark-assistant.rst b/docs/plugins/embark-assistant.rst index 797c23c3d..c7a3f778e 100644 --- a/docs/plugins/embark-assistant.rst +++ b/docs/plugins/embark-assistant.rst @@ -14,7 +14,10 @@ tool. If you enable the plugin, you'll also be able to invoke ``embark-assistant`` with the :kbd:`A` key on the pre-embark screen. -Usage:: +Usage +----- + +:: enable embark-assistant embark-assistant diff --git a/docs/plugins/embark-tools.rst b/docs/plugins/embark-tools.rst index df480ff71..64db27953 100644 --- a/docs/plugins/embark-tools.rst +++ b/docs/plugins/embark-tools.rst @@ -5,7 +5,10 @@ embark-tools :summary: Extend the embark screen functionality. :tags: embark fort interface -Usage:: +Usage +----- + +:: enable embark-tools embark-tools enable|disable all diff --git a/docs/plugins/fastdwarf.rst b/docs/plugins/fastdwarf.rst index 7042a71a3..fb0524c3b 100644 --- a/docs/plugins/fastdwarf.rst +++ b/docs/plugins/fastdwarf.rst @@ -5,7 +5,10 @@ fastdwarf :summary: Dwarves teleport and/or finish jobs instantly. :tags: fort armok units -Usage:: +Usage +----- + +:: enable fastdwarf fastdwarf [] diff --git a/docs/plugins/filltraffic.rst b/docs/plugins/filltraffic.rst index 218532790..beb57dccd 100644 --- a/docs/plugins/filltraffic.rst +++ b/docs/plugins/filltraffic.rst @@ -17,7 +17,10 @@ filltraffic .. dfhack-command:: restrictliquids :summary: Restrict traffic on all visible tiles with liquid. -Usage:: +Usage +----- + +:: filltraffic [] alltraffic diff --git a/docs/plugins/fix-unit-occupancy.rst b/docs/plugins/fix-unit-occupancy.rst index ba75ed389..991c77314 100644 --- a/docs/plugins/fix-unit-occupancy.rst +++ b/docs/plugins/fix-unit-occupancy.rst @@ -8,7 +8,10 @@ fix-unit-occupancy If you see "unit blocking tile" messages that you can't account for (:bug:`3499`), this tool can help. -Usage:: +Usage +----- + +:: enable fix-unit-occupancy fix-unit-occupancy [here] [-n] diff --git a/docs/plugins/fixveins.rst b/docs/plugins/fixveins.rst index f8b9c4c36..616f84fae 100644 --- a/docs/plugins/fixveins.rst +++ b/docs/plugins/fixveins.rst @@ -8,6 +8,9 @@ fixveins This tool can also remove invalid references to mineral inclusions if you broke your embark with tools like `tiletypes`. -Usage:: +Usage +----- + +:: fixveins diff --git a/docs/plugins/flows.rst b/docs/plugins/flows.rst index 994057878..bbb2c6661 100644 --- a/docs/plugins/flows.rst +++ b/docs/plugins/flows.rst @@ -8,6 +8,9 @@ flows If you suspect that your magma sea leaks into HFS, you can use this tool to be sure without revealing the map. -Usage:: +Usage +----- + +:: flows diff --git a/docs/plugins/follow.rst b/docs/plugins/follow.rst index b6bc610b2..0bf1e4d0f 100644 --- a/docs/plugins/follow.rst +++ b/docs/plugins/follow.rst @@ -9,6 +9,9 @@ Once you exit from the current menu or cursor mode, the screen will stay centered on the unit. Handy for watching dwarves running around. Deactivated by moving the cursor manually. -Usage:: +Usage +----- + +:: follow diff --git a/docs/plugins/forceequip.rst b/docs/plugins/forceequip.rst index b835865e2..a32af524b 100644 --- a/docs/plugins/forceequip.rst +++ b/docs/plugins/forceequip.rst @@ -20,7 +20,10 @@ the items. Be sure to unforbid the items that you want to work with! Weapons are not currently supported. -Usage:: +Usage +----- + +:: forceequip [] diff --git a/docs/plugins/generated-creature-renamer.rst b/docs/plugins/generated-creature-renamer.rst index 6af13595a..68302dbf5 100644 --- a/docs/plugins/generated-creature-renamer.rst +++ b/docs/plugins/generated-creature-renamer.rst @@ -16,7 +16,8 @@ Now, forgotten beasts, titans, necromancer experiments, etc. will have raw token names that match the description given in-game instead of unreadable generated strings. -Usage: +Usage +----- ``enable generated-creature-renamer`` Rename generated creatures when a world is loaded. diff --git a/docs/plugins/getplants.rst b/docs/plugins/getplants.rst index 90f4203b9..05bac71c9 100644 --- a/docs/plugins/getplants.rst +++ b/docs/plugins/getplants.rst @@ -8,7 +8,8 @@ getplants Specify the types of trees to cut down and/or shrubs to gather by their plant names. -Usage: +Usage +----- ``getplants [-t|-s|-f]`` List valid tree/shrub ids, optionally restricted to the specified type. diff --git a/docs/plugins/hotkeys.rst b/docs/plugins/hotkeys.rst index 6115bc90c..6780efca1 100644 --- a/docs/plugins/hotkeys.rst +++ b/docs/plugins/hotkeys.rst @@ -8,7 +8,10 @@ hotkeys The command opens an in-game screen showing which DFHack keybindings are active in the current context. See also `hotkey-notes`. -Usage:: +Usage +----- + +:: hotkeys diff --git a/docs/plugins/infiniteSky.rst b/docs/plugins/infiniteSky.rst index 144c6c6e7..f9a68a05a 100644 --- a/docs/plugins/infiniteSky.rst +++ b/docs/plugins/infiniteSky.rst @@ -9,7 +9,8 @@ If enabled, this plugin will automatically allocate new z-levels of sky at the top of the map as you build up. Or it can allocate one or many additional levels at your command. -Usage: +Usage +----- ``enable infiniteSky`` Enables monitoring of constructions. If you build anything in the second diff --git a/docs/plugins/jobutils.rst b/docs/plugins/jobutils.rst index 46b221f89..9d083d92f 100644 --- a/docs/plugins/jobutils.rst +++ b/docs/plugins/jobutils.rst @@ -17,7 +17,8 @@ jobutils .. dfhack-command:: job-material :summary: Alters the material of the selected job. -Usage: +Usage +----- ``job`` Print details of the current job. The job can be selected in a workshop or diff --git a/docs/plugins/labormanager.rst b/docs/plugins/labormanager.rst index b168a3b7a..5c3632b6a 100644 --- a/docs/plugins/labormanager.rst +++ b/docs/plugins/labormanager.rst @@ -24,7 +24,10 @@ untouched. labors while it is enabled, including through other tools such as Dwarf Therapist. Do not run both autolabor and labormanager at the same time! -Usage:: +Usage +----- + +:: enable labormanager diff --git a/docs/plugins/lair.rst b/docs/plugins/lair.rst index f42cc0777..ed2816818 100644 --- a/docs/plugins/lair.rst +++ b/docs/plugins/lair.rst @@ -7,7 +7,8 @@ lair This avoids item scatter when the fortress is abandoned. -Usage: +Usage +----- ``lair`` Mark the map as monster lair. diff --git a/docs/plugins/liquids.rst b/docs/plugins/liquids.rst index a498364fc..5bc24d04f 100644 --- a/docs/plugins/liquids.rst +++ b/docs/plugins/liquids.rst @@ -16,7 +16,8 @@ this functionality. Also, if you only want to add or remove water or magma from a single tile, the `source` script may be easier to use. -Usage: +Usage +----- ``liquids`` Start the interactive terminal settings interpreter. This command must be diff --git a/docs/plugins/manipulator.rst b/docs/plugins/manipulator.rst index a0c8ec38e..3dc7f35b7 100644 --- a/docs/plugins/manipulator.rst +++ b/docs/plugins/manipulator.rst @@ -10,7 +10,10 @@ It is equivalent to the popular Dwarf Therapist utility. To activate, open the unit screen and press :kbd:`l`. -Usage:: +Usage +----- + +:: enable manipulator diff --git a/docs/plugins/misery.rst b/docs/plugins/misery.rst index af71ae19a..b3634d2ac 100644 --- a/docs/plugins/misery.rst +++ b/docs/plugins/misery.rst @@ -8,7 +8,8 @@ misery When enabled, negative thoughts that your dwarves have will multiply by the specified factor. -Usage: +Usage +----- ``enable misery`` Start multiplying negative thoughts. diff --git a/docs/plugins/mode.rst b/docs/plugins/mode.rst index 50cc1d0d2..33173a5d3 100644 --- a/docs/plugins/mode.rst +++ b/docs/plugins/mode.rst @@ -12,7 +12,8 @@ mode Not all combinations are good for every situation and most of them will produce undesirable results. There are a few good ones though. -Usage: +Usage +----- ``mode`` Print the current game mode. diff --git a/docs/plugins/mousequery.rst b/docs/plugins/mousequery.rst index eb6550d60..12f4092bd 100644 --- a/docs/plugins/mousequery.rst +++ b/docs/plugins/mousequery.rst @@ -9,7 +9,10 @@ Adds mouse controls to the DF interface. For example, with ``mousequery`` you can click on buildings to configure them, hold the mouse button to draw dig designations, or click and drag to move the map around. -Usage:: +Usage +----- + +:: enable mousequery mousequery [rbutton|track|edge|live] [enable|disable] diff --git a/docs/plugins/nestboxes.rst b/docs/plugins/nestboxes.rst index 9182eee09..3c07cc30c 100644 --- a/docs/plugins/nestboxes.rst +++ b/docs/plugins/nestboxes.rst @@ -10,6 +10,9 @@ This plugin will automatically scan for and forbid fertile eggs incubating in a nestbox so that dwarves won't come to collect them for eating. The eggs will hatch normally, even when forbidden. -Usage:: +Usage +----- + +:: enable nestboxes diff --git a/docs/plugins/orders.rst b/docs/plugins/orders.rst index 036e0df11..298800c96 100644 --- a/docs/plugins/orders.rst +++ b/docs/plugins/orders.rst @@ -5,7 +5,8 @@ orders :summary: Manage manager orders. :tags: fort productivity workorders -Usage: +Usage +----- ``orders orders list`` Shows the list of previously exported orders, including the orders library. diff --git a/docs/plugins/petcapRemover.rst b/docs/plugins/petcapRemover.rst index d4e1f2279..62959e731 100644 --- a/docs/plugins/petcapRemover.rst +++ b/docs/plugins/petcapRemover.rst @@ -13,7 +13,8 @@ population more stable and avoid sudden population booms as you go below the raised population cap, this plugin counts pregnancies toward the new population cap. It can still go over, but only in the case of multiple births. -Usage: +Usage +----- ``enable petcapRemover`` Enables the plugin and starts running with default settings. diff --git a/docs/plugins/plants.rst b/docs/plugins/plants.rst index cc23c84dd..f0a4f4af5 100644 --- a/docs/plugins/plants.rst +++ b/docs/plugins/plants.rst @@ -11,7 +11,8 @@ plants .. dfhack-command:: plant :summary: Create a plant or make an existing plant grow up. -Usage: +Usage +----- ``plant create `` Creates a new plant of the specified type at the active cursor position. diff --git a/docs/plugins/probe.rst b/docs/plugins/probe.rst index 7da332ba5..f9941bc48 100644 --- a/docs/plugins/probe.rst +++ b/docs/plugins/probe.rst @@ -11,7 +11,8 @@ probe .. dfhack-command:: cprobe :summary: Display low-level properties of the selected unit. -Usage: +Usage +----- ``probe`` Displays properties of the tile selected with :kbd:`k`. Some of these diff --git a/docs/plugins/prospector.rst b/docs/plugins/prospector.rst index 5764bc44e..4628d11c8 100644 --- a/docs/plugins/prospector.rst +++ b/docs/plugins/prospector.rst @@ -14,7 +14,10 @@ prospector It can also calculate an estimate of resources available in the selected embark area. -Usage:: +Usage +----- + +:: prospect [all|hell] [] diff --git a/docs/plugins/regrass.rst b/docs/plugins/regrass.rst index a4b011a1e..1a3fc7ed9 100644 --- a/docs/plugins/regrass.rst +++ b/docs/plugins/regrass.rst @@ -7,7 +7,10 @@ regrass Use this command if your grazers have eaten everything down to the dirt. -Usage:: +Usage +----- + +:: regrass [max] diff --git a/docs/plugins/rename.rst b/docs/plugins/rename.rst index c3e4d5b59..137cf56a4 100644 --- a/docs/plugins/rename.rst +++ b/docs/plugins/rename.rst @@ -7,7 +7,8 @@ rename Use `gui/rename` for an in-game interface. -Usage: +Usage +----- ``rename squad ""`` Rename the indicated squad. The ordinal is the number that corresponds to diff --git a/docs/plugins/rendermax.rst b/docs/plugins/rendermax.rst index af3dc6c0c..747b74642 100644 --- a/docs/plugins/rendermax.rst +++ b/docs/plugins/rendermax.rst @@ -8,7 +8,8 @@ rendermax This plugin provides a collection of OpenGL lighting filters that affect how the map is drawn to the screen. -Usage: +Usage +----- ``rendermax light`` Light the map tiles realisitically. Outside tiles are light during the day diff --git a/docs/plugins/resume.rst b/docs/plugins/resume.rst index b8c388738..d6e0b81cb 100644 --- a/docs/plugins/resume.rst +++ b/docs/plugins/resume.rst @@ -14,7 +14,10 @@ When run as a command, it can resume all suspended building jobs, allowing you to quickly recover if a bunch of jobs were suspended due to the workers getting scared off by wildlife or items temporarily blocking buildling sites. -Usage:: +Usage +----- + +:: enable resume resume all diff --git a/docs/plugins/reveal.rst b/docs/plugins/reveal.rst index 37497111e..19066076b 100644 --- a/docs/plugins/reveal.rst +++ b/docs/plugins/reveal.rst @@ -26,7 +26,8 @@ This reveals all z-layers in fort mode. It also works in adventure mode, but any of its effects are negated once you move. When you use it this way, you don't need to run ``unreveal`` to hide the map again. -Usage: +Usage +----- ``reveal [hell|demon]`` Reveal the whole map. If ``hell`` is specified, also reveal HFS areas, but diff --git a/docs/plugins/ruby.rst b/docs/plugins/ruby.rst index f808735d4..f1fafbb36 100644 --- a/docs/plugins/ruby.rst +++ b/docs/plugins/ruby.rst @@ -14,7 +14,10 @@ ruby .. dfhack-command:: rb_eval :summary: Eval() a ruby string. -Usage:: +Usage +----- + +:: enable ruby rb "ruby expression" diff --git a/docs/plugins/search.rst b/docs/plugins/search.rst index 937e09885..c489b4c40 100644 --- a/docs/plugins/search.rst +++ b/docs/plugins/search.rst @@ -13,7 +13,10 @@ aassignment candidates), Military (position candidates), Burrows (unit list), Rooms, Announcements, Job List, and Unit List screens all get hotkeys that allow you to dynamically filter the displayed lists. -Usage:: +Usage +----- + +:: enable search diff --git a/docs/plugins/seedwatch.rst b/docs/plugins/seedwatch.rst index 7d31c160c..c471f467d 100644 --- a/docs/plugins/seedwatch.rst +++ b/docs/plugins/seedwatch.rst @@ -14,7 +14,8 @@ The plugin needs a fortress to be loaded and will deactivate automatically otherwise. You have to reactivate with ``enable seedwatch`` after you load a fort. -Usage: +Usage +----- ``enable seedwatch`` Start managing seed and plant cooking. By default, no types are watched. diff --git a/docs/plugins/showmood.rst b/docs/plugins/showmood.rst index a14dcf225..e12770341 100644 --- a/docs/plugins/showmood.rst +++ b/docs/plugins/showmood.rst @@ -5,6 +5,9 @@ showmood :summary: Shows all items needed for the active strange mood. :tags: fort armok inspection jobs units -Usage:: +Usage +----- + +:: showmood diff --git a/docs/plugins/siege-engine.rst b/docs/plugins/siege-engine.rst index a6b3e87a8..d01fc524c 100644 --- a/docs/plugins/siege-engine.rst +++ b/docs/plugins/siege-engine.rst @@ -14,7 +14,10 @@ in four directions. To make them useful above-ground, this plugin allows you to: * load any object into a catapult, not just stones * aim at a rectangular area in any direction, and across Z-levels -Usage:: +Usage +----- + +:: enable siege-engine diff --git a/docs/plugins/sort.rst b/docs/plugins/sort.rst index c746f1c79..f5bce9bae 100644 --- a/docs/plugins/sort.rst +++ b/docs/plugins/sort.rst @@ -12,7 +12,10 @@ sort .. dfhack-command:: sort-units :summary: Sort the visible unit list. -Usage:: +Usage +----- + +:: sort-items [ ...] sort-units [ ...] diff --git a/docs/plugins/spectate.rst b/docs/plugins/spectate.rst index 96147695a..d9e9d3929 100644 --- a/docs/plugins/spectate.rst +++ b/docs/plugins/spectate.rst @@ -6,7 +6,10 @@ spectate :tags: fort interface :no-command: -Usage:: +Usage +----- + +:: enable spectate diff --git a/docs/plugins/stockflow.rst b/docs/plugins/stockflow.rst index 358305a96..9ce91eaca 100644 --- a/docs/plugins/stockflow.rst +++ b/docs/plugins/stockflow.rst @@ -22,7 +22,8 @@ number of identical orders already in the queue. This plugin is similar to `workflow`, but uses stockpiles to manage job triggers instead of abstract stock quantities. -Usage: +Usage +----- ``enable stockflow`` Enable the plugin. diff --git a/docs/plugins/stockpiles.rst b/docs/plugins/stockpiles.rst index 960675d44..e7f02f970 100644 --- a/docs/plugins/stockpiles.rst +++ b/docs/plugins/stockpiles.rst @@ -21,7 +21,8 @@ When the plugin is enabled, the :kbd:`q` menu of each stockpile will have an option for saving or loading the stockpile settings. See `gui/stockpiles` for an in-game interface. -Usage: +Usage +----- ``enable stockpiles`` Add a hotkey that you can hit to easily save and load settings from diff --git a/docs/plugins/stocks.rst b/docs/plugins/stocks.rst index 144ba2287..d8fae9579 100644 --- a/docs/plugins/stocks.rst +++ b/docs/plugins/stocks.rst @@ -12,7 +12,10 @@ When the plugin is enabled, two new hotkeys become available: * :kbd:`i` when a stockpile is selected in :kbd:`q` mode will launch the stockpile inventory management screen. -Usage:: +Usage +----- + +:: enable stocks stocks show diff --git a/docs/plugins/stonesense.rst b/docs/plugins/stonesense.rst index bd3d438f2..23c20ef0a 100644 --- a/docs/plugins/stonesense.rst +++ b/docs/plugins/stonesense.rst @@ -8,7 +8,8 @@ stonesense .. dfhack-command:: ssense :summary: An alias for stonesense. -Usage: +Usage +----- ``stonesense`` or ``ssense`` Open the visualiser in a new window. diff --git a/docs/plugins/strangemood.rst b/docs/plugins/strangemood.rst index 8d1fc8081..7aabda93d 100644 --- a/docs/plugins/strangemood.rst +++ b/docs/plugins/strangemood.rst @@ -5,7 +5,10 @@ strangemood :summary: Trigger a strange mood. :tags: fort armok units -Usage:: +Usage +----- + +:: stangemood [] diff --git a/docs/plugins/tailor.rst b/docs/plugins/tailor.rst index 646e73f91..af7d253b2 100644 --- a/docs/plugins/tailor.rst +++ b/docs/plugins/tailor.rst @@ -16,7 +16,10 @@ raw materials that you have on hand in the fort. For example, if you have lots of silk, but no cloth, then ``tailor`` will order only silk clothing to be made. -Usage:: +Usage +----- + +:: enable tailor tailor status diff --git a/docs/plugins/tiletypes.rst b/docs/plugins/tiletypes.rst index ee3d4a02f..44fba00df 100644 --- a/docs/plugins/tiletypes.rst +++ b/docs/plugins/tiletypes.rst @@ -30,7 +30,8 @@ Both paint and filter can have many different properties, like general shape materials (MICROCLINE, MARBLE, etc.), state of 'designated', 'hidden', and 'light' flags, and many others. -Usage: +Usage +----- ``tiletypes`` Start the interactive terminal prompt where you can iteratively modify diff --git a/docs/plugins/title-folder.rst b/docs/plugins/title-folder.rst index ca349a0ed..a6c7ee63c 100644 --- a/docs/plugins/title-folder.rst +++ b/docs/plugins/title-folder.rst @@ -6,6 +6,9 @@ title-folder :tags: interface :no-command: -Usage:: +Usage +----- + +:: enable title-folder diff --git a/docs/plugins/title-version.rst b/docs/plugins/title-version.rst index 239b08bc2..307a4da18 100644 --- a/docs/plugins/title-version.rst +++ b/docs/plugins/title-version.rst @@ -6,6 +6,9 @@ title-version :tags: interface :no-command: -Usage:: +Usage +----- + +:: enable title-version diff --git a/docs/plugins/trackstop.rst b/docs/plugins/trackstop.rst index 1c638dfd7..3ca47f465 100644 --- a/docs/plugins/trackstop.rst +++ b/docs/plugins/trackstop.rst @@ -11,6 +11,9 @@ completely blank in vanilla DF. This allows you to view and/or change the track stop's friction and dump direction settings, using the keybindings from the track stop building interface. -Usage:: +Usage +----- + +:: enable trackstop diff --git a/docs/plugins/tubefill.rst b/docs/plugins/tubefill.rst index 865e4341d..1085897c8 100644 --- a/docs/plugins/tubefill.rst +++ b/docs/plugins/tubefill.rst @@ -7,7 +7,10 @@ tubefill Veins that were originally hollow will be left alone. -Usage:: +Usage +----- + +:: tubefill [hollow] diff --git a/docs/plugins/tweak.rst b/docs/plugins/tweak.rst index 0bc156960..bb125fc0d 100644 --- a/docs/plugins/tweak.rst +++ b/docs/plugins/tweak.rst @@ -5,7 +5,10 @@ tweak :summary: A collection of tweaks and bugfixes. :tags: adventure fort armok bugfix fps interface -Usage:: +Usage +----- + +:: tweak [disable] diff --git a/docs/plugins/workNow.rst b/docs/plugins/workNow.rst index 27709c166..55004bca2 100644 --- a/docs/plugins/workNow.rst +++ b/docs/plugins/workNow.rst @@ -9,7 +9,8 @@ After finishing a job, dwarves will wander away for a while before picking up a new job. This plugin will automatically poke the game to assign dwarves to new tasks. -Usage: +Usage +----- ``workNow`` Print current plugin status. diff --git a/docs/plugins/workflow.rst b/docs/plugins/workflow.rst index db615c876..6bf89008b 100644 --- a/docs/plugins/workflow.rst +++ b/docs/plugins/workflow.rst @@ -29,7 +29,8 @@ configure all the vanilla manager options. Also see the `orders` plugin for a library of manager orders that may make managing your stocks even more convenient than ``workflow`` can. -Usage: +Usage +----- ``enable workflow`` Start monitoring for and managing workshop jobs that are set to repeat. diff --git a/docs/plugins/zone.rst b/docs/plugins/zone.rst index bf9428a6c..93b244399 100644 --- a/docs/plugins/zone.rst +++ b/docs/plugins/zone.rst @@ -5,7 +5,8 @@ zone :summary: Manage activity zones, cages, and the animals therein. :tags: fort productivity animals buildings -Usage: +Usage +----- ``enable zone`` Add helpful filters to the pen/pasture sidebar menu (e.g. show only caged