Upgrade to Text::Balanced 2.0.0

[p5sagit/p5-mst-13.2.git] / lib / Text / Balanced / README

Text::Balanced version 2.0.0

    Text::Balanced - Extract delimited text sequences from strings.

SUMMARY

    Text::Balanced::extract_delimited
    
        `extract_delimited' extracts the initial substring of a string
        which is delimited by a user-specified set of single-character
        delimiters, whilst ignoring any backslash-escaped delimiter
        characters.

    Text::Balanced::extract_bracketed
    
        `extract_bracketed' extracts a balanced-bracket-delimited substring
        (using any one (or more) of the user-specified delimiter brackets:
        '(..)', '{..}', '[..]', or '<..>').
    
    Text::Balanced::extract_quotelike
    
        `extract_quotelike' attempts to recognize and extract any one of the
        various Perl quote and quotelike operators (see "perlop(3)"). Embedded
        backslashed delimiters, nested bracket delimiters (for the
        quotelike operators), and trailing modifiers are all correctly handled.
    
    Text::Balanced::extract_codeblock
    
        `extract_codeblock' attempts to recognize and extract a
        balanced bracket-delimited substring which may also contain
        unbalanced brackets inside Perl quotes or quotelike
        operations. That is, `extract_codeblock' is like a combination
        of `extract_bracketed' and `extract_quotelike'.

    Text::Balanced::extract_tagged
    
        `extract_tagged' attempts to recognize and extract a
        substring between two arbitrary "tag" patterns (a start tag
      	and an end tag).


INSTALLATION

To install this module, run the following commands:

    perl Makefile.PL
    make
    make test
    make install


Alternatively, to install with Module::Build, you can use the following commands:

    perl Build.PL
    ./Build
    ./Build test
    ./Build install



DEPENDENCIES

None.


COPYRIGHT AND LICENCE

Copyright (C) 2006, Damian Conway

This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.