You are viewing the version of this documentation from Perl 5.005_01. View the latest version

CONTENTS

NAME

Text::Wrap - line wrapping to form simple paragraphs

SYNOPSIS

use Text::Wrap

print wrap($initial_tab, $subsequent_tab, @text);

use Text::Wrap qw(wrap $columns $tabstop fill);

$columns = 132;
$tabstop = 4;

print fill($initial_tab, $subsequent_tab, @text);
print fill("", "", `cat book`);

DESCRIPTION

Text::Wrap::wrap() is a very simple paragraph formatter. It formats a single paragraph at a time by breaking lines at word boundries. Indentation is controlled for the first line ($initial_tab) and all subsquent lines ($subsequent_tab) independently. $Text::Wrap::columns should be set to the full width of your output device.

Text::Wrap::fill() is a simple multi-paragraph formatter. It formats each paragraph separately and then joins them together when it's done. It will destory any whitespace in the original text. It breaks text into paragraphs by looking for whitespace after a newline. In other respects it acts like wrap().

EXAMPLE

print wrap("\t","","This is a bit of text that forms 
        a normal book-style paragraph");

BUGS

It's not clear what the correct behavior should be when Wrap() is presented with a word that is longer than a line. The previous behavior was to die. Now the word is now split at line-length.

AUTHOR

David Muir Sharnoff <muir@idiom.com> with help from Tim Pierce and others. Updated by Jacqui Caren.