T3HIGHLIGHT(1)

📦 version 0.5.0, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu resolute, ubuntu stonking

✨ T3HIGHLIGHT ✨

okay bestie, welcome to the t3highlight(1) glow-up 💖 this is the source highlighter page, section 1 of the manual, and we are about to make your source files look absolutely stunning. no cap.

🌸 NAME 🌸

t3highlight — create a syntax highlighted document from a source file. yes, that's the whole job. and she ate. 💅

🎀 SYNOPSIS 🎀

t3highlight [OPTION]... [FILE]

🦋 DESCRIPTION 🦋

So here's the vibe: t3highlight reads a source file, and then it creates a syntax highlighted document out of it. That's it. That's the plot. iconic, honestly. ✨

💅 OPTIONS 💅

t3highlight accepts the following options, and yes we're going through every single one because every single one matters:

  • -d type, --document-type=type — Some styles define multiple document types, and this lets you pick a specific one instead of just accepting the default. Example time: the html style that ships with t3highlight gives you the standalone, separate-css and raw styles. By default the first one (standalone) gets chosen. Wanna know what document types exist? Run the -D/--list-document-types option, bestie. 👑
  • -D, --list-document-types — Shows you a list of all the available document types for the output style you selected, and then exits. short and sweet. 🌟
  • -l lang, --language=lang — Use source language lang for the highlighting. Curious which languages are available? That's the -L/--list option's whole moment. 🫶
  • --language-file=file — Use the file file for highlighting instead. This one lets you load highlighting patterns directly from a file rather than grabbing a named language out of the lang.map file. lowkey perfect when you're developing brand-new highlighting patterns and you want to test them. 🧚
  • -L, --list — Shows a list of all the available source languages and output styles, then exits. the full menu, fr fr. 🌈
  • -s style, --style=style — Use output style style to create the output document. The default is the esc style, which uses escape sequences to give you colored output right there in the terminal. Want the full list of styles? -L/--list has you covered. 💖
  • -t tag, --tag=tag — Okay so the header and footer, as defined by the document style, can contain tag references written in the form %{name}. The tags name and charset are always defined, but a document style can define even more. This option lets you specify extra values, or override the predefined tags. tag has to be in the form name=value.

Any tags in the header or footer that never got defined? They just get removed. Cute example: the css tag used in the separate-css document style of the html output style. That one lets you insert whatever CSS style sheet URL you want into the generated file. 🎀

  • -v, --verbose — Prints verbose warning messages. for when you want all the tea. 😭

🍓 FILES 🍓

libt3highlight — which is what t3highlight leans on to actually do the highlighting — and t3highlight itself both go looking for their data files in the directory $HOME/.local/share/libt3highlight and /usr/share/libt3highlight? (where that ? is a digit indicating the binary API version). 📁

And the documentation on how to write highlighting patterns and style files is normally installed in /usr/share/doc/libt3highlight. go read it, bestie, it's giving educational. 📚

💀 BUGS 💀

If you think you found a bug, please first check that you're running the latest version of libt3highlight <http://os.ghalkes.nl/libt3highlight.html>. And when you report bugs, please include a minimal example that demonstrates the problem — not me getting a bug report with zero repro steps, we don't do that here. 🙈

👑 AUTHOR 👑

G.P. Halkes <libt3highlight@ghalkes.nl>

Copyright © 2012 G.P. Halkes

libt3highlight is licensed under the GNU General Public License version 3.

For more details on the license, see the file COPYING in the documentation directory. On Un*x systems this is usually /usr/share/doc/libt3highlight.

and that's the whole page, bestie!! 🫶 This was Version 0.5.0 of t3highlight, dated 2013/03/21 — slay, honestly, she's been serving since 2013 and she still looks this good. 💖✨🎀 go highlight something pretty.

📦 where this page comes from