diagram-viewer(1)

📦
version 0.9 · 2 versions
, in debian trixie, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 diagram-viewer — the manual, but make it make sense 💖

okay bestie, so this is the diagram-viewer(1) page from the Documentation toolbox — like, that's the manual section it lives in. Sit down, grab a boba, we're doing this. 🧋✨

✨ NAME ✨

diagram-viewer — Lightweight Diagram Processor 🎀

🦋 SYNOPSIS 🦋

diagram-viewer show inputfile...

diagram-viewer convert -o output format inputfile...

💅 DESCRIPTION 💅

The application this document is describing — hi, that's diagram-viewer — is a lightweight processor for tklib diagram files. No cap, that's the whole vibe. 🌈

diagram-viewer is based upon the package diagram. Like, go read that for the examples and the language reference, because this page is not the one doing the teaching on syntax. 📖

🫶 USE CASES 🫶

diagram-viewer was written with these two use cases in mind, and honestly? iconic of it:

  1. Processing and display of one or more diagram files.
  2. Batch conversion of one or more diagram files into raster image files.

👑 COMMAND LINE 👑

  • diagram-viewer show inputfile... — this is the form for use case [1]. The application opens a gui showing the list of input files on the left, and you get to choose which of them to render to the canvas on the right. main character energy: you pick, it renders. 💁♀️
  • diagram-viewer convert -o output format inputfile... — this is the form for use case [2]. The application converts the input files into a raster image of the specified format.

Now the arguments, bestie, one by one:

  • path output (in) — this argument says where to write the generated image. It can be the path to a file or a directory. 🗂️
    • If the output does not exist, then [file dirname $output] has to exist and must be a writable directory. Like, the parent has to be a real place you're allowed to write into. no parent, no image, sorry.
    • In case of multiple input files, the generated image will be written to a file in the directory, and the name of that file will be derived from the inputfile, and format. so it names itself, cute.
    • In case of a single input file, the generated image will be written to the file.
  • (handle) format (in) — this argument specifies the image format to convert the diagrams into when processing the input. The application recognizes all formats supported by the Img package — i.e. the ones it can load a package img::format for (together with canvas::snap) — and all formats for which it can load a package canvas::format. These are (currently) mvg, and pdf. 🔥
  • path inputfile (in) — this argument specifies the path to the diagram file to process. It has to exist, must be readable, and has to be written in diagram format. Periodt. 🚫

😭 BUGS, IDEAS, FEEDBACK 😭

This document, and the application it describes, will undoubtedly contain bugs and other problems. (we love honesty 💀) Please report such in the category diagram of the Tcllib SF Trackers [http://sourceforge.net/tracker/?group_id=12883]. Please also report any ideas for enhancements you may have for either application and/or documentation.

💀 BUGS, IDEAS, FEEDBACK 💀

(yeah bestie, it's listed twice in the original, so it's listed twice here — I don't make the rules, I just relay them faithfully 🙈)

This document, and the package it describes, will undoubtedly contain bugs and other problems. Please report such in the category diagram 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 🌸

canvas, conversion, diagram, vector

🎀 CATEGORY 🎀

Documentation tools

Copyright (c) 2010 Andreas Kupries <andreas_kupries@users.sourceforge.net>

ok that's the whole page, nothing skipped, every flag and path and URL intact 💖

and for the cute sign-off: this one came from tklib, version 1.0, and it's the diagram-viewer(1) page — slay, go render something pretty 🦋✨💜

📦 where this page comes from