From: octo <octo>
Date: Tue, 2 May 2006 20:17:36 +0000 (+0000)
Subject: Added `oping(8)'
X-Git-Tag: liboping-0.1.0~5
X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=aa34b1e86f05431c910372fb64aec3cf227cb13e;p=collectd.git

Added `oping(8)'
src/liboping.c: Added comment about a static function `ping_open_socket' to be added.
debian/liboping-dev.manpages: Added *.3 manpages..
---

diff --git a/debian/liboping-dev.manpages b/debian/liboping-dev.manpages
index 32e3db4b..c1e9e833 100644
--- a/debian/liboping-dev.manpages
+++ b/debian/liboping-dev.manpages
@@ -1,3 +1,8 @@
 src/mans/liboping.3
 src/mans/ping_construct.3
-src/mans/ping_setopt.3
+src/mans/ping_get_error.3
+src/mans/ping_host_add.3
+src/mans/ping_iterator_get.3
+src/mans/ping_iterator_get_context.3
+src/mans/ping_iterator_get_info.3
+src/mans/ping_send.3
diff --git a/src/liboping.c b/src/liboping.c
index db3b9592..af29a64f 100644
--- a/src/liboping.c
+++ b/src/liboping.c
@@ -983,6 +983,8 @@ int ping_host_add (pingobj_t *obj, const char *host)
 			continue;
 		}
 
+		/* TODO: Move this to a static function `ping_open_socket' and
+		 * call it whenever the socket dies. */
 		ph->fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype, ai_ptr->ai_protocol);
 		if (ph->fd == -1)
 		{
diff --git a/src/mans/Makefile.am b/src/mans/Makefile.am
index 5c4552a1..87c30543 100644
--- a/src/mans/Makefile.am
+++ b/src/mans/Makefile.am
@@ -1,6 +1,7 @@
 man_MANS = liboping.3 ping_construct.3 ping_setopt.3 ping_host_add.3 \
 	   ping_send.3 ping_get_error.3 ping_iterator_get.3 \
-	   ping_iterator_get_info.3 ping_iterator_get_context.3
+	   ping_iterator_get_info.3 ping_iterator_get_context.3 \
+	   oping.8
 
 liboping_3_SOURCES = liboping.pod
 ping_construct_3_SOURCES = ping_construct.pod
@@ -11,9 +12,13 @@ ping_get_error_3_SOURCES = ping_get_error.pod
 ping_iterator_get_3_SOURCES = ping_iterator_get.pod
 ping_iterator_get_info_3_SOURCES = ping_iterator_get_info.pod
 ping_iterator_get_context_3_SOURCES = ping_iterator_get_context.pod
+oping_8_SOURCES = oping.pod
 
 .pod.1:
 	pod2man --release=$(VERSION) --center=$(PACKAGE) $< >$@
 
 .pod.3:
 	pod2man --section=3 --release=$(VERSION) --center=$(PACKAGE) $< >$@
+
+.pod.8:
+	pod2man --section=8 --release=$(VERSION) --center=$(PACKAGE) $< >$@
diff --git a/src/mans/oping.pod b/src/mans/oping.pod
new file mode 100644
index 00000000..df260a01
--- /dev/null
+++ b/src/mans/oping.pod
@@ -0,0 +1,58 @@
+=head1 NAME
+
+oping - send ICMP ECHO_REQUEST to network hosts
+
+=head1 SYNOPSIS
+
+B<oping> [B<-4> | B<-6>] [B<-c> I<count>] [B<-i> I<interval>] I<host> [I<host> [I<host> ...]]
+
+=head1 DESCRIPTION
+
+oping uses ICMPv4 or ICMPv6 ECHO_REQUEST packets to measure a hosts
+reachability and the network latency. In contrast to the original ping(8)
+utility B<oping> can send ICMP packets to multiple hosts in parallel and wait
+for all ECHO_RESPONSE packets to arrive. In contrast to the
+B<fping> utility (URL is listed in L<"SEE ALSO">) B<oping> can use both, IPv4
+and IPv6 transparently and side by side.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-4>
+
+Force the use of IPv4. 
+
+=item B<-6>
+
+Force the use of IPv6
+
+=item B<-c> I<count>
+
+Send (and receive) I<count> ICMP packets, then stop and exit.
+
+=item B<-i> I<interval>
+
+Send one ICMP packet (per host) each I<interval> seconds. This can be a
+floating-point number to specify sub-second precision.
+
+=back
+
+=head1 BUGS
+
+=over 4
+
+=item The TTL cannot be set
+
+=back
+
+=head1 SEE ALSO
+
+ping(8), L<http://www.fping.com/>
+
+=head1 AUTHOR
+
+liboping is written by Florian octo Forster E<lt>octo at verplant.orgE<gt>.
+It's homepage can be found at L<http://verplant.org/liboping/>.
+
+(c) 2005, 2006 by Florian octo Forster.