ansi_cctrl(n)

1term::ansi::code::ctrl(n)      Terminal control      term::ansi::code::ctrl(n)
2
3
4
5______________________________________________________________________________
6

NAME

8       term::ansi::code::ctrl - ANSI control sequences
9

SYNOPSIS

11       package require Tcl  8.4
12
13       package require term::ansi::code  ?0.2?
14
15       package require term::ansi::code::ctrl  ?0.2?
16
17       ::term::ansi::code::ctrl::names
18
19       ::term::ansi::code::ctrl::import ?ns? ?arg...?
20
21       ::term::ansi::code::ctrl::eeol
22
23       ::term::ansi::code::ctrl::esol
24
25       ::term::ansi::code::ctrl::el
26
27       ::term::ansi::code::ctrl::ed
28
29       ::term::ansi::code::ctrl::eu
30
31       ::term::ansi::code::ctrl::es
32
33       ::term::ansi::code::ctrl::sd
34
35       ::term::ansi::code::ctrl::su
36
37       ::term::ansi::code::ctrl::ch
38
39       ::term::ansi::code::ctrl::sc
40
41       ::term::ansi::code::ctrl::rc
42
43       ::term::ansi::code::ctrl::sca
44
45       ::term::ansi::code::ctrl::rca
46
47       ::term::ansi::code::ctrl::st
48
49       ::term::ansi::code::ctrl::ct
50
51       ::term::ansi::code::ctrl::cat
52
53       ::term::ansi::code::ctrl::qdc
54
55       ::term::ansi::code::ctrl::qds
56
57       ::term::ansi::code::ctrl::qcp
58
59       ::term::ansi::code::ctrl::rd
60
61       ::term::ansi::code::ctrl::elw
62
63       ::term::ansi::code::ctrl::dlw
64
65       ::term::ansi::code::ctrl::eg
66
67       ::term::ansi::code::ctrl::lg
68
69       ::term::ansi::code::ctrl::scs0 tag
70
71       ::term::ansi::code::ctrl::scs1 tag
72
73       ::term::ansi::code::ctrl::sda arg...
74
75       ::term::ansi::code::ctrl::sda_fgblack
76
77       ::term::ansi::code::ctrl::sda_fgred
78
79       ::term::ansi::code::ctrl::sda_fggreen
80
81       ::term::ansi::code::ctrl::sda_fgyellow
82
83       ::term::ansi::code::ctrl::sda_fgblue
84
85       ::term::ansi::code::ctrl::sda_fgmagenta
86
87       ::term::ansi::code::ctrl::sda_fgcyan
88
89       ::term::ansi::code::ctrl::sda_fgwhite
90
91       ::term::ansi::code::ctrl::sda_fgdefault
92
93       ::term::ansi::code::ctrl::sda_bgblack
94
95       ::term::ansi::code::ctrl::sda_bgred
96
97       ::term::ansi::code::ctrl::sda_bggreen
98
99       ::term::ansi::code::ctrl::sda_bgyellow
100
101       ::term::ansi::code::ctrl::sda_bgblue
102
103       ::term::ansi::code::ctrl::sda_bgmagenta
104
105       ::term::ansi::code::ctrl::sda_bgcyan
106
107       ::term::ansi::code::ctrl::sda_bgwhite
108
109       ::term::ansi::code::ctrl::sda_bgdefault
110
111       ::term::ansi::code::ctrl::sda_bold
112
113       ::term::ansi::code::ctrl::sda_dim
114
115       ::term::ansi::code::ctrl::sda_italic
116
117       ::term::ansi::code::ctrl::sda_underline
118
119       ::term::ansi::code::ctrl::sda_blink
120
121       ::term::ansi::code::ctrl::sda_revers
122
123       ::term::ansi::code::ctrl::sda_hidden
124
125       ::term::ansi::code::ctrl::sda_strike
126
127       ::term::ansi::code::ctrl::sda_nobold
128
129       ::term::ansi::code::ctrl::sda_noitalic
130
131       ::term::ansi::code::ctrl::sda_nounderline
132
133       ::term::ansi::code::ctrl::sda_noblink
134
135       ::term::ansi::code::ctrl::sda_norevers
136
137       ::term::ansi::code::ctrl::sda_nohidden
138
139       ::term::ansi::code::ctrl::sda_nostrike
140
141       ::term::ansi::code::ctrl::sda_reset
142
143       ::term::ansi::send::fcp row col
144
145       ::term::ansi::code::ctrl::cu ?n?
146
147       ::term::ansi::code::ctrl::cd ?n?
148
149       ::term::ansi::code::ctrl::cf ?n?
150
151       ::term::ansi::code::ctrl::cb ?n?
152
153       ::term::ansi::code::ctrl::ss ?s e?
154
155       ::term::ansi::code::ctrl::skd code str
156
157       ::term::ansi::code::ctrl::title str
158
159       ::term::ansi::code::ctrl::gron
160
161       ::term::ansi::code::ctrl::groff
162
163       ::term::ansi::code::ctrl::tlc
164
165       ::term::ansi::code::ctrl::trc
166
167       ::term::ansi::code::ctrl::brc
168
169       ::term::ansi::code::ctrl::blc
170
171       ::term::ansi::code::ctrl::ltj
172
173       ::term::ansi::code::ctrl::ttj
174
175       ::term::ansi::code::ctrl::rtj
176
177       ::term::ansi::code::ctrl::btj
178
179       ::term::ansi::code::ctrl::fwj
180
181       ::term::ansi::code::ctrl::hl
182
183       ::term::ansi::code::ctrl::vl
184
185       ::term::ansi::code::ctrl::groptim str
186
187       ::term::ansi::code::ctrl::clear
188
189       ::term::ansi::code::ctrl::init
190
191       ::term::ansi::code::ctrl::showat row col text
192
193______________________________________________________________________________
194

