From owner-man-jp-reviewer@jp.freebsd.org  Fri Dec 24 01:26:16 1999
Received: (from daemon@localhost)
	by castle.jp.freebsd.org (8.9.3+3.2W/8.7.3) id BAA28926;
	Fri, 24 Dec 1999 01:26:16 +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 BAA28921
	for <man-jp-reviewer@jp.freebsd.org>; Fri, 24 Dec 1999 01:26:15 +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 BAA12923 for <man-jp-reviewer@jp.freebsd.org>; Fri, 24 Dec 1999 01:26:15 +0900 (JST)
Received: from localhost (pppa27.yk.rim.or.jp [202.247.186.27]) by mail-relay.rim.or.jp (3.7W/HMX-12) id BAA11783 for <man-jp-reviewer@jp.freebsd.org>; Fri, 24 Dec 1999 01:26:14 +0900 (JST)
To: man-jp-reviewer@jp.freebsd.org
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: <19991224012534F.k-horik@yk.rim.or.jp>
Date: Fri, 24 Dec 1999 01:25:34 +0900
From: Kazuo Horikawa <k-horik@yk.rim.or.jp>
X-Dispatcher: imput version 980905(IM100)
Lines: 174
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 1844
Subject: [man-jp-reviewer 1844] ng_tty.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_tty.8 $B$N=iLu$G$9!#(B

--- ng_tty.8.eng	Thu Dec 23 19:30:27 1999
+++ ng_tty.8	Thu Dec 23 21:31:46 1999
@@ -35,97 +35,105 @@
 .\" $FreeBSD: src/sys/modules/netgraph/tty/ng_tty.8,v 1.3.2.1 1999/11/17 07:23:59 julian Exp $
 .\" $Whistle: ng_tty.8,v 1.5 1999/01/25 23:46:28 archie Exp $
 .\"
+.\" jpman %Id: ng_tty.8,v 0.0 1999/11/28 13:24:13 horikawa Stab %
 .Dd January 19, 1999
 .Dt NG_TTY 8
 .Os FreeBSD 4.0
