File: pod2text.html

package info (click to toggle)
perl-doc-html 5.26.0-4
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 39,400 kB
  • sloc: xml: 36; makefile: 7
file content (659 lines) | stat: -rw-r--r-- 26,117 bytes parent folder | download
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
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
  <title>pod2text - perldoc.perl.org</title>
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  <meta http-equiv="Content-Language" content="en-gb">
  <link rel="search" type="application/opensearchdescription+xml" title="Search perldoc.perl.org" href="/static/search.xml"/>
  <link href="static/css-20100830.css" rel="stylesheet" rev="stylesheet" type="text/css" media="screen">
  <link href="static/exploreperl.css" rel="stylesheet" rev="stylesheet" type="text/css">
</head>

<body onLoad="perldoc.startup();" onPageShow="if (event.persisted) perldoc.startup();">
    <div id="page">
      
      <div id="header">
	<div id="homepage_link">
	  <a href="index.html"></a>
	</div>
	<div id="strapline">
	  Perl Programming Documentation
	</div>
	<div id="download_link" class="download">
	  <a href="http://www.perl.org/get.html">Download Perl</a>
	</div>
	<div id="explore_link" class="download">
	  <a id="explore_anchor" href="#">Explore</a>
	</div>
      </div>
      
      <div id="body">
        <div id="left_column">
          <div class="side_group">
            
	    <div class="side_panel doc_panel">
              <p>Manual</p>
              <ul>
                <li><a href="index-overview.html">Overview</a>
                <li><a href="index-tutorials.html">Tutorials</a>
                <li><a href="index-faq.html">FAQs</a>
                <li><a href="index-history.html">History / Changes</a>
                <li><a href="index-licence.html">License</a>
              </ul>
            </div>
            <div class="side_panel doc_panel">
              <p>Reference</p>
              <ul>
                <li><a href="index-language.html">Language</a>
                <li><a href="index-functions.html">Functions</a>
                <li><a href="perlop.html">Operators</a>
                <li><a href="perlvar.html">Special Variables</a>
                <li><a href="index-pragmas.html">Pragmas</a>
                <li><a href="index-utilities.html">Utilities</a>
                <li><a href="index-internals.html">Internals</a>
                <li><a href="index-platforms.html">Platform Specific</a>
              </ul>
            </div>
            <div class="side_panel doc_panel">
              <p>Modules</p>
              <ul>
		<li>
		
                
                  
		    
		  
		
                  
		    
		  
		
                  
		    
		  
		
                  
		    
		  
		
                  
		    
		  
		
                  
		    
		  
		
                  
		    
		  
		
                  
		    
		  
		
                  
		    
		  
		
                  
		
                  
		
                  
		    
		  
		
                  
		    
		  
		
                  
		    
		  
		
                  
		    
		  
		
                  
		    
		  
		
                  
		
                  
		
                  
		    
		  
		
                  
		    
		  
		
                  
		    
		  
		
                  
		
                  
		
                  
		    
		  
		
                  
		
                  
		
		
                    <a href="index-modules-A.html">A</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-B.html">B</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-C.html">C</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-D.html">D</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-E.html">E</a>
                    
                      
                        <li>
                      
                    
                
                    <a href="index-modules-F.html">F</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-G.html">G</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-H.html">H</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-I.html">I</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-L.html">L</a>
                    
                      
                        <li>
                      
                    
                
                    <a href="index-modules-M.html">M</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-N.html">N</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-O.html">O</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-P.html">P</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-S.html">S</a>
                    
                      
                        <li>
                      
                    
                
                    <a href="index-modules-T.html">T</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-U.html">U</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-X.html">X</a>
                    
                
              </ul>
            </div>
            
	      <div class="side_panel doc_panel">
		<p>Tools</p>
		<ul>
		  <li><a href="preferences.html">Preferences</a>
		</ul>
	      </div>
            
          </div>
        </div>
        <div id="centre_column">
          <div id="content_header">
            <div id="title_bar">
              <div id="page_name">
                <h1>pod2text</h1>
              </div>
              <div id="perl_version">
                Perl 5 version 26.0 documentation
              </div>
              <div class="page_links" id="page_links_top">
                <a href="#" onClick="toolbar.goToTop();return false;">Go to top</a>
		
              </div>
	      <div class="page_links" id="page_links_bottom">
		
                  <a href="#" id="page_index_toggle">Show page index</a> &bull;
		
                <a href="#" id="recent_pages_toggle">Show recent pages</a>		
	      </div>
	      <div id="search_form">
		<form action="search.html" method="GET" id="search">
		  <input type="text" name="q" id="search_box" alt="Search">
		</form>
	      </div>
            </div>
            <div id="breadcrumbs">
                
    <a href="index.html">Home</a> &gt;
    
      
        <a href="index-utilities.html">Utilities</a> &gt;
      
    
    pod2text
  

            </div>
          </div>
          <div id="content_body">
	    <!--[if lt IE 7]>
 <div class="noscript">
   <p>
     <strong>It looks like you're using Internet Explorer 6. This is a very old
     browser which does not offer full support for modern websites.</strong>
   </p>
   <p>
     Unfortunately this means that this website will not work on
     your computer.
   </p>
   <p>
     Don't miss out though! To view the site (and get a better experience from
     many other websites), simply upgrade to
     <a href="http://www.microsoft.com/windows/Internet-explorer/default.aspx">Internet
Explorer 8</a>
     or download an alternative browser such as
     <a href="http://www.mozilla.com/en-US/firefox/firefox.html">Firefox</a>,
     <a href="http://www.apple.com/safari/download/">Safari</a>, or
     <a href="http://www.google.co.uk/chrome">Google Chrome</a>.
   </p>
   <p>
     All of these browsers are free. If you're using a PC at work, you may
     need to contact your IT administrator.
   </p>
 </div>
<![endif]-->
	    <noscript>
	      <div class="noscript">
	      <p>
                <strong>Please note: Many features of this site require JavaScript. You appear to have JavaScript disabled,
	        or are running a non-JavaScript capable web browser.</strong>
	      </p>
	      <p>
		To get the best experience, please enable JavaScript or download a modern web browser such as <a href="http://www.microsoft.com/windows/Internet-explorer/default.aspx">Internet Explorer 8</a>, <a href="http://www.mozilla.com/en-US/firefox/firefox.html">Firefox</a>, <a href="http://www.apple.com/safari/download/">Safari</a>, or <a href="http://www.google.co.uk/chrome">Google Chrome</a>.
              </p>
	      </div>
	    </noscript>

	    <div id="recent_pages" class="hud_container">
	      <div id="recent_pages_header" class="hud_header">
		<div id="recent_pages_close" class="hud_close"><a href="#" onClick="recentPages.hide();return false;"></a></div>
		<div id="recent_pages_title" class="hud_title"><span class="hud_span_top">Recently read</span></div>
		<div id="recent_pages_topright" class="hud_topright"></div>
	      </div>
	      <div id="recent_pages_content" class="hud_content">
	      </div>
	      <div id="recent_pages_footer" class="hud_footer">
		<div id="recent_pages_bottomleft" class="hud_bottomleft"></div>
		<div id="recent_pages_bottom" class="hud_bottom"><span class="hud_span_bottom"></span></div>
		<div id="recent_pages_resize" class="hud_resize"></div>
	      </div>
	    </div>
  
	    <div id="from_search"></div>
            <h1>pod2text</h1>


  <!--    -->
<ul><li><a href="#NAME">NAME</a><li><a href="#SYNOPSIS">SYNOPSIS</a><li><a href="#DESCRIPTION">DESCRIPTION</a><li><a href="#OPTIONS">OPTIONS</a><li><a href="#EXIT-STATUS">EXIT STATUS</a><li><a href="#DIAGNOSTICS">DIAGNOSTICS</a><li><a href="#ENVIRONMENT">ENVIRONMENT</a><li><a href="#SEE-ALSO">SEE ALSO</a><li><a href="#AUTHOR">AUTHOR</a><li><a href="#COPYRIGHT-AND-LICENSE">COPYRIGHT AND LICENSE</a></ul><a name="NAME"></a><h1>NAME</h1>
<p>pod2text - Convert POD data to formatted ASCII text</p>
<a name="SYNOPSIS"></a><h1>SYNOPSIS</h1>
<p>pod2text [<b>-aclostu</b>] [<b>--code</b>] [<b>--errors</b>=<i>style</i>] [<b>-i</b> <i>indent</i>]
    [<b>-q</b> <i>quotes</i>] [<b>--nourls</b>] [<b>--stderr</b>] [<b>-w</b> <i>width</i>]
    [<i>input</i> [<i>output</i> ...]]</p>
