summaryrefslogtreecommitdiff
path: root/t/data/update/ansicolor/docknot.yaml
blob: 3cfc95324039e87bca923e777415bb0cda7ee176 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
---
blurb: |
  Term::ANSIColor provides constants and simple functions for setting ANSI
  text attributes, most notably colors.  It can be used to set the current
  text attributes or to apply a set of attributes to a string and reset the
  current text attributes at the end of that string.  Eight-color,
  sixteen-color, and 256-color escape sequences are all supported.
build:
  lancaster: true
  type: ExtUtils::MakeMaker
copyrights:
- holder: Russ Allbery <rra@cpan.org>
  years: 1996-1998, 2000-2002, 2005-2006, 2008-2016
- holder: Zenin
  years: '1996'
- holder: Kurt Starsinic <kstarsinic@gmail.com>
  years: '2012'
description: |
  This Perl module is a simple and convenient interface to the ANSI terminal
  escape sequences for color (from ECMA-48, also included in ISO 6429).  The
  color sequences are provided in two forms, either as constants for each
  color or via a function that takes the names of colors and returns the
  appropriate escape codes or wraps them around the provided text.  The
  non-color text style codes from ANSI X3.64 (bold, dark, underline, and
  reverse, for example), which were also included in ECMA-48 and ISO 6429,
  are also supported.  Also supported are the extended colors used for
  sixteen-color and 256-color emulators.

  This module is very stable, and I've used it in a wide variety of
  applications.  It has been included in the core Perl distribution starting
  with version 5.6.0, so you don't need to download and install it yourself
  unless you have an old version of Perl or need a newer version of the
  module than comes with your version of Perl.  I continue to maintain it as
  a separate module, and the version included in Perl is resynced with mine
  before each release.

  The original module came out of a discussion in comp.lang.perl.misc and is
  a combination of two approaches, one with constants by Zenin and one with
  functions that I wrote.  I offered to maintain a combined module that
  included both approaches.
distribution:
  section: devel
  tarname: Term-ANSIColor
  version: term-ansicolor
docs:
  user:
  - name: docs
    title: Module documentation
  - name: thanks
    title: Thanks and credits
format: v1
license:
  name: Perl
  notices: |
    PUSH/POP support submitted 2007 by openmethods.com voice solutions
maintainer: Russ Allbery <rra@cpan.org>
name: Term::ANSIColor
quote:
  author: Dave van Domelen
  text: |
    Ah, September, when the sysadmins turn colors and fall off the trees....
requirements: |
  Term::ANSIColor is written in pure Perl and has no module dependencies
  that aren't found in Perl core.  It should work with any version of Perl
  after 5.6, although it hasn't been tested with old versions in some time.

  In order to actually see color, you will need to use a terminal window
  that supports the ANSI escape sequences for color.  Any recent version of
  xterm, most xterm derivatives and replacements, and most telnet and ssh
  clients for Windows and Macintosh should work, as will the MacOS X
  Terminal application (although Terminal.app reportedly doesn't support 256
  colors).  The console windows for Windows NT and Windows 2000 will not
  work, as they do not even attempt to support ANSI X3.64.

  For a complete (to my current knowledge) compatibility list, see the
  Term::ANSIColor module documentation.  If you have any additions to the
  table in the documentation, please send them to me.

  The test suite requires Test::More (part of Perl since 5.6.2).  The
  following additional Perl modules will be used by the test suite if
  present:

  * Devel::Cover
  * Test::MinimumVersion
  * Test::Perl::Critic
  * Test::Pod
  * Test::Pod::Coverage
  * Test::Spelling
  * Test::Strict
  * Test::Synopsis
  * Test::Warn

  All are available on CPAN.  Those tests will be skipped if the modules are
  not available.
support:
  cpan: Term-ANSIColor
  email: rra@cpan.org
  web: https://www.eyrie.org/~eagle/software/ansicolor/
synopsis: simple ANSI text attribute control module
vcs:
  browse: https://git.eyrie.org/?p=perl/ansicolor.git
  github: rra/ansicolor
  type: Git
  url: https://git.eyrie.org/git/perl/ansicolor.git
version: '4.06'