diff options
author | andreas_kupries <akupries@shaw.ca> | 2007-11-05 20:43:43 (GMT) |
---|---|---|
committer | andreas_kupries <akupries@shaw.ca> | 2007-11-05 20:43:43 (GMT) |
commit | 8496c7c6845c751453f883cb2af48738e39cce90 (patch) | |
tree | 6d0b26744593691d1144a68e2091bf08eafe9c6f | |
parent | 1eaf13b6be506ec80ad95f582328f4269690e1d8 (diff) | |
download | tk-8496c7c6845c751453f883cb2af48738e39cce90.zip tk-8496c7c6845c751453f883cb2af48738e39cce90.tar.gz tk-8496c7c6845c751453f883cb2af48738e39cce90.tar.bz2 |
* doc/CrtConsoleChan.3: New file providing minimal documentation
of 'Tk_InitConsoleChannels()'. This is for [SF Tk Bug 432435].
-rw-r--r-- | ChangeLog | 5 | ||||
-rw-r--r-- | doc/CrtConsoleChan.3 | 45 |
2 files changed, 50 insertions, 0 deletions
@@ -1,3 +1,8 @@ +2007-11-05 Andreas Kupries <andreask@activestate.com> + + * doc/CrtConsoleChan.3: New file providing minimal documentation + of 'Tk_InitConsoleChannels()'. This is for [SF Tk Bug 432435]. + 2007-11-05 Joe English <jenglish@users.sourceforge.net> * macosx/ttkMacOSXTheme.c(TreeitemLayout): Remove focus ring diff --git a/doc/CrtConsoleChan.3 b/doc/CrtConsoleChan.3 new file mode 100644 index 0000000..7d061d3 --- /dev/null +++ b/doc/CrtConsoleChan.3 @@ -0,0 +1,45 @@ +'\" +'\" Copyright (c) 2007 ActiveState Software Inc. +'\" +'\" See the file "license.terms" for information on usage and redistribution +'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. +'\" +'\" RCS: @(#) $Id: CrtConsoleChan.3,v 1.1 2007/11/05 20:43:45 andreas_kupries Exp $ +'\" +.so man.macros +.TH Tk_InitConsoleChannels 3 8.5 Tk "Tk Library Procedures" +.BS +.SH NAME +Tk_InitConsoleChannels \- Install the console channels as standard channels +.SH SYNOPSIS +.nf +\fB#include <tk.h>\fR +.sp +\fBTk_InitConsoleChannels\fR(\fIinterp\fR) +.SH ARGUMENTS +.AS Tcl_Interp *interp in +.AP Tcl_Interp *interp in +Interpreter in which the console channels are created. +.BE +.SH DESCRIPTION +.PP +\fBTk_InitConsoleChannels\fR is invoked to create a set of console +channels and install them as the standard channels. All I/O on these +channels will be discarded until \fBTk_CreateConsoleWindow\fR is +called to attach the console to a text widget. +.PP +This function is for use by shell applications based on Tk, like +\fbwish\fR, on platforms which have no standard channels in graphical +mode, like Win32. +.PP +The \fIinterp\fR argument is the interpreter in which to create and +install the console channels. +.PP +\fBNOTE:\fR If this function is used it has to be called before the +first call to \fBTcl_RegisterChannel\fR, directly, or indirectly +through other channel functions. Because otherwise the standard +channels will be already initialized to the system defaults, which will +be nonsensical for the case \fBTk_InitConsoleChannels\fR is for. +.SH "SEE ALSO" +.SH KEYWORDS +standard channels, console |