diff options
author | jmc <> | 2005-01-06 11:08:47 +0000 |
---|---|---|
committer | jmc <> | 2005-01-06 11:08:47 +0000 |
commit | 590da20c32e4165b6ddc6ac23aef7c3cbef1c4ba (patch) | |
tree | ccf1b99dbfb389d26b48a020d7ce0af5dbccf150 | |
parent | d6b9d99ff5795be0a1a1073b97e3e4a2a876ca69 (diff) | |
download | openbsd-590da20c32e4165b6ddc6ac23aef7c3cbef1c4ba.tar.gz openbsd-590da20c32e4165b6ddc6ac23aef7c3cbef1c4ba.tar.bz2 openbsd-590da20c32e4165b6ddc6ac23aef7c3cbef1c4ba.zip |
tweaks;
-rw-r--r-- | src/lib/libc/net/inet6_rthdr_space.3 | 34 |
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 | |||
78 | eight functions are split into two groups, the first of which builds | 76 | eight functions are split into two groups, the first of which builds |
79 | the header and the second of which can parse it. | 77 | the header and the second of which can parse it. |
80 | The function prototypes for these functions are all in the | 78 | The function prototypes for these functions are all in the |
81 | .In netinet/in.h | 79 | .Aq Pa netinet/in.h |
82 | header. | 80 | header. |
83 | Although direct manipulation of a routing header is possible | 81 | Although direct manipulation of a routing header is possible, |
84 | this set of APIs make it unnecessary and such direct manipulation | 82 | this set of APIs make it unnecessary and such direct manipulation |
85 | should be avoided so that changes to the underlying structures do not | 83 | should be avoided so that changes to the underlying structures do not |
86 | break applications. | 84 | break applications. |
@@ -193,18 +191,18 @@ must be called once. | |||
193 | .Ss inet6_rthdr_reverse | 191 | .Ss inet6_rthdr_reverse |
194 | This function was never implemented. | 192 | This function was never implemented. |
195 | .Pp | 193 | .Pp |
196 | The following four functions provide an API for parsing a received | 194 | The following three functions provide an API for parsing a received |
197 | routing header. | 195 | routing header: |
198 | .\" | 196 | .\" |
199 | .Ss inet6_rthdr_segments | 197 | .Ss inet6_rthdr_segments |
200 | The | 198 | The |
201 | .Fn inet6_rthdr_segments | 199 | .Fn inet6_rthdr_segments |
202 | function returns the number of segments contained in the Routing | 200 | function returns the number of segments contained in the routing |
203 | header pointed to by the | 201 | header pointed to by the |
204 | .Fa cmsg | 202 | .Fa cmsg |
205 | argument. | 203 | argument. |
206 | On success the return value is from 1 to 23. | 204 | On success the return value is from 1 to 23. |
207 | When an error occurs \-1 is returned. | 205 | When an error occurs, \-1 is returned. |
208 | .\" | 206 | .\" |
209 | .Ss inet6_rthdr_getaddr | 207 | .Ss inet6_rthdr_getaddr |
210 | The | 208 | The |
@@ -220,7 +218,7 @@ An application must call | |||
220 | .Fn inet6_rthdr_segments | 218 | .Fn inet6_rthdr_segments |
221 | to obtain the number of segments in the routing header. | 219 | to obtain the number of segments in the routing header. |
222 | .Pp | 220 | .Pp |
223 | If an error occurs the | 221 | If an error occurs, |
224 | .Dv NULL | 222 | .Dv NULL |
225 | is returned. | 223 | is returned. |
226 | .\" | 224 | .\" |
@@ -242,10 +240,13 @@ or | |||
242 | indicating whether loose or strict source routing was requested for | 240 | indicating whether loose or strict source routing was requested for |
243 | that segment. | 241 | that segment. |
244 | .Pp | 242 | .Pp |
245 | When an error occurs \-1 is returned. | 243 | When an error occurs, \-1 is returned. |
246 | .Pp | 244 | .Pp |
247 | Note: Flags begin at index 0 while segments begin at index 1, to | 245 | Note: Flags begin at index 0 while segments begin at index 1, to |
248 | maintain consistency with the terminology and figures in RFC2460. | 246 | maintain consistency with the terminology and figures in RFC 2460. |
247 | .\" | ||
248 | .Sh EXAMPLES | ||
249 | RFC 2292 gives comprehensive examples in chapter 8. | ||
249 | .\" | 250 | .\" |
250 | .Sh DIAGNOSTICS | 251 | .Sh DIAGNOSTICS |
251 | The | 252 | The |
@@ -270,24 +271,21 @@ The | |||
270 | .Fn inet6_rthdr_segments | 271 | .Fn inet6_rthdr_segments |
271 | and | 272 | and |
272 | .Fn inet6_rthdr_getflags | 273 | .Fn inet6_rthdr_getflags |
273 | functions return -1 on error. | 274 | functions return \-1 on error. |
274 | .\" | ||
275 | .Sh EXAMPLES | ||
276 | RFC2292 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 | .\" |