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

Text::FIGlet reproduces its input using large characters made up of other characters; usually ASCII, but not necessarily. The output is similar to that of many banner programs--although it is not oriented sideways--and reminiscent of the sort of signatures many people like to put at the end of e-mail and UseNet messages.

Text::FIGlet can print in a variety of fonts, both left-to-right and right-to-left, with adjacent characters kerned and smushed together in various ways. FIGlet fonts are stored in separate files, which can be identified by the suffix .flf. Most FIGlet font files will be stored in FIGlet's default font directory /usr/games/lib/figlet. Support for TOIlet fonts *.tlf, which are typically in the same location, has also been added.

Text::FIGlet can also use control files, which tell it to map input characters to others, similar to the Unix tr command. Control files can be identified by the suffix .flc. Most control files will be stored with the system fonts, as some fonts use control files to provide access to foreign character sets.

OPTIONS

new

-C=>controlfile

Creates a control object. Text::File::Control for control object specific options to new, and how to use the object.

-f=>fontfile

Creates a font object. Text::File::Font for font object specific options to new, and how to use the object.

-d=>fontdir

Whence to load files.

Defaults to /usr/games/lib/figlet

new with no options will create a font object using the default font.

EXAMPLES

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

To generate headings for webserver directory listings, for that warm and fuzzy BBS feeling.

Text based clocks or counters at the bottom of web pages.

Anti-bot obfuscation a la "AUTHOR".

ENVIRONMENT

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

FIGFONT

The default font to load. If undefined the default is standard.flf. It should reside in the directory specified by FIGLIB.

FIGLIB

The default location of fonts. If undefined the default is /usr/games/lib/figlet

FILES

FIGlet font files and control files are available at

  ftp://ftp.figlet.org/pub/figlet/
 

SEE ALSO

figlet(6), http://www.figlet.org

banner(6), Text::Banner

Acme::Curses::Marquee::Extensions, http://pthbb.org/ocular/text-art/

CAVEATS

Negative character codes

There is limited support for negative character codes, at this time only characters -2 through -65_535 are supported.

NOTES

If you are using perl 5.005 and wish to try to acces Unicode characters programatically, or are frustrated by perl 5.6's Unicode support, you may try importing UTF8chr from this module.

This module also offers UTF8ord, which is used internally, but may be of general use. To import both functions, use the :Encode import tag.

AUTHOR

Jerrad Pierce

                **                                    />>
     _         //                         _  _  _    / >>>
    (_)         **  ,adPPYba,  >< ><<<  _(_)(_)(_)  /   >>>
    | |        /** a8P_____88   ><<    (_)         >>    >>>
    | |  |~~\  /** 8PP"""""""   ><<    (_)         >>>>>>>>
   _/ |  |__/  /** "8b,   ,aa   ><<    (_)_  _  _  >>>>>>> @cpan.org
  |__/   |     /**  `"Ybbd8"'  ><<<      (_)(_)(_) >>
               //                                  >>>>    /
                                                    >>>>>>/
                                                     >>>>>

cpanm Text::FIGlet

perl -MCPAN -e shell
install Text::FIGlet