add missing labels

docs/plugins/cleaners.rst

@@ -1,3 +1,6 @@
+.. _clean:
+.. _spotclean:
+
 cleaners
 ========
 

docs/plugins/cromulate.rst

@@ -1,7 +1,7 @@
 cromulate
 =========
 
-Tags: `tag/productivity`, `tag/unit`, `tag/adventure`
+Tags: `tag/productivity`, `tag/units`, `tag/adventure`
 :dfhack-keybind:`cromulate`
 
 :index:`Collects all widgets into a frobozz electric cromufiler.

docs/plugins/dig.rst

@@ -1,4 +1,5 @@
 .. _digv:
+.. _digtype:
 
 dig
 ===
@@ -20,3 +21,88 @@ Basic commands:
     specifying the designation priority with ``-p#``, ``-p #``, or ``p=#``,
     where ``#`` is a number from 1 to 7. If a priority is not specified, the
     priority selected in-game is used as the default.
+digcircle
+=========
+A command for easy designation of filled and hollow circles.
+It has several types of options.
+
+Shape:
+
+:hollow:   Set the circle to hollow (default)
+:filled:   Set the circle to filled
+:#:        Diameter in tiles (default = 0, does nothing)
+
+Action:
+
+:set:      Set designation (default)
+:unset:    Unset current designation
+:invert:   Invert designations already present
+
+Designation types:
+
+:dig:      Normal digging designation (default)
+:ramp:     Ramp digging
+:ustair:   Staircase up
+:dstair:   Staircase down
+:xstair:   Staircase up/down
+:chan:     Dig channel
+
+After you have set the options, the command called with no options
+repeats with the last selected parameters.
+
+Examples:
+
+``digcircle filled 3``
+        Dig a filled circle with diameter = 3.
+``digcircle``
+        Do it again.
+digtype
+=======
+For every tile on the map of the same vein type as the selected tile,
+this command designates it to have the same designation as the
+selected tile. If the selected tile has no designation, they will be
+dig designated.
+If an argument is given, the designation of the selected tile is
+ignored, and all appropriate tiles are set to the specified
+designation.
+
+Options:
+
+:dig:
+:channel:
+:ramp:
+:updown: up/down stairs
+:up:     up stairs
+:down:   down stairs
+:clear:  clear designation
+digexp
+======
+This command is for :wiki:`exploratory mining <Exploratory_mining>`.
+
+There are two variables that can be set: pattern and filter.
+
+Patterns:
+
+:diag5:            diagonals separated by 5 tiles
+:diag5r:           diag5 rotated 90 degrees
+:ladder:           A 'ladder' pattern
+:ladderr:          ladder rotated 90 degrees
+:clear:            Just remove all dig designations
+:cross:            A cross, exactly in the middle of the map.
+
+Filters:
+
+:all:              designate whole z-level
+:hidden:           designate only hidden tiles of z-level (default)
+:designated:       Take current designation and apply pattern to it.
+
+After you have a pattern set, you can use ``expdig`` to apply it again.
+
+Examples:
+
+``expdig diag5 hidden``
+  Designate the diagonal 5 patter over all hidden tiles
+``expdig``
+  Apply last used pattern and filter
+``expdig ladder designated``
+  Take current designations and replace them with the ladder pattern

docs/plugins/filltraffic.rst

@@ -1,3 +1,5 @@
+.. _alltraffic:
+
 filltraffic
 ===========
 Set traffic designations using flood-fill starting at the cursor.
@@ -15,3 +17,14 @@ Example:
 
 ``filltraffic H``
   When used in a room with doors, it will set traffic to HIGH in just that room.
+alltraffic
+==========
+Set traffic designations for every single tile of the map - useful for resetting
+traffic designations.  See also `filltraffic`, `restrictice`, and `restrictliquids`.
+
+Options:
+
+:H:     High Traffic
+:N:     Normal Traffic
+:L:     Low Traffic
+:R:     Restricted Traffic

docs/plugins/zone.rst

@@ -1,3 +1,6 @@
+.. _autobutcher:
+.. _autonestbox:
+
 zone
 ====
 Helps a bit with managing activity zones (pens, pastures and pits) and cages.
@@ -128,3 +131,113 @@ Examples
 ``zone tocages count 50 own tame male not grazer``
    Stuff up to 50 owned tame male animals who are not grazers into cages built
    on the current default zone.
+autobutcher
+===========
+Assigns lifestock for slaughter once it reaches a specific count. Requires that
+you add the target race(s) to a watch list. Only tame units will be processed.
+
+Units will be ignored if they are:
+
+* Nicknamed (for custom protection; you can use the `rename` ``unit`` tool
+  individually, or `zone` ``nick`` for groups)
+* Caged, if and only if the cage is defined as a room (to protect zoos)
+* Trained for war or hunting
+
+Creatures who will not reproduce (because they're not interested in the
+opposite sex or have been gelded) will be butchered before those who will.
+Older adults and younger children will be butchered first if the population
+is above the target (default 1 male, 5 female kids and adults).  Note that
+you may need to set a target above 1 to have a reliable breeding population
+due to asexuality etc.  See `fix-ster` if this is a problem.
+
+Options:
+
+:example:      Print some usage examples.
+:start:        Start running every X frames (df simulation ticks).
+               Default: X=6000, which would be every 60 seconds at 100fps.
+:stop:         Stop running automatically.
+:sleep <x>:    Changes the timer to sleep X frames between runs.
+:watch R:      Start watching a race. R can be a valid race RAW id (ALPACA,
+               BIRD_TURKEY, etc) or a list of ids seperated by spaces or
+               the keyword 'all' which affects all races on your current
+               watchlist.
+:unwatch R:    Stop watching race(s). The current target settings will be
+               remembered. R can be a list of ids or the keyword 'all'.
+:forget R:     Stop watching race(s) and forget it's/their target settings.
+               R can be a list of ids or the keyword 'all'.
+:autowatch:    Automatically adds all new races (animals you buy from merchants,
+               tame yourself or get from migrants) to the watch list using
+               default target count.
+:noautowatch:  Stop auto-adding new races to the watchlist.
+:list:         Print the current status and watchlist.
+:list_export:  Print the commands needed to set up status and watchlist,
+               which can be used to import them to another save (see notes).
+:target <fk> <mk> <fa> <ma> <R>:
+               Set target count for specified race(s).  The first four arguments
+               are the number of female and male kids, and female and male adults.
+               R can be a list of spceies ids, or the keyword ``all`` or ``new``.
+               ``R = 'all'``: change target count for all races on watchlist
+               and set the new default for the future. ``R = 'new'``: don't touch
+               current settings on the watchlist, only set the new default
+               for future entries.
+:list_export:  Print the commands required to rebuild your current settings.
+
+.. note::
+
+    Settings and watchlist are stored in the savegame, so that you can have
+    different settings for each save. If you want to copy your watchlist to
+    another savegame you must export the commands required to recreate your settings.
+
+    To export, open an external terminal in the DF directory, and run
+    ``dfhack-run autobutcher list_export > filename.txt``.  To import, load your
+    new save and run ``script filename.txt`` in the DFHack terminal.
+
+
+Examples:
+
+You want to keep max 7 kids (4 female, 3 male) and max 3 adults (2 female,
+1 male) of the race alpaca. Once the kids grow up the oldest adults will get
+slaughtered. Excess kids will get slaughtered starting with the youngest
+to allow that the older ones grow into adults. Any unnamed cats will
+be slaughtered as soon as possible. ::
+
+     autobutcher target 4 3 2 1 ALPACA BIRD_TURKEY
+     autobutcher target 0 0 0 0 CAT
+     autobutcher watch ALPACA BIRD_TURKEY CAT
+     autobutcher start
+
+Automatically put all new races onto the watchlist and mark unnamed tame units
+for slaughter as soon as they arrive in your fort. Settings already made
+for specific races will be left untouched. ::
+
+     autobutcher target 0 0 0 0 new
+     autobutcher autowatch
+     autobutcher start
+
+Stop watching the races alpaca and cat, but remember the target count
+settings so that you can use 'unwatch' without the need to enter the
+values again. Note: 'autobutcher unwatch all' works, but only makes sense
+if you want to keep the plugin running with the 'autowatch' feature or manually
+add some new races with 'watch'. If you simply want to stop it completely use
+'autobutcher stop' instead. ::
+
+    autobutcher unwatch ALPACA CAT
+autonestbox
+===========
+Assigns unpastured female egg-layers 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, most birds grow up
+quite fast. Egglayers 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 egglayers could destroy your neat
+nestbox zones when they revert to wild. When called without options autonestbox
+will instantly run once.
+
+Options:
+
+:start:        Start running every X frames (df simulation ticks).
+               Default: X=6000, which would be every 60 seconds at 100fps.
+:stop:         Stop running automatically.
+:sleep:        Must be followed by number X. Changes the timer to sleep X
+               frames between runs.