summaryrefslogtreecommitdiffstats
path: root/tcllib/modules/term/ansi_cmacros.man
diff options
context:
space:
mode:
authorWilliam Joye <wjoye@cfa.harvard.edu>2016-10-27 19:39:39 (GMT)
committerWilliam Joye <wjoye@cfa.harvard.edu>2016-10-27 19:39:39 (GMT)
commitea28451286d3ea4a772fa174483f9a7a66bb1ab3 (patch)
tree6ee9d8a7848333a7ceeee3b13d492e40225f8b86 /tcllib/modules/term/ansi_cmacros.man
parentb5ca09bae0d6a1edce939eea03594dd56383f2c8 (diff)
parent7c621da28f07e449ad90c387344f07a453927569 (diff)
downloadblt-ea28451286d3ea4a772fa174483f9a7a66bb1ab3.zip
blt-ea28451286d3ea4a772fa174483f9a7a66bb1ab3.tar.gz
blt-ea28451286d3ea4a772fa174483f9a7a66bb1ab3.tar.bz2
Merge commit '7c621da28f07e449ad90c387344f07a453927569' as 'tcllib'
Diffstat (limited to 'tcllib/modules/term/ansi_cmacros.man')
-rw-r--r--tcllib/modules/term/ansi_cmacros.man66
1 files changed, 66 insertions, 0 deletions
diff --git a/tcllib/modules/term/ansi_cmacros.man b/tcllib/modules/term/ansi_cmacros.man
new file mode 100644
index 0000000..3545adb
--- /dev/null
+++ b/tcllib/modules/term/ansi_cmacros.man
@@ -0,0 +1,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]