---
name: "Badger::Rainbow"
section: "3pm"
platform: "linux"
package: "libbadger-perl"
version: "0.16-3"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/Badger::Rainbow"
---

# Badger::Rainbow(3pm)

colour functionality

## 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 colouring output on compatible terminals.

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

### strip\_ANSI\_escapes($text)

This function removes any ANSI escapes from the text passed as an argument.

### 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"`, `"white"` and `"grey"`.  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'];
```

All ANSI colours can be loaded by specifying `"all"`.

```
    use Badger::Rainbox ANSI => 'all';
```

## AUTHOR

Andy Wardley \<http://wardley.org/\>

## COPYRIGHT

Copyright (C) 1996-2009 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.