[ Tcllib Home | Main Table Of Contents | Table Of Contents | Keyword Index | Categories | Modules | Applications ]

# term::ansi::code(n) 0.2 tcllib "Terminal control"

## Name

term::ansi::code - Helper for control sequences

## Synopsis

- package require Tcl 8.4
- package require term::ansi::code ?0.2?

- ::term::ansi::code::esc str
- ::term::ansi::code::escb str
- ::term::ansi::code::define name escape code
- ::term::ansi::code::const name code

## Description

This package provides commands enabling the definition of control sequences in an easy manner.

::term::ansi::code::esc str

  This command returns the argument string, prefixed with the ANSI escape character, "\033."

::term::ansi::code::escb str

  This command returns the argument string, prefixed with a common ANSI escape sequence, "\033[".

::term::ansi::code::define name escape code

  This command defines a procedure name which returns the control sequence code, beginning with the specified escape sequence, either esc, or escb.

::term::ansi::code::const name code

  This command defines a procedure name which returns the control sequence code.

## 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 Trackers. Please also report any ideas for enhancements you may have for either package and/or documentation.

When proposing code changes, please provide unified diffs, i.e the output of diff -u.

Note further that attachments are strongly preferred over inlined patches. Attachments can be made by going to the Edit form of the ticket immediately after its creation, and then using the left-most button in the secondary navigation bar.

## Keywords

control, declare, define, terminal

## Category

Terminal control

## Copyright

Copyright © 2006 Andreas Kupries <andreas_kupries@users.sourceforge.net>