From owner-man-jp-reviewer@jp.freebsd.org  Sun Dec  5 17:24:18 1999
Received: (from daemon@localhost)
	by castle.jp.freebsd.org (8.9.3+3.2W/8.7.3) id RAA20743;
	Sun, 5 Dec 1999 17:24:18 +0900 (JST)
	(envelope-from owner-man-jp-reviewer@jp.FreeBSD.org)
Received: from mail.yk.rim.or.jp (root@mail.yk.rim.or.jp [202.247.130.37])
	by castle.jp.freebsd.org (8.9.3+3.2W/8.7.3) with ESMTP id RAA20738
	for <man-jp-reviewer@jp.freebsd.org>; Sun, 5 Dec 1999 17:24:18 +0900 (JST)
	(envelope-from k-horik@yk.rim.or.jp)
Received: from localhost (pppa13.yk.rim.or.jp [202.247.186.13])
	by mail.yk.rim.or.jp (8.8.8/3.6W-RIMNET-98-06-09) with ESMTP id RAA29487
	for <man-jp-reviewer@jp.freebsd.org>; Sun, 5 Dec 1999 17:24:15 +0900 (JST)
To: man-jp-reviewer@jp.freebsd.org
In-Reply-To: Your message of "Sat, 04 Dec 1999 19:46:32 +0900"
	<19991204194632L.k-horik@yk.rim.or.jp>
