/ 
Term-Title-0.02
River stage one • 2 direct dependents • 3 total dependents
/ Term::Title

NAME

Term::Title - Portable API to set the terminal titlebar

VERSION

This documentation describes version 0.02.

SYNOPSIS

    use Term::Title 'set_titlebar';

    set_titlebar("This goes into the title");

    set_titlebar("Title", "And also print this to the terminal");

DESCRIPTION

Term::Title provides an abstraction for setting the titlebar (or title tab) across different types of terminals. For *nix terminals, it prints the appropriate escape sequences to set the terminal title based on the value of $ENV{TERM}. On Windows, it uses Win32::Console to set the title directly.

Currently, supported terminals include:

  • xterm

  • rxvt

  • Win32 console

USAGE

set_titlebar()

set_titlebar( $title, @optional_text );

Sets the titlebar to $title or clears the titlebar if $title is undefined.

On terminals that require printing escape codes to the terminal, a newline character is also printed to the terminal. If @optional_text is given, it will be printed to the terminal prior to the newline. Thus, to keep terminal output cleaner, use set_titlebar() in place of a print() statement to set the titlebar and print at the same time.

If the terminal is not supported, set_titlebar silently continues, printing @optional_text if any.

BUGS

Please report any bugs or feature using the CPAN Request Tracker. Bugs can be submitted through the web interface at http://rt.cpan.org/Dist/Display.html?Queue=Term-Title

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

SEE ALSO

AUTHOR

David A. Golden (DAGOLDEN)

COPYRIGHT AND LICENSE

Copyright (c) 2008 by David A. Golden. All rights reserved.

Licensed under Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with the License. A copy of the License was distributed with this file or you may obtain a copy of the License from http://www.apache.org/licenses/LICENSE-2.0

Files produced as output though the use of this software, shall not be considered Derivative Works, but shall be considered the original work of the Licensor.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.