term::ansi::code::attr(3tcl)

term::ansi::code::attr 💅✨

okay bestie, sit down, we're talking about the Tcllib page term::ansi::code::attr(3tcl) from the Terminal control manual section. this is the one that gives you cute little symbolic names for ANSI attribute codes so you never have to hand-type an escape sequence again. it's giving "I memorized the color codes so you don't have to" and honestly? iconic. 🎀

---

🌸 NAME 🌸

term::ansi::code::attr — ANSI attribute sequences

---

✨ SYNOPSIS ✨

package require Tcl 8.5 9

package require term::ansi::code ?0.2?

package require term::ansi::code::attr ?0.2?

::term::ansi::code::attr::names

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

::term::ansi::code::attr::fgblack

::term::ansi::code::attr::fgred

::term::ansi::code::attr::fggreen

::term::ansi::code::attr::fgyellow

::term::ansi::code::attr::fgblue

::term::ansi::code::attr::fgmagenta

::term::ansi::code::attr::fgcyan

::term::ansi::code::attr::fgwhite

::term::ansi::code::attr::fgdefault

::term::ansi::code::attr::bgblack

::term::ansi::code::attr::bgred

::term::ansi::code::attr::bggreen

::term::ansi::code::attr::bgyellow

::term::ansi::code::attr::bgblue

::term::ansi::code::attr::bgmagenta

::term::ansi::code::attr::bgcyan

::term::ansi::code::attr::bgwhite

::term::ansi::code::attr::bgdefault

::term::ansi::code::attr::bold

::term::ansi::code::attr::dim

::term::ansi::code::attr::italic

::term::ansi::code::attr::underline

::term::ansi::code::attr::blink

::term::ansi::code::attr::revers

::term::ansi::code::attr::hidden

::term::ansi::code::attr::strike

::term::ansi::code::attr::nobold

::term::ansi::code::attr::noitalic

::term::ansi::code::attr::nounderline

::term::ansi::code::attr::noblink

::term::ansi::code::attr::norevers

::term::ansi::code::attr::nohidden

::term::ansi::code::attr::nostrike

::term::ansi::code::attr::reset

---

🦋 DESCRIPTION 🦋

so basically this package hands you symbolic names for the ANSI attribute control codes. for every single control code there's one command, and that command just returns the code as its result. that's it. that's the whole job. 💖

big important note, do not skip this: none of the commands in this package write to a channel. like, zero. not one. that part is handled by higher level packages, like term::ansi::send. so don't come for this package when nothing shows up on your terminal — it's not that kind of girl. 😭

---

👑 API 👑

🔍 INTROSPECTION 🔍

• ::term::ansi::code::attr::names — this one is purely for introspection, bestie. it returns a list containing the names of all the attribute commands. use it when you wanna know what you're working with. 🫶
• ::term::ansi::code::attr::import ?ns? ?arg...? — this command imports some or all of the attribute commands into the namespace ns. by default that namespace is attr. heads up though: it's a relative namespace name, so it drops the imported commands into a child of the current namespace. by default all commands get imported, but you can restrict that by listing the names of the wanted commands after the namespace argument. (yes, the original says "howver". we love a typo era. 💀)

🎨 ATTRIBUTES 🎨

• ::term::ansi::code::attr::fgblack — set text color to Black.
• ::term::ansi::code::attr::fgred — set text color to Red.
• ::term::ansi::code::attr::fggreen — set text color to Green.
• ::term::ansi::code::attr::fgyellow — set text color to Yellow.
• ::term::ansi::code::attr::fgblue — set text color to Blue.
• ::term::ansi::code::attr::fgmagenta — set text color to Magenta.
• ::term::ansi::code::attr::fgcyan — set text color to Cyan.
• ::term::ansi::code::attr::fgwhite — set text color to White.
• ::term::ansi::code::attr::fgdefault — set default text color (Black).
• ::term::ansi::code::attr::bgblack — set background to Black.
• ::term::ansi::code::attr::bgred — set background to Red.
• ::term::ansi::code::attr::bggreen — set background to Green.
• ::term::ansi::code::attr::bgyellow — set background to Yellow.
• ::term::ansi::code::attr::bgblue — set background to Blue.
• ::term::ansi::code::attr::bgmagenta — set background to Magenta.
• ::term::ansi::code::attr::bgcyan — set background to Cyan.
• ::term::ansi::code::attr::bgwhite — set background to White.
• ::term::ansi::code::attr::bgdefault — set default background (Transparent).
• ::term::ansi::code::attr::bold — Bold on.
• ::term::ansi::code::attr::dim — Dim on.
• ::term::ansi::code::attr::italic — Italics on.
• ::term::ansi::code::attr::underline — Underscore on.
• ::term::ansi::code::attr::blink — Blink on.
• ::term::ansi::code::attr::revers — Reverse on.
• ::term::ansi::code::attr::hidden — Hidden on.
• ::term::ansi::code::attr::strike — Strike-through on.
• ::term::ansi::code::attr::nobold — Bold off.
• ::term::ansi::code::attr::noitalic — Italics off.
• ::term::ansi::code::attr::nounderline — Underscore off.
• ::term::ansi::code::attr::noblink — Blink off.
• ::term::ansi::code::attr::norevers — Reverse off.
• ::term::ansi::code::attr::nohidden — Hidden off.
• ::term::ansi::code::attr::nostrike — Strike-through off.
• ::term::ansi::code::attr::reset — Reset all attributes to their default values.

---

💀 BUGS, IDEAS, FEEDBACK 💀

ngl bestie, this document and the package it describes will undoubtedly contain bugs and other problems. like, that's just how it is. please report such in the category term of the Tcllib Trackers at http://core.tcl.tk/tcllib/reportlist. and please also report any ideas for enhancements you may have for either the package and/or the documentation. we love a glow-up suggestion. ✨

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. (iykyk 🫶)

---

🎀 KEYWORDS 🎀

ansi, attribute control, color control, control, terminal

---

🌈 CATEGORY 🌈

Terminal control

---

💜 COPYRIGHT 💜

Copyright (c) 2006 Andreas Kupries <andreas_kupries@users.sourceforge.net>

---

okay and that's the whole page, bestie!! this came to you from tcllib, version 0.2, and the page is term::ansi::code::attr(3tcl) — go color your terminal, you main character 💅🌸🦋 periodt.