<p>pod2text <b>-h</b></p>
<a name="DESCRIPTION"></a><h1>DESCRIPTION</h1>
<p><b>pod2text</b> is a front-end for Pod::Text and its subclasses.  It uses them
to generate formatted ASCII text from POD source.  It can optionally use
either termcap sequences or ANSI color escape sequences to format the text.</p>
<p><i>input</i> is the file to read for POD source (the POD can be embedded in
code).  If <i>input</i> isn't given, it defaults to <code class="inline"><span class="w">STDIN</span></code>
.  <i>output</i>, if
given, is the file to which to write the formatted output.  If <i>output</i>
isn't given, the formatted output is written to <code class="inline"><span class="w">STDOUT</span></code>
.  Several POD
files can be processed in the same <b>pod2text</b> invocation (saving module
load and compile times) by providing multiple pairs of <i>input</i> and
<i>output</i> files on the command line.</p>
<a name="OPTIONS"></a><h1>OPTIONS</h1>
<ul>
<li><a name="*-a*%2c-*--alt*"></a><b><b>-a</b>, <b>--alt</b></b>
<p>Use an alternate output format that, among other things, uses a different
heading style and marks <code class="inline"><span class="pd">=item</span></code>
 entries with a colon in the left margin.</p>
</li>
<li><a name="*--code*"></a><b><b>--code</b></b>
<p>Include any non-POD text from the input file in the output as well.  Useful
for viewing code documented with POD blocks with the POD rendered and the
code left intact.</p>
</li>
<li><a name="*-c*%2c-*--color*"></a><b><b>-c</b>, <b>--color</b></b>
<p>Format the output with ANSI color escape sequences.  Using this option
requires that Term::ANSIColor be installed on your system.</p>
</li>
<li><a name="*--errors*%3d_style_"></a><b><b>--errors</b>=<i>style</i></b>
<p>Set the error handling style.  <code class="inline"><a class="l_k" href="functions/die.html">die</a></code> says to throw an exception on any
POD formatting error.  <code class="inline"><span class="w">stderr</span></code>
 says to report errors on standard error,
but not to throw an exception.  <code class="inline"><span class="w">pod</span></code>
 says to include a POD ERRORS
section in the resulting documentation summarizing the errors.  <code class="inline"><span class="w">none</span></code>

ignores POD errors entirely, as much as possible.</p>
<p>The default is <code class="inline"><a class="l_k" href="functions/die.html">die</a></code>.</p>
</li>
<li><a name="*-i*-_indent_%2c-*--indent%3d*_indent_"></a><b><b>-i</b> <i>indent</i>, <b>--indent=</b><i>indent</i></b>
<p>Set the number of spaces to indent regular text, and the default indentation
for <code class="inline"><span class="pd">=over</span></code>
 blocks.  Defaults to 4 spaces if this option isn't given.</p>
</li>
<li><a name="*-h*%2c-*--help*"></a><b><b>-h</b>, <b>--help</b></b>
<p>Print out usage information and exit.</p>
</li>
<li><a name="*-l*%2c-*--loose*"></a><b><b>-l</b>, <b>--loose</b></b>
<p>Print a blank line after a <code class="inline"><span class="pd">=head1</span></code>
 heading.  Normally, no blank line is
