docs/man/nut-scanner.txt: document that currently different IP range …

…scans do not parallelize together [#2244] See also: #2511 Signed-off-by: Jim Klimov <[email protected]>
networkupstools · Jul 5, 2024 · f202955 · f202955
1 parent 8067751
commit f202955
Showing 1 changed file with 9 additions and 1 deletion.
diff --git a/docs/man/nut-scanner.txt b/docs/man/nut-scanner.txt
@@ -117,11 +117,19 @@ IP addresses.  Normally a new range is specified by a set of one `-s` and one
 `-e` options following each other (in any order).  Lone or consecutive `-s` or
 `-e` options present on the command line would translate to single-IP queries.
 Also a `-m` option squashed between two `-s` and `-e` options would be a new
-range, turning those two into single-IP queries.
+range, turning those two into single-IP queries.  This feature does not by
+itself recombine "neighboring" addresses into one range, nor even check for
+duplicate or overlapping specifications.
 +
 Also note that some buses require IP address(es) to scan, and others have a
 different behavior when exactly no addresses are specified (it is not currently
 possible to mix the two behaviors in one invocation of the `nut-scanner` tool).
++
+Finally note that currently even if multi-threaded support is available, each
+range specification is a separate fan-out of queries constrained by the timeout.
+Requests to scan many single IP addresses will take a while to complete, much
+longer than if they were a single range.  This will be hopefully fixed in later
+releases.
 
 *-t* | *--timeout* 'timeout'::
 Set the network timeout in seconds. Default timeout is 5 seconds.