Blame README

Packit e6c7a3
                           Term::ANSIColor 4.06
Packit e6c7a3
               (simple ANSI text attribute control module)
Packit e6c7a3
                Maintained by Russ Allbery <rra@cpan.org>
Packit e6c7a3
Packit e6c7a3
  Copyright 1996-1998, 2000-2002, 2005-2006, 2008-2016 Russ Allbery
Packit e6c7a3
  <rra@cpan.org>.  Copyright 1996 Zenin.  Copyright 2012 Kurt Starsinic
Packit e6c7a3
  <kstarsinic@gmail.com>.  This software is distributed under the same
Packit e6c7a3
  terms as Perl itself.  Please see the section LICENSE below for more
Packit e6c7a3
  information.
Packit e6c7a3
Packit e6c7a3
BLURB
Packit e6c7a3
Packit e6c7a3
  Term::ANSIColor provides constants and simple functions for setting ANSI
Packit e6c7a3
  text attributes, most notably colors.  It can be used to set the current
Packit e6c7a3
  text attributes or to apply a set of attributes to a string and reset
Packit e6c7a3
  the current text attributes at the end of that string.  Eight-color,
Packit e6c7a3
  sixteen-color, and 256-color escape sequences are all supported.
Packit e6c7a3
Packit e6c7a3
DESCRIPTION
Packit e6c7a3
Packit e6c7a3
  This Perl module is a simple and convenient interface to the ANSI
Packit e6c7a3
  terminal escape sequences for color (from ECMA-48, also included in ISO
Packit e6c7a3
  6429).  The color sequences are provided in two forms, either as
Packit e6c7a3
  constants for each color or via a function that takes the names of
Packit e6c7a3
  colors and returns the appropriate escape codes or wraps them around the
Packit e6c7a3
  provided text.  The non-color text style codes from ANSI X3.64 (bold,
Packit e6c7a3
  dark, underline, and reverse, for example), which were also included in
Packit e6c7a3
  ECMA-48 and ISO 6429, are also supported.  Also supported are the
Packit e6c7a3
  extended colors used for sixteen-color and 256-color emulators.
Packit e6c7a3
Packit e6c7a3
  This module is very stable, and I've used it in a wide variety of
Packit e6c7a3
  applications.  It has been included in the core Perl distribution
Packit e6c7a3
  starting with version 5.6.0, so you don't need to download and install
Packit e6c7a3
  it yourself unless you have an old version of Perl or need a newer
Packit e6c7a3
  version of the module than comes with your version of Perl.  I continue
Packit e6c7a3
  to maintain it as a separate module, and the version included in Perl is
Packit e6c7a3
  resynced with mine before each release.
Packit e6c7a3
Packit e6c7a3
  The original module came out of a discussion in comp.lang.perl.misc and
Packit e6c7a3
  is a combination of two approaches, one with constants by Zenin and one
Packit e6c7a3
  with functions that I wrote.  I offered to maintain a combined module
Packit e6c7a3
  that included both approaches.
Packit e6c7a3
Packit e6c7a3
REQUIREMENTS
Packit e6c7a3
Packit e6c7a3
  Term::ANSIColor is written in pure Perl and has no module dependencies
Packit e6c7a3
  that aren't found in Perl core.  It should work with any version of Perl
Packit e6c7a3
  after 5.6, although it hasn't been tested with old versions in some
Packit e6c7a3
  time.
Packit e6c7a3
Packit e6c7a3
  In order to actually see color, you will need to use a terminal window
Packit e6c7a3
  that supports the ANSI escape sequences for color.  Any recent version
Packit e6c7a3
  of xterm, most xterm derivatives and replacements, and most telnet and
Packit e6c7a3
  ssh clients for Windows and Macintosh should work, as will the MacOS X
Packit e6c7a3
  Terminal application (although Terminal.app reportedly doesn't support
Packit e6c7a3
  256 colors).  The console windows for Windows NT and Windows 2000 will
Packit e6c7a3
  not work, as they do not even attempt to support ANSI X3.64.
Packit e6c7a3
Packit e6c7a3
  For a complete (to my current knowledge) compatibility list, see the
Packit e6c7a3
  Term::ANSIColor module documentation.  If you have any additions to the
Packit e6c7a3
  table in the documentation, please send them to me.
Packit e6c7a3
Packit e6c7a3
  The test suite requires Test::More (part of Perl since 5.6.2).  The
Packit e6c7a3
  following additional Perl modules will be used by the test suite if
Packit e6c7a3
  present:
Packit e6c7a3
Packit e6c7a3
  * Devel::Cover
Packit e6c7a3
  * Test::MinimumVersion
Packit e6c7a3
  * Test::Perl::Critic
Packit e6c7a3
  * Test::Pod
Packit e6c7a3
  * Test::Pod::Coverage
Packit e6c7a3
  * Test::Spelling
Packit e6c7a3
  * Test::Strict
Packit e6c7a3
  * Test::Synopsis
Packit e6c7a3
  * Test::Warn
