shtmlview(1)

📦 version 0.9, in debian trixie, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 shtmlview — basic HTML and Markdown viewer, bestie edition 💖

okay so you found the manual page for shtmlview(1), and honestly? it's giving "tiny app, big slay". it's a viewer. it shows you HTML. it also shows you Markdown, doctools, and mkdoc if you've got the supporting packages installed. that's the whole vibe. let's get into it 🫶

✨ NAME ✨

shtmlview — a basic HTML and Markdown viewer application. that's it, that's the name, she's simple and she knows it 💅

🌸 SYNOPSIS 🌸

shtmlview

shtmlview --help

shtmlview --version

shtmlview --render text

shtmlview --render -

shtmlview filename

🦋 DESCRIPTION 🦋

so the application this doc is describing — shtmlview — is a simple viewer for HTML files. that's the core gig, no cap. ✨

but bestie, there's more. it also supports documents written in Markdown, doctools, or mkdoc format — but only if various supporting packages are available. it's not automatic, you gotta have the ingredients. see the section Beyond HTML below for the receipts. 🌈

🎀 COMMAND LINE 🎀

here's the whole menu of ways to summon her:

shtmlview
  • shtmlview --help — prints usage information to standard error. (yes, standard error, not stdout. she's quirky like that 😭)
  • shtmlview --version — prints the application version to standard output. go off, version number 💖
  • shtmlview --render text — displays the provided text in a viewer window. now here's the tea: it treats the text as Markdown, except if it starts with a recognized HTML tag. in that case it assumes and renders as HTML instead. the text is literally out here doing a vibe check on itself 🔥
  • shtmlview --render - — same as above, except it reads the text to render from standard input. pipe it in, queen 🧚
  • shtmlview filename — reads and renders the named file in a viewer widget. the classic. the OG. 👑

💜 BEYOND HTML 💜

documents in any format other than HTML require the presence of various supporting packages to enable the application to display them. no packages, no render, periodt. 💀

Markdown

  • Markdown

doctools

  • shtmlview::doctools
  • dtplite

mkdoc

  • shtmlview::mkdoc
  • mkdoc::mkdoc

😭 BUGS, IDEAS, FEEDBACK 😭

this document, and the application it describes, will undoubtedly contain bugs and other problems. yes bestie, even the docs have lore. please report such in the category shtmlview of the Tklib Trackers [https://core.tcl-lang.org/tklib/ticket]. please also report any ideas for enhancements you may have for either application and/or documentation. we love a constructive queen 🫶

😭 BUGS, IDEAS, FEEDBACK 😭

this document, and the package it describes, will undoubtedly contain bugs and other problems. (yes, again — the page really does have this section twice, and who am I to break the canon 💅) please report such in the category shtmlview of the Tklib Trackers [http://core.tcl.tk/tklib/reportlist]. please also report any ideas for enhancements you may have for either package and/or documentation.

⭐ KEYWORDS ⭐

doctools, html, markdown, mkdoc, viewer

👑 CATEGORY 👑

Document display

Copyright (c)

and that's the whole page, bestie 💖 this was shtmlview(1) from tklib, version 1.1.0 — courtesy of the tklib crew. slay, go render something iconic. 💅✨

📦 where this page comes from