DESCRIPTION

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

API

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
208       ::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
216   SEQUENCES
217       ::term::ansi::code::ctrl::eeol
218              Erase (to) End Of Line
219
220       ::term::ansi::code::ctrl::esol
221              Erase (to) Start Of Line
222
223       ::term::ansi::code::ctrl::el
224              Erase (current) Line
225
226       ::term::ansi::code::ctrl::ed
227              Erase Down (to bottom)
228
229       ::term::ansi::code::ctrl::eu
230              Erase Up (to top)
231
232       ::term::ansi::code::ctrl::es
233              Erase Screen
234
235       ::term::ansi::code::ctrl::sd
236              Scroll Down
237
238       ::term::ansi::code::ctrl::su
239              Scroll Up
240
241       ::term::ansi::code::ctrl::ch
242              Cursor Home
243
244       ::term::ansi::code::ctrl::sc
245              Save Cursor
246
247       ::term::ansi::code::ctrl::rc
248              Restore Cursor (Unsave)
249
250       ::term::ansi::code::ctrl::sca
251              Save Cursor + Attributes
252
253       ::term::ansi::code::ctrl::rca
254              Restore Cursor + Attributes
255
256       ::term::ansi::code::ctrl::st
257              Set Tab (@ current position)
258
259       ::term::ansi::code::ctrl::ct
260              Clear Tab (@ current position)
261
262       ::term::ansi::code::ctrl::cat
263              Clear All Tabs
264
265       ::term::ansi::code::ctrl::qdc
266              Query Device Code
267
268       ::term::ansi::code::ctrl::qds
269              Query Device Status
270
271       ::term::ansi::code::ctrl::qcp
272              Query Cursor Position
273
274       ::term::ansi::code::ctrl::rd
275              Reset Device
276
277       ::term::ansi::code::ctrl::elw
278              Enable Line Wrap
279
280       ::term::ansi::code::ctrl::dlw
281              Disable Line Wrap
282
283       ::term::ansi::code::ctrl::eg
284              Enter Graphics Mode
285
286       ::term::ansi::code::ctrl::lg
287              Exit Graphics Mode
288
289       ::term::ansi::code::ctrl::scs0 tag
290              Set default character set
291
292       ::term::ansi::code::ctrl::scs1 tag
293              Set alternate character set Select Character Set.
294
295              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
299              The legal tags, and their meanings, are:
300
301              A      United Kingdom Set
302
303              B      ASCII Set
304
305              0      Special Graphics
306
307              1      Alternate Character ROM Standard Character Set
308
309              2      Alternate Character ROM Special Graphics
310
311       ::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
318       ::term::ansi::code::ctrl::sda_fgblack
319              Set text color to Black.
320
321       ::term::ansi::code::ctrl::sda_fgred
322              Set text color to Red.
323
324       ::term::ansi::code::ctrl::sda_fggreen
325              Set text color to Green.
326
327       ::term::ansi::code::ctrl::sda_fgyellow
328              Set text color to Yellow.
329
330       ::term::ansi::code::ctrl::sda_fgblue
331              Set text color to Blue.
332
333       ::term::ansi::code::ctrl::sda_fgmagenta
334              Set text color to Magenta.
335
336       ::term::ansi::code::ctrl::sda_fgcyan
337              Set text color to Cyan.
338
339       ::term::ansi::code::ctrl::sda_fgwhite
340              Set text color to White.
341
342       ::term::ansi::code::ctrl::sda_fgdefault
343              Set default text color (Black).
344
345       ::term::ansi::code::ctrl::sda_bgblack
346              Set background to Black.
347
348       ::term::ansi::code::ctrl::sda_bgred
349              Set background to Red.
350
351       ::term::ansi::code::ctrl::sda_bggreen
352              Set background to Green.
353
354       ::term::ansi::code::ctrl::sda_bgyellow
355              Set background to Yellow.
356
357       ::term::ansi::code::ctrl::sda_bgblue
358              Set background to Blue.
359
360       ::term::ansi::code::ctrl::sda_bgmagenta
361              Set background to Magenta.
362
363       ::term::ansi::code::ctrl::sda_bgcyan
364              Set background to Cyan.
365
366       ::term::ansi::code::ctrl::sda_bgwhite
367              Set background to White.
368
369       ::term::ansi::code::ctrl::sda_bgdefault
370              Set default background (Transparent).
371
372       ::term::ansi::code::ctrl::sda_bold
373              Bold on.
374
375       ::term::ansi::code::ctrl::sda_dim
376              Dim on.
377
378       ::term::ansi::code::ctrl::sda_italic
379              Italics on.
380
381       ::term::ansi::code::ctrl::sda_underline
382              Underscore on.
383
384       ::term::ansi::code::ctrl::sda_blink
385              Blink on.
386
387       ::term::ansi::code::ctrl::sda_revers
388              Reverse on.
389
390       ::term::ansi::code::ctrl::sda_hidden
391              Hidden on.
392
393       ::term::ansi::code::ctrl::sda_strike
394              Strike-through on.
395
396       ::term::ansi::code::ctrl::sda_nobold
397              Bold off.
398
399       ::term::ansi::code::ctrl::sda_noitalic
400              Italics off.
401
402       ::term::ansi::code::ctrl::sda_nounderline
403              Underscore off.
404
405       ::term::ansi::code::ctrl::sda_noblink
406              Blink off.
407
408       ::term::ansi::code::ctrl::sda_norevers
409              Reverse off.
410
411       ::term::ansi::code::ctrl::sda_nohidden
412              Hidden off.
413
414       ::term::ansi::code::ctrl::sda_nostrike
415              Strike-through off.
416
417       ::term::ansi::code::ctrl::sda_reset
418              Reset all attributes to their default values.
419
420       ::term::ansi::send::fcp row col
421              Force Cursor Position (aka Go To).
422
423       ::term::ansi::code::ctrl::cu ?n?
424              Cursor Up. n defaults to 1.
425
426       ::term::ansi::code::ctrl::cd ?n?
427              Cursor Down. n defaults to 1.
428
429       ::term::ansi::code::ctrl::cf ?n?
430              Cursor Forward. n defaults to 1.
431
432       ::term::ansi::code::ctrl::cb ?n?
433              Cursor Backward. n defaults to 1.
434
435       ::term::ansi::code::ctrl::ss ?s e?
436              Scroll Screen (entire display, or between rows start end, inclu‐
437              sive).
438
439       ::term::ansi::code::ctrl::skd code str
440              Set Key Definition.
441
442       ::term::ansi::code::ctrl::title str
443              Set the terminal title.
444
445       ::term::ansi::code::ctrl::gron
446              Switch to character/box graphics. I.e. switch to  the  alternate
447              font.
448
449       ::term::ansi::code::ctrl::groff
450              Switch to regular characters. I.e. switch to the default font.
451
452       ::term::ansi::code::ctrl::tlc
453              Character graphics, Top Left Corner.
454
455       ::term::ansi::code::ctrl::trc
456              Character graphics, Top Right Corner.
457
458       ::term::ansi::code::ctrl::brc
459              Character graphics, Bottom Right Corner.
460
461       ::term::ansi::code::ctrl::blc
462              Character graphics, Bottom Left Corner.
463
464       ::term::ansi::code::ctrl::ltj
465              Character graphics, Left T Junction.
466
467       ::term::ansi::code::ctrl::ttj
468              Character graphics, Top T Junction.
469
470       ::term::ansi::code::ctrl::rtj
471              Character graphics, Right T Junction.
472
473       ::term::ansi::code::ctrl::btj
474              Character graphics, Bottom T Junction.
475
476       ::term::ansi::code::ctrl::fwj
477              Character graphics, Four-Way Junction.
478
479       ::term::ansi::code::ctrl::hl
480              Character graphics, Horizontal Line.
481
482       ::term::ansi::code::ctrl::vl
483              Character graphics, Vertical Line.
484
485       ::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
493       ::term::ansi::code::ctrl::clear
494              Clear screen. In essence a sequence of CursorHome + EraseDown.
495
496       ::term::ansi::code::ctrl::init
497              Initialize default and alternate fonts to ASCII and  box  graph‐
498              ics.
499
500       ::term::ansi::code::ctrl::showat row col text
501              Format the block of text for display at the specified location.
502

BUGS, IDEAS, FEEDBACK

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  Trackers  [http://core.tcl.tk/tcllib/reportlist].   Please
507       also report any ideas for enhancements you may have for either  package
508       and/or documentation.
509
510       When proposing code changes, please provide unified diffs, i.e the out‐
511       put of diff -u.
512
513       Note further that  attachments  are  strongly  preferred  over  inlined
514       patches.  Attachments  can  be  made  by  going to the Edit form of the
515       ticket immediately after its creation, and  then  using  the  left-most
516       button in the secondary navigation bar.
517

KEYWORDS

519       ansi, attribute control, color control, control, terminal
520

COPYRIGHT

525       Copyright (c) 2006-2008 Andreas Kupries <andreas_kupries@users.sourceforge.net>
526
527
528
529
530tcllib                                0.2            term::ansi::code::ctrl(n)