summaryrefslogtreecommitdiffstats
path: root/doc/read.n
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2011-07-17 15:00:43 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2011-07-17 15:00:43 (GMT)
commit9f51e32c984e0ad2e812d241e588c492c4179cf8 (patch)
treec3920dbd3e235492a7b453af9a7f5cf5f080c734 /doc/read.n
parentff87b46b5269cbd4def059244e47ec2db336e166 (diff)
downloadtcl-9f51e32c984e0ad2e812d241e588c492c4179cf8.zip
tcl-9f51e32c984e0ad2e812d241e588c492c4179cf8.tar.gz
tcl-9f51e32c984e0ad2e812d241e588c492c4179cf8.tar.bz2
Documentation improvements (small; some revision to parsing script) to improve
the quality of HTML doc builds.
Diffstat (limited to 'doc/read.n')
-rw-r--r--doc/read.n7
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/read.n b/doc/read.n
index a64e079..007c0ac 100644
--- a/doc/read.n
+++ b/doc/read.n
@@ -54,7 +54,7 @@ which \fBfconfigure\fR will alter input.
'\" Note: this advice actually applies to many versions of Tcl
.PP
For most applications a channel connected to a serial port should be
-configured to be nonblocking: \fBfconfigure \fIchannelId \fB\-blocking
+configured to be nonblocking: \fBfconfigure\fI channelId \fB\-blocking
\fI0\fR. Then \fBread\fR behaves much like described above. Care
must be taken when using \fBread\fR on blocking serial ports:
.TP
@@ -66,7 +66,7 @@ from the serial port.
\fBread \fIchannelId\fR
.
In this form \fBread\fR blocks until the reception of the end-of-file
-character, see \fBfconfigure -eofchar\fR. If there no end-of-file
+character, see \fBfconfigure\fR \fB\-eofchar\fR. If there no end-of-file
character has been configured for the channel, then \fBread\fR will
block forever.
.SH "EXAMPLE"
@@ -84,3 +84,6 @@ set lines [split $data \en]
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
+'\"Local Variables:
+'\"mode: nroff
+'\"End: