Commit | Line | Data |
---|---|---|
86530b38 AT |
1 | '\" |
2 | '\" Copyright (c) 1995-1996 Sun Microsystems, Inc. | |
3 | '\" | |
4 | '\" See the file "license.terms" for information on usage and redistribution | |
5 | '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. | |
6 | '\" | |
7 | '\" RCS: @(#) $Id: fconfigure.n,v 1.7.2.2 2004/10/27 12:52:40 dkf Exp $ | |
8 | '\" | |
9 | '\" The definitions below are for supplemental macros used in Tcl/Tk | |
10 | '\" manual entries. | |
11 | '\" | |
12 | '\" .AP type name in/out ?indent? | |
13 | '\" Start paragraph describing an argument to a library procedure. | |
14 | '\" type is type of argument (int, etc.), in/out is either "in", "out", | |
15 | '\" or "in/out" to describe whether procedure reads or modifies arg, | |
16 | '\" and indent is equivalent to second arg of .IP (shouldn't ever be | |
17 | '\" needed; use .AS below instead) | |
18 | '\" | |
19 | '\" .AS ?type? ?name? | |
20 | '\" Give maximum sizes of arguments for setting tab stops. Type and | |
21 | '\" name are examples of largest possible arguments that will be passed | |
22 | '\" to .AP later. If args are omitted, default tab stops are used. | |
23 | '\" | |
24 | '\" .BS | |
25 | '\" Start box enclosure. From here until next .BE, everything will be | |
26 | '\" enclosed in one large box. | |
27 | '\" | |
28 | '\" .BE | |
29 | '\" End of box enclosure. | |
30 | '\" | |
31 | '\" .CS | |
32 | '\" Begin code excerpt. | |
33 | '\" | |
34 | '\" .CE | |
35 | '\" End code excerpt. | |
36 | '\" | |
37 | '\" .VS ?version? ?br? | |
38 | '\" Begin vertical sidebar, for use in marking newly-changed parts | |
39 | '\" of man pages. The first argument is ignored and used for recording | |
40 | '\" the version when the .VS was added, so that the sidebars can be | |
41 | '\" found and removed when they reach a certain age. If another argument | |
42 | '\" is present, then a line break is forced before starting the sidebar. | |
43 | '\" | |
44 | '\" .VE | |
45 | '\" End of vertical sidebar. | |
46 | '\" | |
47 | '\" .DS | |
48 | '\" Begin an indented unfilled display. | |
49 | '\" | |
50 | '\" .DE | |
51 | '\" End of indented unfilled display. | |
52 | '\" | |
53 | '\" .SO | |
54 | '\" Start of list of standard options for a Tk widget. The | |
55 | '\" options follow on successive lines, in four columns separated | |
56 | '\" by tabs. | |
57 | '\" | |
58 | '\" .SE | |
59 | '\" End of list of standard options for a Tk widget. | |
60 | '\" | |
61 | '\" .OP cmdName dbName dbClass | |
62 | '\" Start of description of a specific option. cmdName gives the | |
63 | '\" option's name as specified in the class command, dbName gives | |
64 | '\" the option's name in the option database, and dbClass gives | |
65 | '\" the option's class in the option database. | |
66 | '\" | |
67 | '\" .UL arg1 arg2 | |
68 | '\" Print arg1 underlined, then print arg2 normally. | |
69 | '\" | |
70 | '\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $ | |
71 | '\" | |
72 | '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. | |
73 | .if t .wh -1.3i ^B | |
74 | .nr ^l \n(.l | |
75 | .ad b | |
76 | '\" # Start an argument description | |
77 | .de AP | |
78 | .ie !"\\$4"" .TP \\$4 | |
79 | .el \{\ | |
80 | . ie !"\\$2"" .TP \\n()Cu | |
81 | . el .TP 15 | |
82 | .\} | |
83 | .ta \\n()Au \\n()Bu | |
84 | .ie !"\\$3"" \{\ | |
85 | \&\\$1 \\fI\\$2\\fP (\\$3) | |
86 | .\".b | |
87 | .\} | |
88 | .el \{\ | |
89 | .br | |
90 | .ie !"\\$2"" \{\ | |
91 | \&\\$1 \\fI\\$2\\fP | |
92 | .\} | |
93 | .el \{\ | |
94 | \&\\fI\\$1\\fP | |
95 | .\} | |
96 | .\} | |
97 | .. | |
98 | '\" # define tabbing values for .AP | |
99 | .de AS | |
100 | .nr )A 10n | |
101 | .if !"\\$1"" .nr )A \\w'\\$1'u+3n | |
102 | .nr )B \\n()Au+15n | |
103 | .\" | |
104 | .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n | |
105 | .nr )C \\n()Bu+\\w'(in/out)'u+2n | |
106 | .. | |
107 | .AS Tcl_Interp Tcl_CreateInterp in/out | |
108 | '\" # BS - start boxed text | |
109 | '\" # ^y = starting y location | |
110 | '\" # ^b = 1 | |
111 | .de BS | |
112 | .br | |
113 | .mk ^y | |
114 | .nr ^b 1u | |
115 | .if n .nf | |
116 | .if n .ti 0 | |
117 | .if n \l'\\n(.lu\(ul' | |
118 | .if n .fi | |
119 | .. | |
120 | '\" # BE - end boxed text (draw box now) | |
121 | .de BE | |
122 | .nf | |
123 | .ti 0 | |
124 | .mk ^t | |
125 | .ie n \l'\\n(^lu\(ul' | |
126 | .el \{\ | |
127 | .\" Draw four-sided box normally, but don't draw top of | |
128 | .\" box if the box started on an earlier page. | |
129 | .ie !\\n(^b-1 \{\ | |
130 | \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' | |
131 | .\} | |
132 | .el \}\ | |
133 | \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' | |
134 | .\} | |
135 | .\} | |
136 | .fi | |
137 | .br | |
138 | .nr ^b 0 | |
139 | .. | |
140 | '\" # VS - start vertical sidebar | |
141 | '\" # ^Y = starting y location | |
142 | '\" # ^v = 1 (for troff; for nroff this doesn't matter) | |
143 | .de VS | |
144 | .if !"\\$2"" .br | |
145 | .mk ^Y | |
146 | .ie n 'mc \s12\(br\s0 | |
147 | .el .nr ^v 1u | |
148 | .. | |
149 | '\" # VE - end of vertical sidebar | |
150 | .de VE | |
151 | .ie n 'mc | |
152 | .el \{\ | |
153 | .ev 2 | |
154 | .nf | |
155 | .ti 0 | |
156 | .mk ^t | |
157 | \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' | |
158 | .sp -1 | |
159 | .fi | |
160 | .ev | |
161 | .\} | |
162 | .nr ^v 0 | |
163 | .. | |
164 | '\" # Special macro to handle page bottom: finish off current | |
165 | '\" # box/sidebar if in box/sidebar mode, then invoked standard | |
166 | '\" # page bottom macro. | |
167 | .de ^B | |
168 | .ev 2 | |
169 | 'ti 0 | |
170 | 'nf | |
171 | .mk ^t | |
172 | .if \\n(^b \{\ | |
173 | .\" Draw three-sided box if this is the box's first page, | |
174 | .\" draw two sides but no top otherwise. | |
175 | .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 | |
176 | .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c | |
177 | .\} | |
178 | .if \\n(^v \{\ | |
179 | .nr ^x \\n(^tu+1v-\\n(^Yu | |
180 | \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c | |
181 | .\} | |
182 | .bp | |
183 | 'fi | |
184 | .ev | |
185 | .if \\n(^b \{\ | |
186 | .mk ^y | |
187 | .nr ^b 2 | |
188 | .\} | |
189 | .if \\n(^v \{\ | |
190 | .mk ^Y | |
191 | .\} | |
192 | .. | |
193 | '\" # DS - begin display | |
194 | .de DS | |
195 | .RS | |
196 | .nf | |
197 | .sp | |
198 | .. | |
199 | '\" # DE - end display | |
200 | .de DE | |
201 | .fi | |
202 | .RE | |
203 | .sp | |
204 | .. | |
205 | '\" # SO - start of list of standard options | |
206 | .de SO | |
207 | .SH "STANDARD OPTIONS" | |
208 | .LP | |
209 | .nf | |
210 | .ta 5.5c 11c | |
211 | .ft B | |
212 | .. | |
213 | '\" # SE - end of list of standard options | |
214 | .de SE | |
215 | .fi | |
216 | .ft R | |
217 | .LP | |
218 | See the \\fBoptions\\fR manual entry for details on the standard options. | |
219 | .. | |
220 | '\" # OP - start of full description for a single option | |
221 | .de OP | |
222 | .LP | |
223 | .nf | |
224 | .ta 4c | |
225 | Command-Line Name: \\fB\\$1\\fR | |
226 | Database Name: \\fB\\$2\\fR | |
227 | Database Class: \\fB\\$3\\fR | |
228 | .fi | |
229 | .IP | |
230 | .. | |
231 | '\" # CS - begin code excerpt | |
232 | .de CS | |
233 | .RS | |
234 | .nf | |
235 | .ta .25i .5i .75i 1i | |
236 | .. | |
237 | '\" # CE - end code excerpt | |
238 | .de CE | |
239 | .fi | |
240 | .RE | |
241 | .. | |
242 | .de UL | |
243 | \\$1\l'|0\(ul'\\$2 | |
244 | .. | |
245 | .TH fconfigure n 8.3 Tcl "Tcl Built-In Commands" | |
246 | .BS | |
247 | '\" Note: do not modify the .SH NAME line immediately below! | |
248 | .SH NAME | |
249 | fconfigure \- Set and get options on a channel | |
250 | .SH SYNOPSIS | |
251 | .nf | |
252 | \fBfconfigure \fIchannelId\fR | |
253 | \fBfconfigure \fIchannelId\fR \fIname\fR | |
254 | \fBfconfigure \fIchannelId\fR \fIname value \fR?\fIname value ...\fR? | |
255 | .fi | |
256 | .BE | |
257 | .SH DESCRIPTION | |
258 | .PP | |
259 | The \fBfconfigure\fR command sets and retrieves options for channels. | |
260 | .PP | |
261 | \fIChannelId\fR identifies the channel for which to set or query an | |
262 | option and must refer to an open channel such as a Tcl standard | |
263 | channel (\fBstdin\fR, \fBstdout\fR, or \fBstderr\fR), the return | |
264 | value from an invocation of \fBopen\fR or \fBsocket\fR, or the result | |
265 | of a channel creation command provided by a Tcl extension. | |
266 | .PP | |
267 | If no \fIname\fR or \fIvalue\fR arguments are supplied, the command | |
268 | returns a list containing alternating option names and values for the channel. | |
269 | If \fIname\fR is supplied but no \fIvalue\fR then the command returns | |
270 | the current value of the given option. | |
271 | If one or more pairs of \fIname\fR and \fIvalue\fR are supplied, the | |
272 | command sets each of the named options to the corresponding \fIvalue\fR; | |
273 | in this case the return value is an empty string. | |
274 | .PP | |
275 | The options described below are supported for all channels. In addition, | |
276 | each channel type may add options that only it supports. See the manual | |
277 | entry for the command that creates each type of channels for the options | |
278 | that that specific type of channel supports. For example, see the manual | |
279 | entry for the \fBsocket\fR command for its additional options. | |
280 | .TP | |
281 | \fB\-blocking\fR \fIboolean\fR | |
282 | The \fB\-blocking\fR option determines whether I/O operations on the | |
283 | channel can cause the process to block indefinitely. | |
284 | The value of the option must be a proper boolean value. | |
285 | Channels are normally in blocking mode; if a channel is placed into | |
286 | nonblocking mode it will affect the operation of the \fBgets\fR, | |
287 | \fBread\fR, \fBputs\fR, \fBflush\fR, and \fBclose\fR commands; | |
288 | see the documentation for those commands for details. | |
289 | For nonblocking mode to work correctly, the application must be | |
290 | using the Tcl event loop (e.g. by calling \fBTcl_DoOneEvent\fR or | |
291 | invoking the \fBvwait\fR command). | |
292 | .TP | |
293 | \fB\-buffering\fR \fInewValue\fR | |
294 | . | |
295 | If \fInewValue\fR is \fBfull\fR then the I/O system will buffer output | |
296 | until its internal buffer is full or until the \fBflush\fR command is | |
297 | invoked. If \fInewValue\fR is \fBline\fR, then the I/O system will | |
298 | automatically flush output for the channel whenever a newline character | |
299 | is output. If \fInewValue\fR is \fBnone\fR, the I/O system will flush | |
300 | automatically after every output operation. The default is for | |
301 | \fB\-buffering\fR to be set to \fBfull\fR except for channels that | |
302 | connect to terminal-like devices; for these channels the initial setting | |
303 | is \fBline\fR. Additionally, \fBstdin\fR and \fBstdout\fR are | |
304 | initially set to \fBline\fR, and \fBstderr\fR is set to \fBnone\fR. | |
305 | .TP | |
306 | \fB\-buffersize\fR \fInewSize\fR | |
307 | . | |
308 | \fINewvalue\fR must be an integer; its value is used to set the size of | |
309 | buffers, in bytes, subsequently allocated for this channel to store input | |
310 | or output. \fINewvalue\fR must be between ten and one million, allowing | |
311 | buffers of ten to one million bytes in size. | |
312 | .TP | |
313 | \fB\-encoding\fR \fIname\fR | |
314 | . | |
315 | This option is used to specify the encoding of the channel, so that the data | |
316 | can be converted to and from Unicode for use in Tcl. For instance, in | |
317 | order for Tcl to read characters from a Japanese file in \fBshiftjis\fR | |
318 | and properly process and display the contents, the encoding would be set | |
319 | to \fBshiftjis\fR. Thereafter, when reading from the channel, the bytes in | |
320 | the Japanese file would be converted to Unicode as they are read. | |
321 | Writing is also supported \- as Tcl strings are written to the channel they | |
322 | will automatically be converted to the specified encoding on output. | |
323 | .RS | |
324 | .PP | |
325 | If a file contains pure binary data (for instance, a JPEG image), the | |
326 | encoding for the channel should be configured to be \fBbinary\fR. Tcl | |
327 | will then assign no interpretation to the data in the file and simply read or | |
328 | write raw bytes. The Tcl \fBbinary\fR command can be used to manipulate this | |
329 | byte-oriented data. | |
330 | .PP | |
331 | The default encoding for newly opened channels is the same platform- and | |
332 | locale-dependent system encoding used for interfacing with the operating | |
333 | system. | |
334 | .RE | |
335 | .TP | |
336 | \fB\-eofchar\fR \fIchar\fR | |
337 | .TP | |
338 | \fB\-eofchar\fR \fB{\fIinChar outChar\fB}\fR | |
339 | . | |
340 | This option supports DOS file systems that use Control-z (\ex1a) as an | |
341 | end of file marker. If \fIchar\fR is not an empty string, then this | |
342 | character signals end-of-file when it is encountered during input. For | |
343 | output, the end-of-file character is output when the channel is closed. | |
344 | If \fIchar\fR is the empty string, then there is no special end of file | |
345 | character marker. For read-write channels, a two-element list specifies | |
346 | the end of file marker for input and output, respectively. As a | |
347 | convenience, when setting the end-of-file character for a read-write | |
348 | channel you can specify a single value that will apply to both reading | |
349 | and writing. When querying the end-of-file character of a read-write | |
350 | channel, a two-element list will always be returned. The default value | |
351 | for \fB\-eofchar\fR is the empty string in all cases except for files | |
352 | under Windows. In that case the \fB\-eofchar\fR is Control-z (\ex1a) for | |
353 | reading and the empty string for writing. | |
354 | .TP | |
355 | \fB\-translation\fR \fImode\fR | |
356 | .TP | |
357 | \fB\-translation\fR \fB{\fIinMode outMode\fB}\fR | |
358 | . | |
359 | In Tcl scripts the end of a line is always represented using a single | |
360 | newline character (\en). However, in actual files and devices the end of | |
361 | a line may be represented differently on different platforms, or even for | |
362 | different devices on the same platform. For example, under UNIX newlines | |
363 | are used in files, whereas carriage-return-linefeed sequences are | |
364 | normally used in network connections. On input (i.e., with \fBgets\fP | |
365 | and \fBread\fP) the Tcl I/O system automatically translates the external | |
366 | end-of-line representation into newline characters. Upon output (i.e., | |
367 | with \fBputs\fP), the I/O system translates newlines to the external | |
368 | end-of-line representation. The default translation mode, \fBauto\fP, | |
369 | handles all the common cases automatically, but the \fB\-translation\fR | |
370 | option provides explicit control over the end of line translations. | |
371 | .RS | |
372 | .PP | |
373 | The value associated with \fB\-translation\fR is a single item for | |
374 | read-only and write-only channels. The value is a two-element list for | |
375 | read-write channels; the read translation mode is the first element of | |
376 | the list, and the write translation mode is the second element. As a | |
377 | convenience, when setting the translation mode for a read-write channel | |
378 | you can specify a single value that will apply to both reading and | |
379 | writing. When querying the translation mode of a read-write channel, a | |
380 | two-element list will always be returned. The following values are | |
381 | currently supported: | |
382 | .TP | |
383 | \fBauto\fR | |
384 | . | |
385 | As the input translation mode, \fBauto\fR treats any of newline | |
386 | (\fBlf\fP), carriage return (\fBcr\fP), or carriage return followed by a | |
387 | newline (\fBcrlf\fP) as the end of line representation. The end of line | |
388 | representation can even change from line-to-line, and all cases are | |
389 | translated to a newline. As the output translation mode, \fBauto\fR | |
390 | chooses a platform specific representation; for sockets on all platforms | |
391 | Tcl chooses \fBcrlf\fR, for all Unix flavors, it chooses \fBlf\fR, for the | |
392 | Macintosh platform it chooses \fBcr\fR and for the various flavors of | |
393 | Windows it chooses \fBcrlf\fR. The default setting for | |
394 | \fB\-translation\fR is \fBauto\fR for both input and output. | |
395 | .TP | |
396 | \fBbinary\fR | |
397 | . | |
398 | No end-of-line translations are performed. This is nearly identical to | |
399 | \fBlf\fP mode, except that in addition \fBbinary\fP mode also sets the | |
400 | end-of-file character to the empty string (which disables it) and sets the | |
401 | encoding to \fBbinary\fR (which disables encoding filtering). See the | |
402 | description of \fB\-eofchar\fR and \fB\-encoding\fR for more information. | |
403 | .TP | |
404 | \fBcr\fR | |
405 | . | |
406 | The end of a line in the underlying file or device is represented by a | |
407 | single carriage return character. As the input translation mode, | |
408 | \fBcr\fP mode converts carriage returns to newline characters. As the | |
409 | output translation mode, \fBcr\fP mode translates newline characters to | |
410 | carriage returns. This mode is typically used on Macintosh platforms. | |
411 | .TP | |
412 | \fBcrlf\fR | |
413 | . | |
414 | The end of a line in the underlying file or device is represented by a | |
415 | carriage return character followed by a linefeed character. As the input | |
416 | translation mode, \fBcrlf\fP mode converts carriage-return-linefeed | |
417 | sequences to newline characters. As the output translation mode, | |
418 | \fBcrlf\fP mode translates newline characters to carriage-return-linefeed | |
419 | sequences. This mode is typically used on Windows platforms and for | |
420 | network connections. | |
421 | .TP | |
422 | \fBlf\fR | |
423 | . | |
424 | The end of a line in the underlying file or device is represented by a | |
425 | single newline (linefeed) character. In this mode no translations occur | |
426 | during either input or output. This mode is typically used on UNIX | |
427 | platforms. | |
428 | .RE | |
429 | .PP | |
430 | .SH "STANDARD CHANNELS" | |
431 | .PP | |
432 | The Tcl standard channels (\fBstdin\fR, \fBstdout\fR, and \fBstderr\fR) | |
433 | can be configured through this command like every other channel opened | |
434 | by the Tcl library. Beyond the standard options described above they | |
435 | will also support any special option according to their current type. | |
436 | If, for example, a Tcl application is started by the \fBinet\fR | |
437 | super-server common on Unix system its Tcl standard channels will be | |
438 | sockets and thus support the socket options. | |
439 | .SH EXAMPLES | |
440 | Instruct Tcl to always send output to \fBstdout\fR immediately, | |
441 | whether or not it is to a terminal: | |
442 | .CS | |
443 | \fBfconfigure\fR stdout -buffering none | |
444 | .CE | |
445 | .PP | |
446 | Open a socket and read lines from it without ever blocking the | |
447 | processing of other events: | |
448 | .CS | |
449 | set s [socket some.where.com 12345] | |
450 | \fBfconfigure\fR $s -blocking 0 | |
451 | fileevent $s readable "readMe $s" | |
452 | proc readMe chan { | |
453 | if {[gets $chan line] < 0} { | |
454 | if {[eof $chan]} { | |
455 | close $chan | |
456 | return | |
457 | } | |
458 | # Could not read a complete line this time; Tcl's | |
459 | # internal buffering will hold the partial line for us | |
460 | # until some more data is available over the socket. | |
461 | } else { | |
462 | puts stdout $line | |
463 | } | |
464 | } | |
465 | .CE | |
466 | .PP | |
467 | Read a PPM-format image from a file: | |
468 | .CS | |
469 | # Open the file and put it into Unix ASCII mode | |
470 | set f [open teapot.ppm] | |
471 | \fBfconfigure\fR $f \-encoding ascii \-translation lf | |
472 | ||
473 | # Get the header | |
474 | if {[gets $f] ne "P6"} { | |
475 | error "not a raw\-bits PPM" | |
476 | } | |
477 | ||
478 | # Read lines until we have got non-comment lines | |
479 | # that supply us with three decimal values. | |
480 | set words {} | |
481 | while {[llength $words] < 3} { | |
482 | gets $f line | |
483 | if {[string match "#*" $line]} continue | |
484 | lappend words [eval concat [scan $line %d%d%d]] | |
485 | } | |
486 | ||
487 | # Those words supply the size of the image and its | |
488 | # overall depth per channel. Assign to variables. | |
489 | foreach {xSize ySize depth} $words {break} | |
490 | ||
491 | # Now switch to binary mode to pull in the data, | |
492 | # one byte per channel (red,green,blue) per pixel. | |
493 | \fBfconfigure\fR $f \-translation binary | |
494 | set numDataBytes [expr {3 * $xSize * $ySize}] | |
495 | set data [read $f $numDataBytes] | |
496 | ||
497 | close $f | |
498 | .CE | |
499 | ||
500 | .SH "SEE ALSO" | |
501 | close(n), flush(n), gets(n), open(n), puts(n), read(n), socket(n), | |
502 | Tcl_StandardChannels(3) | |
503 | ||
504 | .SH KEYWORDS | |
505 | blocking, buffering, carriage return, end of line, flushing, linemode, | |
506 | newline, nonblocking, platform, translation, encoding, filter, byte array, | |
507 | binary |