diff options
author | dkf <donal.k.fellows@manchester.ac.uk> | 2016-07-24 13:09:40 (GMT) |
---|---|---|
committer | dkf <donal.k.fellows@manchester.ac.uk> | 2016-07-24 13:09:40 (GMT) |
commit | f6a4d71bada6d59b1daf550d919038e8e34ba666 (patch) | |
tree | 53df24589f91130262820f09c2de4c00396ccb0b /doc/chan.n | |
parent | 316be1544dc9ff959fc623486731310634dae74b (diff) | |
download | tcl-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/chan.n')
-rw-r--r-- | doc/chan.n | 14 |
1 files changed, 8 insertions, 6 deletions
@@ -287,12 +287,14 @@ slow destinations like network sockets. .RS .PP The \fBchan copy\fR command transfers data from \fIinputChan\fR until -end of file or \fIsize\fR bytes have been transferred. If no -\fB\-size\fR argument is given, then the copy goes until end of file. -All the data read from \fIinputChan\fR is copied to \fIoutputChan\fR. -Without the \fB\-command\fR option, \fBchan copy\fR blocks until the -copy is complete and returns the number of bytes written to -\fIoutputChan\fR. +end of file 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 +\fIinputChan\fR is copied to \fIoutputChan\fR. Without the +\fB\-command\fR option, \fBchan copy\fR blocks until the copy is +complete and returns the number of bytes or characters (using the same +rules as for the \fB\-size\fR option) written to \fIoutputChan\fR. .PP The \fB\-command\fR argument makes \fBchan copy\fR work in the background. In this case it returns immediately and the |