term::ansi::code::attr(n)

✨ term::ansi::code::attr — the ANSI attribute glow-up ✨

okay bestie, welcome to term::ansi::code::attr, a lil Tcllib package (manual name term::ansi::code::attr(n), filed under Terminal control) that hands you cute symbolic names for all the ANSI attribute control codes. no cap, that's the whole job. 🎀

---

💖 NAME 💖

term::ansi::code::attr — ANSI attribute sequences. that's it, that's the name, iconic.

---

🌸 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 this package is literally just a vibe dictionary for ANSI attribute control codes. for every single control code there's one command, and that command returns the code as its result. done. that's the tea. ✨

big important note, bestie: none of these commands write to a channel. not one. that whole "actually putting the codes on the screen" situation is handled by higher level packages, like term::ansi::send. this package is just the lookup table, the backstage crew, the main-character-adjacent supporting cast. 🫶

---

👑 API 👑

🔍 INTROSPECTION 🔍

• ::term::ansi::code::attr::names — this one is for introspection, iykyk. it returns a list containing the names of all the attribute commands. your full menu, no substitutions.
• ::term::ansi::code::attr::import ?ns? ?arg...? — this one imports some or all of the attribute commands into the namespace ns. by default ns is the namespace attr. heads up though: it's a relative namespace name, so the imported command lands in a child of the current namespace, not some absolute place. and by default all the commands get imported — you can restrict that by listing the names of the wanted commands after the namespace argument. picky eaters welcome. 💅

🌈 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. the big undo button, the factory reset, the "we don't talk about that anymore". 💀

---

😭 BUGS, IDEAS, FEEDBACK 😭

ngl, this document — and the package it describes — will undoubtedly contain bugs and other problems. that's just how it is, we're all doing our best out here. 🙈 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 want the ideas, we love the ideas. 💜

when proposing code changes, please provide unified diffs, i.e the output of diff -u. no vibes-based diffs, bestie, we need the real thing.

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. screenshot the buttons, follow the path, slay. 🔥

---

⭐ KEYWORDS ⭐

ansi, attribute control, color control, control, terminal

---

🎀 CATEGORY 🎀

Terminal control

---

💅 COPYRIGHT 💅

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

---

and that's the whole page, bestie — brought to you by tcllib, version 0.2, living under Terminal control, and yes the copyright has been 2006 Andreas Kupries the whole time. periodt. 💖✨