From bmah@eisenhower.ca.sandia.gov  Tue Feb 29 14:07:01 2000
Return-Path: <bmah@eisenhower.ca.sandia.gov>
Received: from eisenhower.ca.sandia.gov (eisenhower.ca.sandia.gov [146.246.243.57])
	by hub.freebsd.org (Postfix) with ESMTP id 7F4F637BBEA
	for <FreeBSD-gnats-submit@freebsd.org>; Tue, 29 Feb 2000 14:06:56 -0800 (PST)
	(envelope-from bmah@eisenhower.ca.sandia.gov)
Received: (from bmah@localhost)
	by eisenhower.ca.sandia.gov (8.9.3/8.9.3) id OAA01209;
	Tue, 29 Feb 2000 14:06:38 -0800 (PST)
	(envelope-from bmah)
Message-Id: <200002292206.OAA01209@eisenhower.ca.sandia.gov>
Date: Tue, 29 Feb 2000 14:06:38 -0800 (PST)
From: "Bruce A. Mah" <bmah@eisenhower.ca.sandia.gov>
Reply-To: bmah@eisenhower.ca.sandia.gov
To: FreeBSD-gnats-submit@freebsd.org
Subject: [patch] share/man/man4/inet6.4 fixes
X-Send-Pr-Version: 3.2

>Number:         17082
>Category:       docs
>Synopsis:       [patch] share/man/man4/inet6.4 fixes
>Confidential:   no
>Severity:       critical
>Priority:       medium
>Responsible:    freebsd-doc
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          change-request
>Submitter-Id:   current-users
>Arrival-Date:   Tue Feb 29 14:10:01 PST 2000
>Closed-Date:    Tue Feb 29 18:32:29 PST 2000
>Last-Modified:  Tue Feb 29 18:38:16 PST 2000
>Originator:     Bruce A. Mah
>Release:        FreeBSD 4.0-CURRENT i386
>Organization:
Sandia National Laboratories
>Environment:

	

>Description:

Here are a few fixes for the inet6(4) manpage.  They fix two
problems:

1) Merge some text in from recent KAME distributions concerning
the syntax of scoped addresses.

2) Fix typos and grammatical nitpicks.

>How-To-Repeat:

	

>Fix:

*** inet6.4.orig	Tue Feb 29 13:25:21 2000
--- inet6.4	Tue Feb 29 14:01:01 2000
***************
*** 53,59 ****
  is a collection of protocols layered atop the
  .Em Internet Protocol version 6
  .Pq Tn IPv6
! transport layer, and utilizing the IPv6 address format.
  The
  .Nm
  family provides protocol support for the
--- 53,59 ----
  is a collection of protocols layered atop the
  .Em Internet Protocol version 6
  .Pq Tn IPv6
! network layer, and utilizing the IPv6 address format.
  The
  .Nm
  family provides protocol support for the
***************
*** 66,72 ****
  .Tn IPv6
  protocol.
  .Sh ADDRESSING
! IPv6 addresses are 16 byte quantities, stored in network standard format
  The include file
  .Aq Pa netinet/in.h
  defines this address
--- 66,72 ----
  .Tn IPv6
  protocol.
  .Sh ADDRESSING
! IPv6 addresses are 16 byte quantities, stored in network standard format.
  The include file
  .Aq Pa netinet/in.h
  defines this address
***************
*** 103,148 ****
  .Dq Dv ::
  to mean
  .Dq this host .
  .Dq Dv ::
! can be obtained by setting
  .Dv sin6_addr
! field into 0, or by using the address contained in variable
  .Dv in6addr_any .
  .Pp
! IPv6 defines scoped address such as link-local or site-local address.
  To manipulate link-local addresses properly from the userland,
! programs must use advanced API defined in RFC2292.
! Otherwise, the address is ambiguous to the kernel and error will be generated.
! Scoped address is not for daily use at this moment both from specification
! and implementation point of view.
! Most of normal userland program
  like
  .Xr telnet 1
  or
! .Xr telnetd 8
! cannot handle scoped address properly.
! Only special programs,
! like
  .Xr ping6 8 ,
! supports scoped address.
! For example,
! .Xr ping6 8
! has special option for specifying outgoing interface
  to disambiguate scoped addresses.
  .Pp
  Scoped addresses are handled specially in the kernel.
! Scoped addresses will have its interface index embedded into the address,
! in routing table or interface structure.
  Therefore,
! the address on some of the kernel structure is not the same as that on the wire.
! The embedded index will be visible on
  .Dv PF_ROUTE
! socket and results from
! .Xr ifconfig 8 ,
  HOWEVER, users should never use the embedded form.
! For details please consult
  .Pa IMPLEMENTATION
! supplied with KAME kit.
  .Sh PROTOCOLS
  The
  .Nm
--- 103,163 ----
  .Dq Dv ::
  to mean
  .Dq this host .
+ The address
  .Dq Dv ::
! can be obtained by setting the
  .Dv sin6_addr
! field to 0, or by using the address contained in the variable
  .Dv in6addr_any .
  .Pp
! IPv6 defines scoped addresses such as link-local or site-local addresses.
  To manipulate link-local addresses properly from the userland,
! programs must use the advanced API defined in RFC2292.
! Otherwise, the address is ambiguous to the kernel and 
! an error will be generated.
! Scoped addressing is not for daily use at this time, and is discouraged
! both by the specifications and specific implementations.
! .Pp
! FreeBSD's IPv6 implementation supports extended numeric IPv6 address 
! notation for link-local addresses,
  like
+ .Dq Li fe80::1%de0
+ to specify
+ .Do
+ .Li fe80::1
+ on the
+ .Li de0
+ interface
+ .Dc .
+ This notation is supported by
+ .Xr getaddrinfo 3
+ and
+ .Xr getnameinfo 3 .
+ Some of the normal userland programs, such as
  .Xr telnet 1
  or
! .Xr ftp 8 ,
! are able to use this notation.
! With some special programs such as
  .Xr ping6 8 ,
! you can specify an outgoing interface by an extra command line option
  to disambiguate scoped addresses.
  .Pp
  Scoped addresses are handled specially in the kernel.
! Scoped addresses will have their interface indices embedded into the address,
! in the routing table or interface structures.
  Therefore,
! a scoped address may have a different representation in the kernel
! than on the wire.
! The embedded index will be visible in
  .Dv PF_ROUTE
! sockets, kernel memory accesses via
! .Xr kvm 3
! and some other occasions.
  HOWEVER, users should never use the embedded form.
! For details, please consult
  .Pa IMPLEMENTATION
! supplied with the KAME kit.
  .Sh PROTOCOLS
  The
  .Nm
***************
*** 283,287 ****
  .Sh HISTORY
  The
  .Nm
! protocol interface are defined in RFC2553 and RFC2292.
  The implementation described herein appeared in WIDE/KAME project.
--- 298,302 ----
  .Sh HISTORY
  The
  .Nm
! IPv6 APIs are defined in RFC2553 and RFC2292.
  The implementation described herein appeared in WIDE/KAME project.

>Release-Note:
>Audit-Trail:
State-Changed-From-To: open->closed 
State-Changed-By: gsutter 
State-Changed-When: Tue Feb 29 18:32:29 PST 2000 
State-Changed-Why:  
Committed.  Thanks! 
>Unformatted:
