From owner-man-jp-reviewer@jp.freebsd.org  Sat Dec 25 16:08:14 1999
Received: (from daemon@localhost)
	by castle.jp.freebsd.org (8.9.3+3.2W/8.7.3) id QAA80283;
	Sat, 25 Dec 1999 16:08:14 +0900 (JST)
	(envelope-from owner-man-jp-reviewer@jp.FreeBSD.org)
Received: from multi.al.rim.or.jp (multi.al.rim.or.jp [202.247.191.252] (may be forged))
	by castle.jp.freebsd.org (8.9.3+3.2W/8.7.3) with ESMTP id QAA80278
	for <man-jp-reviewer@jp.freebsd.org>; Sat, 25 Dec 1999 16:08:13 +0900 (JST)
	(envelope-from k-horik@yk.rim.or.jp)
Received: from mail-relay.rim.or.jp by multi.al.rim.or.jp (8.8.8/3.7W/HMX-12) with ESMTP id QAA10148 for <man-jp-reviewer@jp.freebsd.org>; Sat, 25 Dec 1999 16:08:13 +0900 (JST)
Received: from localhost (pppa22.yk.rim.or.jp [202.247.186.22]) by mail-relay.rim.or.jp (3.7W/HMX-12) id QAA11300 for <man-jp-reviewer@jp.freebsd.org>; Sat, 25 Dec 1999 16:08:11 +0900 (JST)
To: man-jp-reviewer@jp.freebsd.org
In-Reply-To: Your message of "Fri, 24 Dec 1999 21:24:15 -0500"
	<0FN900CODYEWGA@mail.ocs.drexel.edu>
References: <0FN900CODYEWGA@mail.ocs.drexel.edu>
X-Mailer: Mew version 1.93 on Emacs 19.34 / Mule 2.3 (SUETSUMUHANA)
Mime-Version: 1.0
Content-Type: Text/Plain; charset=iso-2022-jp
Content-Transfer-Encoding: 7bit
Message-Id: <19991225160732N.k-horik@yk.rim.or.jp>
Date: Sat, 25 Dec 1999 16:07:32 +0900
From: Kazuo Horikawa <k-horik@yk.rim.or.jp>
X-Dispatcher: imput version 980905(IM100)
Lines: 283
Reply-To: man-jp-reviewer@jp.freebsd.org
Precedence: list
X-Distribute: distribute version 2.1 (Alpha) patchlevel 24e+990727
X-Sequence: man-jp-reviewer 1858
Subject: [man-jp-reviewer 1858] Re: ng_vjc.8
Errors-To: owner-man-jp-reviewer@jp.freebsd.org
Sender: owner-man-jp-reviewer@jp.freebsd.org
X-Originator: k-horik@yk.rim.or.jp

 $BKY@n$G$9!#(B
 ng_vjc.8 $B$N:FDs=P$G$9!#(B

--- ng_vjc.8.eng	Thu Dec 23 23:27:39 1999
+++ ng_vjc.8	Sat Dec 25 15:29:12 1999
@@ -32,170 +32,171 @@
 .\" 
 .\" Author: Archie Cobbs <archie@whistle.com>
 .\"
-.\" $FreeBSD: src/sys/modules/netgraph/vjc/ng_vjc.8,v 1.5.2.3 1999/12/08 19:44:14 julian Exp $
+.\" $FreeBSD: src/sys/modules/netgraph/vjc/ng_vjc.8,v 1.5.2.1 1999/11/17 07:24:00 julian Exp $
 .\" $Whistle: ng_vjc.8,v 1.4 1999/01/25 23:46:28 archie Exp $
 .\"
+.\" jpman %Id: ng_vjc.8,v 0.0 1999/11/28 13:24:13 horikawa Stab %
 .Dd January 19, 1999
 .Dt NG_VJC 8
 .Os FreeBSD 4.0
