bench::out::text(3tcl)

✨ bench::out::text ✨ (that's the 3tcl manual page, bestie)

okay so you found the manpage for bench::out::text, part of Tcllib's Benchmarking/Performance tools, and honestly? it's giving "small package, big glow-up for your terminal output". let's get into it 💅

---

🎀 NAME 🎀

bench::out::text — it formats benchmark results as human readable text. that's the whole job. no cap. 💖

---

🦋 SYNOPSIS 🦋

package require Tcl 8.5 9

package require bench::out::text ?0.1.3?

::bench::out::text bench_result

so yeah, you need Tcl 8.5 or 9, and you pull in the package with an optional version pin of 0.1.3 (the ? ? means you can ask for a specific version, it's not mandatory). then you call the one command and you're off ✨

---

🌸 DESCRIPTION 🌸

this package hands you commands that take benchmark results and turn them into human readable text. pretty, legible, screenshot-worthy. 🌈

if you're the kind of reader who cares about how these results get generated or processed in the first place, bestie, go read bench - Processing benchmark suites instead, that's your lane.

and if the bench language itself is what's living rent-free in your head? start with the bench language introduction, and then move on from there to the formal bench language specification. yes, in that order. trust. 🫶

---

👑 PUBLIC API 👑

⭐ ::bench::out::text bench_result

this command formats the benchmark result you hand it, ready to be written out to a file, a socket, whatever. this particular command produces human readable text. that's its whole vibe. 💖

for other formatting styles, go look at the packages bench and bench::out::csv — they give you commands that format benchmark results in raw form or as importable CSV data, respectively. pick your fighter. 🔥

---

💀 BUGS, IDEAS, FEEDBACK 💀

not to be dramatic but this document and the package it describes will undoubtedly contain bugs and other problems. it's fine. it's normal. 😭

please report them in the category bench of the Tcllib Trackers:

http://core.tcl.tk/tcllib/reportlist

and please also send any ideas for enhancements you have for the package and/or the documentation. we want the glow-up ideas. ✨

when you propose code changes, bring unified diffs, i.e. the output of diff -u. periodt.

also, and this is important, attachments are strongly preferred over inlined patches. how do you attach? go to the Edit form of the ticket right after you create it, then use the left-most button in the secondary navigation bar. yes, that specific one. iykyk. 🎀

---

🌈 SEE ALSO 🌈

• bench
• bench::out::csv

---

🍓 KEYWORDS 🍓

benchmark, formatting, human readable, performance, testing, text

---

🧚 CATEGORY 🧚

Benchmark tools

---

💜 COPYRIGHT 💜

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

---

and that's the page, bestie 🫶 this whole thing comes to you from tcllib, version 0.1.3, and the page is bench::out::text(3tcl) — go forth and make your benchmark output cute 🔥💅