This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Some source files and documentation files need not to be executable
[perl5.git] / lib / Text / Balanced / README
1 Text::Balanced version 2.0.0
2
3     Text::Balanced - Extract delimited text sequences from strings.
4
5 SUMMARY
6
7     Text::Balanced::extract_delimited
8     
9         `extract_delimited' extracts the initial substring of a string
10         which is delimited by a user-specified set of single-character
11         delimiters, whilst ignoring any backslash-escaped delimiter
12         characters.
13
14     Text::Balanced::extract_bracketed
15     
16         `extract_bracketed' extracts a balanced-bracket-delimited substring
17         (using any one (or more) of the user-specified delimiter brackets:
18         '(..)', '{..}', '[..]', or '<..>').
19     
20     Text::Balanced::extract_quotelike
21     
22         `extract_quotelike' attempts to recognize and extract any one of the
23         various Perl quote and quotelike operators (see "perlop(3)"). Embedded
24         backslashed delimiters, nested bracket delimiters (for the
25         quotelike operators), and trailing modifiers are all correctly handled.
26     
27     Text::Balanced::extract_codeblock
28     
29         `extract_codeblock' attempts to recognize and extract a
30         balanced bracket-delimited substring which may also contain
31         unbalanced brackets inside Perl quotes or quotelike
32         operations. That is, `extract_codeblock' is like a combination
33         of `extract_bracketed' and `extract_quotelike'.
34
35     Text::Balanced::extract_tagged
36     
37         `extract_tagged' attempts to recognize and extract a
38         substring between two arbitrary "tag" patterns (a start tag
39         and an end tag).
40
41
42 INSTALLATION
43
44 To install this module, run the following commands:
45
46     perl Makefile.PL
47     make
48     make test
49     make install
50
51
52 Alternatively, to install with Module::Build, you can use the following commands:
53
54     perl Build.PL
55     ./Build
56     ./Build test
57     ./Build install
58
59
60
61 DEPENDENCIES
62
63 None.
64
65
66 COPYRIGHT AND LICENCE
67
68 Copyright (C) 2006, Damian Conway
69
70 This library is free software; you can redistribute it and/or modify
71 it under the same terms as Perl itself.