summaryrefslogtreecommitdiffstats
path: root/doc/read.n
diff options
context:
space:
mode:
Diffstat (limited to 'doc/read.n')
-rw-r--r--doc/read.n8
1 files changed, 6 insertions, 2 deletions
diff --git a/doc/read.n b/doc/read.n
index aca4c1d..59ad47b 100644
--- a/doc/read.n
+++ b/doc/read.n
@@ -5,7 +5,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: read.n,v 1.12 2007/10/24 14:29:39 dkf Exp $
+'\" RCS: @(#) $Id: read.n,v 1.13 2007/10/26 20:11:53 dgp Exp $
'\"
.so man.macros
.TH read n 8.1 Tcl "Tcl Built-In Commands"
@@ -53,8 +53,10 @@ newline characters according to the \fB\-translation\fR option
for the channel.
See the \fBfconfigure\fR manual entry for a discussion on ways in
which \fBfconfigure\fR will alter input.
+
.SH "USE WITH SERIAL PORTS"
-.\" Note: this advice actually applies to many versions of Tcl
+'\" Note: this advice actually applies to many versions of Tcl
+
For most applications a channel connected to a serial port should be
configured to be nonblocking: \fBfconfigure \fIchannelId \fB\-blocking
\fI0\fR. Then \fBread\fR behaves much like described above. Care
@@ -78,7 +80,9 @@ set data [\fBread\fR $fl]
close $fl
set lines [split $data \\n]
.CE
+
.SH "SEE ALSO"
file(n), eof(n), fblocked(n), fconfigure(n), Tcl_StandardChannels(3)
+
.SH KEYWORDS
blocking, channel, end of line, end of file, nonblocking, read, translation, encoding