blob: 3545adbdf6f04139eedfb2ee8aaec49bb90d254f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
|
[comment {-*- tcl -*- doctools manpage}]
[manpage_begin term::ansi::code::macros n 0.1]
[keywords ansi]
[keywords control]
[keywords frame]
[keywords menu]
[keywords terminal]
[copyright {2006 Andreas Kupries <andreas_kupries@users.sourceforge.net>}]
[moddesc {Terminal control}]
[titledesc {Macro sequences}]
[category {Terminal control}]
[require Tcl 8.4]
[require textutil::repeat]
[require textutil::tabify]
[require term::ansi::code::macros [opt 0.1]]
[description]
This package provides higher level control sequences for more complex
shapes.
[section API]
[subsection Introspection]
[list_begin definitions]
[call [cmd ::term::ansi::code::macros::names]]
This command is for introspection. It returns as its result a list
containing the names of all attribute commands.
[call [cmd ::term::ansi::code::macros::import] [opt [arg ns]] [opt [arg arg]...]]
This command imports some or all attribute commands into the namespace
[arg ns]. This is by default the namespace [emph macros]. Note that
this is relative namespace name, placing the imported command into a
child of the current namespace. By default all commands are imported,
this can howver be restricted by listing the names of the wanted
commands after the namespace argument.
[list_end]
[subsection Sequences]
[list_begin definitions]
[call [cmd ::term::ansi::code::macros::menu] [arg menu]]
The description of a menu is converted into a formatted rectangular
block of text, with the menu command characters highlighted using bold
red text. The result is returned as the result of the command.
[para]
The description, [arg menu], is a dictionary mapping from menu label
to command character.
[call [cmd ::term::ansi::code::macros::frame] [arg string]]
The paragraph of text contained in the string is padded with spaces at
the right margin, after normalizing internal tabs, and then put into a
frame made of box-graphics. The result is returned as the result of
the command.
[list_end]
[vset CATEGORY term]
[include ../doctools2base/include/feedback.inc]
[manpage_end]
|
