summaryrefslogtreecommitdiffstats
path: root/doc/fcopy.n
diff options
context:
space:
mode:
authordgp <dgp@users.sourceforge.net>2016-07-26 13:54:57 (GMT)
committerdgp <dgp@users.sourceforge.net>2016-07-26 13:54:57 (GMT)
commita1b3e256e7d1607cf66fd65931a60d041d3ba566 (patch)
treeda1cf11e12bf524556ed195b9e811ee39fefa84b /doc/fcopy.n
parent7b960b4cdbdb05dd87c12eff280e839eace1cd54 (diff)
parentc8206cd0eabcf7418eb982e0b8e5d680a46e68c9 (diff)
downloadtcl-a1b3e256e7d1607cf66fd65931a60d041d3ba566.zip
tcl-a1b3e256e7d1607cf66fd65931a60d041d3ba566.tar.gz
tcl-a1b3e256e7d1607cf66fd65931a60d041d3ba566.tar.bz2
a few test & docs fixescore_8_6_6core_8_6_6_rc
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: