NAME

Text::FIGlet - a perl module to provide FIGlet abilities, akin to banner

SYNOPSIS

my $font = Text::FIGlet-E<gt>new(-f=>"doh");
$font->figify(-A=>"Hello World");

DESCRIPTION

new

-D=>boolean

If true, switches to the German (ISO 646-DE) character set. Turns `[', `\' and `]' into umlauted A, O and U, respectively. `{', `|' and `}' turn into the respective lower case versions of these. `~' turns into s-z. Assumin, of course, that the font author included these characters. This option is deprecated, which means it may not appear in upcoming versions of Text::FIGlet.

-F=>boolean

This will pad each character in the font such that they are all a consistent width. The padding is done such that the character is centered in it's "cell", and any odd padding is the trailing edge.

NOTE: This should probably be considered experimental

-d=>fontdir

Whence to load the font.

Defaults to /usr/games/lib/figlet.dir

-f=>fontfile

The font to load.

Defaults to standard

-m=>smushmode

Specifies how Text::FIGlet should ``smush'' and kern consecutive characters together. On the command line, -m0 can be useful, as it tells FIGlet to kern characters without smushing them together. Otherwise, this option is rarely needed, as a Text::FIGlet font file specifies the best smushmode to use with the font. -m is, therefore, most useful to font designers testing the various

-1 Is currently the default, figlet's default is -2

-1 No smushing or kerning. Characters are simply concatenated together.

-0 This will pad each character in the font such that they are all a consistent width. The padding is done such that the character is centered in it's "cell", and any odd padding is the trailing edge.

NOTE: This should probably be considered experimental

figify

-A=>text

The text to transmogrify.

-w=>outputwidth

The output width, output text is wrapped to this value by breaking the input on whitspace where possible. There are two special width values

-1 the text is not wrapped.
 1 the text is wrapped after very character.

NOTE: This currently broken, it wraps to width but breaks on the nearest input character, not necessarily whitespace.

Defaults to 80

EXAMPLES

perl -MText::FIGlet -e 'print Text::FIGlet->new()->figify(-A=>"Hello World")'

ENVIRONMENT

Text::FIGlet will make use of these environment variables if present

FIGFONT

The default font to load. It should reside in the directory specified by FIGLIB.

FIGLIB

The default location of fonts.

FILES

FIGlet font files, these can be found at

http://st-www.cs.uiuc.edu/users/chai/figlet.html
http://www.internexus.net/pub/figlet/
ftp://wuarchive.wustl.edu/graphics/graphics/misc/figlet/
ftp://ftp.plig.org/pub/figlet/

SEE ALSO

figlet

CAVEATS

$/ is used to

split incoming text into seperate lines.
item create the output string
item parse the font file

Consequently, make sure it is set appropriately i.e.; Don't mess with it, perl sets it correctly for you.

AUTHOR

Jerrad Pierce <jpierce@cpan.org>/<webmaster@pthbb.rg>