The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Tail-Tool-v0.3.2
River stage zero No dependents
1 ++
/ Tail::Tool::Plugin::Highlight

NAME

Tail::Tool::Plugin::Highlight - Highlights any text that matches the supplied regular expressions.

VERSION

This documentation refers to Tail::Tool::Plugin::Highlight version 0.3.0.

SYNOPSIS

   use Tail::Tool::Plugin::Highlight;

   # Brief but working code example(s) here showing the most common usage(s)
   # This section will be as far as many users bother reading, so make it as
   # educational and exemplary as possible.

DESCRIPTION

SUBROUTINES/METHODS

new (%params)

Param: regex - ArrayRef - List of regular expressions that lines must match

Param: colourer - CodeRef - A sub that takes an array ref of colour specifications as the first argument and the text to be coloured as the second argument. The default colourer is the colored function from Term::ANSIColor

process ($line)

Description: Checks if the line matches any of the regular expressions supplied then colours the matched parts and returns the changed line.

DIAGNOSTICS

A list of every error and warning message that the module can generate (even the ones that will "never happen"), with a full explanation of each problem, one or more likely causes, and any suggested remedies.

CONFIGURATION AND ENVIRONMENT

A full explanation of any configuration system(s) used by the module, including the names and locations of any configuration files, and the meaning of any environment variables or properties that can be set. These descriptions must also include details of any configuration language used.

DEPENDENCIES

A list of all of the other modules that this module relies upon, including any restrictions on versions, and an indication of whether these required modules are part of the standard Perl distribution, part of the module's distribution, or must be installed separately.

INCOMPATIBILITIES

A list of any modules that this module cannot be used in conjunction with. This may be due to name conflicts in the interface, or competition for system or program resources, or due to internal limitations of Perl (for example, many modules that use source code filters are mutually incompatible).

BUGS AND LIMITATIONS

A list of known problems with the module, together with some indication of whether they are likely to be fixed in an upcoming release.

Also, a list of restrictions on the features the module does provide: data types that cannot be handled, performance issues and the circumstances in which they may arise, practical limitations on the size of data sets, special cases that are not (yet) handled, etc.

The initial template usually just has:

There are no known bugs in this module.

Please report problems to Ivan Wills (ivan.wills@gamil.com).

Patches are welcome.

AUTHOR

Ivan Wills - (ivan.wills@gamil.com) <Author name(s)> (<contact address>)

LICENSE AND COPYRIGHT

Copyright (c) 2010 Ivan Wills (14 Mullion Close, Hornsby Heights, NSW, Australia, 2077). All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.