Commit | Line | Data |
---|---|---|
920dae64 AT |
1 | '\" |
2 | '\" Copyright (c) 1993 The Regents of the University of California. | |
3 | '\" Copyright (c) 1994-1997 Sun Microsystems, Inc. | |
4 | '\" | |
5 | '\" See the file "license.terms" for information on usage and redistribution | |
6 | '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. | |
7 | '\" | |
8 | '\" RCS: @(#) $Id: fcopy.n,v 1.3 2001/05/19 16:59:04 andreas_kupries Exp $ | |
9 | '\" | |
10 | '\" The definitions below are for supplemental macros used in Tcl/Tk | |
11 | '\" manual entries. | |
12 | '\" | |
13 | '\" .AP type name in/out ?indent? | |
14 | '\" Start paragraph describing an argument to a library procedure. | |
15 | '\" type is type of argument (int, etc.), in/out is either "in", "out", | |
16 | '\" or "in/out" to describe whether procedure reads or modifies arg, | |
17 | '\" and indent is equivalent to second arg of .IP (shouldn't ever be | |
18 | '\" needed; use .AS below instead) | |
19 | '\" | |
20 | '\" .AS ?type? ?name? | |
21 | '\" Give maximum sizes of arguments for setting tab stops. Type and | |
22 | '\" name are examples of largest possible arguments that will be passed | |
23 | '\" to .AP later. If args are omitted, default tab stops are used. | |
24 | '\" | |
25 | '\" .BS | |
26 | '\" Start box enclosure. From here until next .BE, everything will be | |
27 | '\" enclosed in one large box. | |
28 | '\" | |
29 | '\" .BE | |
30 | '\" End of box enclosure. | |
31 | '\" | |
32 | '\" .CS | |
33 | '\" Begin code excerpt. | |
34 | '\" | |
35 | '\" .CE | |
36 | '\" End code excerpt. | |
37 | '\" | |
38 | '\" .VS ?version? ?br? | |
39 | '\" Begin vertical sidebar, for use in marking newly-changed parts | |
40 | '\" of man pages. The first argument is ignored and used for recording | |
41 | '\" the version when the .VS was added, so that the sidebars can be | |
42 | '\" found and removed when they reach a certain age. If another argument | |
43 | '\" is present, then a line break is forced before starting the sidebar. | |
44 | '\" | |
45 | '\" .VE | |
46 | '\" End of vertical sidebar. | |
47 | '\" | |
48 | '\" .DS | |
49 | '\" Begin an indented unfilled display. | |
50 | '\" | |
51 | '\" .DE | |
52 | '\" End of indented unfilled display. | |
53 | '\" | |
54 | '\" .SO | |
55 | '\" Start of list of standard options for a Tk widget. The | |
56 | '\" options follow on successive lines, in four columns separated | |
57 | '\" by tabs. | |
58 | '\" | |
59 | '\" .SE | |
60 | '\" End of list of standard options for a Tk widget. | |
61 | '\" | |
62 | '\" .OP cmdName dbName dbClass | |
63 | '\" Start of description of a specific option. cmdName gives the | |
64 | '\" option's name as specified in the class command, dbName gives | |
65 | '\" the option's name in the option database, and dbClass gives | |
66 | '\" the option's class in the option database. | |
67 | '\" | |
68 | '\" .UL arg1 arg2 | |
69 | '\" Print arg1 underlined, then print arg2 normally. | |
70 | '\" | |
71 | '\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $ | |
72 | '\" | |
73 | '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. | |
74 | .if t .wh -1.3i ^B | |
75 | .nr ^l \n(.l | |
76 | .ad b | |
77 | '\" # Start an argument description | |
78 | .de AP | |
79 | .ie !"\\$4"" .TP \\$4 | |
80 | .el \{\ | |
81 | . ie !"\\$2"" .TP \\n()Cu | |
82 | . el .TP 15 | |
83 | .\} | |
84 | .ta \\n()Au \\n()Bu | |
85 | .ie !"\\$3"" \{\ | |
86 | \&\\$1 \\fI\\$2\\fP (\\$3) | |
87 | .\".b | |
88 | .\} | |
89 | .el \{\ | |
90 | .br | |
91 | .ie !"\\$2"" \{\ | |
92 | \&\\$1 \\fI\\$2\\fP | |
93 | .\} | |
94 | .el \{\ | |
95 | \&\\fI\\$1\\fP | |
96 | .\} | |
97 | .\} | |
98 | .. | |
99 | '\" # define tabbing values for .AP | |
100 | .de AS | |
101 | .nr )A 10n | |
102 | .if !"\\$1"" .nr )A \\w'\\$1'u+3n | |
103 | .nr )B \\n()Au+15n | |
104 | .\" | |
105 | .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n | |
106 | .nr )C \\n()Bu+\\w'(in/out)'u+2n | |
107 | .. | |
108 | .AS Tcl_Interp Tcl_CreateInterp in/out | |
109 | '\" # BS - start boxed text | |
110 | '\" # ^y = starting y location | |
111 | '\" # ^b = 1 | |
112 | .de BS | |
113 | .br | |
114 | .mk ^y | |
115 | .nr ^b 1u | |
116 | .if n .nf | |
117 | .if n .ti 0 | |
118 | .if n \l'\\n(.lu\(ul' | |
119 | .if n .fi | |
120 | .. | |
121 | '\" # BE - end boxed text (draw box now) | |
122 | .de BE | |
123 | .nf | |
124 | .ti 0 | |
125 | .mk ^t | |
126 | .ie n \l'\\n(^lu\(ul' | |
127 | .el \{\ | |
128 | .\" Draw four-sided box normally, but don't draw top of | |
129 | .\" box if the box started on an earlier page. | |
130 | .ie !\\n(^b-1 \{\ | |
131 | \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' | |
132 | .\} | |
133 | .el \}\ | |
134 | \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' | |
135 | .\} | |
136 | .\} | |
137 | .fi | |
138 | .br | |
139 | .nr ^b 0 | |
140 | .. | |
141 | '\" # VS - start vertical sidebar | |
142 | '\" # ^Y = starting y location | |
143 | '\" # ^v = 1 (for troff; for nroff this doesn't matter) | |
144 | .de VS | |
145 | .if !"\\$2"" .br | |
146 | .mk ^Y | |
147 | .ie n 'mc \s12\(br\s0 | |
148 | .el .nr ^v 1u | |
149 | .. | |
150 | '\" # VE - end of vertical sidebar | |
151 | .de VE | |
152 | .ie n 'mc | |
153 | .el \{\ | |
154 | .ev 2 | |
155 | .nf | |
156 | .ti 0 | |
157 | .mk ^t | |
158 | \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' | |
159 | .sp -1 | |
160 | .fi | |
161 | .ev | |
162 | .\} | |
163 | .nr ^v 0 | |
164 | .. | |
165 | '\" # Special macro to handle page bottom: finish off current | |
166 | '\" # box/sidebar if in box/sidebar mode, then invoked standard | |
167 | '\" # page bottom macro. | |
168 | .de ^B | |
169 | .ev 2 | |
170 | 'ti 0 | |
171 | 'nf | |
172 | .mk ^t | |
173 | .if \\n(^b \{\ | |
174 | .\" Draw three-sided box if this is the box's first page, | |
175 | .\" draw two sides but no top otherwise. | |
176 | .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c | |
177 | .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c | |
178 | .\} | |
179 | .if \\n(^v \{\ | |
180 | .nr ^x \\n(^tu+1v-\\n(^Yu | |
181 | \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c | |
182 | .\} | |
183 | .bp | |
184 | 'fi | |
185 | .ev | |
186 | .if \\n(^b \{\ | |
187 | .mk ^y | |
188 | .nr ^b 2 | |
189 | .\} | |
190 | .if \\n(^v \{\ | |
191 | .mk ^Y | |
192 | .\} | |
193 | .. | |
194 | '\" # DS - begin display | |
195 | .de DS | |
196 | .RS | |
197 | .nf | |
198 | .sp | |
199 | .. | |
200 | '\" # DE - end display | |
201 | .de DE | |
202 | .fi | |
203 | .RE | |
204 | .sp | |
205 | .. | |
206 | '\" # SO - start of list of standard options | |
207 | .de SO | |
208 | .SH "STANDARD OPTIONS" | |
209 | .LP | |
210 | .nf | |
211 | .ta 5.5c 11c | |
212 | .ft B | |
213 | .. | |
214 | '\" # SE - end of list of standard options | |
215 | .de SE | |
216 | .fi | |
217 | .ft R | |
218 | .LP | |
219 | See the \\fBoptions\\fR manual entry for details on the standard options. | |
220 | .. | |
221 | '\" # OP - start of full description for a single option | |
222 | .de OP | |
223 | .LP | |
224 | .nf | |
225 | .ta 4c | |
226 | Command-Line Name: \\fB\\$1\\fR | |
227 | Database Name: \\fB\\$2\\fR | |
228 | Database Class: \\fB\\$3\\fR | |
229 | .fi | |
230 | .IP | |
231 | .. | |
232 | '\" # CS - begin code excerpt | |
233 | .de CS | |
234 | .RS | |
235 | .nf | |
236 | .ta .25i .5i .75i 1i | |
237 | .. | |
238 | '\" # CE - end code excerpt | |
239 | .de CE | |
240 | .fi | |
241 | .RE | |
242 | .. | |
243 | .de UL | |
244 | \\$1\l'|0\(ul'\\$2 | |
245 | .. | |
246 | .TH fcopy n 8.0 Tcl "Tcl Built-In Commands" | |
247 | .BS | |
248 | '\" Note: do not modify the .SH NAME line immediately below! | |
249 | .SH NAME | |
250 | fcopy \- Copy data from one channel to another. | |
251 | .SH SYNOPSIS | |
252 | \fBfcopy \fIinchan\fR \fIoutchan\fR ?\fB\-size \fIsize\fR? ?\fB\-command \fIcallback\fR? | |
253 | .BE | |
254 | ||
255 | .SH DESCRIPTION | |
256 | .PP | |
257 | The \fBfcopy\fP command copies data from one I/O channel, \fIinchan\fR to another I/O channel, \fIoutchan\fR. | |
258 | The \fBfcopy\fP command leverages the buffering in the Tcl I/O system to | |
259 | avoid extra copies and to avoid buffering too much data in | |
260 | main memory when copying large files to slow destinations like | |
261 | network sockets. | |
262 | .PP | |
263 | The \fBfcopy\fP | |
264 | command transfers data from \fIinchan\fR until end of file | |
265 | or \fIsize\fP bytes have been | |
266 | transferred. If no \fB\-size\fP argument is given, | |
267 | then the copy goes until end of file. | |
268 | All the data read from \fIinchan\fR is copied to \fIoutchan\fR. | |
269 | Without the \fB\-command\fP option, \fBfcopy\fP blocks until the copy is complete | |
270 | and returns the number of bytes written to \fIoutchan\fR. | |
271 | .PP | |
272 | The \fB\-command\fP argument makes \fBfcopy\fP work in the background. | |
273 | In this case it returns immediately and the \fIcallback\fP is invoked | |
274 | later when the copy completes. | |
275 | The \fIcallback\fP is called with | |
276 | one or two additional | |
277 | arguments that indicates how many bytes were written to \fIoutchan\fR. | |
278 | If an error occurred during the background copy, the second argument is the | |
279 | error string associated with the error. | |
280 | With a background copy, | |
281 | it is not necessary to put \fIinchan\fR or \fIoutchan\fR into | |
282 | non-blocking mode; the \fBfcopy\fP command takes care of that automatically. | |
283 | However, it is necessary to enter the event loop by using | |
284 | the \fBvwait\fP command or by using Tk. | |
285 | .PP | |
286 | You are not allowed to do other I/O operations with | |
287 | \fIinchan\fR or \fIoutchan\fR during a background fcopy. | |
288 | If either \fIinchan\fR or \fIoutchan\fR get closed | |
289 | while the copy is in progress, the current copy is stopped | |
290 | and the command callback is \fInot\fP made. | |
291 | If \fIinchan\fR is closed, | |
292 | then all data already queued for \fIoutchan\fR is written out. | |
293 | .PP | |
294 | Note that \fIinchan\fR can become readable during a background copy. | |
295 | You should turn off any \fBfileevent\fP handlers during a background | |
296 | copy so those handlers do not interfere with the copy. | |
297 | Any I/O attempted by a \fBfileevent\fP handler will get a "channel busy" error. | |
298 | .PP | |
299 | \fBFcopy\fR translates end-of-line sequences in \fIinchan\fR and \fIoutchan\fR | |
300 | according to the \fB\-translation\fR option | |
301 | for these channels. | |
302 | See the manual entry for \fBfconfigure\fR for details on the | |
303 | \fB\-translation\fR option. | |
304 | The translations mean that the number of bytes read from \fIinchan\fR | |
305 | can be different than the number of bytes written to \fIoutchan\fR. | |
306 | Only the number of bytes written to \fIoutchan\fR is reported, | |
307 | either as the return value of a synchronous \fBfcopy\fP or | |
308 | as the argument to the callback for an asynchronous \fBfcopy\fP. | |
309 | .PP | |
310 | \fBFcopy\fR obeys the encodings configured for the channels. This | |
311 | means that the incoming characters are converted internally first | |
312 | UTF-8 and then into the encoding of the channel \fBfcopy\fR writes | |
313 | to. See the manual entry for \fBfconfigure\fR for details on the | |
314 | \fB\-encoding\fR option. No conversion is done if both channels are | |
315 | set to encoding "binary". If only the output channel is set to | |
316 | encoding "binary" the system will write the internal UTF-8 | |
317 | representation of the incoming characters. If only the input channel | |
318 | is set to encoding "binary" the system will assume that the incoming | |
319 | bytes are valid UTF-8 characters and convert them according to the | |
320 | output encoding. The behaviour of the system for bytes which are not | |
321 | valid UTF-8 characters is undefined in this case. | |
322 | ||
323 | .SH EXAMPLE | |
324 | .PP | |
325 | This first example shows how the callback gets | |
326 | passed the number of bytes transferred. | |
327 | It also uses vwait to put the application into the event loop. | |
328 | Of course, this simplified example could be done without the command | |
329 | callback. | |
330 | .DS | |
331 | proc Cleanup {in out bytes {error {}}} { | |
332 | global total | |
333 | set total $bytes | |
334 | close $in | |
335 | close $out | |
336 | if {[string length $error] != 0} { | |
337 | # error occurred during the copy | |
338 | } | |
339 | } | |
340 | set in [open $file1] | |
341 | set out [socket $server $port] | |
342 | fcopy $in $out -command [list Cleanup $in $out] | |
343 | vwait total | |
344 | ||
345 | .DE | |
346 | .PP | |
347 | The second example copies in chunks and tests for end of file | |
348 | in the command callback | |
349 | .DS | |
350 | proc CopyMore {in out chunk bytes {error {}}} { | |
351 | global total done | |
352 | incr total $bytes | |
353 | if {([string length $error] != 0) || [eof $in] { | |
354 | set done $total | |
355 | close $in | |
356 | close $out | |
357 | } else { | |
358 | fcopy $in $out -command [list CopyMore $in $out $chunk] \\ | |
359 | -size $chunk | |
360 | } | |
361 | } | |
362 | set in [open $file1] | |
363 | set out [socket $server $port] | |
364 | set chunk 1024 | |
365 | set total 0 | |
366 | fcopy $in $out -command [list CopyMore $in $out $chunk] -size $chunk | |
367 | vwait done | |
368 | ||
369 | .DE | |
370 | ||
371 | .SH "SEE ALSO" | |
372 | eof(n), fblocked(n), fconfigure(n) | |
373 | ||
374 | .SH KEYWORDS | |
375 | blocking, channel, end of line, end of file, nonblocking, read, translation |