-.Sh NAME
+.Sh $BL>>N(B
 .Nm ng_tty
-.Nd netgraph node type that is also a line discipline
-.Sh SYNOPSIS
+.Nd $B2s@~5,Ls$G$b$"$k(B netgraph $B%N!<%I%?%$%W(B
+.Sh $B=q<0(B
 .Fd #include <sys/ttycom.h>
 .Fd #include <netgraph/ng_message.h>
 .Fd #include <netgraph/ng_tty.h>
-.Sh DESCRIPTION
-The
+.Sh $B2r@b(B
 .Nm tty
-node type is both a netgraph node type and a line discipline.
-A new node is created when the corresponding line discipline,
-.Dv NETGRAPHDISC ,
-is registered on a tty device (see
-.Xr tty 4 ")."
+$B%N!<%I%?%$%W$O!"(B
+netgraph $B%N!<%I%?%$%W$G$"$k$HF1;~$K!"2s@~5,Ls$G$b$"$j$^$9!#(B
+$B?75,%N!<%I$O!"BP1~$9$k2s@~5,Ls(B
+.Dv NETGRAPHDISC
+$B$,(B tty $B%G%P%$%9(B (
+.Xr tty 4
+$B;2>H(B) $B$KEPO?$5$l$?;~$K!"@8@.$5$l$^$9!#(B
 .Pp
-The node has a single hook called
-.Dv hook .
-Incoming bytes received on the tty device are sent out on this hook,
-and frames received on
+$BK\%N!<%I$O!"(B
 .Dv hook
-are transmitted out on the tty device.
-No modification to the data is performed in either direction.
-While the line discipline is installed on a tty, the normal
-read and write operations are unavailable, returning
-.Er EIO .
-.Pp
-The node supports an optional ``hot character.'' If set to non-zero, incoming
-data from the tty device is queued until this character is seen.
-This avoids sending lots of mbufs containing a small number of bytes,
-but introduces potentially infinite latency.
-The default hot character is 0x7e, consistent with
+$B$H8F$P$l$kC10l$N%U%C%/$r;}$A$^$9!#(B
+tty $B%G%P%$%9>e$G<u?.$5$l$kF~NO%P%$%H$O!"K\%U%C%/$+$iAw=P$5$l!"(B
 .Dv hook
-being connected to a
+$B>e$G<u?.$5$l$k%U%l!<%`$O(B tty $B%G%P%$%9$+$iAw=P$5$l$^$9!#(B
+$B$I$A$i$NJ}8~$K$*$$$F$b!"%G!<%?$N=$@5$O9T$o$l$^$;$s!#(B
+$B2s@~5,Ls$,(B tty $B$K%$%s%9%H!<%k$5$l$F$$$k4V$O!"(B
+$BDL>o$NFI$_9~$_$H=q$-9~$_$NA`:n$OMxMQ$G$-$:!"(B
+.Er EIO
+$B$rJV$7$^$9!#(B
+.Pp
+$BK\%N!<%I$O!"%*%W%7%g%s$N!V%[%C%HJ8;z(B ``hot character''$B!W$r%5%]!<%H$7$^$9!#(B
+$B$3$l$rHs(B 0 $B$K@_Dj$9$k$H!"(Btty $B%G%P%$%9$+$i$NF~NO%G!<%?$O!"(B
+$B$3$NJ8;z$,E~Ce$9$k$^$G%-%e!<$5$l$^$9!#(B
+$B$3$l$K$h$j!">/?t%P%$%H$r4^$`B??t$N(B mbuf $B$NAw?.$rHr$1$i$l$^$9$,!"(B
+$B@x:_E*$JL58BCY1d$rF3F~$7$F$7$^$$$^$9!#(B
+$B%G%U%)%k%H$N%[%C%HJ8;z$O(B 0x7e $B$G$"$j!"(B
 .Xr ng_async 8
-type node. The hot character has no effect on the transmission of data.
+$B%?%$%W%N!<%I$K@\B3$5$l$k(B
+.Dv hook
+$B$H0l4S@-$,$"$j$^$9!#(B
+$B%[%C%HJ8;z$O!"Aw?.%G!<%?$X$N1F6A$r;}$A$^$;$s!#(B
 .Pp
-The node will attempt to give itself the same netgraph name as the name
-of the tty device.
-In any case, information about the node is available via the netgraph
+$BK\%N!<%I$O!"(Btty $B%G%P%$%9$HF1$8(B netgraph $BL>$r!"<+8J$KM?$($h$&$H$7$^$9!#(B
+$B$$$+$J$k>l9g$G$b!"K\%N!<%I$N>pJs$O!"(Bnetgraph $B$N(B
 .Xr ioctl 2
-command
-.Dv NGIOCGINFO .
-This command returns a
-.Dv "struct nodeinfo"
-similar to the
+$B%3%^%s%I(B
+.Dv NGIOCGINFO
+$B$GMxMQ2DG=$G$9!#(B
+$BK\%3%^%s%I$O!"(B
 .Dv NGM_NODEINFO
-netgraph control message.
-.Sh HOOKS
-This node type supports the following hooks:
+netgraph $B@)8f%a%C%;!<%8$HF1MM$N!"C10l$N(B
+.Dv "struct nodeinfo"
+$B$rJV$7$^$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 hook
-.Xr tty 4
-serial data contained in
 .Dv mbuf
-structures, with arbitrary inter-frame boundaries.
+$B9=B$BN$K3JG<$5$l$?!"G$0U$N%U%l!<%`4V6-3&$N!"(B
+.Xr tty 4
+$B%7%j%"%k%G!<%?!#(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_TTY_SET_HOTCHAR
-This command takes an integer argument and sets the hot character
-from the lower 8 bits. A hot character of zero disables queueing,
-so that all received data is forwarded immediately.
+$BK\%3%^%s%I$O!"C10l$N@0?t0z?t$r<h$j!"(B
+$B2<0L(B 8 $B%S%C%H$+$i%[%C%HJ8;z$r@_Dj$7$^$9!#(B
+$B%[%C%HJ8;z(B 0 $B$O!"%-%e!<%$%s%0$rL58z$K$7$^$9$N$G!"(B
+$BA4<u?.%G!<%?$OB(:B$KE>Aw$5$l$^$9!#(B
 .It Dv NGM_TTY_GET_HOTCHAR
-Returns an integer containing the current hot character in the lower
-eight bits.
-.Sh SHUTDOWN
-This node shuts down when the corresponding device is closed
-(or the line discipline is uninstalled on the device).
-The
+$B2<0L(B 8 $B%S%C%H$K8=:_$N%[%C%HJ8;z$r3JG<$7$?!"C10l@0?t$rJV$7$^$9!#(B
+.Sh $B%7%c%C%H%@%&%s(B
+$BK\%N!<%I$O!"BP1~$9$k%G%P%$%9$,%/%m!<%:$5$l$?$H$-(B
+($B$^$?$O%G%P%$%9>e$+$i2s@~5,Ls$,%"%s%$%s%9%H!<%k$5$l$?$H$-(B) $B$K!"(B
+$B%7%c%C%H%@%&%s$7$^$9!#(B
 .Dv NGM_SHUTDOWN
-control message is not valid, and always returns the error
-.Er EOPNOTSUPP .
-.Sh BUGS
-The serial driver code also has a notion of a ``hot character.''
-Unfortunately, this value is statically defined in terms of the
-line discipline and cannot be changed.
-Therefore, if a hot character other than 0x7e (the default) is set for the
+$B@)8f%a%C%;!<%8$OL58z$G$"$j!">o$K%(%i!<(B
+.Er EOPNOTSUPP
+$B$rJV$7$^$9!#(B
+.Sh $B%P%0(B
+$B%7%j%"%k%I%i%$%P%3!<%I$b$^$?!V%[%C%HJ8;z!W$N35G0$r;}$A$^$9!#(B
+$BIT9,$J$3$H$K!"(B
+$B$3$NCM$O2s@~5,Ls$N$b$H$K@EE*$KDj5A$5$l$F$*$j!"JQ99IT2DG=$G$9!#(B
+$B$=$l8N!"(B0x7e ($B%G%U%)%k%H(B) $B0J30$N%[%C%HJ8;z$,(B
 .Nm tty
-node, the node has no way to convey this information to the
-serial driver, and sub-optimal performance may result.
-.Sh SEE ALSO
+$B%N!<%IMQ$KDj5A$5$l$k$H!"(B
+$BK\%N!<%I$O$3$N>pJs$r%7%j%"%k%I%i%$%P$XEA$($kJ}K!$r;}$?$J$$$?$a!"(B
+$B=`:GE,$J@-G=$K$J$C$F$7$^$$$^$9!#(B
+.Sh $B4XO"9`L\(B
 .Xr ioctl 2 ,
 .Xr netgraph 4 ,
 .Xr tty 4 ,
 .Xr ng_async 8 ,
-.Xr ngctl 8 .
-.Sh AUTHOR
+.Xr ngctl 8
+.Sh $B:n<T(B
 Archie Cobbs <archie@whistle.com>
