toilet(1)

📦
version 0.3 · 2 versions
, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing

💖 TOIlet — yeah that's literally its name, bestie 💖

okay so hi, welcome to the toilet(1) page, General Commands Manual vibes, and yes the tool is called TOIlet and yes that is iconic of it. She's the glow-up cousin of FIGlet and she's here to make your terminal text huge and fabulous. Let's go 🫶

✨ NAME ✨

TOIlet — display large colourful characters 💅

Like, she takes your lil baby letters and turns them into BIG dramatic letters made out of smaller characters. Main character energy fr fr.

🌈 SYNOPSIS 🌈

toilet [ -hkostvSW ] [ -d fontdirectory ]
       [ -f fontfile ] [ -F filter ] [ -w outputwidth ]
       [ -I infocode ] [ -E format ] [ message ]

🦋 DESCRIPTION 🦋

So TOIlet prints text using large characters made of smaller characters. It is similar in many ways to FIGlet — but with additional features, and those features are lowkey the whole point: Unicode handling, colour fonts, filters, and various export formats. Obsessed. 😭✨

🎀 USAGE 🎀

TOIlet either reads its input from the command line or from the standard input. Pick your lane, both are valid. 💖

👑 OPTIONS 👑

  • -f, --font <name> — Use the given font instead of the default value. Fonts are .flf or .tlf files stored in the /usr/share/figlet directory. Fonts are looked first in the font directory, then in the current directory. There is also a special built-in font called term that serves as a fallback if no font is available. (bestie, term is your safety net, she's always there 🫶)
  • -d, --directory <dir> — Specify the directory in which to look for fonts. The default value is set at build time and usually defaults to /usr/share/figlet.
  • -s, -S, -k, -W, -o — Select character composition rules. Let's break it down, no cap:
    • -S sets smushing (nicely merging glyphs) ✨
    • -k sets kerning (rendering subcharacters as close to each other as possible)
    • -W renders characters at their full width
    • -o sets overlapping (glyphs slightly overlap the previous one)
    • -s (default behaviour) uses the font's smushing information if any, otherwise forces overlapping, or does nothing if the glyph only has one subcharacter.
  • -w, --width <width> — Set the output width. By default, TOIlet will wrap its output at 80 character columns.
  • -t, --termwidth — Set the output width to the terminal width. It's giving "match my energy" 💅
  • -F, --filter <filters>
  • -F, --filter list
  • --gay, --metal — Specify a list of filters to be applied to the output. <filters> is a colon-separated list of filters such as crop:rotate:gay and the special argument list outputs a list of available filters.

--gay and --metal are shortcuts to commonly used filters that are guaranteed to exist. Several -F flags can also be specified on the command line, in which case filters will be applied in order of appearance. Order matters, bestie, it's a whole pipeline moment 🔥

  • -E, --export <format>
  • -E, --export list
  • --irc, --html — Specify the output format. By default, TOIlet will output UTF-8 text using ANSI colour codes suitable for most terminals such as XTerm or rxvt. <format> is the name of the export format as recognised by libcaca. The special argument list outputs a list of available export formats.

--irc and --html are shortcuts to commonly used export formats that are guaranteed to exist.

  • -h, --help — Display a short help message and exit.
  • -I, --infocode <code> — Print a FIGlet infocode. This flag is only here for FIGlet compatibility, see the figlet manpage for more information about it. (it's a legacy thing, we respect her 🙈)
  • -v, --version — Output version information and exit.

🍓 EXAMPLES 🍓

toilet Hello World
toilet Hello | toilet
tail -f /var/log/messages | toilet -f term --gay

the third one is the vibe, watching your logs scroll by in rainbow letters at 2am 🌈😭

💀 BUGS 💀

FIGlet compatibility is not complete yet. That's it, that's the whole note. Not everything from FIGlet has been ported over, so don't come for her.

💜 AUTHOR 💜

TOIlet and this manual page were written by Sam Hocevar <sam@hocevar.net>. There is a webpage available at http://caca.zoy.org/wiki/toilet. Legend behaviour, honestly 👑

⭐ SEE ALSO ⭐

and that's the whole page, bestie!! this is libcaca @PACKAGE_VERSION@, dated 2006-11-10, from the toilet(1) page of the General Commands Manual. go make something enormous and colourful, you've got this 💖✨🎀

📦 where this page comes from