From 0ed978d3fc4362d54d39eb8327a50d5a3e92afa7 Mon Sep 17 00:00:00 2001
From: Oliver Gorwits <oliver@cpan.org>
Date: Thu, 14 Dec 2017 22:02:53 +0000
Subject: [PATCH] improve netdisco-do docs

---
 bin/netdisco-do | 18 +++++++++++++-----
 1 file changed, 13 insertions(+), 5 deletions(-)

diff --git a/bin/netdisco-do b/bin/netdisco-do
index 859de29d..daf3ca92 100755
--- a/bin/netdisco-do
+++ b/bin/netdisco-do
@@ -170,11 +170,19 @@ The C<-d> option will accept a hostname (that can be resolved to an IP with
 DNS), an IP address, or IP prefix (subnets in CIDR format). It can be any
 interface on the device known to Netdisco.
 
+=head1 ACTIONS
+
 Note that some jobs (C<discoverall>, C<macwalk>, C<arpwalk>, C<nbtwalk>)
 simply add entries to the Netdisco job queue for other jobs, so won't seem
 to do much when you trigger them.
 
-=head1 ACTIONS
+For any action, if you wish to run one of its individual worker stages, then
+pass C<action::stage> as the first argument to C<netdisco-do>, for example
+C<discover::neighbors>.
+
+Any action taking a C<device> parameter can be passed either a hostname or IP,
+or an IP prefix (subnet) which will cause C<netdisco-do> to run the action for
+all addresses in that range.
 
 =head2 discover
 
@@ -184,7 +192,7 @@ Run a discover on the device (specified with C<-d>).
 
 =head2 discoverall
 
-Run a discover for all known devices.
+Queue a discover for all known devices.
 
 =head2 macsuck
 
@@ -194,7 +202,7 @@ Run a macsuck on the device (specified with C<-d>).
 
 =head2 macwalk
 
-Run a macsuck for all known devices.
+Queue a macsuck for all known devices.
 
 =head2 arpnip
 
@@ -204,7 +212,7 @@ Run an arpnip on the device (specified with C<-d>).
 
 =head2 arpwalk
 
-Run an arpnip for all known devices.
+Queue an arpnip for all known devices.
 
 =head2 delete
 
@@ -236,7 +244,7 @@ Run an nbtstat on the node (specified with C<-d>).
 
 =head2 nbtwalk
 
-Run an nbtstat for all known nodes.
+Queue an nbtstat for all known nodes.
 
 =head2 expire