diff options
author | dkf <donal.k.fellows@manchester.ac.uk> | 2007-07-04 13:51:29 (GMT) |
---|---|---|
committer | dkf <donal.k.fellows@manchester.ac.uk> | 2007-07-04 13:51:29 (GMT) |
commit | 76681ff9cf616e99686fb280dc3e3f2b891334d9 (patch) | |
tree | 9bcbc80ca6ba9e03dde14bb4067b70f6a669b2f0 /doc/StdChannels.3 | |
parent | 726415ce000fd8fd519c61d004b3fb673977ef50 (diff) | |
download | tcl-76681ff9cf616e99686fb280dc3e3f2b891334d9.zip tcl-76681ff9cf616e99686fb280dc3e3f2b891334d9.tar.gz tcl-76681ff9cf616e99686fb280dc3e3f2b891334d9.tar.bz2 |
Fixing some minor nroff misuses
Diffstat (limited to 'doc/StdChannels.3')
-rw-r--r-- | doc/StdChannels.3 | 31 |
1 files changed, 14 insertions, 17 deletions
diff --git a/doc/StdChannels.3 b/doc/StdChannels.3 index 73a5776..63d0e8b 100644 --- a/doc/StdChannels.3 +++ b/doc/StdChannels.3 @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: StdChannels.3,v 1.9 2004/09/06 09:44:57 dkf Exp $ +'\" RCS: @(#) $Id: StdChannels.3,v 1.10 2007/07/04 13:51:29 dkf Exp $ '\" .so man.macros .TH "Standard Channels" 3 7.5 Tcl "Tcl Library Procedures" @@ -28,8 +28,7 @@ output and the other for error messages. .PP Tcl generalizes this concept in a cross-platform way and exposes standard channels to the script level. - -.SH APIs +.SS "APPLICATION PROGRAMMING INTERFACES" .PP The public API procedures dealing directly with standard channels are \fBTcl_GetStdChannel\fR and \fBTcl_SetStdChannel\fR. Additional public @@ -51,9 +50,11 @@ Windows NT service.) A single standard channel is initialized when it is explicitly specified in a call to \fBTcl_SetStdChannel\fR. The states of the other standard channels are unaffected. -.sp +.RS +.PP Missing platform-specific standard channels do not matter here. This approach is not available at the script level. +.RE .TP 2) All uninitialized standard channels are initialized to @@ -69,9 +70,7 @@ when information about any standard channel is requested with a call to \fBTcl_GetStdChannel\fR, or with a call to \fBTcl_GetChannel\fR which specifies one of the standard names (\fBstdin\fR, \fBstdout\fR and \fBstderr\fR). -.RE -.sp -.RS +.PP In case of missing platform-specific standard channels, the Tcl standard channels are considered as initialized and then immediately closed. This means that the first three Tcl channels then opened by @@ -82,14 +81,13 @@ the application are designated as the Tcl standard channels. All uninitialized standard channels are initialized to platform-specific default values when a user-requested channel is registered with \fBTcl_RegisterChannel\fR. -.sp +.PP In case of unavailable platform-specific standard channels the channel whose creation caused the initialization of the Tcl standard channels is made a normal channel. The next three Tcl channels opened by the application are designated as the Tcl standard channels. In other words, of the first four Tcl channels opened by the application the second to fourth are designated as the Tcl standard channels. -.PP .SH "RE-INITIALIZATION OF TCL STANDARD CHANNELS" .PP Once a Tcl standard channel is initialized through one of the methods @@ -103,21 +101,20 @@ channel, too. If more than one Tcl standard channel was closed that slot was not initialized before. It is this behavior which enables an application to employ method 1 of initialization, i.e. to create and designate their own Tcl standard channels. - -.SH tclsh +.SH "SHELL-SPECIFIC DETAILS" +.SS tclsh .PP -The Tcl shell (or rather \fBTcl_Main\fR) uses method 2 to initialize +The Tcl shell (or rather the function \fBTcl_Main\fR, which forms the +core of the shell's implementation) uses method 2 to initialize the standard channels. - -.SH wish +.SS wish .PP -The windowing shell (or rather \fBTk_MainEx\fR) uses method 1 to +The windowing shell (or rather the function \fBTk_MainEx\fR, which +forms the core of the shell's implementation) uses method 1 to initialize the standard channels (See \fBTk_InitConsoleChannels\fR) on non-Unix platforms. On Unix platforms, \fBTk_MainEx\fR implicitly uses method 2 to initialize the standard channels. - .SH "SEE ALSO" Tcl_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) - .SH KEYWORDS standard channels |