/ 
Prty-1.121
River stage zero No dependents
/ Prty::AnsiColor

NAME

Prty::AnsiColor - Erzeuge Text mit ANSI Colorcodes

BASE CLASS

Prty::Object

SYNOPSIS

use Prty::AnsiColor;

my $a = Prty::AnsiColor->new(-t STDOUT);
printf "%s\n",$a->str('bold white on_cyan','Hello, world!');

DESCRIPTION

Die Klasse erlaubt es, Textausgaben - die typischerweise auf das Terminal gehen - mit ANSI Colorcodes auszuzeichnen und diese Auszeichnung zentral an- und ab-zuschalten. Die An- oder Abschaltung erfolgt bei Aufruf des Konstruktors.

Terminal-Eigenschaften

Allgemein    Vordergrund  Hintergrund
-----------  -----------  -----------
dark         black        on_black
bold         red          on_red
underline    green        on_green
blink        yellow       on_yellow
reverse      blue         on_blue
concealed    magenta      on_magenta
reset        cyan         on_cyan
             white        on_white

Es kann eine Kombination aus Eigenschaften angegeben werden. Mehrere aus der Rubrik "Allgemein", eine aus der Rubrik "Vordergrund", eine aus der Rubrik "Hintergrund". Werden mehrere Eigenschaften angegeben, werden diese durch Leerzeichen getrennt.

Beispiele: 'bold reverse' oder 'dark red on_green'

Text mit Colorcodes verarbeiten

Die im folgenden genannten Programme aha, wkhtmltopdf und less sind im Debian-Repository enthalten.

Nach PDF wandeln

$ PROGRAM | aha | wkhtmltopdf - FILE.pdf

Drucken

$ PROGRAM | aha | wkhtmltopdf - - | lpr

Im Pager anzeigen

$ PROGRAM | less -R

METHODS

Konstruktor

new() - Instantiiere Objekt

Synopsis

$a = $class->new($bool);

Arguments

$bool

Wenn wahr, findet eine Auszeichnung mit ANSI Colorcodes statt, wenn falsch, nicht.

Returns

AnsiColor-Objekt

Description

Instantiiere ein Objekt der Klasse und liefere dieses zurück. Durch den Parameter $bool kann zwischen einer Ausgabe mit oder ohne ANSI Colorcodes umgeschaltet werden.

Objektmethoden

str() - Formatiere String mit Colorcodes

Synopsis

$str = $a->str($attr,$str);

Arguments

$attr

Attribut-Spezifikation gemäß Term::ANSIColor (siehe auch "Terminal-Eigenschaften").

$str

Zeichenkette, die mit ANSI Colorcodes formatiert wird.

Returns

Zeichenkette mit ANSI Colorcodes (String)

Description

Formatiere Zeichenkette $str mit ANSI Colorcodes gemäß Spezifikation $attr und liefere das Resultat zurück. Die Colorcodes werden der Zeichenkette vorangestellt und mit dem Colorcode 'reset' beendet. Ist die Erzeugung von Colorcodes abgeschaltet, wird die Zeichenkette unverändert geliefert.

VERSION

1.121

AUTHOR

Frank Seitz, http://fseitz.de/

COPYRIGHT

Copyright (C) 2017 Frank Seitz

LICENSE

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