From: octo <octo>
Date: Mon, 1 May 2006 16:59:06 +0000 (+0000)
Subject: Added mans/ping_construct.pod, mans/ping_setopt.pod
X-Git-Tag: liboping-0.1.0~13
X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=0aeea35f5ab66ff65b2ae053f30cb3803d0fc9fb;p=collectd.git

Added mans/ping_construct.pod, mans/ping_setopt.pod
Added mans/Makefile.am
Improved mans/liboping.pod
---

diff --git a/src/mans/Makefile.am b/src/mans/Makefile.am
new file mode 100644
index 00000000..93db2bd4
--- /dev/null
+++ b/src/mans/Makefile.am
@@ -0,0 +1,11 @@
+man_MANS = liboping.3 ping_construct.3 ping_setopt.3
+
+liboping_3_SOURCES = liboping.pod
+ping_construct_3_SOURCES = ping_construct.pod
+ping_setopt_3_SOURCES = ping_setopt.pod
+
+.pod.1:
+	pod2man --release=$(VERSION) --center=$(PACKAGE) $< >$@
+
+.pod.3:
+	pod2man --section=3 --release=$(VERSION) --center=$(PACKAGE) $< >$@
diff --git a/src/mans/liboping.pod b/src/mans/liboping.pod
index a6d46beb..356095d2 100644
--- a/src/mans/liboping.pod
+++ b/src/mans/liboping.pod
@@ -78,7 +78,7 @@ ping_iterator_get_context(3)
 liboping is licensed under the GPLv2. No other version of the license is
 applicable.
 
-=head1 CONTACT / AUTHOR
+=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/>.
diff --git a/src/mans/ping_construct.pod b/src/mans/ping_construct.pod
new file mode 100644
index 00000000..068bd262
--- /dev/null
+++ b/src/mans/ping_construct.pod
@@ -0,0 +1,37 @@
+=head1 NAME
+
+ping_construct - Constructor for the liboping class
+
+=head1 SYNOPSIS
+
+  #include <oping.h>
+
+  pingobj_t *ping_construct (void);
+  void       ping_destroy   (pingobj_t *obj);
+
+=head1 DESCRIPTION
+
+The B<ping_construct> constructor allocates the memory neccessary for a
+liboping object, initializes that memory and returns a pointer to it.
+
+The B<ping_destroy> iterates over all hosts associated with the liboping object
+I<obj>, closes the sockets, removes the hosts and frees I<obj>'s memory.
+
+=head1 RETURN VALUE
+
+The B<ping_construct> constructor returns a pointer to the allocated memory or NULL if no memory could be allocated.
+
+=head1 SEE ALSO
+
+ping_setopt(3),
+ping_send(3),
+ping_host_add(3),
+ping_iterator_get(3),
+ping_get_error(3)
+
+=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.
diff --git a/src/mans/ping_setopt.pod b/src/mans/ping_setopt.pod
new file mode 100644
index 00000000..c4f5eeb2
--- /dev/null
+++ b/src/mans/ping_setopt.pod
@@ -0,0 +1,61 @@
+=head1 NAME
+
+ping_setopt - Set options for a liboping object
+
+=head1 SYNOPSIS
+
+  #include <oping.h>
+
+  int ping_setopt (pingobj_t *obj, int opt, void *val);
+
+=head1 DESCRIPTION
+
+The B<ping_setopt> method sets options that effect all hosts associated with
+the object I<obj> and hosts that are yet to be added to the object.
+
+The I<obj> argument is a pointer to an liboping object, as returned by
+ping_construct(3).
+
+The I<opt> argument specifies the option to set. Use one of the following
+constants:
+
+=over 4
+
+=item B<PING_OPT_TIMEOUT>
+
+The time to wait for a "echo reply" to be received; in seconds. In this case
+the memory pointed to by I<val> is interpreted as a double value and must be
+greater than zero. The default is B<PING_DEF_TIMEOUT>.
+
+=item B<PING_OPT_TTL>
+
+The value written into the time-to-live (= TTL) field of generated ICMP
+packets. The memory pointed to by I<val> is interpreted as an integer. Valid
+values are 1 through 255. Default is B<PING_DEF_TTL>.
+
+=item B<PING_OPT_AF>
+
+The address family to use. The memory pointed to by I<val> is interpreted as an
+integer and must be either B<AF_UNSPEC>, B<AF_INET>, or B<AF_INET6>. Default is
+B<PING_DEF_AF>.
+
+=back
+
+The I<val> argument is a pointer to the new value. It must not be NULL. It is
+dereferences depending on the value of the I<opt> argument, see above. The
+memory pointed to by I<val> is not changed.
+
+=head1 RETURN VALUE
+
+B<ping_setopt> returns zero upon success or less than zero upon failure.
+
+=head1 SEE ALSO
+
+ping_construct(3)
+
+=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.