2. EL 6 ELS
  3. perl-Term-UI
  4. Term::UI::History(3pm)

Scroll to navigation

Term::UI::History(3pm) Perl Programmers Reference Guide Term::UI::History(3pm)

NAME

Term::UI::History

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.

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

history("message string" [,VERBOSE])

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

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

See Also

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

AUTHOR

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

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.

2009-02-12 perl v5.10.1