-.Sh NAME
+.Sh $BL>>N(B
 .Nm ng_vjc
-.Nd Van Jacobsen compression netgraph node type
-.Sh SYNOPSIS
+.Nd Van Jacobsen $B05=L(B netgraph $B%N!<%I%?%$%W(B
+.Sh $B=q<0(B
 .Fd #include <net/slcompress.h>
 .Fd #include <netgraph/ng_vjc.h>
-.Sh DESCRIPTION
-The
+.Sh $B2r@b(B
 .Nm vjc
-node type performs Van Jacobsen compression, which is used
-over PPP, SLIP, and other point-to-point IP connections to
-compress TCP packet headers.  The
+$B%N!<%I%?%$%W$O!"(BVan Jacobsen $B05=L$r9T$$$^$9!#(B
+$B$3$l$O!"(BPPP $B$d(B SLIP $B$dB>$N(B point-to-point IP $B@\B3$K$*$$$F!"(B
+TCP $B%Q%1%C%H%X%C%@05=L$K;HMQ$5$l$^$9!#(B
 .Dv ip
-hook represents the uncompressed side of the node, while the
+$B%U%C%/$O!"K\%N!<%I$NL$05=LB&$rI=$7!"(B
 .Dv vjcomp ,
 .Dv vjuncomp ,
-and
 .Dv vjip
-hooks represent the compressed side of the node. Packets received on the
+$B%U%C%/$O!"K\%N!<%I$N05=LB&$rI=$7$^$9!#(B
 .Dv ip
-will be compressed or passed through as appropriate. Packets received
-on the other three hooks will be uncompressed as appropriate.
-This node also supports ``always pass through'' mode in either direction.
-.Pp
-Van Jacobsen compression only applies to TCP packets.
-Only ``normal'' (i.e., common case) TCP packets are actually compressed.
-These are output on the
+$B>e$G<u?.$5$l$?%Q%1%C%H$O!"I,MW$K1~$8$F05=L$5$lDL2a$7$^$9!#(B
+$BB>$N(B 3 $B$D$N%U%C%/>e$G<u?.$5$l$?%Q%1%C%H$O!"I,MW$K1~$8$F?-D9$5$l$^$9!"(B
+.Pp
+Van Jacobsen $B05=L$O!"(BTCP $B%Q%1%C%H$KBP$7$F$N$_E,MQ$5$l$^$9!#(B
+$B!VDL>o$N!W(B($B$9$J$o$A0lHL$N(B) TCP $B%Q%1%C%H$N$_$,!"<B:]$K05=L$5$l$^$9!#(B
+$B$3$l$i$O(B
 .Dv vjcomp
-hook. Other TCP packets are run through the state machine but not
-compressed; these appear on the
+$B%U%C%/$+$i=PNO$5$l$^$9!#(B
+$BB>$N(B TCP $B%Q%1%C%H$O!">uBV5!3#$rDL2a$7$^$9$,!"05=L$5$l$^$;$s!#(B
+$B$3$l$i$O(B
 .Dv vjuncomp
-hook.
-Other non-TCP IP packets are forwarded unchanged to
-.Dv vjip .
+$B%U%C%/>e$K8=$l$^$9!#(B
+$BB>$NHs(B TCP IP $B%Q%1%C%H$O!"L5JQ99$G(B
+.Dv vjip
+$B$XE>Aw$5$l$^$9!#(B
 .Pp
-When connecting to a
 .Xr ng_ppp 8
-node, the
+$B%N!<%I$X@\B3$5$l$?$H$-!"(B
 .Dv ip ,
 .Dv vjuncomp ,
 .Dv vjcomp , 
-and
 .Dv vjip
-hooks should be connected to the
+$B%U%C%/$O!"$=$l$>$l(B
 .Xr ng_ppp 8
-node's
+$B%N!<%I$N(B
 .Dv vjc_ip ,
 .Dv vjc_vjcomp ,
 .Dv vjc_vjuncomp ,
-and
 .Dv vjc_ip
-hooks, respectively.
-.Sh HOOKS
-This node type supports the following hooks:
+$B%U%C%/$K@\B3$5$l$k$Y$-$G$9!#(B
+.Sh $B%U%C%/(B
+$BK\%N!<%I%?%$%W$O<!$N%U%C%/$r%5%]!<%H$7$^$9(B:
 .Pp
 .Bl -tag -width foobarbazi
 .It Dv ip
-Upstream (uncompressed) IP packets.
+$B>eN.(B (upstream) $B$N(B ($BHs05=L(B) IP $B%Q%1%C%H!#(B
 .It Dv vjcomp
-Downstream compressed TCP packets.
+$B2<N.(B (downstream) $B$N05=L(B TCP $B%Q%1%C%H!#(B
 .It Dv vjuncomp
-Downstream uncompressed TCP packets.
+$B2<N.(B (downstream) $B$NHs05=L(B TCP $B%Q%1%C%H!#(B
 .It Dv vjip
-Downstream uncompressed IP packets.
-.Sh CONTROL MESSAGES
-This node type supports the generic control messages, plus the following:
+$B2<N.(B (downstream) $B$NHs05=L(B IP $B%Q%1%C%H!#(B
+.Sh $B@)8f%a%C%;!<%8(B
+$BK\%N!<%I%?%$%W$O!"HFMQ@)8f%a%C%;!<%8$r%5%]!<%H$7!"(B
+$B99$K<!$N$b$N$b%5%]!<%H$7$^$9(B:
 .Bl -tag -width foo
 .It Dv NGM_VJC_SET_CONFIG
-This command resets the compression state and configures it according
-to the supplied
+$BK\%3%^%s%I$O!"05=L$N>uBV$r%j%;%C%H$7!";XDj$5$l$?(B
 .Dv "struct ngm_vjc_config"
-argument. This structure contains the following fields:
+$B0z?t$K=>$C$F@_Dj$7$^$9!#(B
+$B$3$N9=B$BN$O!"<!$N%U%#!<%k%I$r4^$_$^$9(B:
 .Bd -literal -offset 4n
 struct ngm_vjc_config {
-  u_char   enableComp;    /* Enable compression */
-  u_char   enableDecomp;  /* Enable decompression */
-  u_char   maxChannel;    /* Number of outgoing channels - 1 */
-  u_char   compressCID;   /* OK to compress outgoing CID's */
+  u_char   enableComp;    /* $B05=L$rM-8z2=$7$^$9(B */
+  u_char   enableDecomp;  /* $B?-D9$rM-8z2=$7$^$9(B */
+  u_char   maxChannel;    /* $B=PNO%A%c%M%k?t(B - 1 */
+  u_char   compressCID;   /* $B=PNO(B CID $B$N05=L$,(B OK */
 };
 .Ed
 .Pp
-When
 .Dv enableComp
-is set to zero, all packets received on the
+$B$,(B 0 $B$K@_Dj$5$l$k$H!"(B
 .Dv ip
-hook are forwarded unchanged out the
+$B%U%C%/>e$G<u?.$5$l$?A4%Q%1%C%H$,!"L5JQ99$G(B
 .Dv vjip
-hook.  Similarly, when
+$B%U%C%/$XE>Aw$5$l$^$9!#(B
+$BF1MM$K!"(B
 .Dv enableDecomp
-is set to zero, all packets received on the
+$B$,(B 0 $B$K@_Dj$5$l$k$H!"(B
 .Dv vjip
-hook are forwarded unchanged out the
+$B%U%C%/>e$G<u?.$5$l$?A4%Q%1%C%H$,L5JQ99$G(B
 .Dv ip
-hook, and packets are not accepted on the
+$B%U%C%/$XE>Aw$5$l!"(B
 .Dv vjcomp
-and
+$B$H(B
 .Dv vjuncomp
-hooks.
-When a node is first created,
-both compression and decompression are disabled and the node is
-therefore operating in bi-directional ``pass through'' mode.
+$B$N%U%C%/>e$G$O%Q%1%C%H$r<u?.$7$^$;$s!#(B
+$B%N!<%I$,:G=i$K:n@.$5$l$?$H$-!"05=L$H?-D9$O6&$KL58z2=$5$l!"(B
+$B$=$l8NK\%N!<%I$OAPJ}8~!VDL2a!W%b!<%I$GF0:n$7$^$9!#(B
 .Pp
-When enabling compression,
+$B05=LM-8z2=;~$K$O!"(B
 .Dv maxChannel
-should be set to the number of outgoing compression channels minus one,
-and is a value between 3 and 15, inclusive. Also, the
+$B$O=PNO05=L%A%c%M%k?t$+$i(B 1 $B$r8:$8$??t$K@_Dj$9$Y$-$G$"$j!"(B
+3 $B0J>e(B 15 $B0J2<$NCM$H$J$j$^$9!#(B
+$B$^$?!"(B
 .Dv compressCID
-field indicates whether it is OK to compress the CID field for
-outgoing compressed TCP packets. This value should be zero unless
-either (a) it is not possible for an incoming frame to be lost, or
-(b) lost frames can be reliably detected and a
+$B%U%#!<%k%I$O!"(B
+$B=PNO05=L(B TCP $B%Q%1%C%H$N(B CID $B%U%#!<%k%I$r05=L$7$F$bNI$$$+$r<($7$^$9!#(B
+(a) $BF~NO%U%l!<%`$NAS<:2DG=@-$,L5$$>l9g$H!"(B
+(b) $BAS<:%U%l!<%`$,9b?.Mj$G8!=P2DG=$G$"$C$F!"AS<:;~$K$OB(:B$K(B
 .Dv NGM_VJC_RECV_ERROR
-message is immediately sent whenever this occurs.
+$B%a%C%;!<%8$,Aw$i$l$k>l9g$r=|$-!"$3$NCM$O(B 0 $B$G$"$k$Y$-$G$9!#(B
 .It Dv NGM_VJC_GET_STATE
-This command returns the node's current state described by the
+$BK\%3%^%s%I$O!"(B
 .Dv "struct slcompress"
-structure, which is defined in
-.Dv "net/slcompress.h" .
+$B9=B$BN$G5-=R$5$l$k!"%N!<%I$N8=:_$N>uBV$rJV$7$^$9!#(B
+$B$3$N9=B$BN$O(B
+.Dv "net/slcompress.h"
+$B$GDj5A$5$l$F$$$^$9!#(B
 .It Dv NGM_VJC_CLR_STATS
-Clears the node statistics counters. Statistics are also cleared whenever the
+$B%N!<%I$NE}7W>pJs%+%&%s%?$r%/%j%"$7$^$9!#(B
+.Dv NGM_VJC_SET_CONFIG
+$B@)8f%a%C%;!<%8$K$h$j(B
 .Dv enableComp
-or
+$B$^$?$O(B
 .Dv enableDecomp
-fields are changed from zero to one by a
-.Dv NGM_VJC_SET_CONFIG
-control message.
+$B$N%U%#!<%k%I$,(B 0 $B$+$i(B 1 $B$KJQ99$5$l$?$H$-$K$b!"E}7W>pJs$O%/%j%"$5$l$^$9!#(B
 .It Dv NGM_VJC_RECV_ERROR
-When the
 .Dv compressCID
-is set to one, this message must be sent to the node immediately
-after detecting that a received frame has been lost, due to a bad
-checksum or for any other reason. Failing to do this can result
-in corrupted TCP stream data.
-.Sh SHUTDOWN
-This node shuts down upon receipt of a
+$B$,(B 1 $B$K@_Dj$5$l$?$H$-!"(B
+$B<u?.%U%l!<%`$NAS<:$r%A%'%C%/%5%`ITNI$dB>$NM}M3$K$h$C$F8!=P$7$?D>8e$K!"(B
+$BK\%a%C%;!<%8$,K\%N!<%I$XAw$i$l$kI,MW$,$"$j$^$9!#(B
+$B$3$NF0:n$r9T$o$J$$$H!"(BTCP $B%9%H%j!<%`%G!<%?$,2u$l$^$9!#(B
+.Sh $B%7%c%C%H%@%&%s(B
+$BK\%N!<%I$O!"(B
 .Dv NGM_SHUTDOWN
-control message, or when all hooks have been disconnected.
-.Sh BUGS
-Because the initialization routine in the kernel implementation of
-Van Jacobsen compression initializes both compression and decompression
-at once, this node does not allow compression and decompression to
-be enabled in separate operations.  In order to enable one when
-the other is already enabled, first both must be disabled, then
-both enabled.  This of course resets the node state.  This restriction
-may be lifted in a later version.
-.Pp
-When built as a loadable kernel module, this module includes the file
-.Dv "net/slcompress.c" .
-Although loading the module should fail if
+$B@)8f%a%C%;!<%8$N<u?.;~$+!"A4%U%C%/$,@ZCG$5$l$?$H$-$K!"%7%c%C%H%@%&%s$7$^$9!#(B
+.Sh $B%P%0(B
+Van Jacobsen $B05=L$N%+!<%M%k<BAu$K$*$1$k=i4|2=%k!<%A%s$,(B
+$B05=L$H?-D9$rN>J}F1;~$K=i4|2=$7$F$7$^$&$?$a!"(B
+$BK\%N!<%I$N05=L$H?-D9$rJL!9$NA`:n$GM-8z2=$G$-$^$;$s!#(B
+$B$b$&0lJ}$,4{$KM-8z2=$5$l$F$$$k$H$-$K0lJ}$rM-8z2=$9$k$K$O!"(B
+$B$^$:N>J}$rL58z2=$7$F$+$i!"N>J}$rM-8z2=$9$kI,MW$,$"$j$^$9!#(B
+$B$3$l$O$b$A$m$s!"%N!<%I$N>uBV$r%j%;%C%H$7$F$7$^$$$^$9!#(B
+$B$3$N@)Ls$O!">-Mh$N%P!<%8%g%s$G2r=|$5$l$k$+$b$7$l$^$;$s!#(B
+.Pp
+$B%m!<%I2DG=%+!<%M%k%b%8%e!<%k$H$7$F;HMQ$9$k$H$-!"(B
+$BK\%N!<%I%?%$%W$O!"%U%!%$%k(B
+.Dv "net/slcompress.c"
+$B$,%+!<%M%k$KAH$_9~$^$l$F$$$k$3$H$rMW5a$7$^$9!#(B
 .Dv "net/slcompress.c"
-already exists in the kernel, currently it does not, and the duplicate
-copies of the file do not interfere.
-However, this may change in the future.
-.Sh SEE ALSO
+$B$,%+!<%M%k$KAH$_9~$_:Q$N>l9g$K$O%b%8%e!<%k$N%m!<%I$O<:GT$9$Y$-$G$9$,!"(B
+$B8=:_$O$=$&$J$C$F$*$i$:!"(B
+$B%U%!%$%k$NJ#@=4V$G$N%$%s%?%U%'!<%9$O9T$o$l$^$;$s!#(B
+$B$7$+$7!"$3$NF0:n$O>-MhJQ99$5$l$k$+$b$7$l$^$;$s!#(B
+.Sh $B4XO"9`L\(B
 .Xr netgraph 4 ,
 .Xr ng_ppp 8 ,
 .Xr ng_iface 8 ,
-.Xr ngctl 8 .
+.Xr ngctl 8
 .Rs
 .%A V. Jacobsen
 .%T "Compressing TCP/IP Headers"
@@ -206,5 +207,5 @@
 .%T "The PPP Internet Control Protocol (IPCP)"
 .%O RFC 1332
 .Re
-.Sh AUTHOR
+.Sh $B:n<T(B
 Archie Cobbs <archie@whistle.com>
