From a4ef8142b3ec5f753c12533c067fbea23e580be9 Mon Sep 17 00:00:00 2001 From: David Schweikert Date: Thu, 19 Jul 2012 22:43:16 +0200 Subject: [PATCH] Update documentation for --enable-ipv6 --- .gitignore | 1 + README | 19 +++++++++++++++---- doc/Makefile.am | 15 +++++++++++++-- doc/fping.pod | 4 ++++ 4 files changed, 33 insertions(+), 6 deletions(-) diff --git a/.gitignore b/.gitignore index baa8fac..b1a4051 100644 --- a/.gitignore +++ b/.gitignore @@ -20,3 +20,4 @@ src/fping src/fping6 stamp-h1 doc/fping.8 +doc/fping6.8 diff --git a/README b/README index 15a445b..2928b75 100644 --- a/README +++ b/README @@ -9,7 +9,7 @@ Current maintainer: David Schweikert Website: - http://www.fping.org + http://www.fping.org/ Installation ------------ @@ -24,12 +24,23 @@ If you want to install fping from source, proceed as follows: sudo setcap cap_net_raw+ep fping -4. Have a look at the fping(1) manual for usage help +4. Have a look at the fping(8) manual for usage help (fping -h will also give a minimal help output) +IPv6 support +------------ +You can can compile fping with support for IPv6 addresses. A separate binary +is used for that, called fping6. To build it, use ./configure --enable-ipv6 +(possibly combined with --enable-ipv4 to also build fping for IPv4). E.g.: + + # ./configure --prefix=/usr/local --enable-ipv4 --enable-ipv6 + # make + # make install + # sudo setcap cap_net_raw+ep /usr/local/bin/fping* + Credits ------- Original author: Roland Schemers (schemers@stanford.edu) Previous maintainer: RL "Bob" Morgan (morgan@stanford.edu) -IPv6 Support: Jeroen Massar (jeroen@unfix.org / jeroen@ipng.nl) - to enable IPV6 compile with -DIPV6 +Initial IPv6 Support: Jeroen Massar (jeroen@unfix.org / jeroen@ipng.nl) +Other contributors: see ChangeLog diff --git a/doc/Makefile.am b/doc/Makefile.am index b124bad..8824ea0 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,6 +1,17 @@ -man_MANS = fping.8 +man_MANS = + +if IPV4 +man_MANS += fping.8 +endif + +if IPV6 +man_MANS += fping6.8 +endif + EXTRA_DIST = $(man_MANS) fping.pod README.1992 fping.8: fping.pod - pod2man $< >$@ pod2man -c "" -s 8 -r "fping $(VERSION)" $< >$@ + +fping6.8: fping.pod + pod2man -c "" -s 8 -r "fping $(VERSION)" -n fping6 $< >$@ diff --git a/doc/fping.pod b/doc/fping.pod index aea5108..119e4cc 100644 --- a/doc/fping.pod +++ b/doc/fping.pod @@ -5,6 +5,7 @@ fping - send ICMP ECHO_REQUEST packets to network hosts =head1 SYNOPSIS B [ I ] [ I ] +B [ I ] [ I ] =head1 DESCRIPTION @@ -21,6 +22,9 @@ sending a specified number of pings to a target, or looping indefinitely (as in B ). Unlike B, B is meant to be used in scripts, so its output is designed to be easy to parse. +The binary named B is the same as B, except that it uses IPv6 +addresses instead of IPv4. + =head1 OPTIONS =over 5 -- 2.43.0