This manual page is for Mac OS X version 10.6

If you are running a different version of Mac OS X, view the documentation locally:

  • In Terminal, using the man(1) command

Reading manual pages

Manual pages are intended as a quick reference for people who already understand a technology.

  • For more information about the manual page format, see the manual page for manpages(5).

  • For more information about this technology, look for other documentation in the Apple Reference Library.

  • For general information about writing shell scripts, read Shell Scripting Primer.




term::ansi::code::macros(n)                   Terminal control                   term::ansi::code::macros(n)



____________________________________________________________________________________________________________

NAME
       term::ansi::code::macros - Macro sequences

SYNOPSIS
       package require Tcl  8.4

       package require textutil::repeat

       package require textutil::tabify

       package require term::ansi::code::macros  ?0.1?

       ::term::ansi::code::macros::names

       ::term::ansi::code::macros::import ?ns? ?arg...?

       ::term::ansi::code::macros::menu menu

       ::term::ansi::code::macros::frame string

____________________________________________________________________________________________________________

DESCRIPTION
       This package provides higher level control sequences for more complex shapes.

API
   INTROSPECTION
       ::term::ansi::code::macros::names
              This command is for introspection. It returns as its result a list containing the names of all
              attribute commands.

       ::term::ansi::code::macros::import ?ns? ?arg...?
              This command imports some or all attribute commands into the namespace ns. This is by  default
              the  namespace 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.


   SEQUENCES
       ::term::ansi::code::macros::menu 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.

              The description, menu, is a dictionary mapping from menu label to command character.

       ::term::ansi::code::macros::frame 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.


BUGS, IDEAS, FEEDBACK
       This  document,  and  the  package  it  describes,  will undoubtedly contain bugs and other problems.
       Please  report  such  in  the   category   term   of   the   Tcllib   SF   Trackers   [http://source-
       forge.net/tracker/?group_id=12883].   Please  also report any ideas for enhancements you may have for
       either package and/or documentation.

KEYWORDS
       ansi, control, frame, menu, terminal

COPYRIGHT
       Copyright (c) 2006 Andreas Kupries <[email protected]>




term                                                 0.1                         term::ansi::code::macros(n)

Reporting Problems

The way to report a problem with this manual page depends on the type of problem:

Content errors
Report errors in the content of this documentation with the feedback links below.
Bug reports
Report bugs in the functionality of the described tool or API through Bug Reporter.
Formatting problems
Report formatting mistakes in the online version of these pages with the feedback links below.