SWIRC.THEME(5)

πŸ“¦
version 3.5.9 Β· 2 versions
, in debian trixie, ubuntu questing, ubuntu resolute, ubuntu stonking

πŸ’– swirc.theme β€” the manual page, bestie edition πŸ’–

okay so this is swirc.theme(5), from the File Formats Manual section, and it's literally the guide to writing themes for swirc. let's get into it 🫢


✨ NAME ✨

swirc.theme β€” how to write themes for swirc πŸ’…


🌸 DESCRIPTION 🌸

This manual page is the ultimate reference to consult when you're writing themes for swirc(1). like, no other page, just this one. it's giving "the final boss of theme docs" πŸ‘‘


πŸŽ€ TEXT DECORATION πŸŽ€

Here's the whole vibe chart, bestie β€” the name, the hex, the octal, and what it actually looks like:

  • Blink β€” 1d, 035, ^]
  • Bold β€” 02, 002, ^B
  • Color β€” 03, 003, ^C
  • Normal β€” 0f, 017, ^O
  • Reverse β€” 16, 026, ^V
  • Underline β€” 1f, 037, ^_

Example usage:

blabla ^Bbold text^B blabla
blabla ^Vreversed text^V blabla
blabla ^_underlined text^_ blabla
Always use the literal control characters because else it won't work! 😭 fr fr, no shortcuts.

Blink is a no operation because it's annoying. periodt. it does nothing. we don't do that here. πŸ’€


🌈 COLORS 🌈

The classic sixteen, icon by icon:

  • 00 β€” white
  • 01 β€” black
  • 02 β€” blue (navy)
  • 03 β€” green
  • 04 β€” red
  • 05 β€” brown (maroon)
  • 06 β€” purple
  • 07 β€” orange (olive)
  • 08 β€” yellow
  • 09 β€” lt.green (lime)
  • 10 β€” teal (a kinda green/blue cyan)
  • 11 β€” lt.cyan (cyan ?) (aqua)
  • 12 β€” lt.blue (royal)
  • 13 β€” pink (light purple) (fuchsia)
  • 14 β€” grey
  • 15 β€” lt.grey (silver)

For the colors 16-99 see the output of the command /colormap. Enough color pairs must've been initialized. (and heads up: 193 color pairs are too few for the colors 16-99 to be used as backgrounds. πŸ’€)

The syntax of the color attribute in text has the format ^CN[,M]. N will be the text (foreground) color and M the background color. A background color (M) is optional and is not always included.

N and M can maximally be two digits long. Although the colors {0,1,2,...,9} are supported you are highly encouraged to use {00,01,02,...,09}. ✨

A plain ^C can be used to turn the color effect off. While typing ^O will make sure ALL the text effects gets reset. For example:

blabla ^C05,02red text on blue background^C blabla
blabla ^C09green text^O blabla

Of course settings can start with colored text and a closing ^C is not essential. πŸ¦‹


πŸ’œ SETTING TYPES πŸ’œ

See swirc.conf(5). that's it, that's the section, go read the other one bestie 🫢


πŸ‘‘ SETTINGS πŸ‘‘

  • term_background (int) β€” Which background color (0-15) is this theme written for?
    • 0 = white
    • 1 = black
  • term_enable_colors (bool) β€” Enable colors (yes/no)?
  • term_use_default_colors (bool) β€” Use terminal's default colors? I.e. call use_default_colors(3).
  • color3, color4 (string) β€” Colors used in uncategorized contexts. Must begin with ^C.
  • gfx_failure, gfx_success, gfx_warning (string) β€” Used in contexts where to flag failures, successes and warnings respectively.
  • left_bracket, right_bracket (string) β€” Left and right bracket. Frequently used.
  • logo_color (string) β€” Swirc ASCII logo color displayed at startup. (Must begin with ^C.)
  • nick_s1, nick_s2 (string) β€” When you or another user types something the nickname will be enclosed by s1 and s2.
  • nicklist_my_nick_color, nicklist_nick_color, nicklist_privilege_color, nicklist_vline_color (int) β€” Nicklist decoration. All of these settings are of type int (0-99) thus ^C is not needed and should not be used.
  • notice_color1, notice_color2 (string) β€” Notice colors. ^C should be used.
  • notice_lb, notice_rb, notice_sep (string) β€” Notice left/right bracket and separator
  • notice_inner_b1, notice_inner_b2 (string) β€” Notice inner bracket 1 and 2. (I.e. left and right.)
  • primary_color, secondary_color (string) β€” Primary and secondary color for the theme. Frequently used. (Begin with ^C.)
  • slogan (string) β€” Swirc slogan displayed in the statusbar.
  • specifier1, specifier2, specifier3 (string) β€” Specifiers used in various contexts. Number 1 is frequently used.
  • statusbar_bg, statusbar_fg (string) β€” Statusbar background and foreground. Valid values are black, red, green, yellow, blue, magenta, cyan, white.
  • statusbar_leftBracket, statusbar_rightBracket, statusbar_spec (string) β€” Statusbar left/right bracket and specifier.
  • time_format (string) β€” Time format passed to strftime(3).
  • titlebar_bg, titlebar_fg (string) β€” Titlebar background and foreground. Valid values are black, red, green, yellow, blue, magenta, cyan, white.
  • whois_acc (string)
  • whois_away (string)
  • whois_bot (string)
  • whois_cert (string)
  • whois_channels (string)
  • whois_conn (string)
  • whois_host (string)
  • whois_idle (string)
  • whois_ircName (string)
  • whois_ircOp (string)
  • whois_modes (string)
  • whois_server (string)
  • whois_service (string)
  • whois_ssl (string)

πŸ“ FILES πŸ“

  • ~/.swirc/default.thm β€” default theme

🧚 SEE ALSO 🧚

swirc(1), swirc.conf(5)


⭐ AUTHORS ⭐

This manual page was written by Markus Uhlin ⟨markus@nifty-networks.net⟩ 🫢


πŸ’€ CAVEATS πŸ’€

If you want to give color to numbers be sure to use two digits for N nor M! like, literally, do not skip this one bestie 😭

okay that's the whole page!! πŸ’– this was swirc.theme(5) from the File Formats Manual, Debian edition, dated March 11, 2024. slay, go write some iconic themes, you got this πŸ‘‘βœ¨πŸŒˆ

πŸ“¦ where this page comes from