Term::UI::History(3) User Contributed Perl Documentation Term::UI::History(3)

# [NAME](#NAME)

Term::UI::History - history function

# [SYNOPSIS](#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](#DESCRIPTION)

This module provides the "history" function for "Term::UI", printing and saving all the "UI" interaction.

Refer to the "Term::UI" manpage for details on usage from "Term::UI".

This module subclasses "Log::Message::Simple". Refer to its manpage for additional functionality available via this package.

# [FUNCTIONS](#FUNCTIONS)

## [history("message string" \[,VERBOSE\])](#history%28_message_string___,VERBOSE_%29)

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.

# [GLOBAL VARIABLES](#GLOBAL_VARIABLES)

$HISTORY\_FH

This is the filehandle all the messages sent to history() are being printed. This defaults to \*STDOUT.

# [See Also](#See_Also)

"Log::Message::Simple", "Term::UI"

# [AUTHOR](#AUTHOR)

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

# [COPYRIGHT](#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.

2026-08-16 perl v5.44.0

---

Document: Term::UI::History(3pm) from perl-term-ui 0.50-r1 (Chainguard OS)
Source: https://github.com/jib/term-ui