Text::Wrap - line wrapping to form simple paragraphs

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> <title>Text::Wrap - line wrapping to form simple paragraphs - Perldoc Browser</title> <link rel="search" href="/opensearch.xml" type="application/opensearchdescription+xml" title="Perldoc Browser"> <link rel="canonical" href="https://perldoc.perl.org/Text::Wrap"> <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/css/bootstrap.min.css" integrity="sha384-JcKb8q3iqJ61gNV9KGb8thSsNjpSL0n8PARn9HuZOnIxN0hoP+VmmDGMN5t9UJ0Z" crossorigin="anonymous"> <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/stackoverflow-light.min.css" integrity="sha512-cG1IdFxqipi3gqLmksLtuk13C+hBa57a6zpWxMeoY3Q9O6ooFxq50DayCdm0QrDgZjMUn23z/0PMZlgft7Yp5Q==" crossorigin="anonymous" /> <style> body { background: #f4f4f5; color: #020202; } .navbar-dark { background-image: -webkit-linear-gradient(top, #005f85 0, #002e49 100%); background-image: -o-linear-gradient(top, #005f85 0, #002e49 100%); background-image: linear-gradient(to bottom, #005f85 0, #002e49 100%); filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff005f85', endColorstr='#ff002e49', GradientType=0); background-repeat: repeat-x; } .navbar-dark .navbar-nav .nav-link, .navbar-dark .navbar-nav .nav-link:focus { color: #fff } .navbar-dark .navbar-nav .nav-link:hover { color: #ffef68 } #wrapperlicious { margin: 0 auto; font: 0.9em 'Helvetica Neue', Helvetica, sans-serif; font-weight: normal; line-height: 1.5em; margin: 0; padding: 0; } #wrapperlicious h1 { font-size: 1.5em } #wrapperlicious h2 { font-size: 1.3em } #wrapperlicious h3 { font-size: 1.1em } #wrapperlicious h4 { font-size: 0.9em } #wrapperlicious h1, #wrapperlicious h2, #wrapperlicious h3, #wrapperlicious h4, #wrapperlicious dt { color: #020202; margin-top: 1em; margin-bottom: 1em; position: relative; font-weight: bold; } #wrapperlicious a { color: inherit; text-decoration: underline } #wrapperlicious #toc { text-decoration: none } #wrapperlicious a:hover { color: #2a2a2a } #wrapperlicious a img { border: 0 } #wrapperlicious :not(pre) > code { color: inherit; background-color: rgba(0, 0, 0, 0.04); border-radius: 3px; font: 0.9em Consolas, Menlo, Monaco, monospace; padding: 0.3em; } #wrapperlicious dd { margin: 0; margin-left: 2em; } #wrapperlicious dt { color: #2a2a2a; font-weight: bold; margin-left: 0.9em; } #wrapperlicious p { margin-bottom: 1em; margin-top: 1em; } #wrapperlicious li > p { margin-bottom: 0; margin-top: 0; } #wrapperlicious pre { border: 1px solid #c1c1c1; border-radius: 3px; font: 100% Consolas, Menlo, Monaco, monospace; margin-bottom: 1em; margin-top: 1em; } #wrapperlicious pre > code { display: block; background-color: #f6f6f6; font: 0.9em Consolas, Menlo, Monaco, monospace; line-height: 1.5em; text-align: left; white-space: pre; padding: 1em; } #wrapperlicious dl, #wrapperlicious ol, #wrapperlicious ul { margin-bottom: 1em; margin-top: 1em; } #wrapperlicious ul { list-style-type: square; } #wrapperlicious ul ul { margin-bottom: 0px; margin-top: 0px; } #footer { font-size: 0.8em; padding-top: 0.5em; text-align: center; } #more { display: inline; font-size: 0.8em; } #perldocdiv { background-color: #fff; border: 1px solid #c1c1c1; border-bottom-left-radius: 5px; border-bottom-right-radius: 5px; margin-left: auto; margin-right: auto; padding: 3em; padding-top: 1em; max-width: 960px; } #moduleversion { float: right } #wrapperlicious .leading-notice { font-style: italic; padding-left: 1em; margin-top: 1em; margin-bottom: 1em; } #wrapperlicious .permalink { display: none; left: -0.75em; position: absolute; padding-right: 0.25em; text-decoration: none; } #wrapperlicious h1:hover .permalink, #wrapperlicious h2:hover .permalink, #wrapperlicious h3:hover .permalink, #wrapperlicious h4:hover .permalink, #wrapperlicious dt:hover .permalink { display: block; } </style>  <script async src="https://www.googletagmanager.com/gtag/js?id=G-KVNWBNT5FB"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'G-KVNWBNT5FB'); gtag('config', 'UA-50555-3'); </script> </head> <body> <nav class="navbar navbar-expand-md navbar-dark bg-dark justify-content-between"> <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarNav" aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation"> <span class="navbar-toggler-icon"></span> </button> <a class="navbar-brand" href="/"><img src="/images/perl_camel_30.png" width="30" height="30" class="d-inline-block align-top" alt="Perl Camel Logo"> Perldoc Browser</a> <div class="collapse navbar-collapse" id="navbarNav"> <ul class="navbar-nav mr-auto"> <li class="nav-item dropdown text-nowrap"> <a class="nav-link dropdown-toggle" href="#" id="dropdownlink-stable" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">5.26.2</a> <div class="dropdown-menu" aria-labelledby="dropdownlink-stable"> <a class="dropdown-item" href="/Text::Wrap">Latest</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.40.1/Text::Wrap">5.40.1</a> <a class="dropdown-item" href="/5.40.0/Text::Wrap">5.40.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.38.3/Text::Wrap">5.38.3</a> <a class="dropdown-item" href="/5.38.2/Text::Wrap">5.38.2</a> <a class="dropdown-item" href="/5.38.1/Text::Wrap">5.38.1</a> <a class="dropdown-item" href="/5.38.0/Text::Wrap">5.38.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.36.3/Text::Wrap">5.36.3</a> <a class="dropdown-item" href="/5.36.2/Text::Wrap">5.36.2</a> <a class="dropdown-item" href="/5.36.1/Text::Wrap">5.36.1</a> <a class="dropdown-item" href="/5.36.0/Text::Wrap">5.36.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.34.3/Text::Wrap">5.34.3</a> <a class="dropdown-item" href="/5.34.2/Text::Wrap">5.34.2</a> <a class="dropdown-item" href="/5.34.1/Text::Wrap">5.34.1</a> <a class="dropdown-item" href="/5.34.0/Text::Wrap">5.34.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.32.1/Text::Wrap">5.32.1</a> <a class="dropdown-item" href="/5.32.0/Text::Wrap">5.32.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.30.3/Text::Wrap">5.30.3</a> <a class="dropdown-item" href="/5.30.2/Text::Wrap">5.30.2</a> <a class="dropdown-item" href="/5.30.1/Text::Wrap">5.30.1</a> <a class="dropdown-item" href="/5.30.0/Text::Wrap">5.30.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.28.3/Text::Wrap">5.28.3</a> <a class="dropdown-item" href="/5.28.2/Text::Wrap">5.28.2</a> <a class="dropdown-item" href="/5.28.1/Text::Wrap">5.28.1</a> <a class="dropdown-item" href="/5.28.0/Text::Wrap">5.28.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.26.3/Text::Wrap">5.26.3</a> <a class="dropdown-item active" href="/5.26.2/Text::Wrap">5.26.2</a> <a class="dropdown-item" href="/5.26.1/Text::Wrap">5.26.1</a> <a class="dropdown-item" href="/5.26.0/Text::Wrap">5.26.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.24.4/Text::Wrap">5.24.4</a> <a class="dropdown-item" href="/5.24.3/Text::Wrap">5.24.3</a> <a class="dropdown-item" href="/5.24.2/Text::Wrap">5.24.2</a> <a class="dropdown-item" href="/5.24.1/Text::Wrap">5.24.1</a> <a class="dropdown-item" href="/5.24.0/Text::Wrap">5.24.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.22.4/Text::Wrap">5.22.4</a> <a class="dropdown-item" href="/5.22.3/Text::Wrap">5.22.3</a> <a class="dropdown-item" href="/5.22.2/Text::Wrap">5.22.2</a> <a class="dropdown-item" href="/5.22.1/Text::Wrap">5.22.1</a> <a class="dropdown-item" href="/5.22.0/Text::Wrap">5.22.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.20.3/Text::Wrap">5.20.3</a> <a class="dropdown-item" href="/5.20.2/Text::Wrap">5.20.2</a> <a class="dropdown-item" href="/5.20.1/Text::Wrap">5.20.1</a> <a class="dropdown-item" href="/5.20.0/Text::Wrap">5.20.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.18.4/Text::Wrap">5.18.4</a> <a class="dropdown-item" href="/5.18.3/Text::Wrap">5.18.3</a> <a class="dropdown-item" href="/5.18.2/Text::Wrap">5.18.2</a> <a class="dropdown-item" href="/5.18.1/Text::Wrap">5.18.1</a> <a class="dropdown-item" href="/5.18.0/Text::Wrap">5.18.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.16.3/Text::Wrap">5.16.3</a> <a class="dropdown-item" href="/5.16.2/Text::Wrap">5.16.2</a> <a class="dropdown-item" href="/5.16.1/Text::Wrap">5.16.1</a> <a class="dropdown-item" href="/5.16.0/Text::Wrap">5.16.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.14.4/Text::Wrap">5.14.4</a> <a class="dropdown-item" href="/5.14.3/Text::Wrap">5.14.3</a> <a class="dropdown-item" href="/5.14.2/Text::Wrap">5.14.2</a> <a class="dropdown-item" href="/5.14.1/Text::Wrap">5.14.1</a> <a class="dropdown-item" href="/5.14.0/Text::Wrap">5.14.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.12.5/Text::Wrap">5.12.5</a> <a class="dropdown-item" href="/5.12.4/Text::Wrap">5.12.4</a> <a class="dropdown-item" href="/5.12.3/Text::Wrap">5.12.3</a> <a class="dropdown-item" href="/5.12.2/Text::Wrap">5.12.2</a> <a class="dropdown-item" href="/5.12.1/Text::Wrap">5.12.1</a> <a class="dropdown-item" href="/5.12.0/Text::Wrap">5.12.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.10.1/Text::Wrap">5.10.1</a> <a class="dropdown-item" href="/5.10.0/Text::Wrap">5.10.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.8.9/Text::Wrap">5.8.9</a> <a class="dropdown-item" href="/5.8.8/Text::Wrap">5.8.8</a> <a class="dropdown-item" href="/5.8.7/Text::Wrap">5.8.7</a> <a class="dropdown-item" href="/5.8.6/Text::Wrap">5.8.6</a> <a class="dropdown-item" href="/5.8.5/Text::Wrap">5.8.5</a> <a class="dropdown-item" href="/5.8.4/Text::Wrap">5.8.4</a> <a class="dropdown-item" href="/5.8.3/Text::Wrap">5.8.3</a> <a class="dropdown-item" href="/5.8.2/Text::Wrap">5.8.2</a> <a class="dropdown-item" href="/5.8.1/Text::Wrap">5.8.1</a> <a class="dropdown-item" href="/5.8.0/Text::Wrap">5.8.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.6.2/Text::Wrap">5.6.2</a> <a class="dropdown-item" href="/5.6.1/Text::Wrap">5.6.1</a> <a class="dropdown-item" href="/5.6.0/Text::Wrap">5.6.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.005_04/Text::Wrap">5.005_04</a> <a class="dropdown-item" href="/5.005_03/Text::Wrap">5.005_03</a> <a class="dropdown-item" href="/5.005_02/Text::Wrap">5.005_02</a> <a class="dropdown-item" href="/5.005_01/Text::Wrap">5.005_01</a> <a class="dropdown-item" href="/5.005/Text::Wrap">5.005</a> </div> </li> <li class="nav-item dropdown text-nowrap"> <a class="nav-link dropdown-toggle" href="#" id="dropdownlink-dev" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Dev</a> <div class="dropdown-menu" aria-labelledby="dropdownlink-dev"> <a class="dropdown-item" href="/blead/Text::Wrap">blead</a> <a class="dropdown-item" href="/5.41.10/Text::Wrap">5.41.10</a> <a class="dropdown-item" href="/5.41.9/Text::Wrap">5.41.9</a> <a class="dropdown-item" href="/5.41.8/Text::Wrap">5.41.8</a> <a class="dropdown-item" href="/5.41.7/Text::Wrap">5.41.7</a> <a class="dropdown-item" href="/5.41.6/Text::Wrap">5.41.6</a> <a class="dropdown-item" href="/5.41.5/Text::Wrap">5.41.5</a> <a class="dropdown-item" href="/5.41.4/Text::Wrap">5.41.4</a> <a class="dropdown-item" href="/5.41.3/Text::Wrap">5.41.3</a> <a class="dropdown-item" href="/5.41.2/Text::Wrap">5.41.2</a> <a class="dropdown-item" href="/5.41.1/Text::Wrap">5.41.1</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.40.1-RC1/Text::Wrap">5.40.1-RC1</a> <a class="dropdown-item" href="/5.40.0-RC2/Text::Wrap">5.40.0-RC2</a> <a class="dropdown-item" href="/5.40.0-RC1/Text::Wrap">5.40.0-RC1</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.39.10/Text::Wrap">5.39.10</a> <a class="dropdown-item" href="/5.39.9/Text::Wrap">5.39.9</a> <a class="dropdown-item" href="/5.39.8/Text::Wrap">5.39.8</a> <a class="dropdown-item" href="/5.39.7/Text::Wrap">5.39.7</a> <a class="dropdown-item" href="/5.39.6/Text::Wrap">5.39.6</a> <a class="dropdown-item" href="/5.39.5/Text::Wrap">5.39.5</a> <a class="dropdown-item" href="/5.39.4/Text::Wrap">5.39.4</a> <a class="dropdown-item" href="/5.39.3/Text::Wrap">5.39.3</a> <a class="dropdown-item" href="/5.39.2/Text::Wrap">5.39.2</a> <a class="dropdown-item" href="/5.39.1/Text::Wrap">5.39.1</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.38.3-RC1/Text::Wrap">5.38.3-RC1</a> </div> </li> <li class="nav-item dropdown text-nowrap"> <a class="nav-link dropdown-toggle" href="#" id="dropdownlink-nav" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Documentation</a> <div class="dropdown-menu" aria-labelledby="dropdownlink-nav"> <a class="dropdown-item" href="/5.26.2/perl">Perl</a> <a class="dropdown-item" href="/5.26.2/perlintro">Intro</a> <a class="dropdown-item" href="/5.26.2/perl#Tutorials">Tutorials</a> <a class="dropdown-item" href="/5.26.2/perlfaq">FAQs</a> <a class="dropdown-item" href="/5.26.2/perl#Reference-Manual">Reference</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.26.2/perlop">Operators</a> <a class="dropdown-item" href="/5.26.2/functions">Functions</a> <a class="dropdown-item" href="/5.26.2/variables">Variables</a> <a class="dropdown-item" href="/5.26.2/modules">Modules</a> <a class="dropdown-item" href="/5.26.2/perlutil">Utilities</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.26.2/perldelta">Release Notes</a> <a class="dropdown-item" href="/5.26.2/perlcommunity">Community</a> <a class="dropdown-item" href="/5.26.2/perlhist">History</a> </div> </li> </ul> <ul class="navbar-nav"> <script> function set_expand (expand) { var perldocdiv = document.getElementById('perldocdiv'); var width = window.getComputedStyle(perldocdiv).getPropertyValue('max-width'); var expanded = (width == '' || width == 'none') ? true : false; if (expand === null) { expand = !expanded; } if ((expand && !expanded) || (!expand && expanded)) { perldocdiv.style.setProperty('max-width', expand ? 'none' : '960px'); var button_classlist = document.getElementById('content-expand-button').classList; if (expand) { button_classlist.add('btn-light'); button_classlist.remove('btn-outline-light'); } else { button_classlist.add('btn-outline-light'); button_classlist.remove('btn-light'); } } return expand; } function toggle_expand () { var expand = set_expand(null); document.cookie = 'perldoc_expand=' + (expand ? 1 : 0) + '; path=/; expires=Tue, 19 Jan 2038 03:14:07 UTC'; } function read_expand () { return document.cookie.split(';').some(function (item) { return item.indexOf('perldoc_expand=1') >= 0 }); } if (document.readyState === 'loading') { document.addEventListener('DOMContentLoaded', function () { if (read_expand()) { set_expand(true); } }); } else if (read_expand()) { set_expand(true); } </script> <button id="content-expand-button" type="button" class="btn btn-outline-light d-none d-lg-inline-block mr-4" onclick="toggle_expand()">Expand</button> </ul> <form class="form-inline" method="get" action="/5.26.2/search"> <input class="form-control mr-3" type="search" name="q" placeholder="Search" aria-label="Search" value=""> </form> </div> </nav> <div id="wrapperlicious" class="container-fluid"> <div id="perldocdiv"> <div id="links"> <a href="/5.26.2/Text::Wrap">Text::Wrap</a> <div id="more"> (<a href="/5.26.2/Text::Wrap.txt">source</a>, <a href="https://metacpan.org/pod/Text::Wrap">CPAN</a>) </div> <div id="moduleversion">version 2013.0523</div> </div> <div class="leading-notice"> You are viewing the version of this documentation from Perl 5.26.2. <a href="/Text::Wrap">View the latest version</a> </div> <h1><a id="toc">CONTENTS</a></h1> <ul> <li> <a class="text-decoration-none" href="#NAME">NAME</a> </li> <li> <a class="text-decoration-none" href="#SYNOPSIS">SYNOPSIS</a> </li> <li> <a class="text-decoration-none" href="#DESCRIPTION">DESCRIPTION</a> </li> <li> <a class="text-decoration-none" href="#OVERRIDES">OVERRIDES</a> </li> <li> <a class="text-decoration-none" href="#EXAMPLES">EXAMPLES</a> </li> <li> <a class="text-decoration-none" href="#SUBVERSION">SUBVERSION</a> </li> <li> <a class="text-decoration-none" href="#SEE-ALSO">SEE ALSO</a> </li> <li> <a class="text-decoration-none" href="#AUTHOR">AUTHOR</a> </li> <li> <a class="text-decoration-none" href="#LICENSE">LICENSE</a> </li> </ul> <h1 id="NAME"><a class="permalink" href="#NAME">#</a>NAME</h1> <p>Text::Wrap - line wrapping to form simple paragraphs</p> <h1 id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">#</a>SYNOPSIS</h1> <p><b>Example 1</b></p> <pre><code>use Text::Wrap; $initial_tab = "\t"; # Tab before first line $subsequent_tab = ""; # All other lines flush left print wrap($initial_tab, $subsequent_tab, @text); print fill($initial_tab, $subsequent_tab, @text); $lines = wrap($initial_tab, $subsequent_tab, @text); @paragraphs = fill($initial_tab, $subsequent_tab, @text);</code></pre> <p><b>Example 2</b></p> <pre><code>use Text::Wrap qw(wrap $columns $huge); $columns = 132; # Wrap at 132 characters $huge = 'die'; $huge = 'wrap'; $huge = 'overflow';</code></pre> <p><b>Example 3</b></p> <pre><code>use Text::Wrap; $Text::Wrap::columns = 72; print wrap('', '', @text);</code></pre> <h1 id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">#</a>DESCRIPTION</h1> <p><code>Text::Wrap::wrap()</code> is a very simple paragraph formatter. It formats a single paragraph at a time by breaking lines at word boundaries. Indentation is controlled for the first line (<code>$initial_tab</code>) and all subsequent lines (<code>$subsequent_tab</code>) independently. Please note: <code>$initial_tab</code> and <code>$subsequent_tab</code> are the literal strings that will be used: it is unlikely you would want to pass in a number.</p> <p><code>Text::Wrap::fill()</code> is a simple multi-paragraph formatter. It formats each paragraph separately and then joins them together when it's done. It will destroy 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().</p> <p><code>wrap()</code> compresses trailing whitespace into one newline, and <code>fill()</code> deletes all trailing whitespace.</p> <p>Both <code>wrap()</code> and <code>fill()</code> return a single string.</p> <p>Unlike the old Unix fmt(1) utility, this module correctly accounts for any Unicode combining characters (such as diacriticals) that may occur in each line for both expansion and unexpansion. These are overstrike characters that do not increment the logical position. Make sure you have the appropriate Unicode settings enabled.</p> <h1 id="OVERRIDES"><a class="permalink" href="#OVERRIDES">#</a>OVERRIDES</h1> <p><code>Text::Wrap::wrap()</code> has a number of variables that control its behavior. Because other modules might be using <code>Text::Wrap::wrap()</code> it is suggested that you leave these variables alone! If you can't do that, then use <code>local($Text::Wrap::VARIABLE) = YOURVALUE</code> when you change the values so that the original value is restored. This <code>local()</code> trick will not work if you import the variable into your own namespace.</p> <p>Lines are wrapped at <code>$Text::Wrap::columns</code> columns (default value: 76). <code>$Text::Wrap::columns</code> should be set to the full width of your output device. In fact, every resulting line will have length of no more than <code>$columns - 1</code>.</p> <p>It is possible to control which characters terminate words by modifying <code>$Text::Wrap::break</code>. Set this to a string such as <code>'[\s:]'</code> (to break before spaces or colons) or a pre-compiled regexp such as <code>qr/[\s']/</code> (to break before spaces or apostrophes). The default is simply <code>'\s'</code>; that is, words are terminated by spaces. (This means, among other things, that trailing punctuation such as full stops or commas stay with the word they are "attached" to.) Setting <code>$Text::Wrap::break</code> to a regular expression that doesn't eat any characters (perhaps just a forward look-ahead assertion) will cause warnings.</p> <p>Beginner note: In example 2, above <code>$columns</code> is imported into the local namespace, and set locally. In example 3, <code>$Text::Wrap::columns</code> is set in its own namespace without importing it.</p> <p><code>Text::Wrap::wrap()</code> starts its work by expanding all the tabs in its input into spaces. The last thing it does it to turn spaces back into tabs. If you do not want tabs in your results, set <code>$Text::Wrap::unexpand</code> to a false value. Likewise if you do not want to use 8-character tabstops, set <code>$Text::Wrap::tabstop</code> to the number of characters you do want for your tabstops.</p> <p>If you want to separate your lines with something other than <code>\n</code> then set <code>$Text::Wrap::separator</code> to your preference. This replaces all newlines with <code>$Text::Wrap::separator</code>. If you just want to preserve existing newlines but add new breaks with something else, set <code>$Text::Wrap::separator2</code> instead.</p> <p>When words that are longer than <code>$columns</code> are encountered, they are broken up. <code>wrap()</code> adds a <code>"\n"</code> at column <code>$columns</code>. This behavior can be overridden by setting <code>$huge</code> to 'die' or to 'overflow'. When set to 'die', large words will cause <code>die()</code> to be called. When set to 'overflow', large words will be left intact.</p> <p>Historical notes: 'die' used to be the default value of <code>$huge</code>. Now, 'wrap' is the default value.</p> <h1 id="EXAMPLES"><a class="permalink" href="#EXAMPLES">#</a>EXAMPLES</h1> <p>Code:</p> <pre><code>print wrap("\t","",<<END); This is a bit of text that forms a normal book-style indented paragraph END</code></pre> <p>Result:</p> <pre><code class="plaintext">" This is a bit of text that forms a normal book-style indented paragraph "</code></pre> <p>Code:</p> <pre><code>$Text::Wrap::columns=20; $Text::Wrap::separator="|"; print wrap("","","This is a bit of text that forms a normal book-style paragraph");</code></pre> <p>Result:</p> <pre><code class="plaintext">"This is a bit of|text that forms a|normal book-style|paragraph"</code></pre> <h1 id="SUBVERSION"><a class="permalink" href="#SUBVERSION">#</a>SUBVERSION</h1> <p>This module comes in two flavors: one for modern perls (5.10 and above) and one for ancient obsolete perls. The version for modern perls has support for Unicode. The version for old perls does not. You can tell which version you have installed by looking at <code>$Text::Wrap::SUBVERSION</code>: it is <code>old</code> for obsolete perls and <code>modern</code> for current perls.</p> <p>This man page is for the version for modern perls and so that's probably what you've got.</p> <h1 id="SEE-ALSO"><a class="permalink" href="#SEE-ALSO">#</a><a id="SEE"></a>SEE ALSO</h1> <p>For correct handling of East Asian half- and full-width characters, see <a href="/5.26.2/Text::WrapI18N">Text::WrapI18N</a>. For more detailed controls: <a href="/5.26.2/Text::Format">Text::Format</a>.</p> <h1 id="AUTHOR"><a class="permalink" href="#AUTHOR">#</a>AUTHOR</h1> <p>David Muir Sharnoff <cpan@dave.sharnoff.org> with help from Tim Pierce and many many others.</p> <h1 id="LICENSE"><a class="permalink" href="#LICENSE">#</a>LICENSE</h1> <p>Copyright (C) 1996-2009 David Muir Sharnoff. Copyright (C) 2012-2013 Google, Inc. This module may be modified, used, copied, and redistributed at your own risk. Although allowed by the preceding license, please do not publicly redistribute modified versions of this code with the name "Text::Wrap" unless it passes the unmodified Text::Wrap test suite.</p> </div> <div id="footer"> <p>Perldoc Browser is maintained by Dan Book (<a href="https://metacpan.org/author/DBOOK">DBOOK</a>). Please contact him via the <a href="https://github.com/Grinnz/perldoc-browser/issues">GitHub issue tracker</a> or <a href="mailto:dbook@cpan.org">email</a> regarding any issues with the site itself, search, or rendering of documentation.</p> <p>The Perl documentation is maintained by the Perl 5 Porters in the development of Perl. Please contact them via the <a href="https://github.com/Perl/perl5/issues">Perl issue tracker</a>, the <a href="https://lists.perl.org/list/perl5-porters.html">mailing list</a>, or <a href="https://kiwiirc.com/client/irc.perl.org/p5p">IRC</a> to report any issues with the contents or format of the documentation.</p> </div> </div> <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.5.1/jquery.slim.min.js" integrity="sha512-/DXTXr6nQodMUiq+IUJYCt2PPOUjrHJ9wFrqpJ3XkgPNOZVfMok7cRw6CSxyCQxXn6ozlESsSh1/sMCTF1rL/g==" crossorigin="anonymous"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.16.1/umd/popper.min.js" integrity="sha512-ubuT8Z88WxezgSqf3RLuNi5lmjstiJcyezx34yIU2gAHonIi27Na7atqzUZCOoY4CExaoFumzOsFQ2Ch+I/HCw==" crossorigin="anonymous"></script> <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/js/bootstrap.min.js" integrity="sha384-B4gt1jrGC7Jh4AgTPSdUtOBvfO8shuf57BaghqFfPlYxofvL8/KUEfYiJOMMV+rV" crossorigin="anonymous"></script> <script src="/js/highlight.pack.js"></script> <script>hljs.highlightAll();</script> </body> </html>

CINXE.COM

Text::Wrap - line wrapping to form simple paragraphs - Perldoc Browser