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>
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,
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.
=head1 AUTHOR
liboping is written by Florian octo Forster E<lt>octo at verplant.orgE<gt>.
=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.
(c) 2005-2009 by Florian octo Forster.
=head1 AUTHOR
liboping is written by Florian octo Forster E<lt>octo at verplant.orgE<gt>.
=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.
(c) 2005-2009 by Florian octo Forster.
=head1 AUTHOR
liboping is written by Florian octo Forster E<lt>octo at verplant.orgE<gt>.
=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.
(c) 2005-2009 by Florian octo Forster.
=head1 AUTHOR
liboping is written by Florian octo Forster E<lt>octo at verplant.orgE<gt>.
=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.
(c) 2005-2009 by Florian octo Forster.
=head1 AUTHOR
liboping is written by Florian octo Forster E<lt>octo at verplant.orgE<gt>.
=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.
(c) 2005-2009 by Florian octo Forster.
=head1 AUTHOR
liboping is written by Florian octo Forster E<lt>octo at verplant.orgE<gt>.
=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.
(c) 2005-2009 by Florian octo Forster.
=head1 AUTHOR
liboping is written by Florian octo Forster E<lt>octo at verplant.orgE<gt>.
=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.
(c) 2005-2009 by Florian octo Forster.
=head1 AUTHOR
liboping is written by Florian octo Forster E<lt>octo at verplant.orgE<gt>.
=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.
(c) 2005-2009 by Florian octo Forster.
-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
zero if an error occurred. Use L<ping_get_error(3)> to receive an error message.
=head1 SEE ALSO
=head1 AUTHOR
liboping is written by Florian octo Forster E<lt>octo at verplant.orgE<gt>.
=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.
(c) 2005-2009 by Florian octo Forster.
-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
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
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
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.
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.
=head1 AUTHOR
liboping is written by Florian octo Forster E<lt>octo at verplant.orgE<gt>.
=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.
(c) 2005-2009 by Florian octo Forster.