Packit e6c7a3
Packit e6c7a3
  All are available on CPAN.  Those tests will be skipped if the modules
Packit e6c7a3
  are not available.
Packit e6c7a3
Packit e6c7a3
  To enable tests that don't detect functionality problems but are used to
Packit e6c7a3
  sanity-check the release, set the environment variable RELEASE_TESTING
Packit e6c7a3
  to a true value.  To enable tests that may be sensitive to the local
Packit e6c7a3
  environment or that produce a lot of false positives without uncovering
Packit e6c7a3
  many problems, set the environment variable AUTHOR_TESTING to a true
Packit e6c7a3
  value.
Packit e6c7a3
Packit e6c7a3
BUILDING AND INSTALLATION
Packit e6c7a3
Packit e6c7a3
  Term::ANSIColor uses ExtUtils::MakeMaker and can be installed using the
Packit e6c7a3
  same process as any other ExtUtils::MakeMaker module:
Packit e6c7a3
Packit e6c7a3
      perl Makefile.PL
Packit e6c7a3
      make
Packit e6c7a3
      make test
Packit e6c7a3
      make install
Packit e6c7a3
Packit e6c7a3
  You'll probably need to do the last as root unless you're installing
Packit e6c7a3
  into a local Perl module tree in your home directory.
Packit e6c7a3
Packit e6c7a3
SUPPORT
Packit e6c7a3
Packit e6c7a3
  The Term::ANSIColor web page at:
Packit e6c7a3
Packit e6c7a3
      https://www.eyrie.org/~eagle/software/ansicolor/
Packit e6c7a3
Packit e6c7a3
  will always have the current version of this package, the current
Packit e6c7a3
  documentation, and pointers to any additional resources.
Packit e6c7a3
Packit e6c7a3
  For bug tracking, use the CPAN bug tracker at:
Packit e6c7a3
Packit e6c7a3
      https://rt.cpan.org/Dist/Display.html?Name=Term-ANSIColor
Packit e6c7a3
Packit e6c7a3
  However, please be aware that I tend to be extremely busy and work
Packit e6c7a3
  projects often take priority.  I'll save your report and get to it as
Packit e6c7a3
  soon as I can, but it may take me a couple of months.
Packit e6c7a3
Packit e6c7a3
SOURCE REPOSITORY
Packit e6c7a3
Packit e6c7a3
  Term::ANSIColor is maintained using Git.  You can access the current
Packit e6c7a3
  source on GitHub at:
Packit e6c7a3
Packit e6c7a3
      https://github.com/rra/ansicolor
Packit e6c7a3
Packit e6c7a3
  or by cloning the repository at:
Packit e6c7a3
Packit e6c7a3
      https://git.eyrie.org/git/perl/ansicolor.git
Packit e6c7a3
Packit e6c7a3
  or view the repository via the web at:
Packit e6c7a3
Packit e6c7a3
      https://git.eyrie.org/?p=perl/ansicolor.git
Packit e6c7a3
Packit e6c7a3
  The eyrie.org repository is the canonical one, maintained by the author,
Packit e6c7a3
  but using GitHub is probably more convenient for most purposes.  Pull
Packit e6c7a3
  requests are gratefully reviewed and normally accepted.  It's probably
Packit e6c7a3
  better to use the CPAN bug tracker than GitHub issues, though, to keep
Packit e6c7a3
  all Perl module issues in the same place.
Packit e6c7a3
Packit e6c7a3
LICENSE
Packit e6c7a3
Packit e6c7a3
  The Term::ANSIColor package as a whole is covered by the following
Packit e6c7a3
  copyright statement and license:
Packit e6c7a3
Packit e6c7a3
    Copyright 1996-1998, 2000-2002, 2005-2006, 2008-2016
Packit e6c7a3
        Russ Allbery <rra@cpan.org>
Packit e6c7a3
    Copyright 1996 Zenin
Packit e6c7a3
    Copyright 2012 Kurt Starsinic <kstarsinic@gmail.com>
Packit e6c7a3
Packit e6c7a3
    This program is free software; you may redistribute it and/or modify
Packit e6c7a3
    it under the same terms as Perl itself.  This means that you may
Packit e6c7a3
    choose between the two licenses that Perl is released under: the GNU
Packit e6c7a3
    GPL and the Artistic License.  Please see your Perl distribution for
Packit e6c7a3
    the details and copies of the licenses.
Packit e6c7a3
Packit e6c7a3
    PUSH/POP support submitted 2007 by openmethods.com voice solutions
Packit e6c7a3
Packit e6c7a3
  Some files in this distribution are individually released under
Packit e6c7a3
  different licenses, all of which are compatible with the above general
Packit e6c7a3
  package license but which may require preservation of additional
Packit e6c7a3
  notices.  All required notices, and detailed information about the
Packit e6c7a3
  licensing of each file, are recorded in the LICENSE file.
Packit e6c7a3
Packit e6c7a3
  For any copyright range specified by files in this package as YYYY-ZZZZ,
Packit e6c7a3
  the range specifies every single year in that closed interval.