From 8496c7c6845c751453f883cb2af48738e39cce90 Mon Sep 17 00:00:00 2001 From: andreas_kupries Date: Mon, 5 Nov 2007 20:43:43 +0000 Subject: * doc/CrtConsoleChan.3: New file providing minimal documentation of 'Tk_InitConsoleChannels()'. This is for [SF Tk Bug 432435]. --- ChangeLog | 5 +++++ doc/CrtConsoleChan.3 | 45 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 50 insertions(+) create mode 100644 doc/CrtConsoleChan.3 diff --git a/ChangeLog b/ChangeLog index e7973c9..187832f 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +2007-11-05 Andreas Kupries + + * doc/CrtConsoleChan.3: New file providing minimal documentation + of 'Tk_InitConsoleChannels()'. This is for [SF Tk Bug 432435]. + 2007-11-05 Joe English * 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 \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 -- cgit v0.12