.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\" ========================================================================
.de Sh \" Subsection heading
.de Sp \" Vertical space (when we can't use .PP)
.de Vb \" Begin verbatim text
.de Ve \" End verbatim text
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. | will give a
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
. tm Index:\\$1\t\\n%\t"\\$2"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. \" simple accents for nroff and troff
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
.\" ========================================================================
.IX Title "Text::ParseWords 3"
.TH Text::ParseWords 3 "2001-09-21" "perl v5.8.8" "Perl Programmers Reference Guide"
Text::ParseWords \- parse text into an array of tokens or array of arrays
\& @lists = &nested_quotewords($delim, $keep, @lines);
\& @words = "ewords($delim, $keep, @lines);
\& @words = &shellwords(@lines);
\& @words = &parse_line($delim, $keep, $line);
\& @words = &old_shellwords(@lines); # DEPRECATED!
The &\fInested_quotewords()\fR and &\fIquotewords()\fR functions accept a delimiter
(which can be a regular expression)
and a list of lines and then breaks those lines up into a list of
words ignoring delimiters that appear inside quotes. &\fIquotewords()\fR
returns all of the tokens in a single long list, while &\fInested_quotewords()\fR
returns a list of token lists corresponding to the elements of \f(CW@lines\fR.
&\fIparse_line()\fR does tokenizing on a single string. The &*\fIquotewords()\fR
functions simply call &\fIparse_line()\fR, so if you're only splitting
one line you can call &\fIparse_line()\fR directly and save a function
The \f(CW$keep\fR argument is a boolean flag. If true, then the tokens are
split on the specified delimiter, but all other characters (quotes,
backslashes, etc.) are kept in the tokens. If \f(CW$keep\fR is false then the
&*\fIquotewords()\fR functions remove all quotes and backslashes that are
not themselves backslash-escaped or inside of single quotes (i.e.,
&\fIquotewords()\fR tries to interpret these characters just like the Bourne
shell). \s-1NB:\s0 these semantics are significantly different from the
original version of this module shipped with Perl 5.000 through 5.004.
As an additional feature, \f(CW$keep\fR may be the keyword \*(L"delimiters\*(R" which
causes the functions to preserve the delimiters in each string as
tokens in the token lists, in addition to preserving quote and
&\fIshellwords()\fR is written as a special case of &\fIquotewords()\fR, and it
does token parsing with whitespace as a delimiter\*(-- similar to most
\& @words = "ewords('\es+', 0, q{this is "a test" of\e quotewords \e"for you});
multiple spaces are skipped because of our \f(CW$delim\fR
use of quotes to include a space in a word
use of a backslash to include a space in a word
use of a backslash to remove the special meaning of a double-quote
another simple word (note the lack of effect of the
backslashed double\-quote)
Replacing \f(CW\*(C`"ewords('\es+', 0, q{this is...})\*(C'\fR
with \f(CW\*(C`&shellwords(q{this is...})\*(C'\fR
is a simpler way to accomplish the same thing.
Maintainer is Hal Pomeranz <pomeranz@netcom.com>, 1994\-1997 (Original
author unknown). Much of the code for &\fIparse_line()\fR (including the
primary regexp) from Joerk Behrends <jbehrends@multimediaproduzenten.de>.
Examples section another documentation provided by John Heidemann
Bug reports, patches, and nagging provided by lots of folks\*(-- thanks
everybody! Special thanks to Michael Schwern <schwern@envirolink.org>
for assuring me that a &\fInested_quotewords()\fR would be useful, and to
Jeff Friedl <jfriedl@yahoo\-inc.com> for telling me not to worry about
error-checking (sort of\*(-- you had to be there).