References: <19991204194632L.k-horik@yk.rim.or.jp>
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: <19991205172327A.k-horik@yk.rim.or.jp>
Date: Sun, 05 Dec 1999 17:23:27 +0900
From: Kazuo Horikawa <k-horik@yk.rim.or.jp>
X-Dispatcher: imput version 980905(IM100)
Lines: 211
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 1755
Subject: [man-jp-reviewer 1755] Re: ng_async.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

 ng_async.8 $B$r(B 3.3-19991204-STABLE $BBP1~$K$7$^$7$?!#(B

--- ENG/ng_async.8.eng	Sun Dec  5 16:01:39 1999
+++ ng_async.8	Sun Dec  5 15:57:33 1999
@@ -35,113 +35,129 @@
 .\" $FreeBSD: src/sys/modules/netgraph/async/ng_async.8,v 1.4.2.2 1999/12/01 19:29:27 julian Exp $
 .\" $Whistle: ng_async.8,v 1.6 1999/01/25 23:46:25 archie Exp $
 .\"
+.\" jpman %Id: ng_async.8,v 0.0 1999/11/28 13:24:13 horikawa Stab %
 .Dd January 19, 1999
 .Dt NG_ASYNC 8
 .Os FreeBSD 4.0
-.Sh NAME
+.Sh $BL>>N(B
 .Nm ng_async
-.Nd asynchronous framing netgraph node type
-.Sh SYNOPSIS
+.Nd $BHsF14|%U%l!<%`2=(B netgraph $B%N!<%I%?%$%W(B
+.Sh $B=q<0(B
 .Fd #include <netgraph/ng_async.h>
-.Sh DESCRIPTION
-The
+.Sh $B2r@b(B
 .Nm async
-node type performs conversion between synchronous frames and
-asynchronous frames, as defined for the PPP protocol in RFC 1662.
-Asynchronous framing uses flag bytes and octet-stuffing
-to simulate a frame oriented connection over an octet-oriented
-asynchronous serial line.
+$B%N!<%I%?%$%W$O!"(BRFC 1662 $B$G(B PPP $B%W%m%H%3%kMQ$KDj5A$5$l$k$h$&$K!"(B
+$BF14|%U%l!<%`$HHsF14|%U%l!<%`$N4V$NJQ49$r9T$$$^$9!#(B
+$BHsF14|%U%l!<%`2=$O!"%U%i%0%P%$%H$H%*%/%F%C%H$N5M$aJ*$r;HMQ$7!"(B
+$B%*%/%F%C%H;X8~$NHsF14|%7%j%"%k2s@~>e$G!"(B
+$B%U%l!<%`;X8~$N@\B3$r%7%_%e%l!<%H$7$^$9!#(B
 .Pp
-The node transmits and receives asynchronous data on the
+$BK\%N!<%I$O!"(B
 .Dv async
-hook.  Mbuf boundaries of incoming data are ignored.
-Once a complete packet has been received, it is decoded and
-stripped of all framing bytes, and transmitted out the
+$B%U%C%/>e$G!"HsF14|%G!<%?$rAw<u?.$7$^$9!#(B
+$BE~Ce%G!<%?$N(B mbuf $B6-3&$OL5;k$5$l$^$9!#(B
+$B40A4$J%Q%1%C%H$,<u?.$5$l$k$H!"%G%3!<%I$,9T$o$l!"(B
+$B%U%l!<%`2=$NA4%P%$%H$,=|5n$5$l!"(B
+$BC10l%U%l!<%`$H$7$F(B
 .Dv sync
-hook as a single frame.
+$B%U%C%/$KAw$j=P$5$l$^$9!#(B
 .Pp
-Synchronous frames are transmitted and received on the
+$BF14|%U%l!<%`$O(B
 .Dv sync
-hook.
-Packets received on this hook are encoded as asynchronous frames
-and sent out on
-.Dv async .
-Received packets should start with the address and control fields,
-or the PPP protocol field if address and control field compression
-is employed, and contain no checksum field.  If the first four bytes are
+$B%U%C%/>e$GAw<u?.$5$l$^$9!#(B
+$BK\%U%C%/>e$G<u?.$5$l$?%Q%1%C%H$OHsF14|%U%l!<%`$H$7$F%(%s%3!<%I$5$l!"(B
+.Dv async
+$B>e$KAw$j=P$5$l$^$9!#(B
+$B<u?.%Q%1%C%H$O!"(B
+$B%"%I%l%9$H@)8f$N%U%#!<%k%I$+$i3+;O$7$F$$$k$+!"(B
+$B%"%I%l%9$H@)8f$N%U%#!<%k%I$,05=L$5$l$F$$$k>l9g$K$O(B
+PPP $B%W%m%H%3%k%U%#!<%k%I$+$i3+;O$7$F$$$k$O$:$G$"$j!"(B
+$B%A%'%C%/%5%`$r;}$A$^$;$s!#(B
+$B:G=i$N(B 4 $B%P%$%H$,(B
 .Dv "0xff 0x03 0xc0 0x21"
-(an LCP protocol frame) then complete control character escaping
-is enabled for that frame (in PPP, LCP packets are always sent with
-no address and control field compression and all control characters
-escaped).
+(LCP $B%W%m%H%3%k%U%l!<%`(B) $B$N>l9g!"(B
+$B$3$N%U%l!<%`$KBP$7$F$O(B
+$B40A4$J@)8fJ8;z%(%9%1!<%W2=$r9T$$$^$9(B
+(PPP $B$G$O!"(BLCP $B%Q%1%C%H$O>o$K$3$N@_Dj$GAw=P$5$l$^$9(B)$B!#(B
 .Pp
-This node supports ``flag sharing'' for packets transmitted on
-.Dv async .
-This is an optimization where the trailing flag byte
-of one frame is shared with the opening flag byte of the next.
-Flag sharing between frames is disabled after one second of transmit
-idle time.
-.Sh HOOKS
-This node type supports the following hooks:
+$BK\%N!<%I$O!"(B
+.Dv async
+$B>e$GAw=P$5$l$k%Q%1%C%H$KBP$9$k(B ``$B%U%i%06&M-(B'' $B$r%5%]!<%H$7$^$9!#(B
+$B$3$N:GE,2=$O!"$"$k%U%l!<%`$NKvHx$N%U%i%0%P%$%H$r(B
+$B<!$N%U%l!<%`$N3+;O%U%i%0%P%$%H$H6&M-$9$k$H$$$&$b$N$G$9!#(B
+$B%U%l!<%`4V$N%U%i%06&M-$O!"Aw=P%"%$%I%k;~4V8e!"$9$J$o$A(B 1 $BIC8e$KL58z2=$5$l$^$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 foobar
 .It Dv async
-Asynchronous connection.
-Typically this hook would be connected to a
+$BHsF14|@\B3!#(B
+$BE57?E*$K$O!"$3$N%U%C%/$O(B
+.Xr ng_tty 8
+$B%N!<%I$X@\B3$5$l$^$9!#(B
 .Xr ng_tty 8
-node, which handles transmission of serial data over a tty device.
+$B$O!"(Btty $B%G%P%$%9>e$N%7%j%"%k%G!<%?E>Aw$r07$$$^$9!#(B
 .It Dv sync
-Synchronous connection.  This hook sends and receives synchronous frames.
-For PPP, these frames should contain address, control, and protocol fields,
-but no checksum field.
-Typically this hook would be connected to an individual link hook of a
+$BF14|@\B3!#(B
+$B$3$N%U%C%/$OF14|%U%l!<%`$rAw<u?.$7$^$9!#(B
+PPP $B$G$O!"$3$N%U%l!<%`$O%"%I%l%9$H@)8f$N%U%#!<%k%I$r4^$`$O$:$G$9$,!"(B
+$B%A%'%C%/%5%`%U%#!<%k%I$O4^$^$J$$$O$:$G$9!#(B
+$B3F%U%l!<%`$O(B PPP $B%W%m%H%3%kHV9f$G3+;O$7$^$9!#(B
+$BE57?E*$K$O!"$3$N%U%C%/$O(B
 .Xr ng_ppp 8
-type node.
+$B%?%$%W%N!<%I$NFHN)$7$?%j%s%/%U%C%/$X@\B3$5$lF@$^$9!#(B
 .El
-.Sh CONTROL MESSAGES
-This node type supports the generic control messages, plus the following:
+.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_ASYNC_CMD_GET_STATS
-This command returns a
+$BK\%3%^%s%I$O(B
 .Dv "struct ng_async_stat"
-containing node statistics for packet, octet, and error counts.
+$B$rJV$7$^$9!#(B
+$B$3$l$K$O!"(B
+$B%Q%1%C%H$H%*%/%F%C%H$H%(%i!<$N?t$K4X$9$k%N!<%I$NE}7W>pJs$,4^$^$l$^$9!#(B
 .It Dv NGM_ASYNC_CMD_CLR_STATS
-Clears the node statistics.
+$B%N!<%I$NE}7W>pJs$r%/%j%"$7$^$9!#(B
 .It Dv NGM_ASYNC_CMD_SET_CONFIG
-Sets the node configuration, which is described by a
-.Dv "struct ng_async_cfg" :
+$B%N!<%I9=@.$r@_Dj$7$^$9!#$3$l$O<!$N(B
+.Dv "struct ng_async_cfg"
+$B$G5-=R$5$l$^$9(B:
 .Bd -literal -offset 4n
 struct ng_async_cfg {
-  u_char    enabled;  /* Turn encoding on/off */
-  u_int16_t amru;     /* Max receive async frame len */
-  u_int16_t smru;     /* Max receive sync frame len */
-  u_int32_t accm;     /* ACCM encoding */
+  u_char    enabled;  /* $B%(%s%3!<%G%#%s%0$N%*%s(B/$B%*%U(B */
+  u_int16_t amru;     /* $B<u?.HsF14|%U%l!<%`D9$N:GBg(B */
+  u_int16_t smru;     /* $B<u?.F14|%U%l!<%`D9$N:GBg(B */
+  u_int32_t accm;     /* ACCM $B%(%s%3!<%G%#%s%0(B */
 };
 .Ed
 .Pp
-The
 .Dv enabled
-field enables or disables all encoding/decoding functions (default disabled).
-When disabled, the node operates in simple ``pass through'' mode.
-The
+$B%U%#!<%k%I$O!"(B
+$B$9$Y$F$N%(%s%3!<%I(B/$B%G%3!<%I$N5!G=$NM-8z2=$^$?$OL58z2=$r9T$$$^$9(B
+($B%G%U%)%k%H$OL58z(B)$B!#(B
+$BL58z;~$K$O!"%N!<%I$OC1=c(B ``$BDL2a(B'' $B%b!<%I$GF0:n$7$^$9!#(B
 .Dv amru
-and
+$B$*$h$S(B
 .Dv smru
-fields are the asynchronous and synchronous MRU (maximum receive unit) values,
-respectively.  These both default to 1600; note that the async MRU
-applies to the incoming frame length after asynchronous decoding.
-The
+$B$N%U%#!<%k%I$O!"$=$l$>$lF14|$*$h$SHsF14|$N(B MRU ($B:GBg<u?.C10L(B) $BCM$G$9!#(B
+$B$I$A$i$b%G%U%)%k%HCM$O(B 1600 $B$G$9!#(B
+$BHsF14|(B MRU $B$O!"(B
+$BHsF14|$N%G%3!<%I=hM}8e$NF~NO%U%l!<%`D9$KE,MQ$5$l$k$3$H$KCm0U$7$F$/$@$5$$!#(B
+$B:G8e$K!"(B
 .Dv accm
-field is the asynchronous character control map, which controls the escaping
-of characters 0x00 thorough 0x1f (default 0xffffffff).
+$B%U%#!<%k%I(B
+$B$OHsF14|J8;z@)8f%^%C%W(B (asynchronous character control map) $B$G$"$j!"(B
+$BJ8;z(B 0x00 $B$+$i(B 0x1f $B$NJ8;z$N%(%9%1!<%W$r@)8f$7$^$9(B 
+($B%G%U%)%k%HCM$O(B 0xffffffff)$B!#(B
 .It Dv NGM_ASYNC_CMD_GET_CONFIG
-This command returns the current configuration structure.
+$BK\%3%^%s%I$O!"8=:_$N@_Dj$N9=B$BN$rJV$7$^$9!#(B
 .El
-.Sh SHUTDOWN
-This node shuts down upon receipt of a
+.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 SEE ALSO
+$B@)8f%a%C%;!<%8$N<u?.;~$+!"A4%U%C%/$,@ZCG$5$l$?$H$-$K!"%7%c%C%H%@%&%s$7$^$9!#(B
+.Sh $B4XO"9`L\(B
 .Xr netgraph 4 ,
 .Xr ng_ppp 8 ,
 .Xr ng_tty 8 ,
@@ -156,5 +172,5 @@
 .%T "The Point-to-Point Protocol (PPP)"
 .%O RFC 1661
 .Re
-.Sh AUTHOR
+.Sh $B:n<T(B
 Archie Cobbs <archie@whistle.com>
