diff --git a/docs/plugins/cleanowned.rst b/docs/plugins/cleanowned.rst index 7f80e35cf..27e4806a2 100644 --- a/docs/plugins/cleanowned.rst +++ b/docs/plugins/cleanowned.rst @@ -1,19 +1,37 @@ cleanowned ========== -Confiscates items owned by dwarfs. By default, owned food on the floor -and rotten items are confistacted and dumped. -Options: +Tags: +:dfhack-keybind: -:all: confiscate all owned items -:scattered: confiscated and dump all items scattered on the floor -:x: confiscate/dump items with wear level 'x' and more -:X: confiscate/dump items with wear level 'X' and more -:dryrun: a dry run. combine with other options to see what will happen - without it actually happening. +Confiscates and dumps garbage owned by dwarves. This tool gets dwarves to give +up ownership of scattered items and items with 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! -Example: +Usage:: -``cleanowned scattered X`` - This will confiscate rotten and dropped food, garbage on the floors and any + cleanowned [] [dryrun] + +When run without parameters, ``cleanowned`` will confiscate and dump rotten +items and owned food that is left behind on the floor. Specify the ``dryrun`` +parameter to just print out what would be done, but don't actually confiscate +anything. + +You can confiscate additional types of items by adding them to the commandline: + +- ``scattered`` + Confiscate/dump all items scattered on the floor. +- ``x`` + Confiscate/dump items with wear level 'x' (lightly worn) and more. +- ``X`` + Confiscate/dump items with wear level 'X' (heavily worn) and more. + +Or you can confiscate all owned items by specifying ``all``. + +Example +------- + +- ``cleanowned scattered X`` + Confiscate and dump rotten and dropped food, garbage on the floors, and any worn items with 'X' damage and above. diff --git a/plugins/cleanowned.cpp b/plugins/cleanowned.cpp index 90b0e743d..c1e5b31d4 100644 --- a/plugins/cleanowned.cpp +++ b/plugins/cleanowned.cpp @@ -31,22 +31,9 @@ command_result df_cleanowned (color_ostream &out, vector & parameters); DFhackCExport command_result plugin_init ( color_ostream &out, std::vector &commands) { commands.push_back(PluginCommand( - "cleanowned", "Confiscates and dumps garbage owned by dwarfs.", - df_cleanowned, false, - " This tool lets you confiscate and dump all the garbage\n" - " dwarves ultimately accumulate.\n" - " By default, only rotten and dropped food is confiscated.\n" - "Options:\n" - " dryrun - don't actually do anything, just print what would be done.\n" - " scattered - confiscate owned items on the ground\n" - " all - confiscate everything\n" - " x - confiscate & dump 'x' and worse damaged items\n" - " X - confiscate & dump 'X' and worse damaged items\n" - "Example:\n" - " cleanowned scattered X\n" - " This will confiscate rotten and dropped food, garbage on the floors\n" - " and any worn items with 'X' damage and above.\n" - )); + "cleanowned", + "Confiscates and dumps garbage owned by dwarves.", + df_cleanowned)); return CR_OK; }