add docs

DFHack · Nov 10, 2023 · c24a0cb · c24a0cb
1 parent 84fe195
commit c24a0cb
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 6 deletions.
diff --git a/docs/unforbid.rst b/docs/unforbid.rst
@@ -24,3 +24,6 @@ Options
 
 ``-q``, ``--quiet``
     Suppress non-error console output.
+
+``-x``, ``-include-worn``
+    Include worn (X) and tattered (XX) items when unforbidding.
diff --git a/unforbid.lua b/unforbid.lua
@@ -4,11 +4,7 @@ local argparse = require('argparse')
 
 local function unforbid_all(include_unreachable, quiet, include_worn)
     local p
-    if quiet then
-        p=function(s) return end;
-    else
-        p=function(s) return print(s) end;
-    end
+    if quiet then p=function(s) return end; else p=function(s) return print(s) end; end
     p('Unforbidding all items...')
 
     local citizens = dfhack.units.getCitizens(true)
@@ -57,7 +53,7 @@ local options, args = {
 local positionals = argparse.processArgsGetopt(args, {
     { 'h', 'help', handler = function() options.help = true end },
     { 'q', 'quiet', handler = function() options.quiet = true end },
-    { 'X', 'include-tattered', handler = function() options.include_worn = true end},
+    { 'X', 'include-worn', handler = function() options.include_worn = true end},
     { 'u', 'include-unreachable', handler = function() options.include_unreachable = true end },
 })