util/X86LINUX64/man/mann/console.n

   1 '\"
   2 '\" Copyright (c) 2001 Donal K. Fellows
   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 .TH console n 8.4 Tk "Tk Built-In Commands"
   8 .\" The -*- nroff -*- definitions below are for supplemental macros used
   9 .\" in Tcl/Tk manual entries.
  10 .\"
  11 .\" .AP type name in/out ?indent?
  12 .\"     Start paragraph describing an argument to a library procedure.
  13 .\"     type is type of argument (int, etc.), in/out is either "in", "out",
  14 .\"     or "in/out" to describe whether procedure reads or modifies arg,
  15 .\"     and indent is equivalent to second arg of .IP (shouldn't ever be
  16 .\"     needed;  use .AS below instead)
  17 .\"
  18 .\" .AS ?type? ?name?
  19 .\"     Give maximum sizes of arguments for setting tab stops.  Type and
  20 .\"     name are examples of largest possible arguments that will be passed
  21 .\"     to .AP later.  If args are omitted, default tab stops are used.
  22 .\"
  23 .\" .BS
  24 .\"     Start box enclosure.  From here until next .BE, everything will be
  25 .\"     enclosed in one large box.
  26 .\"
  27 .\" .BE
  28 .\"     End of box enclosure.
  29 .\"
  30 .\" .CS
  31 .\"     Begin code excerpt.
  32 .\"
  33 .\" .CE
  34 .\"     End code excerpt.
  35 .\"
  36 .\" .VS ?version? ?br?
  37 .\"     Begin vertical sidebar, for use in marking newly-changed parts
  38 .\"     of man pages.  The first argument is ignored and used for recording
  39 .\"     the version when the .VS was added, so that the sidebars can be
  40 .\"     found and removed when they reach a certain age.  If another argument
  41 .\"     is present, then a line break is forced before starting the sidebar.
  42 .\"
  43 .\" .VE
  44 .\"     End of vertical sidebar.
  45 .\"
  46 .\" .DS
  47 .\"     Begin an indented unfilled display.
  48 .\"
  49 .\" .DE
  50 .\"     End of indented unfilled display.
  51 .\"
  52 .\" .SO ?manpage?
  53 .\"     Start of list of standard options for a Tk widget. The manpage
  54 .\"     argument defines where to look up the standard options; if
  55 .\"     omitted, defaults to "options". The options follow on successive
  56 .\"     lines, in three columns separated 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 .\" .QW arg1 ?arg2?
  71 .\"     Print arg1 in quotes, then arg2 normally (for trailing punctuation).
  72 .\"
  73 .\" .PQ arg1 ?arg2?
  74 .\"     Print an open parenthesis, arg1 in quotes, then arg2 normally
  75 .\"     (for trailing punctuation) and then a closing parenthesis.
  76 .\"
  77 .\"     # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
  78 .if t .wh -1.3i ^B
  79 .nr ^l \n(.l
  80 .ad b
  81 .\"     # Start an argument description
  82 .de AP
  83 .ie !"\\$4"" .TP \\$4
  84 .el \{\
  85 .   ie !"\\$2"" .TP \\n()Cu
  86 .   el          .TP 15
  87 .\}
  88 .ta \\n()Au \\n()Bu
  89 .ie !"\\$3"" \{\
  90 \&\\$1 \\fI\\$2\\fP (\\$3)
  91 .\".b
  92 .\}
  93 .el \{\
  94 .br
  95 .ie !"\\$2"" \{\
  96 \&\\$1  \\fI\\$2\\fP
  97 .\}
  98 .el \{\
  99 \&\\fI\\$1\\fP
 100 .\}
 101 .\}
 102 ..
 103 .\"     # define tabbing values for .AP
 104 .de AS
 105 .nr )A 10n
 106 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
 107 .nr )B \\n()Au+15n
 108 .\"
 109 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
 110 .nr )C \\n()Bu+\\w'(in/out)'u+2n
 111 ..
 112 .AS Tcl_Interp Tcl_CreateInterp in/out
 113 .\"     # BS - start boxed text
 114 .\"     # ^y = starting y location
 115 .\"     # ^b = 1
 116 .de BS
 117 .br
 118 .mk ^y
 119 .nr ^b 1u
 120 .if n .nf
 121 .if n .ti 0
 122 .if n \l'\\n(.lu\(ul'
 123 .if n .fi
 124 ..
 125 .\"     # BE - end boxed text (draw box now)
 126 .de BE
 127 .nf
 128 .ti 0
 129 .mk ^t
 130 .ie n \l'\\n(^lu\(ul'
 131 .el \{\
 132 .\"     Draw four-sided box normally, but don't draw top of
 133 .\"     box if the box started on an earlier page.
 134 .ie !\\n(^b-1 \{\
 135 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 136 .\}
 137 .el \}\
 138 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 139 .\}
 140 .\}
 141 .fi
 142 .br
 143 .nr ^b 0
 144 ..
 145 .\"     # VS - start vertical sidebar
 146 .\"     # ^Y = starting y location
 147 .\"     # ^v = 1 (for troff;  for nroff this doesn't matter)
 148 .de VS
 149 .if !"\\$2"" .br
 150 .mk ^Y
 151 .ie n 'mc \s12\(br\s0
 152 .el .nr ^v 1u
 153 ..
 154 .\"     # VE - end of vertical sidebar
 155 .de VE
 156 .ie n 'mc
 157 .el \{\
 158 .ev 2
 159 .nf
 160 .ti 0
 161 .mk ^t
 162 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
 163 .sp -1
 164 .fi
 165 .ev
 166 .\}
 167 .nr ^v 0
 168 ..
 169 .\"     # Special macro to handle page bottom:  finish off current
 170 .\"     # box/sidebar if in box/sidebar mode, then invoked standard
 171 .\"     # page bottom macro.
 172 .de ^B
 173 .ev 2
 174 'ti 0
 175 'nf
 176 .mk ^t
 177 .if \\n(^b \{\
 178 .\"     Draw three-sided box if this is the box's first page,
 179 .\"     draw two sides but no top otherwise.
 180 .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
 181 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 182 .\}
 183 .if \\n(^v \{\
 184 .nr ^x \\n(^tu+1v-\\n(^Yu
 185 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
 186 .\}
 187 .bp
 188 'fi
 189 .ev
 190 .if \\n(^b \{\
 191 .mk ^y
 192 .nr ^b 2
 193 .\}
 194 .if \\n(^v \{\
 195 .mk ^Y
 196 .\}
 197 ..
 198 .\"     # DS - begin display
 199 .de DS
 200 .RS
 201 .nf
 202 .sp
 203 ..
 204 .\"     # DE - end display
 205 .de DE
 206 .fi
 207 .RE
 208 .sp
 209 ..
 210 .\"     # SO - start of list of standard options
 211 .de SO
 212 'ie '\\$1'' .ds So \\fBoptions\\fR
 213 'el .ds So \\fB\\$1\\fR
 214 .SH "STANDARD OPTIONS"
 215 .LP
 216 .nf
 217 .ta 5.5c 11c
 218 .ft B
 219 ..
 220 .\"     # SE - end of list of standard options
 221 .de SE
 222 .fi
 223 .ft R
 224 .LP
 225 See the \\*(So manual entry for details on the standard options.
 226 ..
 227 .\"     # OP - start of full description for a single option
 228 .de OP
 229 .LP
 230 .nf
 231 .ta 4c
 232 Command-Line Name:      \\fB\\$1\\fR
 233 Database Name:  \\fB\\$2\\fR
 234 Database Class: \\fB\\$3\\fR
 235 .fi
 236 .IP
 237 ..
 238 .\"     # CS - begin code excerpt
 239 .de CS
 240 .RS
 241 .nf
 242 .ta .25i .5i .75i 1i
 243 ..
 244 .\"     # CE - end code excerpt
 245 .de CE
 246 .fi
 247 .RE
 248 ..
 249 .\"     # UL - underline word
 250 .de UL
 251 \\$1\l'|0\(ul'\\$2
 252 ..
 253 .\"     # QW - apply quotation marks to word
 254 .de QW
 255 .ie '\\*(lq'"' ``\\$1''\\$2
 256 .\"" fix emacs highlighting
 257 .el \\*(lq\\$1\\*(rq\\$2
 258 ..
 259 .\"     # PQ - apply parens and quotation marks to word
 260 .de PQ
 261 .ie '\\*(lq'"' (``\\$1''\\$2)\\$3
 262 .\"" fix emacs highlighting
 263 .el (\\*(lq\\$1\\*(rq\\$2)\\$3
 264 ..
 265 .\"     # QR - quoted range
 266 .de QR
 267 .ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3
 268 .\"" fix emacs highlighting
 269 .el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3
 270 ..
 271 .\"     # MT - "empty" string
 272 .de MT
 273 .QW ""
 274 ..
 275 .BS
 276 '\" Note:  do not modify the .SH NAME line immediately below!
 277 .SH NAME
 278 console \- Control the console on systems without a real console
 279 .SH SYNOPSIS
 280 \fBconsole\fR \fIsubcommand\fR ?\fIarg ...\fR?
 281 .BE
 282 .SH DESCRIPTION
 283 .PP
 284 The console window is a replacement for a real console to allow input
 285 and output on the standard I/O channels on platforms that do not have
 286 a real console.  It is implemented as a separate interpreter with the
 287 Tk toolkit loaded, and control over this interpreter is given through
 288 the \fBconsole\fR command.  The behaviour of the console window is
 289 defined mainly through the contents of the \fIconsole.tcl\fR file in
 290 the Tk library. Except for TkAqua, this command is not available when
 291 Tk is loaded into a tclsh interpreter with
 292 .QW "\fBpackage require Tk\fR" ,
 293 as a conventional terminal is expected to be present in that case.
 294 In TkAqua, this command is only available when stdin is \fB/dev/null\fR
 295 (as is the case e.g. when the application embedding Tk is started
 296 from the Mac OS X Finder).
 297 .PP
 298 .TP
 299 \fBconsole eval \fIscript\fR
 300 Evaluate the \fIscript\fR argument as a Tcl script in the console
 301 interpreter.  The normal interpreter is accessed through the
 302 \fBconsoleinterp\fR command in the console interpreter.
 303 .TP
 304 \fBconsole hide\fR
 305 Hide the console window from view.  Precisely equivalent to
 306 withdrawing the \fB.\fR window in the console interpreter.
 307 .TP
 308 \fBconsole show\fR
 309 Display the console window.  Precisely equivalent to deiconifying the
 310 \fB.\fR window in the console interpreter.
 311 .TP
 312 \fBconsole title \fR?\fIstring\fR?
 313 Query or modify the title of the console window.  If \fIstring\fR is
 314 not specified, queries the title of the console window, and sets the
 315 title of the console window to \fIstring\fR otherwise.  Precisely
 316 equivalent to using the \fBwm title\fR command in the console
 317 interpreter.
 318 .SH "ACCESS TO THE MAIN INTERPRETER"
 319 .PP
 320 The \fBconsoleinterp\fR command in the console interpreter allows
 321 scripts to be evaluated in the main interpreter.  It supports two
 322 subcommands: \fBeval\fR and \fBrecord\fR.
 323 .PP
 324 .TP
 325 \fBconsoleinterp eval \fIscript\fR
 326 Evaluates \fIscript\fR as a Tcl script at the global level in the main
 327 interpreter.
 328 .TP
 329 \fBconsoleinterp record \fIscript\fR
 330 Records and evaluates \fIscript\fR as a Tcl script at the global level
 331 in the main interpreter as if \fIscript\fR had been typed in at the
 332 console.
 333 .SH "ADDITIONAL TRAP CALLS"
 334 .PP
 335 There are several additional commands in the console interpreter that
 336 are called in response to activity in the main interpreter.
 337 \fIThese are documented here for completeness only; they form part of
 338 the internal implementation of the console and are likely to change or
 339 be modified without warning.\fR
 340 .PP
 341 Output to the console from the main interpreter via the stdout and
 342 stderr channels is handled by invoking the \fBtk::ConsoleOutput\fR
 343 command in the console interpreter with two arguments.  The first
 344 argument is the name of the channel being written to, and the second
 345 argument is the string being written to the channel (after encoding
 346 and end-of-line translation processing has been performed.)
 347 .PP
 348 When the \fB.\fR window of the main interpreter is destroyed, the
 349 \fBtk::ConsoleExit\fR command in the console interpreter is called
 350 (assuming the console interpreter has not already been deleted itself,
 351 that is.)
 352 .SH "DEFAULT BINDINGS"
 353 .PP
 354 The default script creates a console window (implemented using a text
 355 widget) that has the following behaviour:
 356 .IP [1]
 357 Pressing the tab key inserts a TAB character (as defined by the Tcl
 358 \et escape.)
 359 .IP [2]
 360 Pressing the return key causes the current line (if complete by the
 361 rules of \fBinfo complete\fR) to be passed to the main interpreter for
 362 evaluation.
 363 .IP [3]
 364 Pressing the delete key deletes the selected text (if any text is
 365 selected) or the character to the right of the cursor (if not at the
 366 end of the line.)
 367 .IP [4]
 368 Pressing the backspace key deletes the selected text (if any text is
 369 selected) or the character to the left of the cursor (of not at the
 370 start of the line.)
 371 .IP [5]
 372 Pressing either Control+A or the home key causes the cursor to go to
 373 the start of the line (but after the prompt, if a prompt is present on
 374 the line.)
 375 .IP [6]
 376 Pressing either Control+E or the end key causes the cursor to go to
 377 the end of the line.
 378 .IP [7]
 379 Pressing either Control+P or the up key causes the previous entry in
 380 the command history to be selected.
 381 .IP [8]
 382 Pressing either Control+N or the down key causes the next entry in the
 383 command history to be selected.
 384 .IP [9]
 385 Pressing either Control+B or the left key causes the cursor to move
 386 one character backward as long as the cursor is not at the prompt.
 387 .IP [10]
 388 Pressing either Control+F or the right key causes the cursor to move
 389 one character forward.
 390 .IP [11]
 391 Pressing F9 rebuilds the console window by destroying all its children
 392 and reloading the Tcl script that defined the console's behaviour.
 393 .PP
 394 Most other behaviour is the same as a conventional text widget except
 395 for the way that the \fI<<Cut>>\fR event is handled identically to the
 396 \fI<<Copy>>\fR event.
 397 .SH EXAMPLE
 398 .PP
 399 Not all platforms have the \fBconsole\fR command, so debugging code
 400 often has the following code fragment in it so output produced by
 401 \fBputs\fR can be seen while during development:
 402 .CS
 403 catch {\fBconsole show\fR}
 404 .CE
 405 .SH "SEE ALSO"
 406 destroy(n), fconfigure(n), history(n), interp(n), puts(n), text(n), wm(n)
 407 .SH KEYWORDS
 408 console, interpreter, window, interactive, output channels
 409 '\" Local Variables:
 410 '\" mode: nroff
 411 '\" End: