File
doc/CrtConsoleChan.3
— part of check-in
[3fa2c360]
at
2016-03-11 14:47:03
on branch trunk
— Excess spacing in documentation
(user:
jan.nijtmans
size: 1502)
[more...]
0000: 27 5c 22 0a 27 5c 22 20 43 6f 70 79 72 69 67 68 '\".'\" Copyrigh
0010: 74 20 28 63 29 20 32 30 30 37 20 41 63 74 69 76 t (c) 2007 Activ
0020: 65 53 74 61 74 65 20 53 6f 66 74 77 61 72 65 20 eState Software
0030: 49 6e 63 2e 0a 27 5c 22 0a 27 5c 22 20 53 65 65 Inc..'\".'\" See
0040: 20 74 68 65 20 66 69 6c 65 20 22 6c 69 63 65 6e the file "licen
0050: 73 65 2e 74 65 72 6d 73 22 20 66 6f 72 20 69 6e se.terms" for in
0060: 66 6f 72 6d 61 74 69 6f 6e 20 6f 6e 20 75 73 61 formation on usa
0070: 67 65 20 61 6e 64 20 72 65 64 69 73 74 72 69 62 ge and redistrib
0080: 75 74 69 6f 6e 0a 27 5c 22 20 6f 66 20 74 68 69 ution.'\" of thi
0090: 73 20 66 69 6c 65 2c 20 61 6e 64 20 66 6f 72 20 s file, and for
00a0: 61 20 44 49 53 43 4c 41 49 4d 45 52 20 4f 46 20 a DISCLAIMER OF
00b0: 41 4c 4c 20 57 41 52 52 41 4e 54 49 45 53 2e 0a ALL WARRANTIES..
00c0: 27 5c 22 0a 2e 54 48 20 54 6b 5f 49 6e 69 74 43 '\"..TH Tk_InitC
00d0: 6f 6e 73 6f 6c 65 43 68 61 6e 6e 65 6c 73 20 33 onsoleChannels 3
00e0: 20 38 2e 35 20 54 6b 20 22 54 6b 20 4c 69 62 72 8.5 Tk "Tk Libr
00f0: 61 72 79 20 50 72 6f 63 65 64 75 72 65 73 22 0a ary Procedures".
0100: 2e 73 6f 20 6d 61 6e 2e 6d 61 63 72 6f 73 0a 2e .so man.macros..
0110: 42 53 0a 2e 53 48 20 4e 41 4d 45 0a 54 6b 5f 49 BS..SH NAME.Tk_I
0120: 6e 69 74 43 6f 6e 73 6f 6c 65 43 68 61 6e 6e 65 nitConsoleChanne
0130: 6c 73 20 5c 2d 20 49 6e 73 74 61 6c 6c 20 74 68 ls \- Install th
0140: 65 20 63 6f 6e 73 6f 6c 65 20 63 68 61 6e 6e 65 e console channe
0150: 6c 73 20 61 73 20 73 74 61 6e 64 61 72 64 20 63 ls as standard c
0160: 68 61 6e 6e 65 6c 73 0a 2e 53 48 20 53 59 4e 4f hannels..SH SYNO
0170: 50 53 49 53 0a 2e 6e 66 0a 5c 66 42 23 69 6e 63 PSIS..nf.\fB#inc
0180: 6c 75 64 65 20 3c 74 6b 2e 68 3e 5c 66 52 0a 2e lude <tk.h>\fR..
0190: 73 70 0a 5c 66 42 54 6b 5f 49 6e 69 74 43 6f 6e sp.\fBTk_InitCon
01a0: 73 6f 6c 65 43 68 61 6e 6e 65 6c 73 5c 66 52 28 soleChannels\fR(
01b0: 5c 66 49 69 6e 74 65 72 70 5c 66 52 29 0a 2e 53 \fIinterp\fR)..S
01c0: 48 20 41 52 47 55 4d 45 4e 54 53 0a 2e 41 53 20 H ARGUMENTS..AS
01d0: 54 63 6c 5f 49 6e 74 65 72 70 20 2a 69 6e 74 65 Tcl_Interp *inte
01e0: 72 70 20 69 6e 0a 2e 41 50 20 54 63 6c 5f 49 6e rp in..AP Tcl_In
01f0: 74 65 72 70 20 2a 69 6e 74 65 72 70 20 69 6e 0a terp *interp in.
0200: 49 6e 74 65 72 70 72 65 74 65 72 20 69 6e 20 77 Interpreter in w
0210: 68 69 63 68 20 74 68 65 20 63 6f 6e 73 6f 6c 65 hich the console
0220: 20 63 68 61 6e 6e 65 6c 73 20 61 72 65 20 63 72 channels are cr
0230: 65 61 74 65 64 2e 0a 2e 42 45 0a 2e 53 48 20 44 eated...BE..SH D
0240: 45 53 43 52 49 50 54 49 4f 4e 0a 2e 50 50 0a 5c ESCRIPTION..PP.\
0250: 66 42 54 6b 5f 49 6e 69 74 43 6f 6e 73 6f 6c 65 fBTk_InitConsole
0260: 43 68 61 6e 6e 65 6c 73 5c 66 52 20 69 73 20 69 Channels\fR is i
0270: 6e 76 6f 6b 65 64 20 74 6f 20 63 72 65 61 74 65 nvoked to create
0280: 20 61 20 73 65 74 20 6f 66 20 63 6f 6e 73 6f 6c a set of consol
0290: 65 0a 63 68 61 6e 6e 65 6c 73 20 61 6e 64 20 69 e.channels and i
02a0: 6e 73 74 61 6c 6c 20 74 68 65 6d 20 61 73 20 74 nstall them as t
02b0: 68 65 20 73 74 61 6e 64 61 72 64 20 63 68 61 6e he standard chan
02c0: 6e 65 6c 73 2e 20 41 6c 6c 20 49 2f 4f 20 6f 6e nels. All I/O on
02d0: 20 74 68 65 73 65 0a 63 68 61 6e 6e 65 6c 73 20 these.channels
02e0: 77 69 6c 6c 20 62 65 20 64 69 73 63 61 72 64 65 will be discarde
02f0: 64 20 75 6e 74 69 6c 20 5c 66 42 54 6b 5f 43 72 d until \fBTk_Cr
0300: 65 61 74 65 43 6f 6e 73 6f 6c 65 57 69 6e 64 6f eateConsoleWindo
0310: 77 5c 66 52 20 69 73 0a 63 61 6c 6c 65 64 20 74 w\fR is.called t
0320: 6f 20 61 74 74 61 63 68 20 74 68 65 20 63 6f 6e o attach the con
0330: 73 6f 6c 65 20 74 6f 20 61 20 74 65 78 74 20 77 sole to a text w
0340: 69 64 67 65 74 2e 0a 2e 50 50 0a 54 68 69 73 20 idget...PP.This
0350: 66 75 6e 63 74 69 6f 6e 20 69 73 20 66 6f 72 20 function is for
0360: 75 73 65 20 62 79 20 73 68 65 6c 6c 20 61 70 70 use by shell app
0370: 6c 69 63 61 74 69 6f 6e 73 20 62 61 73 65 64 20 lications based
0380: 6f 6e 20 54 6b 2c 20 6c 69 6b 65 0a 5c 66 42 77 on Tk, like.\fBw
0390: 69 73 68 5c 66 52 2c 20 6f 6e 20 70 6c 61 74 66 ish\fR, on platf
03a0: 6f 72 6d 73 20 77 68 69 63 68 20 68 61 76 65 20 orms which have
03b0: 6e 6f 20 73 74 61 6e 64 61 72 64 20 63 68 61 6e no standard chan
03c0: 6e 65 6c 73 20 69 6e 20 67 72 61 70 68 69 63 61 nels in graphica
03d0: 6c 0a 6d 6f 64 65 2c 20 6c 69 6b 65 20 57 69 6e l.mode, like Win
03e0: 33 32 2e 0a 2e 50 50 0a 54 68 65 20 5c 66 49 69 32...PP.The \fIi
03f0: 6e 74 65 72 70 5c 66 52 20 61 72 67 75 6d 65 6e nterp\fR argumen
0400: 74 20 69 73 20 74 68 65 20 69 6e 74 65 72 70 72 t is the interpr
0410: 65 74 65 72 20 69 6e 20 77 68 69 63 68 20 74 6f eter in which to
0420: 20 63 72 65 61 74 65 20 61 6e 64 0a 69 6e 73 74 create and.inst
0430: 61 6c 6c 20 74 68 65 20 63 6f 6e 73 6f 6c 65 20 all the console
0440: 63 68 61 6e 6e 65 6c 73 2e 0a 2e 50 50 0a 5c 66 channels...PP.\f
0450: 42 4e 4f 54 45 3a 5c 66 52 20 49 66 20 74 68 69 BNOTE:\fR If thi
0460: 73 20 66 75 6e 63 74 69 6f 6e 20 69 73 20 75 73 s function is us
0470: 65 64 20 69 74 20 68 61 73 20 74 6f 20 62 65 20 ed it has to be
0480: 63 61 6c 6c 65 64 20 62 65 66 6f 72 65 20 74 68 called before th
0490: 65 0a 66 69 72 73 74 20 63 61 6c 6c 20 74 6f 20 e.first call to
04a0: 5c 66 42 54 63 6c 5f 52 65 67 69 73 74 65 72 43 \fBTcl_RegisterC
04b0: 68 61 6e 6e 65 6c 5c 66 52 2c 20 64 69 72 65 63 hannel\fR, direc
04c0: 74 6c 79 2c 20 6f 72 20 69 6e 64 69 72 65 63 74 tly, or indirect
04d0: 6c 79 0a 74 68 72 6f 75 67 68 20 6f 74 68 65 72 ly.through other
04e0: 20 63 68 61 6e 6e 65 6c 20 66 75 6e 63 74 69 6f channel functio
04f0: 6e 73 2e 20 42 65 63 61 75 73 65 20 6f 74 68 65 ns. Because othe
0500: 72 77 69 73 65 20 74 68 65 20 73 74 61 6e 64 61 rwise the standa
0510: 72 64 0a 63 68 61 6e 6e 65 6c 73 20 77 69 6c 6c rd.channels will
0520: 20 62 65 20 61 6c 72 65 61 64 79 20 69 6e 69 74 be already init
0530: 69 61 6c 69 7a 65 64 20 74 6f 20 74 68 65 20 73 ialized to the s
0540: 79 73 74 65 6d 20 64 65 66 61 75 6c 74 73 2c 20 ystem defaults,
0550: 77 68 69 63 68 20 77 69 6c 6c 0a 62 65 20 6e 6f which will.be no
0560: 6e 73 65 6e 73 69 63 61 6c 20 66 6f 72 20 74 68 nsensical for th
0570: 65 20 63 61 73 65 20 5c 66 42 54 6b 5f 49 6e 69 e case \fBTk_Ini
0580: 74 43 6f 6e 73 6f 6c 65 43 68 61 6e 6e 65 6c 73 tConsoleChannels
0590: 5c 66 52 20 69 73 20 66 6f 72 2e 0a 2e 53 48 20 \fR is for...SH
05a0: 22 53 45 45 20 41 4c 53 4f 22 0a 63 6f 6e 73 6f "SEE ALSO".conso
05b0: 6c 65 28 6e 29 0a 2e 53 48 20 4b 45 59 57 4f 52 le(n)..SH KEYWOR
05c0: 44 53 0a 73 74 61 6e 64 61 72 64 20 63 68 61 6e DS.standard chan
05d0: 6e 65 6c 73 2c 20 63 6f 6e 73 6f 6c 65 0a nels, console.