Module Name: src
Committed By: wiz
Date: Sat Jan 4 15:37:46 UTC 2014
Modified Files:
src/lib/libc/net: inet6_rth_space.3
Log Message:
Sort sections. Remove trailing whitespace.
To generate a diff of this commit:
cvs rdiff -u -r1.1 -r1.2 src/lib/libc/net/inet6_rth_space.3
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/lib/libc/net/inet6_rth_space.3
diff -u src/lib/libc/net/inet6_rth_space.3:1.1 src/lib/libc/net/inet6_rth_space.3:1.2
--- src/lib/libc/net/inet6_rth_space.3:1.1 Fri May 5 00:03:21 2006
+++ src/lib/libc/net/inet6_rth_space.3 Sat Jan 4 15:37:46 2014
@@ -1,4 +1,4 @@
-.\" $NetBSD: inet6_rth_space.3,v 1.1 2006/05/05 00:03:21 rpaulo Exp $
+.\" $NetBSD: inet6_rth_space.3,v 1.2 2014/01/04 15:37:46 wiz Exp $
.\" $KAME: inet6_rth_space.3,v 1.7 2005/01/05 03:00:44 itojun Exp $
.\"
.\" Copyright (C) 2004 WIDE Project.
@@ -60,7 +60,7 @@
The IPv6 Advanced API, RFC 3542, defines the functions that an
application calls to build and examine IPv6 Routing headers.
Routing headers are used to perform source routing in IPv6 networks.
-The RFC uses the word
+The RFC uses the word
.Dq segments
to describe addresses and that is the term used here as well.
All of the functions are defined in the
@@ -81,14 +81,14 @@ The
.Fn inet6_rth_space
function returns the number of bytes required to hold a Routing Header
of the type, specified in the
-.Fa type
+.Fa type
argument and containing the number of addresses specified in the
.Fa segments
argumment.
-When the type is
+When the type is
.Dv IPV6_RTHDR_TYPE_0
the number of segments must be from 0 through 127.
-Routing headers of type
+Routing headers of type
.Dv IPV6_RTHDR_TYPE_2
contain only one segment, and are only used with Mobile IPv6.
The return value from this function is the number of bytes required to
@@ -165,20 +165,25 @@ The
.Fa index
is the location in the routing header from which the application wants
to retrieve an address.
-The
-.Fa index
+The
+.Fa index
parameter must have a value between 0 and one less than the number of
segments present in the routing header.
The
-.Fn inet6_rth_segments
+.Fn inet6_rth_segments
function, described in the last section, should be used to determine
the total number of segments in the routing header.
The
.Fn inet6_rth_getaddr
-function returns a pointer to an IPv6 address on success or
+function returns a pointer to an IPv6 address on success or
.Dv NULL
when an error has occurred.
.\"
+.Sh EXAMPLES
+RFC 3542 gives extensive examples in Section 21, Appendix B.
+.Pp
+KAME also provides examples in the advapitest directory of its kit.
+.\"
.Sh DIAGNOSTICS
The
.Fn inet6_rth_space
@@ -197,11 +202,6 @@ and
.Fn inet6_rth_reverse
functions return 0 on success, or \-1 upon an error.
.\"
-.Sh EXAMPLES
-RFC 3542 gives extensive examples in Section 21, Appendix B.
-.Pp
-KAME also provides examples in the advapitest directory of its kit.
-.\"
.Sh SEE ALSO
.Rs
.%A W. Stevens
