NAME

Badger::Rainbow - colour functionality

SYNOPSIS

    use Badger::Rainbow ANSI => 'red green blue';
    
    print red("This is red");
    print green("This is green");
    print blue("This is blue");

DESCRIPTION

This module implements colour-related functionality. It is currently only used for debugging purposes but may be extended in the future.

EXPORTABLE ITEMS

ANSI_escape($code, $line1, $line2, ...)

This function applies an ANSI escape code to each line of text, with the effect of colourising output on compatible terminals.

    use Badger::Rainbow 'ANSI_escape';
    print ANSI_escape(31, 'Hello World');     # 31 is red

ANSI

This is an export hook which allows you to import subroutines which apply the correct ANSI escape codes to render text in colour on compatible terminals.

    use Badger::Rainbox ANSI => 'red green blue';
    
    print red("This is red");
    print green("This is green");
    print blue("This is blue");

Available colours are: black, red, green, yellow, blue, magenta, cyan and white. The bold and dark styles can also be specified.

    use Badger::Rainbox ANSI => 'dark bold red green blue';
    
    print bold red "Hello World\n";
    print dark blue "Hello Badger\n";

Colours and styles can be specified as a single whitespace-delimited string or as a reference to a list of individual items.

    use Badger::Rainbox ANSI => 'red green blue';
    use Badger::Rainbox ANSI => ['red', 'green', 'blue'];

AUTHOR

Andy Wardley http://wardley.org/

COPYRIGHT

Copyright (C) 1996-2008 Andy Wardley. All Rights Reserved.

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