update docs for autonestbox

myk002 · myk002 · commit b2ab93b3cd97 · 2022-08-03T23:35:13.000-07:00
diff --git a/docs/plugins/autonestbox.rst b/docs/plugins/autonestbox.rst
@@ -0,0 +1,27 @@
+autonestbox
+===========
+Tags:
+:dfhack-keybind:`autonestbox`
+
+Auto-assign egg-laying female pets to nestbox zones. Requires that you create
+pen/pasture zones above nestboxes. If the pen is bigger than 1x1, the nestbox
+must be in the top left corner. Only 1 unit will be assigned per pen, regardless
+of the size. The age of the units is currently not checked since most birds grow
+up quite fast. Egg layers who are also grazers will be ignored, since confining
+them to a 1x1 pasture is not a good idea. Only tame and domesticated own units
+are processed since pasturing half-trained wild egg layers could destroy your
+neat nestbox zones when they revert to wild.
+
+Usage:
+
+``enable autonestbox``
+    Start checking for unpastured egg-layers and assigning them to nestbox
+    zones.
+``autonestbox``
+    Print current status.
+``autonestbox now``
+    Run a scan and assignment cycle right now. Does not require that the plugin
+    is enabled.
+``autonestbox ticks <ticks>``
+    Change the number of ticks between scan and assignment cycles when the
+    plugin is enabled. The default is 6000 (about 8 days).
diff --git a/plugins/autonestbox.cpp b/plugins/autonestbox.cpp
@@ -33,24 +33,6 @@ DFHACK_PLUGIN_IS_ENABLED(is_enabled);
 
 REQUIRE_GLOBAL(world);
 
-static const string autonestbox_help =
-    "Assigns unpastured female egg-layers to nestbox zones.\n"
-    "Requires that you create pen/pasture zones above nestboxes.\n"
-    "If the pen is bigger than 1x1 the nestbox must be in the top left corner.\n"
-    "Only 1 unit will be assigned per pen, regardless of the size.\n"
-    "The age of the units is currently not checked, most birds grow up quite fast.\n"
-    "Usage:\n"
-    "\n"
-    "enable autonestbox\n"
-    "    Start checking for unpastured egg-layers and assigning them to nestbox zones.\n"
-    "autonestbox\n"
-    "    Print current status."
-    "autonestbox now\n"
-    "    Run a scan and assignment cycle right now. Does not require that the plugin is enabled.\n"
-    "autonestbox ticks <ticks>\n"
-    "    Change the number of ticks between scan and assignment cycles when the plugin is enabled.\n"
-    "    The default is 6000 (about 8 days)\n";
-
 namespace DFHack {
     // for configuration-related logging
     DBG_DECLARE(autonestbox, status, DebugCategory::LINFO);
@@ -90,9 +72,7 @@ DFhackCExport command_result plugin_init(color_ostream &out, std::vector <Plugin
     commands.push_back(PluginCommand(
         plugin_name,
         "Auto-assign egg-laying female pets to nestbox zones.",
-        df_autonestbox,
-        false,
-        autonestbox_help.c_str()));
+        df_autonestbox));
     return CR_OK;
 }
 
