summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorjmc <>2005-01-06 11:08:47 +0000
committerjmc <>2005-01-06 11:08:47 +0000
commit590da20c32e4165b6ddc6ac23aef7c3cbef1c4ba (patch)
treeccf1b99dbfb389d26b48a020d7ce0af5dbccf150
parentd6b9d99ff5795be0a1a1073b97e3e4a2a876ca69 (diff)
downloadopenbsd-590da20c32e4165b6ddc6ac23aef7c3cbef1c4ba.tar.gz
openbsd-590da20c32e4165b6ddc6ac23aef7c3cbef1c4ba.tar.bz2
openbsd-590da20c32e4165b6ddc6ac23aef7c3cbef1c4ba.zip
tweaks;
-rw-r--r--src/lib/libc/net/inet6_rthdr_space.334
1 files changed, 16 insertions, 18 deletions
diff --git a/src/lib/libc/net/inet6_rthdr_space.3 b/src/lib/libc/net/inet6_rthdr_space.3
index 77dbd64e3c..4474228be0 100644
--- a/src/lib/libc/net/inet6_rthdr_space.3
+++ b/src/lib/libc/net/inet6_rthdr_space.3
@@ -1,4 +1,4 @@
1.\" $OpenBSD: inet6_rthdr_space.3,v 1.15 2005/01/06 03:50:46 itojun Exp $ 1.\" $OpenBSD: inet6_rthdr_space.3,v 1.16 2005/01/06 11:08:47 jmc Exp $
2.\" $KAME: inet6_rthdr_space.3,v 1.11 2005/01/05 03:00:44 itojun Exp $ 2.\" $KAME: inet6_rthdr_space.3,v 1.11 2005/01/05 03:00:44 itojun Exp $
3.\" 3.\"
4.\" Copyright (C) 2004 WIDE Project. 4.\" Copyright (C) 2004 WIDE Project.
@@ -43,8 +43,6 @@
43.Nm inet6_rthdr_getflags 43.Nm inet6_rthdr_getflags
44.Nd IPv6 Routing Header Options Manipulation 44.Nd IPv6 Routing Header Options Manipulation
45.\" 45.\"
46.Sh LIBRARY
47.Lb libc
48.Sh SYNOPSIS 46.Sh SYNOPSIS
49.In sys/types.h 47.In sys/types.h
50.In netinet/in.h 48.In netinet/in.h
@@ -78,9 +76,9 @@ The
78eight functions are split into two groups, the first of which builds 76eight functions are split into two groups, the first of which builds
79the header and the second of which can parse it. 77the header and the second of which can parse it.
80The function prototypes for these functions are all in the 78The function prototypes for these functions are all in the
81.In netinet/in.h 79.Aq Pa netinet/in.h
82header. 80header.
83Although direct manipulation of a routing header is possible 81Although direct manipulation of a routing header is possible,
84this set of APIs make it unnecessary and such direct manipulation 82this set of APIs make it unnecessary and such direct manipulation
85should be avoided so that changes to the underlying structures do not 83should be avoided so that changes to the underlying structures do not
86break applications. 84break applications.
@@ -193,18 +191,18 @@ must be called once.
193.Ss inet6_rthdr_reverse 191.Ss inet6_rthdr_reverse
194This function was never implemented. 192This function was never implemented.
195.Pp 193.Pp
196The following four functions provide an API for parsing a received 194The following three functions provide an API for parsing a received
197routing header. 195routing header:
198.\" 196.\"
199.Ss inet6_rthdr_segments 197.Ss inet6_rthdr_segments
200The 198The
201.Fn inet6_rthdr_segments 199.Fn inet6_rthdr_segments
202function returns the number of segments contained in the Routing 200function returns the number of segments contained in the routing
203header pointed to by the 201header pointed to by the
204.Fa cmsg 202.Fa cmsg
205argument. 203argument.
206On success the return value is from 1 to 23. 204On success the return value is from 1 to 23.
207When an error occurs \-1 is returned. 205When an error occurs, \-1 is returned.
208.\" 206.\"
209.Ss inet6_rthdr_getaddr 207.Ss inet6_rthdr_getaddr
210The 208The
@@ -220,7 +218,7 @@ An application must call
220.Fn inet6_rthdr_segments 218.Fn inet6_rthdr_segments
221to obtain the number of segments in the routing header. 219to obtain the number of segments in the routing header.
222.Pp 220.Pp
223If an error occurs the 221If an error occurs,
224.Dv NULL 222.Dv NULL
225is returned. 223is returned.
226.\" 224.\"
@@ -242,10 +240,13 @@ or
242indicating whether loose or strict source routing was requested for 240indicating whether loose or strict source routing was requested for
243that segment. 241that segment.
244.Pp 242.Pp
245When an error occurs \-1 is returned. 243When an error occurs, \-1 is returned.
246.Pp 244.Pp
247Note: Flags begin at index 0 while segments begin at index 1, to 245Note: Flags begin at index 0 while segments begin at index 1, to
248maintain consistency with the terminology and figures in RFC2460. 246maintain consistency with the terminology and figures in RFC 2460.
247.\"
248.Sh EXAMPLES
249RFC 2292 gives comprehensive examples in chapter 8.
249.\" 250.\"
250.Sh DIAGNOSTICS 251.Sh DIAGNOSTICS
251The 252The
@@ -270,24 +271,21 @@ The
270.Fn inet6_rthdr_segments 271.Fn inet6_rthdr_segments
271and 272and
272.Fn inet6_rthdr_getflags 273.Fn inet6_rthdr_getflags
273functions return -1 on error. 274functions return \-1 on error.
274.\"
275.Sh EXAMPLES
276RFC2292 gives comprehensive examples in chapter 8.
277.\" 275.\"
278.Sh SEE ALSO 276.Sh SEE ALSO
279.Rs 277.Rs
280.%A W. Stevens 278.%A W. Stevens
281.%A M. Thomas 279.%A M. Thomas
282.%T "Advanced Sockets API for IPv6" 280.%T "Advanced Sockets API for IPv6"
283.%N RFC2292 281.%N RFC 2292
284.%D February 1998 282.%D February 1998
285.Re 283.Re
286.Rs 284.Rs
287.%A S. Deering 285.%A S. Deering
288.%A R. Hinden 286.%A R. Hinden
289.%T "Internet Protocol, Version 6 (IPv6) Specification" 287.%T "Internet Protocol, Version 6 (IPv6) Specification"
290.%N RFC2460 288.%N RFC 2460
291.%D December 1998 289.%D December 1998
292.Re 290.Re
293.\" 291.\"