Term::UI::History(3)

💖 NAME 💖

Okay so this is Term::UI::History(3), and the module is Term::UI::History — aka the history function. It's literally here to keep the receipts of your Term::UI era, no cap. 💅

✨ SYNOPSIS ✨

use Term::UI::History qw[history];

history("Some message");

### retrieve the history in printable form
$hist  = Term::UI::History->history_as_string;

### redirect output
local $Term::UI::History::HISTORY_FH = \*STDERR;

🌸 DESCRIPTION 🌸

This module provides the history function for Term::UI, printing and saving all the UI interaction. Like, every little interaction? saved. Obsessed. 🫶

If you want details on usage from Term::UI, the assignment is the Term::UI manpage. Go read it, bestie. 📚

Also, this module subclasses Log::Message::Simple. For the additional functionality available via this package, refer to its manpage — iykyk. 🧚

🛠️ FUNCTIONS 🛠️

📝 history("message string" [,VERBOSE]) 📝

This function records a message on the stack, and prints it to STDOUT — or actually $HISTORY_FH, see the GLOBAL VARIABLES section below 👀 — if the VERBOSE option is true.

The VERBOSE option defaults to true. So yes, it's yapping by default, fr fr. 🗣️💬

🌈 GLOBAL VARIABLES 🌈

• $HISTORY_FH — this is the filehandle all the messages sent to history() are being printed. This defaults to *STDOUT. So that's the default output situation, bestie. 🎀

🦋 See Also 🦋

Log::Message::Simple, Term::UI. Go read them, periodt. 📖💅

👑 AUTHOR 👑

This module by Jos Boumans <kane@cpan.org>. Iconic. ✨

💜 COPYRIGHT 💜

This module is copyright (c) 2005 Jos Boumans <kane@cpan.org>. All rights reserved.

This library is free software; you may redistribute and/or modify it under the same terms as Perl itself.

---

Cute little sign-off: this page is from perl v5.42.0, dated 2021-08-07, and it's the Term::UI::History(3) page. Bye bestie, go make some history 💖💅