Code

minor doc fixes for liboping
authorVadim Zeitlin <vz-oping@zeitlins.org>
Sun, 20 Dec 2009 20:45:48 +0000 (21:45 +0100)
committerFlorian Forster <octo@verplant.org>
Sun, 20 Dec 2009 23:53:54 +0000 (00:53 +0100)
 Hello,

 I was reading the documentation of your liboping library as I'd like to
use it for a small project of mine and couldn't help noticing a few typos
in the docs, please find attached a tiny patch fixing them.

 Thanks for writing this library!
VZ

Signed-off-by: Florian Forster <octo@verplant.org>
src/mans/liboping.pod
src/mans/oping.pod
src/mans/ping_construct.pod
src/mans/ping_get_error.pod
src/mans/ping_host_add.pod
src/mans/ping_iterator_get.pod
src/mans/ping_iterator_get_context.pod
src/mans/ping_iterator_get_info.pod
src/mans/ping_send.pod
src/mans/ping_setopt.pod

index a9caa038ae762de4a44c8370fd0f6a78e944c45d..d2c42f9ea6cd77e39946f57726bab9d470daf466 100644 (file)
@@ -18,7 +18,7 @@ and protocol independent manner. The interface is simple, object oriented and
 There are two main types that are used by applications. Both are "opaque
 types", meaning they are structures that are B<not> completely defined in the
 header file, so you cannot access the structures' members. You don't need to,
-don't do it. These structures are object to change without notice.
+don't do it. These structures are subject to change without notice.
 
 =over 4
 
@@ -81,6 +81,6 @@ applicable.
 =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/>.
+Its homepage can be found at L<http://verplant.org/liboping/>.
 
 (c) 2005-2009 by Florian octo Forster.
index 12c3a657c0bce67cfe20f16c4670d9b958ede9bc..b005b32c55258a72b7550e232ef6b479821f5d77 100644 (file)
@@ -72,6 +72,6 @@ L<ping(8)>, L<http://www.fping.com/>, L<liboping(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/>.
+Its homepage can be found at L<http://verplant.org/liboping/>.
 
 (c) 2005-2009 by Florian octo Forster.
index 6ee023d891d3cab482a5cc69d072ec2cb9c8d8b6..da082c8a61dc27007caf3ed3600d9b7558fce0bd 100644 (file)
@@ -33,6 +33,6 @@ L<liboping(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/>.
+Its homepage can be found at L<http://verplant.org/liboping/>.
 
 (c) 2005-2009 by Florian octo Forster.
index 81e725fbac213beb53a5ebc17bc4ba79036aef91..df9a015a54b632c84434f4eaf6dc809064dcdbc7 100644 (file)
@@ -25,6 +25,6 @@ L<liboping(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/>.
+Its homepage can be found at L<http://verplant.org/liboping/>.
 
 (c) 2005-2009 by Florian octo Forster.
index bea2c693279c1bfa5295d5753ca38f7f232668e5..254ac3578736ed9c77fb20e14a3ecc89d04469a3 100644 (file)
@@ -47,6 +47,6 @@ L<liboping(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/>.
+Its homepage can be found at L<http://verplant.org/liboping/>.
 
 (c) 2005-2009 by Florian octo Forster.
index 07046121b1f6de7bfffa10590c2a4cd9d235f6de..860f448c2b0aca8514e7a9634d4b8dc5fb7dedb0 100644 (file)
@@ -45,6 +45,6 @@ L<liboping(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/>.
+Its homepage can be found at L<http://verplant.org/liboping/>.
 
 (c) 2005-2009 by Florian octo Forster.
index 1eae4b3efd0bce733a591777593bf7c46cd5c124..f0585abdba82fa82b000b06b0fb1a56e9a640cf7 100644 (file)
@@ -40,6 +40,6 @@ L<liboping(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/>.
+Its homepage can be found at L<http://verplant.org/liboping/>.
 
 (c) 2005-2009 by Florian octo Forster.
index e1cd24fb4b37c2f02c8ee5335dc6eacab8138fdb..23e123e6975d1ab5f6c84d583c0a48511ccf3c95 100644 (file)
@@ -122,6 +122,6 @@ L<liboping(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/>.
+Its homepage can be found at L<http://verplant.org/liboping/>.
 
 (c) 2005-2009 by Florian octo Forster.
index 33c4f5691bfeb6f83db51ec1d20c2b95ed718958..8237daed1e96b41c0c45c73646631ebe28d39e7c 100644 (file)
@@ -22,7 +22,7 @@ page) 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
+B<ping_send> returns the number of echo replies received or a value less than
 zero if an error occurred. Use L<ping_get_error(3)> to receive an error message.
 
 =head1 SEE ALSO
@@ -37,6 +37,6 @@ L<liboping(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/>.
+Its homepage can be found at L<http://verplant.org/liboping/>.
 
 (c) 2005-2009 by Florian octo Forster.
index ad85979c7829cac5c11786c098f9d5dcb81917b2..df9cc5985c379610cf4899a9d6dc682b54f90f9d 100644 (file)
@@ -10,7 +10,7 @@ ping_setopt - Set options for a liboping object
 
 =head1 DESCRIPTION
 
-The B<ping_setopt> method sets options that effect all hosts associated with
+The B<ping_setopt> method sets options that apply to 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 I<liboping> object, as returned by
@@ -39,7 +39,7 @@ values are 1 through 255. Default is B<PING_DEF_TTL>.
 
 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>. This
-option only effects hosts that are being added B<after> this option has been
+option only affects hosts that are being added B<after> this option has been
 set. Default is B<PING_DEF_AF>. If you change this option, and a source address
 is set (see B<PING_OPT_SOURCE>) that setting will be reset.
 
@@ -84,6 +84,6 @@ L<liboping(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/>.
+Its homepage can be found at L<http://verplant.org/liboping/>.
 
 (c) 2005-2009 by Florian octo Forster.