From 755dbddbcb9495450577888960f040699f0665a6 Mon Sep 17 00:00:00 2001 From: octo Date: Mon, 8 May 2006 07:38:56 +0000 Subject: [PATCH] Added `L<...>' around each manpage reference. --- src/mans/Makefile.am | 30 +++++++++++++++----------- src/mans/liboping.pod | 16 +++++++------- src/mans/oping.pod | 4 ++-- src/mans/ping_construct.pod | 12 +++++------ src/mans/ping_get_error.pod | 2 +- src/mans/ping_host_add.pod | 15 +++++++------ src/mans/ping_iterator_get.pod | 12 +++++------ src/mans/ping_iterator_get_context.pod | 16 +++++++------- src/mans/ping_iterator_get_info.pod | 12 +++++------ src/mans/ping_send.pod | 19 ++++++++-------- src/mans/ping_setopt.pod | 5 +++-- 11 files changed, 75 insertions(+), 68 deletions(-) diff --git a/src/mans/Makefile.am b/src/mans/Makefile.am index 87c30543..9e398a92 100644 --- a/src/mans/Makefile.am +++ b/src/mans/Makefile.am @@ -1,21 +1,25 @@ +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 356095d2..496ad352 100644 --- a/src/mans/liboping.pod +++ b/src/mans/liboping.pod @@ -64,14 +64,14 @@ please report back any problems or success messages. Thank you :) =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, +L, +L, +L, +L, +L, +L, +L =head1 LICENSE diff --git a/src/mans/oping.pod b/src/mans/oping.pod index df260a01..e6ef195e 100644 --- a/src/mans/oping.pod +++ b/src/mans/oping.pod @@ -9,7 +9,7 @@ B [B<-4> | B<-6>] [B<-c> I] [B<-i> I] I [I [ =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 utility B can send ICMP packets to multiple hosts in parallel and wait for all ECHO_RESPONSE packets to arrive. In contrast to the B utility (URL is listed in L<"SEE ALSO">) B can use both, IPv4 @@ -48,7 +48,7 @@ floating-point number to specify sub-second precision. =head1 SEE ALSO -ping(8), L +L, L, L =head1 AUTHOR diff --git a/src/mans/ping_construct.pod b/src/mans/ping_construct.pod index 20978916..4fadf704 100644 --- a/src/mans/ping_construct.pod +++ b/src/mans/ping_construct.pod @@ -23,12 +23,12 @@ The B 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, +L, +L, +L, +L, +L =head1 AUTHOR diff --git a/src/mans/ping_get_error.pod b/src/mans/ping_get_error.pod index f246eed7..4f675112 100644 --- a/src/mans/ping_get_error.pod +++ b/src/mans/ping_get_error.pod @@ -20,7 +20,7 @@ was encountered yet. =head1 SEE ALSO -liboping(3) +L =head1 AUTHOR diff --git a/src/mans/ping_host_add.pod b/src/mans/ping_host_add.pod index fe52cf85..c768be31 100644 --- a/src/mans/ping_host_add.pod +++ b/src/mans/ping_host_add.pod @@ -15,11 +15,11 @@ The B method tries to resolve the I argument, open a socket and associate everything with the liboping object I. The I argument is a pointer to an liboping object, as returned by -ping_construct(3). +L. The I 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, the hostname is resolved to an IPv4 or IPv6 address. The B method looks for I within I and remove it if found. It will close the socket and deallocate the memory, too. @@ -28,17 +28,18 @@ found. It will close the socket and deallocate the memory, too. If B 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. B 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 to receive the error message. =head1 SEE ALSO -ping_construct(3), -ping_setopt(3), -ping_get_error(3) +L, +L, +L, +L =head1 AUTHOR diff --git a/src/mans/ping_iterator_get.pod b/src/mans/ping_iterator_get.pod index 40b67fb2..ae735393 100644 --- a/src/mans/ping_iterator_get.pod +++ b/src/mans/ping_iterator_get.pod @@ -24,8 +24,8 @@ liboping object. You can use these methods as follows: } 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 and +L. =head1 RETURN VALUE @@ -37,9 +37,9 @@ NULL if the last host has been reached. =head1 SEE ALSO -ping_host_add(3), -ping_iterator_get_info(3), -ping_iterator_get_context(3), -liboping(3) +L, +L, +L, +L =head1 AUTHOR diff --git a/src/mans/ping_iterator_get_context.pod b/src/mans/ping_iterator_get_context.pod index 18ae4a0a..2ada86a9 100644 --- a/src/mans/ping_iterator_get_context.pod +++ b/src/mans/ping_iterator_get_context.pod @@ -14,12 +14,12 @@ ping_iterator_get_context, ping_iterator_set_context - Store host-dependent data B can be used to store host-specific data within the liboping structures. This data can be received again by calling B. 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) or ping_destroy (see +L) 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 argument is an iterator object as returned by ping_iterator_get(3) -and ping_iterator_next. +The I argument is an iterator object as returned by +L and ping_iterator_next. The I argument of B is a pointer to anything and may be NULL. @@ -32,10 +32,10 @@ been called before. =head1 SEE ALSO -ping_iterator_get(3), -ping_construct(3), -ping_host_add(3), -liboping(3) +L, +L, +L, +L =head1 AUTHOR diff --git a/src/mans/ping_iterator_get_info.pod b/src/mans/ping_iterator_get_info.pod index 5833fc9a..d84c1113 100644 --- a/src/mans/ping_iterator_get_info.pod +++ b/src/mans/ping_iterator_get_info.pod @@ -16,8 +16,8 @@ ping_iterator_get_info - Constructor for the liboping class The B method can be used on an host iterator to return various information about the current host. -The I argument is an iterator as returned by ping_iterator_get(3) or -ping_iterator_next(3). +The I argument is an iterator as returned by L or +L. The I argument specifies the type of information returned. Use the following defines: @@ -28,8 +28,8 @@ 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. The hostname is actually looked up every time you call +this method, no cache is involved within liboping. It is recommended to include C and allocate B bytes of buffer. @@ -85,8 +85,8 @@ untouched. The return value is B in this case. =head1 SEE ALSO -ping_iterator_get(3), -liboping(3) +L, +L =head1 AUTHOR diff --git a/src/mans/ping_send.pod b/src/mans/ping_send.pod index cb7cbc01..b149cfee 100644 --- a/src/mans/ping_send.pod +++ b/src/mans/ping_send.pod @@ -14,24 +14,25 @@ The B method is the actual workhorse of this library. It crafts ICMP packets for the hosts associated with I 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) 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 and ping_iterator_next (described in the same manpage) +and call L on each host. =head1 RETURN VALUE B 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 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, +L, +L, +L, +L, +L =head1 AUTHOR diff --git a/src/mans/ping_setopt.pod b/src/mans/ping_setopt.pod index 0346f8ba..7f64b047 100644 --- a/src/mans/ping_setopt.pod +++ b/src/mans/ping_setopt.pod @@ -14,7 +14,7 @@ The B method sets options that effect all hosts associated with the object I and hosts that are yet to be added to the object. The I argument is a pointer to an liboping object, as returned by -ping_construct(3). +L. The I argument specifies the option to set. Use one of the following constants: @@ -52,7 +52,8 @@ B returns zero upon success or less than zero upon failure. =head1 SEE ALSO -ping_construct(3) +L, +L =head1 AUTHOR -- 2.30.2