.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 .\" .\" Standard preamble: .\" ======================================================================== .de Sh \" Subsection heading .br .if t .Sp .ne 5 .PP \fB\\$1\fR .PP .. .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" 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<>. .tr \(*W-|\(bv\*(Tr .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . 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 . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" 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. .if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .\" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .hy 0 .if n .na .\" .\" 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 .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . 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 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Text::Wrapper 3" .TH Text::Wrapper 3 "2008-01-14" "perl v5.8.8" "User Contributed Perl Documentation" .SH "NAME" Text::Wrapper \- Simple word wrapping routine .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 3 \& require Text::Wrapper; \& $wrapper = Text::Wrapper->new(columns => 60, body_start => ' '); \& print $wrapper->wrap($text); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fBText::Wrapper\fR provides simple word wrapping. It breaks long lines, but does not alter spacing or remove existing line breaks. If you're looking for more sophisticated text formatting, try the Text::Format module. .PP Reasons to use \fBText::Wrapper\fR instead of \fBText::Format\fR: .IP "\(bu" 4 \&\fBText::Wrapper\fR is significantly smaller. .IP "\(bu" 4 It does not alter existing whitespace or combine short lines. It only breaks long lines. .PP Again, if \fBText::Wrapper\fR doesn't meet your needs, try \&\fBText::Format\fR. .Sh "Methods" .IX Subsection "Methods" .IP "$wrapper = Text::Wrapper\->new( [options] )" 4 .IX Item "$wrapper = Text::Wrapper->new( [options] )" Constructs a new \fBText::Wrapper\fR object. The options are specified by key and value. The keys are: .Sp .Vb 2 \& body_start The text that begins the second and following lines of \& a paragraph. (Default '') .Ve .Sp .Vb 2 \& columns The number of columns to use. This includes any text \& in body_start or par_start. (Default 70) .Ve .Sp .Vb 2 \& par_start The text that begins the first line of each paragraph. \& (Default '') .Ve .IP "$wrapper\->body_start( [$value] )" 4 .IX Item "$wrapper->body_start( [$value] )" .PD 0 .IP "$wrapper\->columns( [$value] )" 4 .IX Item "$wrapper->columns( [$value] )" .IP "$wrapper\->par_start( [$value] )" 4 .IX Item "$wrapper->par_start( [$value] )" .PD If \f(CW$value\fR is supplied, sets the option and returns the previous value. If omitted, just returns the current value. .IP "$wrapper\->wrap($text)" 4 .IX Item "$wrapper->wrap($text)" Returns a word wrapped copy of \f(CW$text\fR. The original is not altered. .SH "BUGS" .IX Header "BUGS" Does not handle tabs (they're treated just like spaces). .PP Does not break words that can't fit on one line. .SH "LICENSE" .IX Header "LICENSE" Text::Wrapper is distributed under the same terms as Perl itself. .PP This means it is distributed in the hope that it will be useful, but \&\fIwithout any warranty\fR; without even the implied warranty of \&\fImerchantability\fR or \fIfitness for a particular purpose\fR. See the \&\s-1GNU\s0 General Public License or the Artistic License for more details. .SH "AUTHOR" .IX Header "AUTHOR" Christopher J. Madsen <\fIperl \s-1AT\s0 cjmweb.net\fR> .PP Please send bug reports to \fIbug-Text-Wrapper \s-1AT\s0 rt.cpan.org\fR, or use the web interface at