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