summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authoroehhar <harald.oehlmann@elmicron.de>2023-11-20 16:54:38 (GMT)
committeroehhar <harald.oehlmann@elmicron.de>2023-11-20 16:54:38 (GMT)
commit52e8a706727c83e06fe9ef2a02b24e9223a702ba (patch)
tree328bcc4a9d945bc226075e455eab657eb9c3c4a4
parent4cef082ec68f86f881ba8bed90075ca7b3707f55 (diff)
downloadtcl-52e8a706727c83e06fe9ef2a02b24e9223a702ba.zip
tcl-52e8a706727c83e06fe9ef2a02b24e9223a702ba.tar.gz
tcl-52e8a706727c83e06fe9ef2a02b24e9223a702ba.tar.bz2
fcopy doc: remove depreciation in tcl9, this is 8.7.
-rw-r--r--doc/fcopy.n12
1 files changed, 5 insertions, 7 deletions
diff --git a/doc/fcopy.n b/doc/fcopy.n
index ce15854..dc6d8ea 100644
--- a/doc/fcopy.n
+++ b/doc/fcopy.n
@@ -12,7 +12,7 @@
.SH NAME
fcopy \- Copy data from one channel to another
.SH SYNOPSIS
-\fBfcopy \fIinchan\fR \fIoutchan\fR ?\fB\-size \fIsize\fR? ?\fB\-command \fIcallback\fR?
+\fBfcopy \fIinputChan\fR \fIoutputChan\fR ?\fB\-size \fIsize\fR? ?\fB\-command \fIcallback\fR?
.BE
.SH DESCRIPTION
@@ -22,9 +22,6 @@ The \fBfcopy\fR command leverages the buffering in the Tcl I/O system to
avoid extra copies and to avoid buffering too much data in
main memory when copying large files to destinations like
network sockets.
-.PP
-The \fBfcopy\fR
-command transfers data from \fIinchan\fR to \fIoutchan\fR.
.
.SS "DATA QUANTITY"
All data until \fIEOF\fR is copied.
@@ -32,14 +29,15 @@ In addition, the quantity of copied data may be specified by the option \fB-size
The given size is in bytes, if the input channel is in binary mode.
Otherwise, it is in characters.
.PP
-Depreciated feature: the transfer is treated as a binary transfer, if the encoding
+The transfer is treated as a binary transfer, if the encoding
profile is set to
.QW tcl8
and the input encoding matches the output encoding.
In this case, eventual encoding errors are not handled.
An eventually given size is in bytes in this case.
-This feature exists for TCL 8 compatibility.
-.PP
+This feature is depreciated in TCL 9.
+.
+.SS "BLOCKING OPERATION MODE"
Without the \fB\-command\fR option, \fBfcopy\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 \fIoutchan\fR.