printed after <code class="inline"><span class="pd">=head1</span></code>
, although one is still printed after <code class="inline"><span class="pd">=head2</span></code>
,
because this is the expected formatting for manual pages; if you're
formatting arbitrary text documents, using this option is recommended.</p>
</li>
<li><a name="*-m*-_width_%2c-*--left-margin*%3d_width_%2c-*--margin*%3d_width_"></a><b><b>-m</b> <i>width</i>, <b>--left-margin</b>=<i>width</i>, <b>--margin</b>=<i>width</i></b>
<p>The width of the left margin in spaces.  Defaults to 0.  This is the margin
for all text, including headings, not the amount by which regular text is
indented; for the latter, see <b>-i</b> option.</p>
</li>
<li><a name="*--nourls*"></a><b><b>--nourls</b></b>
<p>Normally, L&lt;&gt; formatting codes with a URL but anchor text are formatted
to show both the anchor text and the URL.  In other words:</p>
<pre class="verbatim"><ol><li>    <span class="w">L</span>&lt;<span class="w">foo</span>|<span class="w">http</span><span class="co">:</span><span class="q">//</span><span class="w">example</span>.<span class="w">com</span><span class="q">/&gt;</span></li></ol></pre><p>is formatted as:</p>
<pre class="verbatim"><ol><li>    <span class="w">foo</span> <span class="q">&lt;<a href="http://example.com/">http://example.com/</a>&gt;</span></li></ol></pre><p>This flag, if given, suppresses the URL when anchor text is given, so this
example would be formatted as just <code class="inline"><span class="w">foo</span></code>
.  This can produce less
cluttered output in cases where the URLs are not particularly important.</p>
</li>
<li><a name="*-o*%2c-*--overstrike*"></a><b><b>-o</b>, <b>--overstrike</b></b>
<p>Format the output with overstrike printing.  Bold text is rendered as
character, backspace, character.  Italics and file names are rendered as
underscore, backspace, character.  Many pagers, such as <b>less</b>, know how
to convert this to bold or underlined text.</p>
</li>
<li><a name="*-q*-_quotes_%2c-*--quotes*%3d_quotes_"></a><b><b>-q</b> <i>quotes</i>, <b>--quotes</b>=<i>quotes</i></b>
<p>Sets the quote marks used to surround C&lt;&gt; text to <i>quotes</i>.  If
<i>quotes</i> is a single character, it is used as both the left and right
quote.  Otherwise, it is split in half, and the first half of the string
is used as the left quote and the second is used as the right quote.</p>
<p><i>quotes</i> may also be set to the special value <code class="inline"><span class="w">none</span></code>
, in which case no
quote marks are added around C&lt;&gt; text.</p>
</li>
<li><a name="*-s*%2c-*--sentence*"></a><b><b>-s</b>, <b>--sentence</b></b>
<p>Assume each sentence ends with two spaces and try to preserve that spacing.
Without this option, all consecutive whitespace in non-verbatim paragraphs
is compressed into a single space.</p>
</li>
<li><a name="*--stderr*"></a><b><b>--stderr</b></b>
<p>By default, <b>pod2text</b> dies if any errors are detected in the POD input.
If <b>--stderr</b> is given and no <b>--errors</b> flag is present, errors are
sent to standard error, but <b>pod2text</b> does not abort.  This is
equivalent to <code class="inline">--<span class="w">errors</span>=<span class="w">stderr</span></code>
 and is supported for backward
compatibility.</p>
</li>
<li><a name="*-t*%2c-*--termcap*"></a><b><b>-t</b>, <b>--termcap</b></b>
<p>Try to determine the width of the screen and the bold and underline
sequences for the terminal from termcap, and use that information in
formatting the output.  Output will be wrapped at two columns less than the
width of your terminal device.  Using this option requires that your system
have a termcap file somewhere where Term::Cap can find it and requires that
your system support termios.  With this option, the output of <b>pod2text</b>
will contain terminal control sequences for your current terminal type.</p>
</li>
<li><a name="*-u*%2c-*--utf8*"></a><b><b>-u</b>, <b>--utf8</b></b>
<p>By default, <b>pod2text</b> tries to use the same output encoding as its input
encoding (to be backward-compatible with older versions).  This option
says to instead force the output encoding to UTF-8.</p>
<p>Be aware that, when using this option, the input encoding of your POD
source should be properly declared unless it's US-ASCII.  Pod::Simple
will attempt to guess the encoding and may be successful if it's
Latin-1 or UTF-8, but it will warn, which by default results in a
<b>pod2text</b> failure.  Use the <code class="inline"><span class="pd">=encoding</span></code>
 command to declare the
