term::ansi::send(n)

📦
version 2.0 · 2 versions
, in fedora 43, fedora 44, nixos 26.05, nixpkgs unstable

🎀 term::ansi::send(n) — Terminal control 🎀

okay bestie, come CLOSE. this is the manual page for term::ansi::send, which lives in the Terminal control section of the Tcl man pages. it's a Tcl package that yeets ANSI control sequences at your terminal, and honestly? it's giving keyboard wizard energy. 💅

we're doing this in parts because it's LONG long, and this is part one. buckle up. 🦋

✨ NAME ✨

term::ansi::send — Output of ANSI control sequences to terminals

like. that's it. that's the whole job description. it sends ANSI control sequences to terminals. no cap. 🔥

✨ SYNOPSIS ✨

first things first, the requirements, because you can't just walk in here without them:

package require Tcl 8.5 9

package require term::ansi::send ?0.2?

so you need Tcl 8.5 or 9, and the package itself, and the version is optional (?0.2? — the ?s mean "this bit is optional", not that it's confused, ok 😭).

then the actual commands. and there are a LOT of them. like, a concerning amount. let's go. 🫶

the import + the little guys

::term::ansi::send::import ?ns? ...

::term::ansi::send::eeol

::term::ansi::send::esol

::term::ansi::send::el

::term::ansi::send::ed

::term::ansi::send::eu

::term::ansi::send::es

::term::ansi::send::sd

::term::ansi::send::su

::term::ansi::send::ch

::term::ansi::send::sc

::term::ansi::send::rc

::term::ansi::send::sca

::term::ansi::send::rca

::term::ansi::send::st

::term::ansi::send::ct

::term::ansi::send::cat

::term::ansi::send::qdc

::term::ansi::send::qds

::term::ansi::send::qcp

::term::ansi::send::rd

::term::ansi::send::elw

::term::ansi::send::dlw

::term::ansi::send::eg

::term::ansi::send::lg

look at all those little two-and-three letter icons ✨ they're short, they're punchy, they're doing the most with the least. main character energy fr fr.

the tag + sda crew

::term::ansi::send::scs0 tag

::term::ansi::send::scs1 tag

::term::ansi::send::sda arg...

scs0 and scs1 both take a tag, and sda takes an arg... (that's a variable number of args, bestie, it's flexible like that 💜).

the sda_ family (yes, all of them, i counted)

::term::ansi::send::sda_fgblack

::term::ansi::send::sda_fgred

::term::ansi::send::sda_fggreen

::term::ansi::send::sda_fgyellow

::term::ansi::send::sda_fgblue

::term::ansi::send::sda_fgmagenta

::term::ansi::send::sda_fgcyan

::term::ansi::send::sda_fgwhite

::term::ansi::send::sda_fgdefault

::term::ansi::send::sda_bgblack

::term::ansi::send::sda_bgred

::term::ansi::send::sda_bggreen

::term::ansi::send::sda_bgyellow

::term::ansi::send::sda_bgblue

::term::ansi::send::sda_bgmagenta

::term::ansi::send::sda_bgcyan

::term::ansi::send::sda_bgwhite

::term::ansi::send::sda_bgdefault

::term::ansi::send::sda_bold

::term::ansi::send::sda_dim

::term::ansi::send::sda_italic

::term::ansi::send::sda_underline

::term::ansi::send::sda_blink

::term::ansi::send::sda_revers

::term::ansi::send::sda_hidden

::term::ansi::send::sda_strike

::term::ansi::send::sda_nobold

::term::ansi::send::sda_noitalic

::term::ansi::send::sda_nounderline

::term::ansi::send::sda_noblink

::term::ansi::send::sda_norevers

::term::ansi::send::sda_nohidden

::term::ansi::send::sda_nostrike

::term::ansi::send::sda_reset

foreground, background, bold, dim, italic, underline, blink, revers, hidden, strike — and then a whole set of no-versions to undo them, plus sda_reset. the way that this list just keeps going. 💀 obsessed. note that it's revers, not reverse — that's not a typo, that's the actual name, don't @ me.

positioning + text + titles

::term::ansi::send::fcp row col

::term::ansi::send::cu ?n?

::term::ansi::send::cd ?n?

::term::ansi::send::cf ?n?

::term::ansi::send::cb ?n?

::term::ansi::send::ss ?s e?

::term::ansi::send::skd code str

::term::ansi::send::title str

fcp wants a row and a col. cu, cd, cf and cb all take an optional n. ss takes optional s and e. skd wants a code and a str. title takes a str. 🍓

the rest of the roster

::term::ansi::send::gron

::term::ansi::send::groff

::term::ansi::send::tlc

::term::ansi::send::trc

::term::ansi::send::brc

::term::ansi::send::blc

::term::ansi::send::ltj

::term::ansi::send::ttj

::term::ansi::send::rtj

::term::ansi::send::btj

::term::ansi::send::fwj

::term::ansi::send::hl

::term::ansi::send::vl

::term::ansi::send::groptim str

::term::ansi::send::clear

::term::ansi::send::init

::term::ansi::send::showat row col text

and that's the full synopsis, every single command, nothing skipped, nothing merged, nothing invented. groptim takes a str, and showat takes row col text. the corner ones (tlc, trc, brc, blc) and the justify ones (ltj, ttj, rtj, btj, fwj) are all here too. ✨

okay that's part one, the synopsis. part two is where we get into what all of these actually DO, and bestie, there's a lot of tea to spill. 🫖 stay tuned 💖

✨ DESCRIPTION ✨

Okay bestie, listen UP, because this package is literally the glow-up your terminal has been waiting for. 💅

This package provides commands to send ANSI terminal control sequences to a terminal. That's the whole vibe. All commands come in two variants:

  • one for sending to any channel
  • one for sending to stdout (the main character, obviously)

The commands are defined using the control sequences provided by the package term::ansi::code::ctrl. They have the same arguments as the commands they're based on — with one exception, the variant for sending to any channel. That variant's first argument is always a channel handle, then followed by the original arguments. 🫶

Below we list only the variant sending to stdout. (The channel one is just this, but with your channel handle up front, iykyk.)

🌸 The Commands 🌸

  • ::term::ansi::send::import ?ns? ... — Imports the commands of this package into the namespace ns. If not specified it defaults to send. Heads up though: this default is a relative namespace name, i.e. the actual namespace will be created under the current namespace. By default all commands will be imported, but you can restrict it to specific commands by listing them after the namespace to import them into. ✨

🧹 Erasing Things

  • ::term::ansi::send::eeol — Erase (to) End Of Line.
  • ::term::ansi::send::esol — Erase (to) Start Of Line.
  • ::term::ansi::send::el — Erase (current) Line.
  • ::term::ansi::send::ed — Erase Down (to bottom).
  • ::term::ansi::send::eu — Erase Up (to top).
  • ::term::ansi::send::es — Erase Screen.

📜 Scrolling

  • ::term::ansi::send::sd — Scroll Down.
  • ::term::ansi::send::su — Scroll Up.

🎯 Cursor Basics

  • ::term::ansi::send::ch — Cursor Home.
  • ::term::ansi::send::sc — Save Cursor. Note: Only one saved position can be handled. This is no unlimited stack. Saving before restoring will overwrite the saved data. 😭
  • ::term::ansi::send::rc — Restore Cursor (Unsave).
  • ::term::ansi::send::sca — Save Cursor + Attributes.
  • ::term::ansi::send::rca — Restore Cursor + Attributes.

📑 Tabs

  • ::term::ansi::send::st — Set Tab (@ current position).
  • ::term::ansi::send::ct — Clear Tab (@ current position).
  • ::term::ansi::send::cat — Clear All Tabs.

🔍 Queries & Device Stuff

  • ::term::ansi::send::qdc — Query Device Code.
  • ::term::ansi::send::qds — Query Device Status.
  • ::term::ansi::send::qcp — Query Cursor Position.
  • ::term::ansi::send::rd — Reset Device.
  • ::term::ansi::send::elw — Enable Line Wrap.
  • ::term::ansi::send::dlw — Disable Line Wrap.

🎨 Graphics Mode & Character Sets

  • ::term::ansi::send::eg — Enter Graphics Mode.
  • ::term::ansi::send::lg — Exit Graphics Mode.
  • ::term::ansi::send::scs0 tag
  • ::term::ansi::send::scs1 tag — Select Character Set.

Choose which character set is used for default (scs0) and alternate font (scs1). This does not change whether default or alternate font are used, just their definitions. 👑

The legal tags, and their meanings, are:

  • A — United Kingdom Set
  • B — ASCII Set
  • 0 — Special Graphics
  • 1 — Alternate Character ROM Standard Character Set
  • 2 — Alternate Character ROM Special Graphics

💖 Display Attributes

  • ::term::ansi::send::sda arg... — Set Display Attributes. The arguments are the code sequences for the possible attributes, as provided by the package term::ansi::code::attr. For convenience this package also provides additional commands, each setting a single specific attribute. 🎀

🌈 Foreground Colours

  • ::term::ansi::send::sda_fgblack — Set text color to Black.
  • ::term::ansi::send::sda_fgred — Set text color to Red.
  • ::term::ansi::send::sda_fggreen — Set text color to Green.
  • ::term::ansi::send::sda_fgyellow — Set text color to Yellow.
  • ::term::ansi::send::sda_fgblue — Set text color to Blue.
  • ::term::ansi::send::sda_fgmagenta — Set text color to Magenta.
  • ::term::ansi::send::sda_fgcyan — Set text color to Cyan.
  • ::term::ansi::send::sda_fgwhite — Set text color to White.
  • ::term::ansi::send::sda_fgdefault — Set default text color (Black).

🦋 Background Colours

  • ::term::ansi::send::sda_bgblack — Set background to Black.
  • ::term::ansi::send::sda_bgred — Set background to Red.
  • ::term::ansi::send::sda_bggreen — Set background to Green.
  • ::term::ansi::send::sda_bgyellow — Set background to Yellow.
  • ::term::ansi::send::sda_bgblue — Set background to Blue.
  • ::term::ansi::send::sda_bgmagenta — Set background to Magenta.
  • ::term::ansi::send::sda_bgcyan — Set background to Cyan.
  • ::term::ansi::send::sda_bgwhite — Set background to White.
  • ::term::ansi::send::sda_bgdefault — Set default background (Transparent).

✨ On & Off

  • ::term::ansi::send::sda_bold — Bold on.
  • ::term::ansi::send::sda_dim — Dim on.
  • ::term::ansi::send::sda_italic — Italics on.
  • ::term::ansi::send::sda_underline — Underscore on.
  • ::term::ansi::send::sda_blink — Blink on.
  • ::term::ansi::send::sda_revers — Reverse on.
  • ::term::ansi::send::sda_hidden — Hidden on.
  • ::term::ansi::send::sda_strike — Strike-through on.
  • ::term::ansi::send::sda_nobold — Bold off.
  • ::term::ansi::send::sda_noitalic — Italics off.
  • ::term::ansi::send::sda_nounderline — Underscore off.
  • ::term::ansi::send::sda_noblink — Blink off.
  • ::term::ansi::send::sda_norevers — Reverse off.
  • ::term::ansi::send::sda_nohidden — Hidden off.
  • ::term::ansi::send::sda_nostrike — Strike-through off.
  • ::term::ansi::send::sda_reset — Reset all attributes to their default values.

🧭 Moving The Cursor

  • ::term::ansi::send::fcp row col — Force Cursor Position (aka Go To).
  • ::term::ansi::send::cu ?n? — Cursor Up. n defaults to 1.
  • ::term::ansi::send::cd ?n? — Cursor Down. n defaults to 1.
  • ::term::ansi::send::cf ?n? — Cursor Forward. n defaults to 1.
  • ::term::ansi::send::cb ?n? — Cursor Backward. n defaults to 1.

🖥️ Screen & Keys

  • ::term::ansi::send::ss ?s e? — Scroll Screen (entire display, or between rows start end, inclusive).
  • ::term::ansi::send::skd code str — Set Key Definition.
  • ::term::ansi::send::title str — Set the terminal title.

📦 Box Graphics, The Moment You've All Been Waiting For 📦

  • ::term::ansi::send::gron — Switch to character/box graphics. I.e. switch to the alternate font.
  • ::term::ansi::send::groff — Switch to regular characters. I.e. switch to the default font.
  • ::term::ansi::send::tlc — Character graphics, Top Left Corner.
  • ::term::ansi::send::trc — Character graphics, Top Right Corner.
  • ::term::ansi::send::brc — Character graphics, Bottom Right Corner.
  • ::term::ansi::send::blc — Character graphics, Bottom Left Corner.
  • ::term::ansi::send::ltj — Character graphics, Left T Junction.
  • ::term::ansi::send::ttj — Character graphics, Top T Junction.
  • ::term::ansi::send::rtj — Character graphics, Right T Junction.
  • ::term::ansi::send::btj — Character graphics, Bottom T Junction.
  • ::term::ansi::send::fwj — Character graphics, Four-Way Junction.
  • ::term::ansi::send::hl — Character graphics, Horizontal Line.
  • ::term::ansi::send::vl — Character graphics, Vertical Line.
  • ::term::ansi::send::groptim str — Optimize character graphics. The generator commands above create way too many superfluous commands shifting into and out of the graphics mode. (Not me calling them out 😭.) This command removes all shifts which are not needed. To this end it also knows which characters will look the same in both modes, to handle strings created outside of this package. 🧚

🏁 Odds & Ends

  • ::term::ansi::send::clear — Clear screen. In essence a sequence of CursorHome + EraseDown.
  • ::term::ansi::send::init — Initialize default and alternate fonts to ASCII and box graphics.
  • ::term::ansi::send::showat row col text — Show the block of text at the specified location.

💀 BUGS, IDEAS, FEEDBACK 💀

This document, and the package it describes, will undoubtedly contain bugs and other problems. Like, obviously. 🙈 Please report such in the category term of the Tcllib Trackers at http://core.tcl.tk/tcllib/reportlist. Please also report any ideas for enhancements you may have for either package and/or documentation — we love ideas here. 🫶

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. No cap. ✨

🔑 KEYWORDS 🔑

character output, control, terminal

🗂️ CATEGORY 🗂️

Terminal control

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

And that's a wrap bestie!! 🎀 This page is term::ansi::send(n) from tcllib, version 0.2 — go forth and make your terminal absolutely serve. Slay. 💅✨🌈

📦 where this page comes from