Add documentation

docs/emigrate-nobles.rst

@@ -2,15 +2,35 @@ emigrate-nobles
 ==========
 
 .. dfhack-tool::
-    :summary: Allow inherited nobles to emigrate from fort for their rightful land.
+    :summary: Allow inherited nobles to emigrate from fort to their site of governance.
     :tags: fort units
 
 Tired of inherited nobility freeloading off your fortress making inane demands? Use this tool
-to find them and have them (willingly) emigrate to their rightful land.
+to have them (willingly) emigrate to their rightful lands.
+
+The unit must not be assigned to a squad.
+
+Warning! Nobles will not surrender any assigned items, be sure to unassign your artefacts before
+using this tool.
 
 Usage
 -----
 
-::
+``emigrate-nobles --list``
+    List all nobles that do not rule your fortress
+``emigrate-nobles --all``
+    Emigrate all nobles that do not rule your fortress
+``emigrate-nobles --unit <id>``
+    Emigrate a noble matching the specified unit ID that does not rule your fortress
+
+Options
+-------
 
-    emigrate-nobles [-h]
+``-h``, ``--help``
+    View help
+``-l``, ``--list``
+    List all nobles that do not rule your fortress
+``-a``, ``--all``
+    Emigrate all nobles do not rule your fortress
+``-u <id>``, ``--unit <id>``
+    Emigrate noble matching specified unit ID that does not rule your fortress

emigrate-nobles.lua

@@ -249,7 +249,7 @@ function main()
         if noble.military.squad_id ~= -1 then
             local squadName = dfhack.military.getSquadName(noble.military.squad_id)
             local nobleName = dfhack.units.getReadableName(noble)
-            print("[x] "..nobleName.." is a soldier of "..squadName..". Unassign him from the squad and try again.")
+            print("[-] "..nobleName.." is a soldier of "..squadName..". Unassign him from the squad and try again.")
         else
             emigrate(noble, site)
         end