Skip to content

Update exterminate.rst #1520

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
+7 −0
Closed

Update exterminate.rst #1520

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/exterminate.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ Examples
Kill all non-friendly creatures.
``exterminate all:MALE``
Kill all non-friendly male creatures.
``exterminate all --children-only``
Kill only non-friendly child units. Helpful for automated cleanup routines
that run on a schedule.

Options
-------
Expand All @@ -49,6 +52,10 @@ Options
Specifies the tool should also kill units friendly to the player.
``-l``, ``--limit <num>``
Set the maximum number of units to exterminate.
``-c``, ``--children-only``
Target only child units. Useful for timer-based automation scripts
that periodically remove wandering poults or other child creatures
that may endanger dwarven children.

Methods
-------
Expand Down