summaryrefslogtreecommitdiffstats
path: root/share/man/man4/faith.4
diff options
context:
space:
mode:
Diffstat (limited to 'share/man/man4/faith.4')
-rw-r--r--share/man/man4/faith.475
1 files changed, 35 insertions, 40 deletions
diff --git a/share/man/man4/faith.4 b/share/man/man4/faith.4
index 4ecc609..c87563c 100644
--- a/share/man/man4/faith.4
+++ b/share/man/man4/faith.4
@@ -1,3 +1,5 @@
+.\" $KAME: faith.4,v 1.9 2001/04/27 17:26:35 itojun Exp $
+.\"
.\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
.\" All rights reserved.
.\"
@@ -25,7 +27,6 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $Id: faith.4,v 1.1.1.1 1999/08/08 23:30:37 itojun Exp $
.\" $FreeBSD$
.\"
.Dd April 10, 1999
@@ -33,33 +34,31 @@
.Os
.Sh NAME
.Nm faith
-.Nd
-.Tn IPv6-to-IPv4 TCP
-relay capturing interface
+.Nd IPv6-to-IPv4 TCP relay capturing interface
.Sh SYNOPSIS
-.Cd "device faith 1"
+.Cd "device faith" Op Ar count
.Sh DESCRIPTION
The
.Nm
-interface captures IPv6 TCP traffic
-for implementing userland IPv6-to-IPv4 TCP relays
+interface captures IPv6 TCP traffic,
+for implementing userland IPv6-to-IPv4 TCP relay
like
.Xr faithd 8 .
.Pp
-Special action will be taken when IPv6 TCP traffic is seen on a router
-and the routing table suggests to route it to the
+Special action will be taken when IPv6 TCP traffic is seen on a router,
+and routing table suggests to route it to
.Nm
interface.
-In this case the packet will be accepted by the router,
-regardless of the list of IPv6 interface addresses assigned to the router.
-The packet will be captured by an IPv6 TCP socket if it has the
+In this case, the packet will be accepted by the router,
+regardless of list of IPv6 interface addresses assigned to the router.
+The packet will be captured by an IPv6 TCP socket, if it has
.Dv IN6P_FAITH
flag turned on and it has matching address/port pairs.
-As a result,
+In result,
.Nm
-will let you divert IPv6 TCP traffic to some specific destination addresses.
+will let you capture IPv6 TCP traffic to some specific destination addresses.
Userland programs, such as
-.Xr faithd 8 ,
+.Xr faithd 8
can use this behavior to relay IPv6 TCP traffic to IPv4 TCP traffic.
The program can accept some specific IPv6 TCP traffic, perform
.Xr getsockname 2
@@ -68,33 +67,29 @@ and perform application-specific address mapping to relay IPv6 TCP to IPv4 TCP.
.Pp
The
.Dv IN6P_FAITH
-flag on an IPv6 TCP socket can be set by using
+flag on IPv6 TCP socket can be set by using
.Xr setsockopt 2 ,
-with
-.Fa level
-set to
+with level equals to
.Dv IPPROTO_IPV6
-and
-.Fa optname
-set to
+and optname equals to
.Dv IPv6_FAITH .
.Pp
-To handle error reports by ICMPv6 some of the ICMPv6 packets routed to the
+To handle error reports by ICMPv6, some of ICMPv6 packets routed to
.Nm
-interface will need be delivered to IPv6 TCP as well.
+interface will be delivered to IPv6 TCP, as well.
.Pp
To understand how
.Nm
-can be used take a look at the source code of
+can be used, take a look at source code of
.Xr faithd 8 .
.Pp
-As the
+As
.Nm
-interface implements potentially dangerous operations,
-great care must be taken when configuring the
+interface implements potentially dangerous operation,
+great care must be taken when configuring
.Nm
interface.
-To avoid possible misuse the
+To avoid possible misuse,
.Xr sysctl 8
variable
.Li net.inet6.ip6.keepfaith
@@ -103,13 +98,12 @@ must be set to
prior to the use of the interface.
When
.Li net.inet6.ip6.keepfaith
-is set to
+is
.Li 0 ,
-no packets will be captured by the
+no packet will be captured by
.Nm
interface.
.Pp
-The
.Nm
interface is intended to be used on routers, not on hosts.
.\"
@@ -117,13 +111,14 @@ interface is intended to be used on routers, not on hosts.
.Xr inet 4 ,
.Xr inet6 4 ,
.Xr faithd 8
-.\" .Rs
-.\" .%A Jun-ichiro itojun Hagino
-.\" .%A Kazu Yamamoto
-.\" .%T ``FAITH'' IPv6-to-IPv4 TCP relay translator
-.\" .%D July 1999
-.\" .Re
-.\"
+.Rs
+.%A Jun-ichiro itojun Hagino
+.%A Kazu Yamamoto
+.%T "An IPv6-to-IPv4 transport relay translator"
+.%R internet draft
+.%N draft-ietf-ngtrans-tcpudp-relay-04.txt
+.%O work in progress material
+.Re
.Sh HISTORY
-The FAITH IPv6-to-IPv4 TCP relay translator first appeared in
+The FAITH IPv6-to-IPv4 TCP relay translator was first appeared in
WIDE hydrangea IPv6 stack.
OpenPOWER on IntegriCloud