1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
|
.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.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. \*(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-
.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" ''
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Text::Wrap 3perl"
.TH Text::Wrap 3perl "2023-11-25" "perl v5.36.0" "Perl Programmers Reference Guide"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Text::Wrap \- line wrapping to form simple paragraphs
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBExample 1\fR
.PP
.Vb 1
\& use Text::Wrap;
\&
\& $initial_tab = "\et"; # 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);
.Ve
.PP
\&\fBExample 2\fR
.PP
.Vb 1
\& use Text::Wrap qw(wrap $columns $huge);
\&
\& $columns = 132; # Wrap at 132 characters
\& $huge = \*(Aqdie\*(Aq;
\& $huge = \*(Aqwrap\*(Aq;
\& $huge = \*(Aqoverflow\*(Aq;
.Ve
.PP
\&\fBExample 3\fR
.PP
.Vb 1
\& use Text::Wrap;
\&
\& $Text::Wrap::columns = 72;
\& print wrap(\*(Aq\*(Aq, \*(Aq\*(Aq, @text);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`Text::Wrap::wrap()\*(C'\fR 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 (\f(CW$initial_tab\fR) and
all subsequent lines (\f(CW$subsequent_tab\fR) independently. Please note:
\&\f(CW$initial_tab\fR and \f(CW$subsequent_tab\fR are the literal strings that will
be used: it is unlikely you would want to pass in a number.
.PP
\&\f(CW\*(C`Text::Wrap::fill()\*(C'\fR 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 \fBwrap()\fR.
.PP
\&\f(CW\*(C`wrap()\*(C'\fR compresses trailing whitespace into one newline, and \f(CW\*(C`fill()\*(C'\fR
deletes all trailing whitespace.
.PP
Both \f(CW\*(C`wrap()\*(C'\fR and \f(CW\*(C`fill()\*(C'\fR return a single string.
.PP
Unlike the old Unix \fBfmt\fR\|(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.
.SH "OVERRIDES"
.IX Header "OVERRIDES"
\&\f(CW\*(C`Text::Wrap::wrap()\*(C'\fR has a number of variables that control its behavior.
Because other modules might be using \f(CW\*(C`Text::Wrap::wrap()\*(C'\fR it is suggested
that you leave these variables alone! If you can't do that, then
use \f(CW\*(C`local($Text::Wrap::VARIABLE) = YOURVALUE\*(C'\fR when you change the
values so that the original value is restored. This \f(CW\*(C`local()\*(C'\fR trick
will not work if you import the variable into your own namespace.
.PP
Lines are wrapped at \f(CW$Text::Wrap::columns\fR columns (default value: 76).
\&\f(CW$Text::Wrap::columns\fR should be set to the full width of your output
device. In fact, every resulting line will have length of no more than
\&\f(CW\*(C`$columns \- 1\*(C'\fR.
.PP
It is possible to control which characters terminate words by
modifying \f(CW$Text::Wrap::break\fR. Set this to a string such as
\&\f(CW\*(Aq[\es:]\*(Aq\fR (to break before spaces or colons) or a pre-compiled regexp
such as \f(CW\*(C`qr/[\es\*(Aq]/\*(C'\fR (to break before spaces or apostrophes). The
default is simply \f(CW\*(Aq\es\*(Aq\fR; 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 \*(L"attached\*(R" to.)
Setting \f(CW$Text::Wrap::break\fR to a regular expression that doesn't
eat any characters (perhaps just a forward look-ahead assertion) will
cause warnings.
.PP
Beginner note: In example 2, above \f(CW$columns\fR is imported into
the local namespace, and set locally. In example 3,
\&\f(CW$Text::Wrap::columns\fR is set in its own namespace without importing it.
.PP
\&\f(CW\*(C`Text::Wrap::wrap()\*(C'\fR 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
\&\f(CW$Text::Wrap::unexpand\fR to a false value. Likewise if you do not
want to use 8\-character tabstops, set \f(CW$Text::Wrap::tabstop\fR to
the number of characters you do want for your tabstops.
.PP
If you want to separate your lines with something other than \f(CW\*(C`\en\*(C'\fR
then set \f(CW$Text::Wrap::separator\fR to your preference. This replaces
all newlines with \f(CW$Text::Wrap::separator\fR. If you just want to
preserve existing newlines but add new breaks with something else, set
\&\f(CW$Text::Wrap::separator2\fR instead.
.PP
When words that are longer than \f(CW$columns\fR are encountered, they
are broken up. \f(CW\*(C`wrap()\*(C'\fR adds a \f(CW"\en"\fR at column \f(CW$columns\fR.
This behavior can be overridden by setting \f(CW$huge\fR to
\&'die' or to 'overflow'. When set to 'die', large words will cause
\&\f(CW\*(C`die()\*(C'\fR to be called. When set to 'overflow', large words will be
left intact.
.PP
Historical notes: 'die' used to be the default value of
\&\f(CW$huge\fR. Now, 'wrap' is the default value.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
Code:
.PP
.Vb 4
\& print wrap("\et","",<<END);
\& This is a bit of text that forms
\& a normal book\-style indented paragraph
\& END
.Ve
.PP
Result:
.PP
.Vb 3
\& " This is a bit of text that forms
\& a normal book\-style indented paragraph
\& "
.Ve
.PP
Code:
.PP
.Vb 3
\& $Text::Wrap::columns=20;
\& $Text::Wrap::separator="|";
\& print wrap("","","This is a bit of text that forms a normal book\-style paragraph");
.Ve
.PP
Result:
.PP
.Vb 1
\& "This is a bit of|text that forms a|normal book\-style|paragraph"
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
For correct handling of East Asian half\- and full-width characters,
see Text::WrapI18N. For more detailed controls: Text::Format.
.SH "AUTHOR"
.IX Header "AUTHOR"
David Muir Sharnoff <cpan@dave.sharnoff.org> with help from Tim Pierce and
many many others.
.SH "LICENSE"
.IX Header "LICENSE"
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 \*(L"Text::Wrap\*(R"
unless it passes the unmodified Text::Wrap test suite.
|
