summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: 35dc8e4)
raw | patch | inline | side by side (parent: 35dc8e4)
author | octo <octo> | |
Mon, 8 May 2006 07:38:56 +0000 (07:38 +0000) | ||
committer | octo <octo> | |
Mon, 8 May 2006 07:38:56 +0000 (07:38 +0000) |
diff --git a/src/mans/Makefile.am b/src/mans/Makefile.am
index 87c30543942a998aa632297d04e8474adf2ea853..9e398a929090e968450fcb8def57829374550d55 100644 (file)
--- a/src/mans/Makefile.am
+++ b/src/mans/Makefile.am
+man_PODS = liboping.pod ping_construct.pod ping_setopt.pod ping_host_add.pod \
+ ping_send.pod ping_get_error.pod ping_iterator_get.pod \
+ ping_iterator_get_info.pod ping_iterator_get_context.pod oping.pod
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 \
- oping.8
+ ping_iterator_get_info.3 ping_iterator_get_context.3 oping.8
-liboping_3_SOURCES = liboping.pod
-ping_construct_3_SOURCES = ping_construct.pod
-ping_setopt_3_SOURCES = ping_setopt.pod
-ping_host_add_3_SOURCES = ping_host_add.pod
-ping_send_3_SOURCES = ping_send.pod
-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
+EXTRA_DIST = $(man_MANS) $(man_PODS)
+
+#liboping_3_SOURCES = liboping.pod
+#ping_construct_3_SOURCES = ping_construct.pod
+#ping_setopt_3_SOURCES = ping_setopt.pod
+#ping_host_add_3_SOURCES = ping_host_add.pod
+#ping_send_3_SOURCES = ping_send.pod
+#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) $< >$@
+ pod2man --section=1 --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 356095d2d95cca06382406b38a7b8a6115567a75..496ad352708dafab489697ff12b27c1046a81eba 100644 (file)
--- a/src/mans/liboping.pod
+++ b/src/mans/liboping.pod
=head1 SEE ALSO
-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)
+L<ping_construct(3)>,
+L<ping_setopt(3)>,
+L<ping_host_add(3)>,
+L<ping_send(3)>,
+L<ping_get_error(3)>,
+L<ping_iterator_get(3)>,
+L<ping_iterator_get_info(3)>,
+L<ping_iterator_get_context(3)>
=head1 LICENSE
diff --git a/src/mans/oping.pod b/src/mans/oping.pod
index df260a0143e33649447414a3dc1d4907405d9f28..e6ef195e74777d056636ccdd33e24d3ec7bc3f71 100644 (file)
--- a/src/mans/oping.pod
+++ b/src/mans/oping.pod
=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)
+reachability and the network latency. In contrast to the original L<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
=head1 SEE ALSO
-ping(8), L<http://www.fping.com/>
+L<ping(8)>, L<http://www.fping.com/>, L<liboping(3)>
=head1 AUTHOR
index 209789165be740df49fc86fe8dcb05f78d783417..4fadf70427a9f9c1c922573d844ff3e8555592bc 100644 (file)
@@ -23,12 +23,12 @@ The B<ping_construct> constructor returns a pointer to the allocated memory or N
=head1 SEE ALSO
-ping_setopt(3),
-ping_send(3),
-ping_host_add(3),
-ping_get_error(3),
-ping_iterator_get(3),
-liboping(3)
+L<ping_setopt(3)>,
+L<ping_send(3)>,
+L<ping_host_add(3)>,
+L<ping_get_error(3)>,
+L<ping_iterator_get(3)>,
+L<liboping(3)>
=head1 AUTHOR
index f246eed7e10c3ea57711e567ef0fecd021c29997..4f67511292d9a3632b7640f8ba1d4495cb4b6aa1 100644 (file)
=head1 SEE ALSO
-liboping(3)
+L<liboping(3)>
=head1 AUTHOR
index fe52cf8570d125b14610c63bbaf53afb3df1aeae..c768be3197c04fe0af2e8426498bb41b94ea97f1 100644 (file)
socket and associate everything with the liboping object I<obj>.
The I<obj> argument is a pointer to an liboping object, as returned by
-ping_construct(3).
+L<ping_construct(3)>.
The I<host> parameter is a '\0' terminated string which is interpreted as a
hostname or an IP address. Depending on the address family setting, set with
-ping_setopt(3), the hostname is resolved to an IPv4 or IPv6 address.
+L<ping_setopt(3)>, the hostname is resolved to an IPv4 or IPv6 address.
The B<ping_host_remove> method looks for I<host> within I<obj> and remove it if
found. It will close the socket and deallocate the memory, too.
If B<ping_host_add> succeeds it returns zero. If an error occurs a value less
than zero is returned and the last error is saved internally. You can receive
-the error message using ping_get_error(3).
+the error message using L<ping_get_error(3)>.
B<ping_host_remove> returns zero upon success and less than zero if it failed.
Currently the only reason for failure is that the host isn't found, but this is
-subject to change. Use ping_get_error(3) to receive the error message.
+subject to change. Use L<ping_get_error(3)> to receive the error message.
=head1 SEE ALSO
-ping_construct(3),
-ping_setopt(3),
-ping_get_error(3)
+L<ping_construct(3)>,
+L<ping_setopt(3)>,
+L<ping_get_error(3)>,
+L<liboping(3)>
=head1 AUTHOR
index 40b67fb2e2d693fd733ca890fac2a6d5525ea4da..ae7353933d8b49fdc695c64e22adc89baf3d4339 100644 (file)
}
To get usable information from an iterator object (which is also an opaque data
-type, just like the liboping object itself) use ping_iterator_get_info(3) and
-ping_iterator_get_context(3).
+type, just like the liboping object itself) use L<ping_iterator_get_info(3)> and
+L<ping_iterator_get_context(3)>.
=head1 RETURN VALUE
=head1 SEE ALSO
-ping_host_add(3),
-ping_iterator_get_info(3),
-ping_iterator_get_context(3),
-liboping(3)
+L<ping_host_add(3)>,
+L<ping_iterator_get_info(3)>,
+L<ping_iterator_get_context(3)>,
+L<liboping(3)>
=head1 AUTHOR
index 18ae4a0aa47b607064e8c47301391b7add6bb65f..2ada86a923172fd0d1a914b0d2895255e7d5e82a 100644 (file)
@@ -14,12 +14,12 @@ ping_iterator_get_context, ping_iterator_set_context - Store host-dependent data
B<ping_iterator_set_context> can be used to store host-specific data within the
liboping structures. This data can be received again by calling
B<ping_iterator_get_context>. The data itself is never touched by liboping. If
-you call ping_host_remove (see ping_host_add(3)) or ping_destroy (see
-ping_construct(3)) and the context is not NULL liboping will assume you know
+you call ping_host_remove (see L<ping_host_add(3)>) or ping_destroy (see
+L<ping_construct(3)>) and the context is not NULL liboping will assume you know
what you're doing and simply ignore the fact this might be a memory leak.
-The I<iter> argument is an iterator object as returned by ping_iterator_get(3)
-and ping_iterator_next.
+The I<iter> argument is an iterator object as returned by
+L<ping_iterator_get(3)> and ping_iterator_next.
The I<context> argument of B<ping_iterator_set_context> is a pointer to
anything and may be NULL.
=head1 SEE ALSO
-ping_iterator_get(3),
-ping_construct(3),
-ping_host_add(3),
-liboping(3)
+L<ping_iterator_get(3)>,
+L<ping_construct(3)>,
+L<ping_host_add(3)>,
+L<liboping(3)>
=head1 AUTHOR
index 5833fc9a189dd4bd73d81eb71036ca7a425b8150..d84c111371a433e3e8ef26bf323502506f7ade65 100644 (file)
The B<ping_iterator_get_info> method can be used on an host iterator to return
various information about the current host.
-The I<iter> argument is an iterator as returned by ping_iterator_get(3) or
-ping_iterator_next(3).
+The I<iter> argument is an iterator as returned by L<ping_iterator_get(3)> or
+L<ping_iterator_next(3)>.
The I<info> argument specifies the type of information returned. Use the
following defines:
Return the hostname of the host the iterator points to. Since the name is
looked up using the socket address this may differ from the hostname passed to
-ping_host_add(3). The hostname is actually looked up every time you call this
-method, no cache is involved within liboping.
+L<ping_host_add(3)>. The hostname is actually looked up every time you call
+this method, no cache is involved within liboping.
It is recommended to include C<netdb.h> and allocate B<NI_MAXHOST> bytes of
buffer.
=head1 SEE ALSO
-ping_iterator_get(3),
-liboping(3)
+L<ping_iterator_get(3)>,
+L<liboping(3)>
=head1 AUTHOR
diff --git a/src/mans/ping_send.pod b/src/mans/ping_send.pod
index cb7cbc01f69e8ae038d157a76c9463d1039795bc..b149cfee1b3834f4e6d4cb53fe0129e88e9621cd 100644 (file)
--- a/src/mans/ping_send.pod
+++ b/src/mans/ping_send.pod
packets for the hosts associated with I<obj> and sends them via the
corresponding sockets. It then waits for echo responses and receives them,
writing latency information for each host. The method returns after all echo
-replies have been read or the timeout (set with ping_setopt(3)) is reached.
+replies have been read or the timeout (set with L<ping_setopt(3)>) is reached.
After this function returns you will most likely iterate over all hosts using
-ping_iterator_get(3) and ping_iterator_next (described in the same manpage) and
-call ping_iterator_get_info(3) on each host.
+L<ping_iterator_get(3)> and ping_iterator_next (described in the same manpage)
+and call L<ping_iterator_get_info(3)> on each host.
=head1 RETURN VALUE
B<ping_send> returns the value of echo replies received or a value less than
-zero if an error occured. Use ping_get_error(3) to receive an error message.
+zero if an error occured. Use L<ping_get_error(3)> to receive an error message.
=head1 SEE ALSO
-ping_construct(3),
-ping_setopt(3),
-ping_iterator_get(3),
-ping_iterator_get_info(3),
-ping_get_error(3)
+L<ping_construct(3)>,
+L<ping_setopt(3)>,
+L<ping_iterator_get(3)>,
+L<ping_iterator_get_info(3)>,
+L<ping_get_error(3)>,
+L<liboping(3)>
=head1 AUTHOR
index 0346f8ba217ac5f34552ed73399909f1b51925f8..7f64b04796a458f3f0cad75f558dbc6b590a92b4 100644 (file)
--- a/src/mans/ping_setopt.pod
+++ b/src/mans/ping_setopt.pod
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).
+L<ping_construct(3)>.
The I<opt> argument specifies the option to set. Use one of the following
constants:
=head1 SEE ALSO
-ping_construct(3)
+L<ping_construct(3)>,
+L<liboping(3)>
=head1 AUTHOR