improve limits documentation in man page

* Mention --enable-safe-limits in -i and -p descriptions
* Mention new unconditional limit for -p in option description
* Mention new unconditional limit for -p in limits section
* More consistent formatting in limits section by using B<>
  for the generator options

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 2e51aa126f899e5a5b0dd78210b87ef87542f241..082515249ab6c43a1b18c2f5798959116bc0d2a9 100644 (file)
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -32,6 +32,7 @@ Next
 - Avoid unsigned overflow when determining the memory size to save
   response times on systems where size\_t is the same as unsigned int
   (#412 by @auerswal)
+- Document the new minimum value for the -p option (#414 by @auerswal)
 
 fping 5.4 (UNRELEASED)
 ======================

diff --git a/doc/fping.pod b/doc/fping.pod
index d1831d762db6d929ba57ae1b8949f0cfb510428e..fb611104964140d2bf0d7ace5d0f6f83b6b3912c 100644 (file)
--- a/doc/fping.pod
+++ b/doc/fping.pod
@@ -150,7 +150,8 @@ If B<fping> cannot read the TTL value, "(TTL unknown)" is returned.
 =item B<-i>, B<--interval>=I<MSEC>
 
 The minimum amount of time (in milliseconds) between sending a ping packet
-to any target (default is 10, minimum is 1).
+to any target (default is 10, minimum is 0 (1 for non-root users if fping
+was configured with C<--enable-safe-limits>)).
 
 =item B<-I>, B<--iface>=I<IFACE>
 
@@ -222,7 +223,8 @@ Displays the TOS value in the output. If B<fping> cannot read the TOS value,
 
 In looping or counting modes (B<-l>, B<-c>, or B<-C>), this parameter sets
 the time in milliseconds that B<fping> waits between successive packets to
-an individual target. Default is 1000 and minimum is 10.
+an individual target. Default is 1000 and minimum is 0.001 (10 for non-root
+users if fping was configured with C<--enable-safe-limits>).
 
 =item B<-q>, B<--quiet>
 
@@ -338,13 +340,16 @@ line arguments, and 4 for a system call failure.
 
 =head1 RESTRICTIONS
 
-The number of addresses that can be generated using the C<-g>, C<--generate>
+The number of addresses that can be generated using the B<-g>, B<--generate>
 option is limited to 131072 (the number of host addresses in one 111-bit IPv6
 prefix, two addresses more than the host addresses in one 15-bit IPv4 prefix).
 
 The length of target names read from file or standard input is limited to
 255 bytes.
 
+The minimum interval for sending successive packets to an individual target
+set with the B<-p> I<n> option is 0.001 msec.
+
 If fping was configured with C<--enable-safe-limits>, the following values are
 not allowed for non-root users: