Initial commit of OpenSPARC T2 design and verification files.
[OpenSPARC-T2-DV] / tools / src / nas,5.n2.os.2 / lib / python / man / man3 / Tcl_StandardChannels.3
CommitLineData
86530b38
AT
1'\"
2'\" Copyright (c) 2001 by ActiveState Corporation
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: StdChannels.3,v 1.8 2002/11/15 15:34:17 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
218See 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
225Command-Line Name: \\fB\\$1\\fR
226Database Name: \\fB\\$2\\fR
227Database 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 "Standard Channels" 3 7.5 Tcl "Tcl Library Procedures"
246.BS
247'\" Note: do not modify the .SH NAME line immediately below!
248.SH NAME
249Tcl_StandardChannels \- How the Tcl library deals with the standard channels
250.BE
251
252.SH DESCRIPTION
253.PP
254This page explains the initialization and use of standard channels in
255the Tcl library.
256.PP
257The term \fIstandard channels\fR comes out of the Unix world and
258refers to the three channels automatically opened by the OS for
259each new application. They are \fBstdin\fR, \fBstdout\fR and
260\fBstderr\fR. The first is the standard input an application can read
261from, the other two refer to writable channels, one for regular
262output and the other for error messages.
263.PP
264Tcl generalizes this concept in a cross-platform way and
265exposes standard channels to the script level.
266
267.SH APIs
268.PP
269The public API procedures dealing directly with standard channels are
270\fBTcl_GetStdChannel\fR and \fBTcl_SetStdChannel\fR. Additional public
271APIs to consider are \fBTcl_RegisterChannel\fR,
272\fBTcl_CreateChannel\fR and \fBTcl_GetChannel\fR.
273.SH "INITIALIZATION OF TCL STANDARD CHANNELS"
274.PP
275Standard channels are initialized by the Tcl library in three cases:
276when explicitly requested, when implicitly required before returning
277channel information, or when implicitly required during registration
278of a new channel.
279.PP
280These cases differ in how they handle unavailable platform- specific
281standard channels. (A channel is not ``available'' if it could not be
282successfully opened; for example, in a Tcl application run as a
283Windows NT service.)
284.TP
2851)
286A single standard channel is initialized when it is explicitly
287specified in a call to \fBTcl_SetStdChannel\fR. The state of the
288other standard channels are unaffected.
289.sp
290Missing platform-specific standard channels do not matter here. This
291approach is not available at the script level.
292.TP
2932)
294All uninitialized standard channels are initialized to
295platform-specific default values:
296.RS
297.TP
298(a)
299when open channels are listed with \fBTcl_GetChannelNames\fR (or the
300\fBfile channels\fR script command), or
301.TP
302(b)
303when information about any standard channel is requested with a call
304to \fBTcl_GetStdChannel\fR, or with a call to \fBTcl_GetChannel\fR
305which specifies one of the standard names (\fBstdin\fR, \fBstdout\fR
306and \fBstderr\fR).
307.RE
308.sp
309.RS
310In case of missing platform-specific standard channels, the Tcl
311standard channels are considered as initialized and then immediately
312closed. This means that the first three Tcl channels then opened by
313the application are designated as the Tcl standard channels.
314.RE
315.TP
3163)
317All uninitialized standard channels are initialized to
318platform-specific default values when a user-requested channel is
319registered with \fBTcl_RegisterChannel\fR.
320.sp
321In case of unavailable platform-specific standard channels the channel
322whose creation caused the initialization of the Tcl standard channels
323is made a normal channel. The next three Tcl channels opened by the
324application are designated as the Tcl standard channels. In other
325words, of the first four Tcl channels opened by the application the
326second to fourth are designated as the Tcl standard channels.
327.PP
328.SH "RE-INITIALIZATION OF TCL STANDARD CHANNELS"
329.PP
330Once a Tcl standard channel is initialized through one of the methods
331above, closing this Tcl standard channel will cause the next call to
332\fBTcl_CreateChannel\fR to make the new channel the new standard
333channel, too. If more than one Tcl standard channel was closed
334\fBTcl_CreateChannel\fR will fill the empty slots in the order
335\fBstdin\fR, \fBstdout\fR and \fBstderr\fR.
336.PP
337\fBTcl_CreateChannel\fR will not try to reinitialize an empty slot if
338that slot was not initialized before. It is this behavior which
339enables an application to employ method 1 of initialization, i.e. to
340create and designate their own Tcl standard channels.
341
342.SH tclsh
343.PP
344The Tcl shell (or rather \fBTcl_Main\fR) uses method 2 to initialize
345the standard channels.
346
347.SH wish
348.PP
349The windowing shell (or rather \fBTk_MainEx\fR) uses method 1 to
350initialize the standard channels (See \fBTk_InitConsoleChannels\fR)
351on non-Unix platforms. On Unix platforms, \fBTk_MainEx\fR implicitly
352uses method 2 to initialize the standard channels.
353
354.SH "SEE ALSO"
355Tcl_CreateChannel(3), Tcl_RegisterChannel(3), Tcl_GetChannel(3), Tcl_GetStdChannel(3), Tcl_SetStdChannel(3), Tk_InitConsoleChannels(3), tclsh(1), wish(1), Tcl_Main(3), Tk_MainEx(3)
356
357.SH KEYWORDS
358standard channels