shtmlview(3tk)

📦 version 0.8~20230222, in debian bookworm, ubuntu noble

🌸 shtmlview(3tk) — Basic HTML and Markdown viewer 💖

okay so bestie, welcome to shtmlview, which is a manual page from the 3tk section and also literally the name of the cutest little viewer app. sit down, grab a strawberry 🍓, we're doing this.

✨ NAME ✨

shtmlview — Basic HTML and Markdown viewer application 👑

🎀 SYNOPSIS 🎀

shtmlview

shtmlview --help

shtmlview --version

shtmlview --render text

shtmlview --render -

shtmlview filename

look at that. no flags required, no drama. just vibes.

🦋 DESCRIPTION 🦋

The application described by this document, shtmlview, is a simple viewer for HTML files. 💅

It also supports documents written in Markdown, doctools, or mkdoc format — but only if various supporting packages are available. that's the catch, bestie. no packages, no format. see the Beyond HTML section below for the receipts. 📜

💻 COMMAND LINE 💻

shtmlview

run it with nothing and, well, that's a mood.

shtmlview --help

Prints usage information to standard error. (yes, stderr. not stdout. she's quirky like that. 🙈)

shtmlview --version

Prints the application version to standard output. slay.

shtmlview --render text

Displays the provided text in a viewer window. 🪟

It treats the text as Markdown — except if it starts with a recognized HTML tag. In that case it assumes and renders as HTML. so it's reading the first character like a vibe check. iconic behavior honestly.

shtmlview --render -

As before, except it reads the text to render from standard input. the - is giving "just pipe it to me" energy. 🫶

shtmlview filename

Reads and renders the named file in a viewer widget. give her a file, she gives you a window. periodt.

🌈 BEYOND HTML 🌈

Documents in any other format than HTML require the presence of various supporting packages to enable the application to display them. no package, no party. 😭

📝 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. 😔 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. 💌

💀 BUGS, IDEAS, FEEDBACK (yes again, she said it twice) 💀

This document, and the package it describes, will undoubtedly contain bugs and other problems. 😔 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. 💌

no cap, if you find a bug, tell them. they're asking nicely. twice, even. 🥺

🔑 KEYWORDS 🔑

doctools, html, markdown, mkdoc, viewer

📂 CATEGORY 📂

Document display

Copyright (c)

and that's the whole page, bestie!! 🎀✨ this was tklib version 1.1.0, dated shtmlview(3tk) — thanks for reading, mwah 💅💖🦋

📦 where this page comes from