Markup and grammar fixes.
This commit is contained in:
parent
b88146f4a2
commit
f572fc8ccb
@ -1,5 +1,4 @@
|
|||||||
.\" $KAME: inet6_opt_init.3,v 1.7 2004/12/27 05:08:23 itojun Exp $
|
.\" $KAME: inet6_opt_init.3,v 1.7 2004/12/27 05:08:23 itojun Exp $
|
||||||
.\" $FreeBSD$
|
|
||||||
.\"
|
.\"
|
||||||
.\" Copyright (C) 2004 WIDE Project.
|
.\" Copyright (C) 2004 WIDE Project.
|
||||||
.\" All rights reserved.
|
.\" All rights reserved.
|
||||||
@ -28,6 +27,8 @@
|
|||||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||||
.\" SUCH DAMAGE.
|
.\" SUCH DAMAGE.
|
||||||
.\"
|
.\"
|
||||||
|
.\" $FreeBSD$
|
||||||
|
.\"
|
||||||
.Dd December 23, 2004
|
.Dd December 23, 2004
|
||||||
.Dt INET6_OPT_INIT 3
|
.Dt INET6_OPT_INIT 3
|
||||||
.Os
|
.Os
|
||||||
@ -63,7 +64,7 @@
|
|||||||
Building and parsing the Hop-by-Hop and Destination options is
|
Building and parsing the Hop-by-Hop and Destination options is
|
||||||
complicated.
|
complicated.
|
||||||
The advanced sockets API defines a set of functions to
|
The advanced sockets API defines a set of functions to
|
||||||
help applications create and manipulate Hop-by-Hope and Destination
|
help applications create and manipulate Hop-by-Hop and Destination
|
||||||
options.
|
options.
|
||||||
This man page describes the functions specified in
|
This man page describes the functions specified in
|
||||||
IETF Draft RFC3542.
|
IETF Draft RFC3542.
|
||||||
@ -82,13 +83,14 @@ function
|
|||||||
returns the number of bytes needed for an empty
|
returns the number of bytes needed for an empty
|
||||||
extension header, one without any options.
|
extension header, one without any options.
|
||||||
If the
|
If the
|
||||||
.Va extbuf
|
.Fa extbuf
|
||||||
argument points to a valid section of memory
|
argument points to a valid section of memory
|
||||||
then the
|
then the
|
||||||
.Fn inet6_opt_init
|
.Fn inet6_opt_init
|
||||||
function also initializes the extension header's length field.
|
function also initializes the extension header's length field.
|
||||||
When attempting to initialize an extension buffer passed in the
|
When attempting to initialize an extension buffer passed in the
|
||||||
.Va extbuf argument
|
.Fa extbuf
|
||||||
|
argument,
|
||||||
.Fa extlen
|
.Fa extlen
|
||||||
must be a positive multiple of 8 or else the function fails and
|
must be a positive multiple of 8 or else the function fails and
|
||||||
returns \-1 to the caller.
|
returns \-1 to the caller.
|
||||||
@ -96,7 +98,7 @@ returns \-1 to the caller.
|
|||||||
.Ss inet6_opt_append
|
.Ss inet6_opt_append
|
||||||
The
|
The
|
||||||
.Fn inet6_opt_append
|
.Fn inet6_opt_append
|
||||||
function can perform to different jobs.
|
function can perform two different jobs.
|
||||||
When a valid
|
When a valid
|
||||||
.Fa extbuf
|
.Fa extbuf
|
||||||
argument is supplied it appends an option to the extension buffer and
|
argument is supplied it appends an option to the extension buffer and
|
||||||
@ -109,7 +111,8 @@ of
|
|||||||
is
|
is
|
||||||
.Dv NULL
|
.Dv NULL
|
||||||
then the
|
then the
|
||||||
.Fn inet6_opt_append function only reports what the total length would
|
.Fn inet6_opt_append
|
||||||
|
function only reports what the total length would
|
||||||
be if the option were actually appended.
|
be if the option were actually appended.
|
||||||
The
|
The
|
||||||
.Fa len
|
.Fa len
|
||||||
@ -156,11 +159,12 @@ parameter must have a value of 1, 2, 4, or 8 and cannot exceed the
|
|||||||
value of
|
value of
|
||||||
.Fa len .
|
.Fa len .
|
||||||
The alignment values represent no alignment, 16 bit, 32 bit and 64 bit
|
The alignment values represent no alignment, 16 bit, 32 bit and 64 bit
|
||||||
alignments respectively.
|
alignments, respectively.
|
||||||
.\"
|
.\"
|
||||||
.Ss inet6_opt_finish
|
.Ss inet6_opt_finish
|
||||||
The
|
The
|
||||||
.Fn inet6_opt_finish
|
.Fn inet6_opt_finish
|
||||||
|
function
|
||||||
calculates the final padding necessary to make the extension header a
|
calculates the final padding necessary to make the extension header a
|
||||||
multiple of 8 bytes, as required by the IPv6 extension header
|
multiple of 8 bytes, as required by the IPv6 extension header
|
||||||
specification, and returns the extension header's updated total
|
specification, and returns the extension header's updated total
|
||||||
@ -191,7 +195,8 @@ The
|
|||||||
argument is a pointer to memory that was returned by the
|
argument is a pointer to memory that was returned by the
|
||||||
.Fn inet6_opt_append
|
.Fn inet6_opt_append
|
||||||
call and the
|
call and the
|
||||||
.Fa offset argument specifies where the option should be placed in the
|
.Fa offset
|
||||||
|
argument specifies where the option should be placed in the
|
||||||
data buffer.
|
data buffer.
|
||||||
The
|
The
|
||||||
.Fa val
|
.Fa val
|
||||||
@ -231,14 +236,12 @@ extension buffer.
|
|||||||
The option is returned in the arguments
|
The option is returned in the arguments
|
||||||
.Fa typep , lenp ,
|
.Fa typep , lenp ,
|
||||||
and
|
and
|
||||||
.Fa databufp .
|
.Fa databufp ,
|
||||||
.Fa typep, lenp,
|
which
|
||||||
and
|
|
||||||
.Fa databufp
|
|
||||||
point to the 8-bit option type, the 8-bit option length and the option
|
point to the 8-bit option type, the 8-bit option length and the option
|
||||||
data respectively.
|
data, respectively.
|
||||||
This function does not return any PAD1 or PADN options.
|
This function does not return any PAD1 or PADN options.
|
||||||
When an error occurs or there are no more options the return
|
When an error occurs or there are no more options, the return
|
||||||
value is \-1.
|
value is \-1.
|
||||||
.\"
|
.\"
|
||||||
.Ss inet6_opt_find
|
.Ss inet6_opt_find
|
||||||
@ -252,11 +255,13 @@ If the option is found then the
|
|||||||
.Fa lenp
|
.Fa lenp
|
||||||
and
|
and
|
||||||
.Fa databufp
|
.Fa databufp
|
||||||
arguments are updated to point to the option's length and data
|
arguments are updated to point to the option's length and data,
|
||||||
respectively.
|
respectively.
|
||||||
|
The
|
||||||
.Fa extbuf
|
.Fa extbuf
|
||||||
and
|
and
|
||||||
.Fa extlen
|
.Fa extlen
|
||||||
|
arguments
|
||||||
must point to a valid extension buffer and give its length.
|
must point to a valid extension buffer and give its length.
|
||||||
The
|
The
|
||||||
.Fa offset
|
.Fa offset
|
||||||
@ -294,7 +299,7 @@ by calculating
|
|||||||
which can be used when extracting option content with multiple fields.
|
which can be used when extracting option content with multiple fields.
|
||||||
Robust receivers must verify alignment before calling this function.
|
Robust receivers must verify alignment before calling this function.
|
||||||
.\"
|
.\"
|
||||||
.Sh DIAGNOSTICS
|
.Sh RETURN VALUES
|
||||||
All the functions return
|
All the functions return
|
||||||
\-1
|
\-1
|
||||||
on an error.
|
on an error.
|
||||||
@ -323,10 +328,10 @@ directory of its kit.
|
|||||||
.%N RFC2460
|
.%N RFC2460
|
||||||
.%D December 1998
|
.%D December 1998
|
||||||
.Re
|
.Re
|
||||||
.Sh HISTORY
|
|
||||||
The implementation first appeared in KAME advanced networking kit.
|
|
||||||
.Sh STANDARDS
|
.Sh STANDARDS
|
||||||
The functions are documented in
|
The functions are documented in
|
||||||
.Dq Advanced Sockets API for IPv6
|
.Dq Advanced Sockets API for IPv6
|
||||||
.Pq RFC3542 .
|
.Pq RFC3542 .
|
||||||
.\"
|
.\"
|
||||||
|
.Sh HISTORY
|
||||||
|
The implementation first appeared in KAME advanced networking kit.
|
||||||
|
@ -1,5 +1,4 @@
|
|||||||
.\" $KAME: inet6_option_space.3,v 1.11 2005/01/05 03:00:44 itojun Exp $
|
.\" $KAME: inet6_option_space.3,v 1.11 2005/01/05 03:00:44 itojun Exp $
|
||||||
.\" $FreeBSD$
|
|
||||||
.\"
|
.\"
|
||||||
.\" Copyright (C) 2004 WIDE Project.
|
.\" Copyright (C) 2004 WIDE Project.
|
||||||
.\" All rights reserved.
|
.\" All rights reserved.
|
||||||
@ -28,6 +27,8 @@
|
|||||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||||
.\" SUCH DAMAGE.
|
.\" SUCH DAMAGE.
|
||||||
.\"
|
.\"
|
||||||
|
.\" $FreeBSD$
|
||||||
|
.\"
|
||||||
.Dd January 24, 2005
|
.Dd January 24, 2005
|
||||||
.Dt INET6_OPTION_SPACE 3
|
.Dt INET6_OPTION_SPACE 3
|
||||||
.Os
|
.Os
|
||||||
@ -45,9 +46,9 @@
|
|||||||
The functions that were documented in this manual page are now
|
The functions that were documented in this manual page are now
|
||||||
deprecated in favor of those described in
|
deprecated in favor of those described in
|
||||||
.Xr inet6_opt_init 3 .
|
.Xr inet6_opt_init 3 .
|
||||||
Please refer to that manual page for information on how to manipulate
|
Please refer to that manual page for information on how to manipulate
|
||||||
IPv6 Hop-by-Hop and Destination options.
|
IPv6 Hop-by-Hop and Destination options.
|
||||||
.Sh SEE ALSO
|
.Sh SEE ALSO
|
||||||
.Xr inet6_opt_init 3 ,
|
.Xr inet6_opt_init 3
|
||||||
.\"
|
.\"
|
||||||
.\"
|
.\"
|
||||||
|
@ -1,5 +1,4 @@
|
|||||||
.\" $KAME: inet6_rthdr_space.3,v 1.11 2005/01/05 03:00:44 itojun Exp $
|
.\" $KAME: inet6_rthdr_space.3,v 1.11 2005/01/05 03:00:44 itojun Exp $
|
||||||
.\" $FreeBSD$
|
|
||||||
.\"
|
.\"
|
||||||
.\" Copyright (C) 2004 WIDE Project.
|
.\" Copyright (C) 2004 WIDE Project.
|
||||||
.\" All rights reserved.
|
.\" All rights reserved.
|
||||||
@ -28,6 +27,8 @@
|
|||||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||||
.\" SUCH DAMAGE.
|
.\" SUCH DAMAGE.
|
||||||
.\"
|
.\"
|
||||||
|
.\" $FreeBSD$
|
||||||
|
.\"
|
||||||
.Dd January 24, 2005
|
.Dd January 24, 2005
|
||||||
.Dt INET6_RTHDR_SPACE 3
|
.Dt INET6_RTHDR_SPACE 3
|
||||||
.Os
|
.Os
|
||||||
@ -48,7 +49,8 @@ The RFC 2292 IPv6 Advanced API has been deprecated in favor of the
|
|||||||
newer, RFC 3542 APIs documented in
|
newer, RFC 3542 APIs documented in
|
||||||
.Xr inet6_rth_space 3 .
|
.Xr inet6_rth_space 3 .
|
||||||
On platforms that support it, currently only
|
On platforms that support it, currently only
|
||||||
FreeBSD, please use the newer API to manipulate routing header
|
.Fx ,
|
||||||
|
please use the newer API to manipulate routing header
|
||||||
options.
|
options.
|
||||||
.\"
|
.\"
|
||||||
.Sh SEE ALSO
|
.Sh SEE ALSO
|
||||||
|
Loading…
Reference in New Issue
Block a user