encoding.  See <i>perlpod(1)</i> for more information.</p>
</li>
<li><a name="*-w*%2c-*--width%3d*_width_%2c-*-*_width_"></a><b><b>-w</b>, <b>--width=</b><i>width</i>, <b>-</b><i>width</i></b>
<p>The column at which to wrap text on the right-hand side.  Defaults to 76,
unless <b>-t</b> is given, in which case it's two columns less than the width of
your terminal device.</p>
</li>
</ul>
<a name="EXIT-STATUS"></a><h1>EXIT STATUS</h1>
<p>As long as all documents processed result in some output, even if that
output includes errata (a <code class="inline"><span class="w">POD</span> <span class="w">ERRORS</span></code>
 section generated with
<code class="inline">--<span class="w">errors</span>=<span class="w">pod</span></code>
), <b>pod2text</b> will exit with status 0.  If any of the
documents being processed do not result in an output document, <b>pod2text</b>
will exit with status 1.  If there are syntax errors in a POD document
being processed and the error handling style is set to the default of
<code class="inline"><a class="l_k" href="functions/die.html">die</a></code>, <b>pod2text</b> will abort immediately with exit status 255.</p>
<a name="DIAGNOSTICS"></a><h1>DIAGNOSTICS</h1>
<p>If <b>pod2text</b> fails with errors, see <a href="Pod/Text.html">Pod::Text</a> and <a href="Pod/Simple.html">Pod::Simple</a> for
information about what those errors might mean.  Internally, it can also
produce the following diagnostics:</p>
<ul>
<li><a name="-c-(--color)-requires-Term%3a%3aANSIColor-be-installed"></a><b>-c (--color) requires Term::ANSIColor be installed</b>
<p>(F) <b>-c</b> or <b>--color</b> were given, but Term::ANSIColor could not be
loaded.</p>
</li>
<li><a name="Unknown-option%3a-%25s"></a><b>Unknown option: %s</b>
<p>(F) An unknown command line option was given.</p>
</li>
</ul>
<p>In addition, other <a href="Getopt/Long.html">Getopt::Long</a> error messages may result from invalid
command-line options.</p>
<a name="ENVIRONMENT"></a><h1>ENVIRONMENT</h1>
<ul>
<li><a name="COLUMNS"></a><b>COLUMNS</b>
<p>If <b>-t</b> is given, <b>pod2text</b> will take the current width of your screen
from this environment variable, if available.  It overrides terminal width
information in TERMCAP.</p>
</li>
<li><a name="TERMCAP"></a><b>TERMCAP</b>
<p>If <b>-t</b> is given, <b>pod2text</b> will use the contents of this environment
variable if available to determine the correct formatting sequences for your
current terminal device.</p>
</li>
</ul>
<a name="SEE-ALSO"></a><h1>SEE ALSO</h1>
<p><a href="Pod/Text.html">Pod::Text</a>, <a href="Pod/Text/Color.html">Pod::Text::Color</a>, <a href="Pod/Text/Overstrike.html">Pod::Text::Overstrike</a>,
<a href="Pod/Text/Termcap.html">Pod::Text::Termcap</a>, <a href="Pod/Simple.html">Pod::Simple</a>, <i>perlpod(1)</i></p>
<p>The current version of this script is always available from its web site at
<a href="http://www.eyrie.org/~eagle/software/podlators/">http://www.eyrie.org/~eagle/software/podlators/</a>.  It is also part of the
Perl core distribution as of 5.6.0.</p>
<a name="AUTHOR"></a><h1>AUTHOR</h1>
<p>Russ Allbery &lt;rra@cpan.org&gt;.</p>
<a name="COPYRIGHT-AND-LICENSE"></a><h1>COPYRIGHT AND LICENSE</h1>
<p>Copyright 1999, 2000, 2001, 2004, 2006, 2008, 2010, 2012, 2013, 2014, 2015,
2016 Russ Allbery &lt;rra@cpan.org&gt;</p>
<p>This program is free software; you may redistribute it and/or modify it
under the same terms as Perl itself.</p>




  <div id="page_index" class="hud_container">
    <div id="page_index_header" class="hud_header">
      <div id="page_index_close" class="hud_close"><a href="#" onClick="pageIndex.hide();return false;"></a></div>
      <div id="page_index_title" class="hud_title"><span class="hud_span_top">Page index</span></div>
      <div id="page_index_topright" class="hud_topright"></div>
    </div>
    <div id="page_index_content" class="hud_content">
      <ul><li><a href="#NAME">NAME</a><li><a href="#SYNOPSIS">SYNOPSIS</a><li><a href="#DESCRIPTION">DESCRIPTION</a><li><a href="#OPTIONS">OPTIONS</a><li><a href="#EXIT-STATUS">EXIT STATUS</a><li><a href="#DIAGNOSTICS">DIAGNOSTICS</a><li><a href="#ENVIRONMENT">ENVIRONMENT</a><li><a href="#SEE-ALSO">SEE ALSO</a><li><a href="#AUTHOR">AUTHOR</a><li><a href="#COPYRIGHT-AND-LICENSE">COPYRIGHT AND LICENSE</a></ul>
    </div>
    <div id="page_index_footer" class="hud_footer">
      <div id="page_index_bottomleft" class="hud_bottomleft"></div>
      <div id="page_index_bottom" class="hud_bottom"><span class="hud_span_bottom"></span></div>
      <div id="page_index_resize" class="hud_resize"></div>
    </div>
  </div>


	    &nbsp;
          </div>
          <div id="content_footer">
          </div>
        </div>
        <div class="clear"></div>
      </div>
      
    <div id="footer">
      <div id="footer_content">
        <div id="footer_strapline">
          perldoc.perl.org - Official documentation for the Perl programming language
        </div>
        <div id="footer_links">
          <div id="address">
            <p class="name">Contact details</p>
            <p class="address">
	      Site maintained by <a href="mailto:jj@jonallen.info">Jon Allen (JJ)</a><br>
	    </p>
            <p class="contact">
              Documentation maintained by the <a href="http://lists.cpan.org/showlist.cgi?name=perl5-porters">Perl 5 Porters</a>
            </p>
          </div>
          <ul class="f1">
            <li>Manual
              <ul class="f2">
                <li><a href="index-overview.html">Overview</a>
                <li><a href="index-tutorials.html">Tutorials</a>
                <li><a href="index-faq.html">FAQs</a>
                <li><a href="index-history.html">Changes</a>
              </ul>
            <li>Reference
              <ul class="f2">
                <li><a href="index-language.html">Language</a>
                <li><a href="index-functions.html">Functions</a>
                <li><a href="perlop.html">Operators</a>
                <li><a href="perlvar.html">Variables</a>
              </ul>
            <li>Modules
              <ul class="f2">
                <li><a href="index-modules-A.html">Modules</a>
                <li><a href="index-pragmas.html">Pragmas</a>
                <li><a href="index-utilities.html">Utilities</a>
              </ul>
            <li>Misc
              <ul class="f2">
                <li><a href="index-licence.html">License</a>
                <li><a href="index-internals.html">Internals</a>
                <li><a href="index-platforms.html">Platforms</a>
              </ul>          </ul>
          <div class="clear"></div>
        </div>
      </div>
      <div id="footer_end">
      </div>
    </div>
      
    </div>
      <script language="JavaScript" type="text/javascript" src="static/exploreperl.js"></script>
      <script language="JavaScript" src="static/combined-20100403.js" type="text/javascript"></script>
<script language="JavaScript" type="text/javascript">
  perldoc.setPath(0);
  perldoc.pageName    = 'pod2text';
  perldoc.pageAddress = 'pod2text.html';
  perldoc.contentPage = 1;
  explorePerl.render();
  explorePerl.addEvents('explore_anchor');
</script>
    
  </body>
</html>