summaryrefslogtreecommitdiffstats
path: root/doc/fcopy.n
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2016-07-24 13:09:40 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2016-07-24 13:09:40 (GMT)
commitf6a4d71bada6d59b1daf550d919038e8e34ba666 (patch)
tree53df24589f91130262820f09c2de4c00396ccb0b /doc/fcopy.n
parent316be1544dc9ff959fc623486731310634dae74b (diff)
downloadtcl-f6a4d71bada6d59b1daf550d919038e8e34ba666.zip
tcl-f6a4d71bada6d59b1daf550d919038e8e34ba666.tar.gz
tcl-f6a4d71bada6d59b1daf550d919038e8e34ba666.tar.bz2
[6a19dedc2e] "Clarified" what the units are that [chan copy] uses for -size and that synchronous copying returns.
Diffstat (limited to 'doc/fcopy.n')
-rw-r--r--doc/fcopy.n12
1 files changed, 9 insertions, 3 deletions
diff --git a/doc/fcopy.n b/doc/fcopy.n
index e5dd1d6..d39c803 100644
--- a/doc/fcopy.n
+++ b/doc/fcopy.n
@@ -25,12 +25,15 @@ network sockets.
.PP
The \fBfcopy\fR
command transfers data from \fIinchan\fR until end of file
-or \fIsize\fR bytes have been
-transferred. If no \fB\-size\fR argument is given,
+or \fIsize\fR bytes or characters have been
+transferred; \fIsize\fR is in bytes if the two channels are using the
+same encoding, and is in characters otherwise.
+If no \fB\-size\fR argument is given,
then the copy goes until end of file.
All the data read from \fIinchan\fR is copied to \fIoutchan\fR.
Without the \fB\-command\fR option, \fBfcopy\fR blocks until the copy is complete
-and returns the number of bytes written to \fIoutchan\fR.
+and returns the number of bytes or characters (using the same rules as
+for the \fB\-size\fR option) written to \fIoutchan\fR.
.PP
The \fB\-command\fR argument makes \fBfcopy\fR work in the background.
In this case it returns immediately and the \fIcallback\fR is invoked
@@ -174,3 +177,6 @@ vwait done
eof(n), fblocked(n), fconfigure(n), file(n)
.SH KEYWORDS
blocking, channel, end of line, end of file, nonblocking, read, translation
+'\" Local Variables:
+'\" mode: nroff
+'\" End: