1term::ansi::code::ctrl(n) Terminal control term::ansi::code::ctrl(n)
2______________________________________________________________________________
6
8 term::ansi::code::ctrl - ANSI control sequences
9
11 package require Tcl 8.4
12 package require term::ansi::code ?0.1?
14 package require term::ansi::code::ctrl ?0.1.1?
16 ::term::ansi::code::ctrl::names
18 ::term::ansi::code::ctrl::import ?ns? ?arg...?
20 ::term::ansi::code::ctrl::eeol
22 ::term::ansi::code::ctrl::esol
24 ::term::ansi::code::ctrl::el
26 ::term::ansi::code::ctrl::ed
28 ::term::ansi::code::ctrl::eu
30 ::term::ansi::code::ctrl::es
32 ::term::ansi::code::ctrl::sd
34 ::term::ansi::code::ctrl::su
36 ::term::ansi::code::ctrl::ch
38 ::term::ansi::code::ctrl::sc
40 ::term::ansi::code::ctrl::rc
42 ::term::ansi::code::ctrl::sca
44 ::term::ansi::code::ctrl::rca
46 ::term::ansi::code::ctrl::st
48 ::term::ansi::code::ctrl::ct
50 ::term::ansi::code::ctrl::cat
52 ::term::ansi::code::ctrl::qdc
54 ::term::ansi::code::ctrl::qds
56 ::term::ansi::code::ctrl::qcp
58 ::term::ansi::code::ctrl::rd
60 ::term::ansi::code::ctrl::elw
62 ::term::ansi::code::ctrl::dlw
64 ::term::ansi::code::ctrl::eg
66 ::term::ansi::code::ctrl::lg
68 ::term::ansi::code::ctrl::scs0 tag
70 ::term::ansi::code::ctrl::scs1 tag
72 ::term::ansi::code::ctrl::sda arg...
74 ::term::ansi::code::ctrl::sda_fgblack
76 ::term::ansi::code::ctrl::sda_fgred
78 ::term::ansi::code::ctrl::sda_fggreen
80 ::term::ansi::code::ctrl::sda_fgyellow
82 ::term::ansi::code::ctrl::sda_fgblue
84 ::term::ansi::code::ctrl::sda_fgmagenta
86 ::term::ansi::code::ctrl::sda_fgcyan
88 ::term::ansi::code::ctrl::sda_fgwhite
90 ::term::ansi::code::ctrl::sda_fgdefault
92 ::term::ansi::code::ctrl::sda_bgblack
94 ::term::ansi::code::ctrl::sda_bgred
96 ::term::ansi::code::ctrl::sda_bggreen
98 ::term::ansi::code::ctrl::sda_bgyellow
100 ::term::ansi::code::ctrl::sda_bgblue
102 ::term::ansi::code::ctrl::sda_bgmagenta
104 ::term::ansi::code::ctrl::sda_bgcyan
106 ::term::ansi::code::ctrl::sda_bgwhite
108 ::term::ansi::code::ctrl::sda_bgdefault
110 ::term::ansi::code::ctrl::sda_bold
112 ::term::ansi::code::ctrl::sda_dim
114 ::term::ansi::code::ctrl::sda_italic
116 ::term::ansi::code::ctrl::sda_underline
118 ::term::ansi::code::ctrl::sda_blink
120 ::term::ansi::code::ctrl::sda_revers
122 ::term::ansi::code::ctrl::sda_hidden
124 ::term::ansi::code::ctrl::sda_strike
126 ::term::ansi::code::ctrl::sda_nobold
128 ::term::ansi::code::ctrl::sda_noitalic
130 ::term::ansi::code::ctrl::sda_nounderline
132 ::term::ansi::code::ctrl::sda_noblink
134 ::term::ansi::code::ctrl::sda_norevers
136 ::term::ansi::code::ctrl::sda_nohidden
138 ::term::ansi::code::ctrl::sda_nostrike
140 ::term::ansi::code::ctrl::sda_reset
142 ::term::ansi::send::fcp row col
144 ::term::ansi::code::ctrl::cu ?n?
146 ::term::ansi::code::ctrl::cd ?n?
148 ::term::ansi::code::ctrl::cf ?n?
150 ::term::ansi::code::ctrl::cb ?n?
152 ::term::ansi::code::ctrl::ss ?s e?
154 ::term::ansi::code::ctrl::skd code str
156 ::term::ansi::code::ctrl::title str
158 ::term::ansi::code::ctrl::gron
160 ::term::ansi::code::ctrl::groff
162 ::term::ansi::code::ctrl::tlc
164 ::term::ansi::code::ctrl::trc
166 ::term::ansi::code::ctrl::brc
168 ::term::ansi::code::ctrl::blc
170 ::term::ansi::code::ctrl::ltj
172 ::term::ansi::code::ctrl::ttj
174 ::term::ansi::code::ctrl::rtj
176 ::term::ansi::code::ctrl::btj
178 ::term::ansi::code::ctrl::fwj
180 ::term::ansi::code::ctrl::hl
182 ::term::ansi::code::ctrl::vl
184 ::term::ansi::code::ctrl::groptim str
186 ::term::ansi::code::ctrl::clear
188 ::term::ansi::code::ctrl::init
190 ::term::ansi::code::ctrl::showat row col text
192_________________________________________________________________
194
196 This package provides symbolic names for the ANSI control sequences.
197 For each sequence a single command is provided which returns the
198 sequence as its result. None of the commands of this package write to a
199 channel; that is handled by higher level packages, like
200 term::ansi::send.
201
203 INTROSPECTION
204 ::term::ansi::code::ctrl::names
205 This command is for introspection. It returns as its result a
206 list containing the names of all attribute commands.
207 ::term::ansi::code::ctrl::import ?ns? ?arg...?
209 This command imports some or all attribute commands into the
210 namespace ns. This is by default the namespace ctrl. Note that
211 this is relative namespace name, placing the imported command
212 into a child of the current namespace. By default all commands
213 are imported, this can howver be restricted by listing the names
214 of the wanted commands after the namespace argument.
215 SEQUENCES
217 ::term::ansi::code::ctrl::eeol
218 Erase (to) End Of Line
219 ::term::ansi::code::ctrl::esol
221 Erase (to) Start Of Line
222 ::term::ansi::code::ctrl::el
224 Erase (current) Line
225 ::term::ansi::code::ctrl::ed
227 Erase Down (to bottom)
228 ::term::ansi::code::ctrl::eu
230 Erase Up (to top)
231 ::term::ansi::code::ctrl::es
233 Erase Screen
234 ::term::ansi::code::ctrl::sd
236 Scroll Down
237 ::term::ansi::code::ctrl::su
239 Scroll Up
240 ::term::ansi::code::ctrl::ch
242 Cursor Home
243 ::term::ansi::code::ctrl::sc
245 Save Cursor
246 ::term::ansi::code::ctrl::rc
248 Restore Cursor (Unsave)
249 ::term::ansi::code::ctrl::sca
251 Save Cursor + Attributes
252 ::term::ansi::code::ctrl::rca
254 Restore Cursor + Attributes
255 ::term::ansi::code::ctrl::st
257 Set Tab (@ current position)
258 ::term::ansi::code::ctrl::ct
260 Clear Tab (@ current position)
261 ::term::ansi::code::ctrl::cat
263 Clear All Tabs
264 ::term::ansi::code::ctrl::qdc
266 Query Device Code
267 ::term::ansi::code::ctrl::qds
269 Query Device Status
270 ::term::ansi::code::ctrl::qcp
272 Query Cursor Position
273 ::term::ansi::code::ctrl::rd
275 Reset Device
276 ::term::ansi::code::ctrl::elw
278 Enable Line Wrap
279 ::term::ansi::code::ctrl::dlw
281 Disable Line Wrap
282 ::term::ansi::code::ctrl::eg
284 Enter Graphics Mode
285 ::term::ansi::code::ctrl::lg
287 Exit Graphics Mode
288 ::term::ansi::code::ctrl::scs0 tag
290 Set default character set
291 ::term::ansi::code::ctrl::scs1 tag
293 Set alternate character set Select Character Set.
294 Choose which character set is used for either default (scs0) or
296 alternate font (scs1). This does not change whether default or
297 alternate font are used, only their definition.
298 The legal tags, and their meanings, are:
300 A United Kingdom Set
302 B ASCII Set
304 0 Special Graphics
306 1 Alternate Character ROM Standard Character Set
308 2 Alternate Character ROM Special Graphics
310 ::term::ansi::code::ctrl::sda arg...
312 Set Display Attributes. The arguments are the code sequences for
313 the possible attributes, as provided by the package
314 term::ansi::code::attr. For convenience this package also pro‐
315 vides additional commands each setting a single specific
316 attribute.
317 ::term::ansi::code::ctrl::sda_fgblack
319 Set text color to Black.
320 ::term::ansi::code::ctrl::sda_fgred
322 Set text color to Red.
323 ::term::ansi::code::ctrl::sda_fggreen
325 Set text color to Green.
326 ::term::ansi::code::ctrl::sda_fgyellow
328 Set text color to Yellow.
329 ::term::ansi::code::ctrl::sda_fgblue
331 Set text color to Blue.
332 ::term::ansi::code::ctrl::sda_fgmagenta
334 Set text color to Magenta.
335 ::term::ansi::code::ctrl::sda_fgcyan
337 Set text color to Cyan.
338 ::term::ansi::code::ctrl::sda_fgwhite
340 Set text color to White.
341 ::term::ansi::code::ctrl::sda_fgdefault
343 Set default text color (Black).
344 ::term::ansi::code::ctrl::sda_bgblack
346 Set background to Black.
347 ::term::ansi::code::ctrl::sda_bgred
349 Set background to Red.
350 ::term::ansi::code::ctrl::sda_bggreen
352 Set background to Green.
353 ::term::ansi::code::ctrl::sda_bgyellow
355 Set background to Yellow.
356 ::term::ansi::code::ctrl::sda_bgblue
358 Set background to Blue.
359 ::term::ansi::code::ctrl::sda_bgmagenta
361 Set background to Magenta.
362 ::term::ansi::code::ctrl::sda_bgcyan
364 Set background to Cyan.
365 ::term::ansi::code::ctrl::sda_bgwhite
367 Set background to White.
368 ::term::ansi::code::ctrl::sda_bgdefault
370 Set default background (Transparent).
371 ::term::ansi::code::ctrl::sda_bold
373 Bold on.
374 ::term::ansi::code::ctrl::sda_dim
376 Dim on.
377 ::term::ansi::code::ctrl::sda_italic
379 Italics on.
380 ::term::ansi::code::ctrl::sda_underline
382 Underscore on.
383 ::term::ansi::code::ctrl::sda_blink
385 Blink on.
386 ::term::ansi::code::ctrl::sda_revers
388 Reverse on.
389 ::term::ansi::code::ctrl::sda_hidden
391 Hidden on.
392 ::term::ansi::code::ctrl::sda_strike
394 Strike-through on.
395 ::term::ansi::code::ctrl::sda_nobold
397 Bold off.
398 ::term::ansi::code::ctrl::sda_noitalic
400 Italics off.
401 ::term::ansi::code::ctrl::sda_nounderline
403 Underscore off.
404 ::term::ansi::code::ctrl::sda_noblink
406 Blink off.
407 ::term::ansi::code::ctrl::sda_norevers
409 Reverse off.
410 ::term::ansi::code::ctrl::sda_nohidden
412 Hidden off.
413 ::term::ansi::code::ctrl::sda_nostrike
415 Strike-through off.
416 ::term::ansi::code::ctrl::sda_reset
418 Reset all attributes to their default values.
419 ::term::ansi::send::fcp row col
421 Force Cursor Position (aka Go To).
422 ::term::ansi::code::ctrl::cu ?n?
424 Cursor Up. n defaults to 1.
425 ::term::ansi::code::ctrl::cd ?n?
427 Cursor Down. n defaults to 1.
428 ::term::ansi::code::ctrl::cf ?n?
430 Cursor Forward. n defaults to 1.
431 ::term::ansi::code::ctrl::cb ?n?
433 Cursor Backward. n defaults to 1.
434 ::term::ansi::code::ctrl::ss ?s e?
436 Scroll Screen (entire display, or between rows start end, inclu‐
437 sive).
438 ::term::ansi::code::ctrl::skd code str
440 Set Key Definition.
441 ::term::ansi::code::ctrl::title str
443 Set the terminal title.
444 ::term::ansi::code::ctrl::gron
446 Switch to character/box graphics. I.e. switch to the alternate
447 font.
448 ::term::ansi::code::ctrl::groff
450 Switch to regular characters. I.e. switch to the default font.
451 ::term::ansi::code::ctrl::tlc
453 Character graphics, Top Left Corner.
454 ::term::ansi::code::ctrl::trc
456 Character graphics, Top Right Corner.
457 ::term::ansi::code::ctrl::brc
459 Character graphics, Bottom Right Corner.
460 ::term::ansi::code::ctrl::blc
462 Character graphics, Bottom Left Corner.
463 ::term::ansi::code::ctrl::ltj
465 Character graphics, Left T Junction.
466 ::term::ansi::code::ctrl::ttj
468 Character graphics, Top T Junction.
469 ::term::ansi::code::ctrl::rtj
471 Character graphics, Right T Junction.
472 ::term::ansi::code::ctrl::btj
474 Character graphics, Bottom T Junction.
475 ::term::ansi::code::ctrl::fwj
477 Character graphics, Four-Way Junction.
478 ::term::ansi::code::ctrl::hl
480 Character graphics, Horizontal Line.
481 ::term::ansi::code::ctrl::vl
483 Character graphics, Vertical Line.
484 ::term::ansi::code::ctrl::groptim str
486 Optimize character graphics. The generator commands above create
487 way to many superfluous commands shifting into and out of the
488 graphics mode. This command removes all shifts which are not
489 needed. To this end it also knows which characters will look the
490 same in both modes, to handle strings created outside of this
491 package.
492 ::term::ansi::code::ctrl::clear
494 Clear screen. In essence a sequence of CursorHome + EraseDown.
495 ::term::ansi::code::ctrl::init
497 Initialize default and alternate fonts to ASCII and box graph‐
498 ics.
499 ::term::ansi::code::ctrl::showat row col text
501 Format the block of text for display at the specified location.
502
504 This document, and the package it describes, will undoubtedly contain
505 bugs and other problems. Please report such in the category term of
506 the Tcllib SF Trackers [http://source‐
507 forge.net/tracker/?group_id=12883]. Please also report any ideas for
508 enhancements you may have for either package and/or documentation.
509
511 ansi, attribute control, color control, control, terminal
512
514 Copyright (c) 2006-2008 Andreas Kupries <andreas_kupries@users.sourceforge.net>
515term 0.1 term::ansi::code::ctrl(n)