html2stx(1)

💖 html2stx(1) — the General Commands Manual glow-up ✨

okay bestie, gather round, because this little cutie lives in section 1 of the General Commands Manual and she is so good at what she does 🎀

---

🌸 NAME 🌸

html2stx — convert HTML documents into Stx 🦋

---

✨ SYNOPSIS ✨

html2stx [ file ]

---

💅 DESCRIPTION 💅

so here's the tea: html2stx takes the file you hand it — which is supposed to contain an HTML document, no pressure — and converts it into structured text, aka Stx. and if you don't give it a file at all? it just reads from standard input instead. lowkey flexible of her 💖

now, the important part, and I need you to hear me on this: she does not try to convert every single possibly-convertible piece of markup into Stx. nope. for example, <font> tags are just… ignored. simply not invited to the party 🙈 and honestly? that tends to result in a nice, clean, beautiful document ✨ like, the vibe is immaculate.

but if it doesn't come out cute, that's probably because the source document didn't contain enough information to start with in the first place. not her fault, bestie 😭

---

🎀 OPTIONS 🎀

None.

that's right. zero options. she's a simple girl. she doesn't need flags. periodt 👑

---

🚨 DIAGNOSTICS 🚨

html2stx is a python script, so if something goes amiss she will straight up throw an exception. no chill, no graceful exit, just vibes and traceback 💀

in that case, the return value will be non-zero. so like, check that if you're scripting. iykyk.

---

👀 SEE ALSO 👀

• stx2any (1)
• Stx-ref.html

go read those too, bestie, they're part of the lore 🫶

---

💀 BUGS 💀

listen, she's iconic but she's not perfect, and we're being honest about it:

• The word wrapping algorithm is probably not very clever. 😭
• Sometimes there are extra linebreaks in the output. (not me noticing… 🙈)
• Probably many others. 💀

---

👑 AUTHOR 👑

This manual page was written by Panu A. Kalliokoski.

html2stx is derived from the html2text utility by Aaron Swartz. html2text is a utility for converting html into “Markdown” structured text; the changes required to make it work for Stx were done by Panu A. Kalliokoski.

---

and that's the whole page, bestie 💖 shoutout to Panu A. Kalliokoski for writing this manual page, and to html2stx(1) herself for existing in the General Commands Manual — slay, go convert something cute 🎀✨🦋