summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorjmc <>2006-12-09 14:25:41 +0000
committerjmc <>2006-12-09 14:25:41 +0000
commita3712ed52140d5133de2172d6925a2cd113c5c51 (patch)
treecda6bdef8b866ea0e69087ebfe43638b1808789d /src
parentdc480bda7434b3d570830e85fb6e1b39be1c5ee0 (diff)
downloadopenbsd-a3712ed52140d5133de2172d6925a2cd113c5c51.tar.gz
openbsd-a3712ed52140d5133de2172d6925a2cd113c5c51.tar.bz2
openbsd-a3712ed52140d5133de2172d6925a2cd113c5c51.zip
various tweaks;
Diffstat (limited to 'src')
-rw-r--r--src/lib/libc/net/inet6_rth_space.335
1 files changed, 17 insertions, 18 deletions
diff --git a/src/lib/libc/net/inet6_rth_space.3 b/src/lib/libc/net/inet6_rth_space.3
index ab593b202a..4bb4b2adc8 100644
--- a/src/lib/libc/net/inet6_rth_space.3
+++ b/src/lib/libc/net/inet6_rth_space.3
@@ -1,4 +1,4 @@
1.\" $OpenBSD: inet6_rth_space.3,v 1.1 2006/12/09 01:12:28 itojun Exp $ 1.\" $OpenBSD: inet6_rth_space.3,v 1.2 2006/12/09 14:25:41 jmc Exp $
2.\" $KAME: inet6_rth_space.3,v 1.7 2005/01/05 03:00:44 itojun Exp $ 2.\" $KAME: inet6_rth_space.3,v 1.7 2005/01/05 03:00:44 itojun Exp $
3.\" 3.\"
4.\" Copyright (C) 2004 WIDE Project. 4.\" Copyright (C) 2004 WIDE Project.
@@ -60,31 +60,31 @@
60The IPv6 Advanced API, RFC 3542, defines the functions that an 60The IPv6 Advanced API, RFC 3542, defines the functions that an
61application calls to build and examine IPv6 Routing headers. 61application calls to build and examine IPv6 Routing headers.
62Routing headers are used to perform source routing in IPv6 networks. 62Routing headers are used to perform source routing in IPv6 networks.
63The RFC uses the word 63The RFC uses the word
64.Dq segments 64.Dq segments
65to describe addresses and that is the term used here as well. 65to describe addresses and that is the term used here as well.
66All of the functions are defined in the header file 66All of the functions are defined in the header file
67.Aq netinet/in.h . 67.Aq Pa netinet/in.h .
68The functions described in this manual page all operate 68The functions described in this manual page all operate
69on routing header structures which are defined in 69on routing header structures which are defined in
70.Aq netinet/ip6.h 70.Aq Pa netinet/ip6.h
71but which should not need to be modified outside the use of this API. 71but which should not need to be modified outside the use of this API.
72The size and shape of the route header structures may change, so using 72The size and shape of the route header structures may change, so using
73the APIs is a more portable, long term, solution. 73the APIs is a more portable, long term, solution.
74.Pp 74.Pp
75The functions in the API are split into two groups, those that build a 75The functions in the API are split into two groups, those that build a
76routing header and those that parse a received routing header. 76routing header and those that parse a received routing header.
77We will describe the builder functions followed by the parser functions. 77The builder functions are described first, followed by the parser functions.
78.Ss inet6_rth_space 78.Ss inet6_rth_space
79The 79The
80.Fn inet6_rth_space 80.Fn inet6_rth_space
81function returns the number of bytes required to hold a Routing Header 81function returns the number of bytes required to hold a Routing Header
82of the type, specified in the 82of the type, specified in the
83.Fa type 83.Fa type
84argument and containing the number of addresses specified in the 84argument and containing the number of addresses specified in the
85.Fa segments 85.Fa segments
86argumment. 86argument.
87When the type is 87When the type is
88.Dv IPV6_RTHDR_TYPE_0 88.Dv IPV6_RTHDR_TYPE_0
89the number of segments must be from 0 through 127. 89the number of segments must be from 0 through 127.
90The return value from this function is the number of bytes required to 90The return value from this function is the number of bytes required to
@@ -162,20 +162,24 @@ The
162.Fa index 162.Fa index
163is the location in the routing header from which the application wants 163is the location in the routing header from which the application wants
164to retrieve an address. 164to retrieve an address.
165The 165The
166.Fa index 166.Fa index
167parameter must have a value between 0 and one less than the number of 167parameter must have a value between 0 and one less than the number of
168segments present in the routing header. 168segments present in the routing header.
169The 169The
170.Fn inet6_rth_segments 170.Fn inet6_rth_segments
171function, described in the last section, should be used to determine 171function, described in the last section, should be used to determine
172the total number of segments in the routing header. 172the total number of segments in the routing header.
173The 173The
174.Fn inet6_rth_getaddr 174.Fn inet6_rth_getaddr
175function returns a pointer to an IPv6 address on success or 175function returns a pointer to an IPv6 address on success or
176.Dv NULL 176.Dv NULL
177when an error has occurred. 177when an error has occurred.
178.\" 178.\"
179.Sh EXAMPLES
180RFC 3542 gives extensive examples in Section 21, Appendix B.
181KAME also provides examples in the advapitest directory of its kit.
182.\"
179.Sh DIAGNOSTICS 183.Sh DIAGNOSTICS
180The 184The
181.Fn inet6_rth_space 185.Fn inet6_rth_space
@@ -194,11 +198,6 @@ and
194.Fn inet6_rth_reverse 198.Fn inet6_rth_reverse
195functions return 0 on success, or \-1 upon an error. 199functions return 0 on success, or \-1 upon an error.
196.\" 200.\"
197.Sh EXAMPLES
198RFC 3542 gives extensive examples in Section 21, Appendix B.
199.Pp
200KAME also provides examples in the advapitest directory of its kit.
201.\"
202.Sh SEE ALSO 201.Sh SEE ALSO
203.Rs 202.Rs
204.%A W. Stevens 203.%A W. Stevens
@@ -213,7 +212,7 @@ KAME also provides examples in the advapitest directory of its kit.
213.%A S. Deering 212.%A S. Deering
214.%A R. Hinden 213.%A R. Hinden
215.%T "Internet Protocol, Version 6 (IPv6) Specification" 214.%T "Internet Protocol, Version 6 (IPv6) Specification"
216.%N RFC2460 215.%N RFC 2460
217.%D December 1998 216.%D December 1998
218.Re 217.Re
219.Sh HISTORY 218.Sh HISTORY