File: perlpod.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 (1017 lines) | stat: -rw-r--r-- 47,720 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
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
  <title>perlpod - 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>perlpod</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-language.html">Language reference</a> &gt;
      
    
    perlpod
  

            </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>perlpod</h1>


  <!--    -->
<ul><li><a href="#NAME">NAME
 </a><li><a href="#DESCRIPTION">DESCRIPTION</a><ul><li><a href="#Ordinary-Paragraph">Ordinary Paragraph
</a><li><a href="#Verbatim-Paragraph">Verbatim Paragraph
 </a><li><a href="#Command-Paragraph">Command Paragraph
</a><li><a href="#Formatting-Codes">Formatting Codes
 
 </a><li><a href="#The-Intent">The Intent
</a><li><a href="#Embedding-Pods-in-Perl-Modules">Embedding Pods in Perl Modules
</a><li><a href="#Hints-for-Writing-Pod">Hints for Writing Pod</a></ul><li><a href="#SEE-ALSO">SEE ALSO</a><li><a href="#AUTHOR">AUTHOR</a></ul><a name="NAME"></a><h1>NAME
 </h1>
<p>perlpod - the Plain Old Documentation format</p>
<a name="DESCRIPTION"></a><h1>DESCRIPTION</h1>
<p>Pod is a simple-to-use markup language used for writing documentation
for Perl, Perl programs, and Perl modules.</p>
<p>Translators are available for converting Pod to various formats
like plain text, HTML, man pages, and more.</p>
<p>Pod markup consists of three basic kinds of paragraphs:
<a href="#Ordinary-Paragraph">ordinary</a>,
<a href="#Verbatim-Paragraph">verbatim</a>, and 
<a href="#Command-Paragraph">command</a>.</p>
<a name="Ordinary-Paragraph"></a><h2>Ordinary Paragraph
</h2>
<p>Most paragraphs in your documentation will be ordinary blocks
of text, like this one.  You can simply type in your text without
any markup whatsoever, and with just a blank line before and
after.  When it gets formatted, it will undergo minimal formatting, 
like being rewrapped, probably put into a proportionally spaced
font, and maybe even justified.</p>
<p>You can use formatting codes in ordinary paragraphs, for <b>bold</b>,
<i>italic</i>, <code class="inline"><span class="w">code</span>-<span class="w">style</span></code>
, <a href="perlfaq.html">hyperlinks</a>, and more.  Such
codes are explained in the "<a href="#Formatting-Codes">Formatting Codes</a>"
section, below.</p>
<a name="Verbatim-Paragraph"></a><h2>Verbatim Paragraph
 </h2>
<p>Verbatim paragraphs are usually used for presenting a codeblock or
other text which does not require any special parsing or formatting,
and which shouldn't be wrapped.</p>
<p>A verbatim paragraph is distinguished by having its first character
be a space or a tab.  (And commonly, all its lines begin with spaces
and/or tabs.)  It should be reproduced exactly, with tabs assumed to
be on 8-column boundaries.  There are no special formatting codes,
so you can't italicize or anything like that.  A \ means \, and
nothing else.</p>
<a name="Command-Paragraph"></a><h2>Command Paragraph
</h2>
<p>A command paragraph is used for special treatment of whole chunks
of text, usually as headings or parts of lists.</p>
<p>All command paragraphs (which are typically only one line long) start
with "=", followed by an identifier, followed by arbitrary text that
the command can use however it pleases.  Currently recognized commands
are</p>
<pre class="verbatim"><ol><li>    =pod</li><li>    =head1 Heading Text</li><li>    =head2 Heading Text</li><li>    =head3 Heading Text</li><li>    =head4 Heading Text</li><li>    =over indentlevel</li><li>    =item stuff</li><li>    =back</li><li>    =begin format</li><li>    =end format</li><li>    =for format text...</li><li>    =encoding type</li><li>    =cut</li></ol></pre><p>To explain them each in detail:</p>
<ul>
<li><a name="%3dhead1-_Heading-Text_"></a><b><code class="inline">=head1 <i>Heading Text</i></code>
   
   </b>
</li>
<li><a name="%3dhead2-_Heading-Text_"></a><b><code class="inline">=head2 <i>Heading Text</i></code></b>
</li>
<li><a name="%3dhead3-_Heading-Text_"></a><b><code class="inline">=head3 <i>Heading Text</i></code></b>
</li>
<li><a name="%3dhead4-_Heading-Text_"></a><b><code class="inline">=head4 <i>Heading Text</i></code></b>
<p>Head1 through head4 produce headings, head1 being the highest
level.  The text in the rest of this paragraph is the content of the
heading.  For example:</p>
<pre class="verbatim"><ol><li>  =<span class="w">head2</span> <span class="w">Object</span> <span class="w">Attributes</span></li></ol></pre><p>The text "Object Attributes" comprises the heading there.
The text in these heading commands can use formatting codes, as seen here:</p>
<pre class="verbatim"><ol><li>  =<span class="w">head2</span> <span class="w">Possible</span> <span class="w">Values</span> for <span class="w">C</span><span class="q">&lt;$/&gt;</span></li></ol></pre><p>Such commands are explained in the
"<a href="#Formatting-Codes">Formatting Codes</a>" section, below.</p>
</li>
<li><a name="%3dover-_indentlevel_"></a><b><code class="inline">=over <i>indentlevel</i></code>
     </b>
</li>
<li><a name="%3ditem-_stuff..._"></a><b><code class="inline">=item <i>stuff...</i></code></b>
</li>
<li><a name="%3dback"></a><b><code class="inline"><span class="pd">=back</span></code>
</b>
<p>Item, over, and back require a little more explanation:  "=over" starts
a region specifically for the generation of a list using "=item"
commands, or for indenting (groups of) normal paragraphs.  At the end
of your list, use "=back" to end it.  The <i>indentlevel</i> option to
"=over" indicates how far over to indent, generally in ems (where
one em is the width of an "M" in the document's base font) or roughly
comparable units; if there is no <i>indentlevel</i> option, it defaults
to four.  (And some formatters may just ignore whatever <i>indentlevel</i>
you provide.)  In the <i>stuff</i> in <code class="inline">=item <i>stuff...</i></code>, you may
use formatting codes, as seen here:</p>
<pre class="verbatim"><ol><li>  =<span class="w">item</span> <span class="w">Using</span> <span class="w">C</span>&lt;<span class="i">$|</span>&gt; <span class="w">to</span> <span class="w">Control</span> <span class="w">Buffering</span></li></ol></pre><p>Such commands are explained in the
"<a href="#Formatting-Codes">Formatting Codes</a>" section, below.</p>
<p>Note also that there are some basic rules to using "=over" ...
"=back" regions:</p>
<ul>
<li>
<p>Don't use "=item"s outside of an "=over" ... "=back" region.</p>
</li>
<li>
<p>The first thing after the "=over" command should be an "=item", unless
there aren't going to be any items at all in this "=over" ... "=back"
region.</p>
</li>
<li>
<p>Don't put "=head<i>n</i>" commands inside an "=over" ... "=back" region.</p>
</li>
<li>
<p>And perhaps most importantly, keep the items consistent: either use
"=item *" for all of them, to produce bullets; or use "=item 1.",
"=item 2.", etc., to produce numbered lists; or use "=item foo",
"=item bar", etc.--namely, things that look nothing like bullets or
numbers.</p>
<p>If you start with bullets or numbers, stick with them, as
formatters use the first "=item" type to decide how to format the
list.</p>
</li>
</ul>
</li>
<li><a name="%3dcut"></a><b><code class="inline"><span class="pd">=cut</span></code>

 </b>
<p>To end a Pod block, use a blank line,
then a line beginning with "=cut", and a blank
line after it.  This lets Perl (and the Pod formatter) know that
this is where Perl code is resuming.  (The blank line before the "=cut"
is not technically necessary, but many older Pod processors require it.)</p>
</li>
<li><a name="%3dpod"></a><b><code class="inline"><span class="pd">=pod</span></code>

 </b>
<p>The "=pod" command by itself doesn't do much of anything, but it
signals to Perl (and Pod formatters) that a Pod block starts here.  A
Pod block starts with <i>any</i> command paragraph, so a "=pod" command is
usually used just when you want to start a Pod block with an ordinary
paragraph or a verbatim paragraph.  For example:</p>
<pre class="verbatim"><ol><li>  =item stuff()</li><li></li><li>  This function does stuff.</li><li></li><li>  =cut</li><li></li><li>  sub stuff {</li><li>    ...</li><li>  }</li><li></li><li>  =pod</li><li></li><li>  Remember to check its return value, as in:</li><li></li><li>    stuff() || die "Couldn't do stuff!";</li><li></li><li>  =cut</li></ol></pre></li>
<li><a name="%3dbegin-_formatname_"></a><b><code class="inline">=begin <i>formatname</i></code>
     </b>
</li>
<li><a name="%3dend-_formatname_"></a><b><code class="inline">=end <i>formatname</i></code></b>
</li>
<li><a name="%3dfor-_formatname_-_text..._"></a><b><code class="inline">=for <i>formatname</i> <i>text...</i></code></b>
<p>For, begin, and end will let you have regions of text/code/data that
are not generally interpreted as normal Pod text, but are passed
directly to particular formatters, or are otherwise special.  A
formatter that can use that format will use the region, otherwise it
will be completely ignored.</p>
<p>A command "=begin <i>formatname</i>", some paragraphs, and a
command "=end <i>formatname</i>", mean that the text/data in between
is meant for formatters that understand the special format
called <i>formatname</i>.  For example,</p>
<pre class="verbatim"><ol><li>  =begin html</li><li></li><li>  &lt;hr&gt; &lt;img src="thang.png"&gt;</li><li>  &lt;p&gt; This is a raw HTML paragraph &lt;/p&gt;</li><li></li><li>  =end html</li></ol></pre><p>The command "=for <i>formatname</i> <i>text...</i>"
specifies that the remainder of just this paragraph (starting
right after <i>formatname</i>) is in that special format.</p>
<pre class="verbatim"><ol><li>  =for html &lt;hr&gt; &lt;img src="thang.png"&gt;</li><li>  &lt;p&gt; This is a raw HTML paragraph &lt;/p&gt;</li></ol></pre><p>This means the same thing as the above "=begin html" ... "=end html"
region.</p>
<p>That is, with "=for", you can have only one paragraph's worth
of text (i.e., the text in "=foo targetname text..."), but with
"=begin targetname" ... "=end targetname", you can have any amount
of stuff in between.  (Note that there still must be a blank line
after the "=begin" command and a blank line before the "=end"
command.)</p>
<p>Here are some examples of how to use these:</p>
<pre class="verbatim"><ol><li>  =begin html</li><li></li><li>  &lt;br&gt;Figure 1.&lt;br&gt;&lt;IMG SRC="figure1.png"&gt;&lt;br&gt;</li><li></li><li>  =end html</li><li></li><li>  =begin text</li><li></li><li>    ---------------</li><li>    |  foo        |</li><li>    |        bar  |</li><li>    ---------------</li><li></li><li>  ^^^^ Figure 1. ^^^^</li><li></li><li>  =end text</li></ol></pre><p>Some format names that formatters currently are known to accept
include "roff", "man", "latex", "tex", "text", and "html".  (Some
formatters will treat some of these as synonyms.)</p>
<p>A format name of "comment" is common for just making notes (presumably
to yourself) that won't appear in any formatted version of the Pod
document:</p>
<pre class="verbatim"><ol><li>  =for <span class="w">comment</span></li><li>  <span class="w">Make</span> <span class="w">sure</span> <span class="w">that</span> <span class="w">all</span> <span class="w">the</span> <span class="w">available</span> <span class="w">options</span> <span class="w">are</span> <span class="w">documented</span>!</li></ol></pre><p>Some <i>formatnames</i> will require a leading colon (as in
<code class="inline"><span class="q">&quot;=for :formatname&quot;</span></code>
, or
<code class="inline"><span class="q">&quot;=begin :formatname&quot;</span> ... <span class="q">&quot;=end :formatname&quot;</span></code>
),
to signal that the text is not raw data, but instead <i>is</i> Pod text
(i.e., possibly containing formatting codes) that's just not for
normal formatting (e.g., may not be a normal-use paragraph, but might
be for formatting as a footnote).</p>
</li>
<li><a name="%3dencoding-_encodingname_"></a><b><code class="inline">=encoding <i>encodingname</i></code>
 </b>
<p>This command is used for declaring the encoding of a document.  Most
users won't need this; but if your encoding isn't US-ASCII,
then put a <code class="inline">=encoding <i>encodingname</i></code> command very early in the document so
that pod formatters will know how to decode the document.  For
<i>encodingname</i>, use a name recognized by the <a href="Encode/Supported.html">Encode::Supported</a>
module.  Some pod formatters may try to guess between a Latin-1 or
CP-1252 versus
UTF-8 encoding, but they may guess wrong.  It's best to be explicit if
you use anything besides strict ASCII.  Examples:</p>
<pre class="verbatim"><ol><li>  =<span class="w">encoding</span> <span class="w">latin1</span></li><li></li><li>  =<span class="w">encoding</span> <span class="w">utf8</span></li><li></li><li>  =<span class="w">encoding</span> <span class="w">koi8</span>-<span class="w">r</span></li><li></li><li>  =<span class="w">encoding</span> <span class="w">ShiftJIS</span></li><li></li><li>  =<span class="w">encoding</span> <span class="w">big5</span></li></ol></pre><p><code class="inline"><span class="pd">=encoding</span></code>
 affects the whole document, and must occur only once.</p>
</li>
</ul>
<p>And don't forget, all commands but <code class="inline"><span class="pd">=encoding</span></code>
 last up
until the end of its <i>paragraph</i>, not its line.  So in the
examples below, you can see that every command needs the blank
line after it, to end its paragraph.  (And some older Pod translators
may require the <code class="inline"><span class="pd">=encoding</span></code>
 line to have a following blank line as
well, even though it should be legal to omit.)</p>
<p>Some examples of lists include:</p>
<pre class="verbatim"><ol><li>  =over</li><li></li><li>  =item *</li><li></li><li>  First item</li><li></li><li>  =item *</li><li></li><li>  Second item</li><li></li><li>  =back</li><li></li><li>  =over</li><li></li><li>  =item Foo()</li><li></li><li>  Description of Foo function</li><li></li><li>  =item Bar()</li><li></li><li>  Description of Bar function</li><li></li><li>  =back</li></ol></pre><a name="Formatting-Codes"></a><h2>Formatting Codes
 
 </h2>
<p>In ordinary paragraphs and in some command paragraphs, various
formatting codes (a.k.a. "interior sequences") can be used:</p>
<ul>
<li><a name="I%3ctext%3e----italic-text"></a><b><code class="inline"><span class="w">I</span><span class="q">&lt;text&gt;</span></code>
 -- italic text
   </b>
<p>Used for emphasis ("<code class="inline"><span class="w">be</span> <span class="w">I</span><span class="q">&lt;careful!&gt;</span></code>
") and parameters
("<code class="inline"><a class="l_k" href="functions/redo.html">redo</a> <span class="j">I</span><span class="q">&lt;LABEL&gt;</span></code>
")</p>
</li>
<li><a name="B%3ctext%3e----bold-text"></a><b><code class="inline"><span class="w">B</span><span class="q">&lt;text&gt;</span></code>
 -- bold text
   </b>
<p>Used for switches ("<code class="inline"><span class="w">perl&#39;s</span> <span class="w">B</span><span class="q">&lt;-n&gt;</span> switch</code>
"), programs
("<code class="inline"><span class="w">some</span> <span class="w">systems</span> <span class="w">provide</span> <span class="w">a</span> <span class="w">B</span><span class="q">&lt;chfn&gt;</span> for <span class="w">that</span></code>
"),
emphasis ("<code class="inline"><span class="w">be</span> <span class="w">B</span><span class="q">&lt;careful!&gt;</span></code>
"), and so on
("<code class="inline">and <span class="w">that</span> <span class="w">feature</span> <span class="w">is</span> <span class="w">known</span> <span class="w">as</span> <span class="w">B</span><span class="q">&lt;autovivification&gt;</span></code>
").</p>
</li>
<li><a name="C%3ccode%3e----code-text"></a><b><code class="inline"><span class="w">C</span><span class="q">&lt;code&gt;</span></code>
 -- code text
   </b>
<p>Renders code in a typewriter font, or gives some other indication that
this represents program text ("<code class="inline"><span class="w">C</span><span class="q">&lt;gmtime($^T)&gt;</span></code>
") or some other
form of computerese ("<code class="inline"><span class="w">C</span><span class="q">&lt;drwxr-xr-x&gt;</span></code>
").</p>
</li>
<li><a name="L%3cname%3e----a-hyperlink"></a><b><code class="inline"><span class="w">L</span><span class="q">&lt;name&gt;</span></code>
 -- a hyperlink
   </b>
<p>There are various syntaxes, listed below.  In the syntaxes given,
<code class="inline"><span class="w">text</span></code>
, <code class="inline"><span class="w">name</span></code>
, and <code class="inline"><span class="w">section</span></code>
 cannot contain the characters
'/' and '|'; and any '&lt;' or '&gt;' should be matched.</p>
<ul>
<li>
<p><code class="inline"><span class="w">L</span><span class="q">&lt;name&gt;</span></code>
</p>
<p>Link to a Perl manual page (e.g., <code class="inline"><span class="w">L</span><span class="q">&lt;Net::Ping&gt;</span></code>
).  Note
that <code class="inline"><span class="w">name</span></code>
 should not contain spaces.  This syntax
is also occasionally used for references to Unix man pages, as in
<code class="inline"><span class="w">L</span><span class="q">&lt;crontab(5)&gt;</span></code>
.</p>
</li>
<li>
<p><code class="inline"><span class="w">L</span><span class="q">&lt;name/&quot;sec&quot;&gt;</span></code>
 or <code class="inline"><span class="w">L</span><span class="q">&lt;name/sec&gt;</span></code>
</p>
<p>Link to a section in other manual page.  E.g.,
<code class="inline"><span class="w">L</span><span class="q">&lt;perlsyn/&quot;For Loops&quot;&gt;</span></code>
</p>
</li>
<li>
<p><code class="inline"><span class="w">L</span><span class="q">&lt;/&quot;sec&quot;&gt;</span></code>
 or <code class="inline"><span class="w">L</span><span class="q">&lt;/sec&gt;</span></code>
</p>
<p>Link to a section in this manual page.  E.g.,
<code class="inline"><span class="w">L</span><span class="q">&lt;/&quot;Object Methods&quot;&gt;</span></code>
</p>
</li>
</ul>
<p>A section is started by the named heading or item.  For
example, <code class="inline"><span class="w">L</span><span class="q">&lt;perlvar/$.&gt;</span></code>
 or <code class="inline"><span class="w">L</span><span class="q">&lt;perlvar/&quot;$.&quot;&gt;</span></code>
 both
link to the section started by "<code class="inline"><span class="pd">=item $.</span></code>
" in perlvar.  And
<code class="inline"><span class="w">L</span><span class="q">&lt;perlsyn/For Loops&gt;</span></code>
 or <code class="inline"><span class="w">L</span><span class="q">&lt;perlsyn/&quot;For Loops&quot;&gt;</span></code>

both link to the section started by "<code class="inline"><span class="pd">=head2 For Loops</span></code>
"
in perlsyn.</p>
<p>To control what text is used for display, you
use "<code class="inline">L&lt;text|...&gt;</code>", as in:</p>
<ul>
<li>
<p><code class="inline"><span class="w">L</span>&lt;<span class="w">text</span>|<span class="w">name</span>&gt;</code>
</p>
<p>Link this text to that manual page.  E.g.,
<code class="inline"><span class="w">L</span>&lt;<span class="w">Perl</span> <span class="w">Error</span> <span class="w">Messages</span>|<span class="w">perldiag</span>&gt;</code>
</p>
</li>
<li>
<p><code class="inline">L&lt;text|name/"sec"&gt;</code> or <code class="inline"><span class="w">L</span>&lt;<span class="w">text</span>|<span class="w">name</span>/<span class="w">sec</span>&gt;</code>
</p>
<p>Link this text to that section in that manual page.  E.g.,
<code class="inline">L&lt;postfix "if"|perlsyn/"Statement Modifiers"&gt;</code></p>
</li>
<li>
<p><code class="inline">L&lt;text|/"sec"&gt;</code> or <code class="inline">L&lt;text|/sec&gt;</code>
or <code class="inline"><span class="w">L</span>&lt;<span class="w">text</span>|<span class="q">&quot;sec&quot;</span>&gt;</code>
</p>
<p>Link this text to that section in this manual page.  E.g.,
<code class="inline">L&lt;the various attributes|/"Member Data"&gt;</code></p>
</li>
</ul>
<p>Or you can link to a web page:</p>
<ul>
<li>
<p><code class="inline"><span class="w">L</span><span class="q">&lt;scheme:...&gt;</span></code>
</p>
<p><code class="inline">L&lt;text|scheme:...&gt;</code></p>
<p>Links to an absolute URL.  For example, <code class="inline">L&lt;<a href="http://www.perl.org/">http://www.perl.org/</a>&gt;</code> or
<code class="inline">L&lt;The Perl Home Page|<a href="http://www.perl.org/">http://www.perl.org/</a>&gt;</code>.</p>
</li>
</ul>
</li>
<li><a name="E%3cescape%3e----a-character-escape"></a><b><code class="inline"><span class="w">E</span><span class="q">&lt;escape&gt;</span></code>
 -- a character escape
   </b>
<p>Very similar to HTML/XML <code class="inline">&amp;<i>foo</i>;</code> "entity references":</p>
<ul>
<li>
<p><code class="inline"><span class="w">E</span><span class="q">&lt;lt&gt;</span></code>
 -- a literal &lt; (less than)</p>
</li>
<li>
<p><code class="inline"><span class="w">E</span><span class="q">&lt;gt&gt;</span></code>
 -- a literal &gt; (greater than)</p>
</li>
<li>
<p><code class="inline"><span class="w">E</span><span class="q">&lt;verbar&gt;</span></code>
 -- a literal | (<i>ver</i>tical <i>bar</i>)</p>
</li>
<li>
<p><code class="inline"><span class="w">E</span><span class="q">&lt;sol&gt;</span></code>
 -- a literal / (<i>sol</i>idus)</p>
<p>The above four are optional except in other formatting codes,
notably <code class="inline"><span class="w">L</span><span class="q">&lt;...&gt;</span></code>
, and when preceded by a
capital letter.</p>
</li>
<li>
<p><code class="inline"><span class="w">E</span><span class="q">&lt;htmlname&gt;</span></code>
</p>
<p>Some non-numeric HTML entity name, such as <code class="inline"><span class="w">E</span><span class="q">&lt;eacute&gt;</span></code>
,
meaning the same thing as <code class="inline"><span class="i">&amp;eacute</span><span class="sc">;</span></code>
 in HTML -- i.e., a lowercase
e with an acute (/-shaped) accent.</p>
</li>
<li>
<p><code class="inline"><span class="w">E</span><span class="q">&lt;number&gt;</span></code>
</p>
<p>The ASCII/Latin-1/Unicode character with that number.  A
leading "0x" means that <i>number</i> is hex, as in
<code class="inline"><span class="w">E</span><span class="q">&lt;0x201E&gt;</span></code>
.  A leading "0" means that <i>number</i> is octal,
as in <code class="inline"><span class="w">E</span><span class="q">&lt;075&gt;</span></code>
.  Otherwise <i>number</i> is interpreted as being
in decimal, as in <code class="inline"><span class="w">E</span><span class="q">&lt;181&gt;</span></code>
.</p>
<p>Note that older Pod formatters might not recognize octal or
hex numeric escapes, and that many formatters cannot reliably
render characters above 255.  (Some formatters may even have
to use compromised renderings of Latin-1/CP-1252 characters, like
rendering <code class="inline"><span class="w">E</span><span class="q">&lt;eacute&gt;</span></code>
 as just a plain "e".)</p>
</li>
</ul>
</li>
<li><a name="F%3cfilename%3e----used-for-filenames"></a><b><code class="inline"><span class="w">F</span><span class="q">&lt;filename&gt;</span></code>
 -- used for filenames
   </b>
<p>Typically displayed in italics.  Example: "<code class="inline"><span class="w">F</span><span class="q">&lt;.cshrc&gt;</span></code>
"</p>
</li>
<li><a name="S%3ctext%3e----text-contains-non-breaking-spaces"></a><b><code class="inline"><span class="w">S</span><span class="q">&lt;text&gt;</span></code>
 -- text contains non-breaking spaces
   
</b>
<p>This means that the words in <i>text</i> should not be broken
across lines.  Example: <code class="inline"><span class="w">S</span><span class="q">&lt;$x ? $y : $z&gt;</span></code>
.</p>
</li>
<li><a name="X%3ctopic-name%3e----an-index-entry"></a><b><code class="inline"><span class="w">X</span><span class="q">&lt;topic name&gt;</span></code>
 -- an index entry
   </b>
<p>This is ignored by most formatters, but some may use it for building
indexes.  It always renders as empty-string.
Example: <code class="inline"><span class="w">X</span><span class="q">&lt;absolutizing relative URLs&gt;</span></code>
</p>
</li>
<li><a name="Z%3c%3e----a-null-(zero-effect)-formatting-code"></a><b><code class="inline"><span class="w">Z</span>&lt;&gt;</code>
 -- a null (zero-effect) formatting code
   </b>
<p>This is rarely used.  It's one way to get around using an
E&lt;...&gt; code sometimes.  For example, instead of
"<code class="inline">NE&lt;lt&gt;3</code>" (for "N&lt;3") you could write
"<code class="inline"><span class="w">NZ</span>&lt;&gt;&lt;<span class="n">3</span></code>
" (the "Z&lt;&gt;" breaks up the "N" and
the "&lt;" so they can't be considered
the part of a (fictitious) "N&lt;...&gt;" code).</p>
</li>
</ul>
<p>Most of the time, you will need only a single set of angle brackets to
delimit the beginning and end of formatting codes.  However,
sometimes you will want to put a real right angle bracket (a
greater-than sign, '&gt;') inside of a formatting code.  This is particularly
common when using a formatting code to provide a different font-type for a
snippet of code.  As with all things in Perl, there is more than
one way to do it.  One way is to simply escape the closing bracket
using an <code class="inline"><span class="w">E</span></code>
 code:</p>
<pre class="verbatim"><ol><li>    C&lt;$a E&lt;lt&gt;=E&lt;gt&gt; $b&gt;</li></ol></pre><p>This will produce: "<code class="inline"><span class="i">$a</span> &lt;=&gt; <span class="i">$b</span></code>
"</p>
<p>A more readable, and perhaps more "plain" way is to use an alternate
set of delimiters that doesn't require a single "&gt;" to be escaped.
Doubled angle brackets ("&lt;&lt;" and "&gt;&gt;") may be used <i>if and only if there is
whitespace right after the opening delimiter and whitespace right
before the closing delimiter!</i>  For example, the following will
do the trick:
</p>
<pre class="verbatim"><ol><li>    <span class="w">C</span>&lt;&lt; <span class="i">$a</span> &lt;=&gt; <span class="i">$b</span> &gt;&gt;</li></ol></pre><p>In fact, you can use as many repeated angle-brackets as you like so
long as you have the same number of them in the opening and closing
delimiters, and make sure that whitespace immediately follows the last
'&lt;' of the opening delimiter, and immediately precedes the first '&gt;'
of the closing delimiter.  (The whitespace is ignored.)  So the
following will also work:
</p>
<pre class="verbatim"><ol><li>    C&lt;&lt;&lt; $a &lt;=&gt; $b &gt;&gt;&gt;</li><li>    C&lt;&lt;&lt;&lt;  $a &lt;=&gt; $b     &gt;&gt;&gt;&gt;</li></ol></pre><p>And they all mean exactly the same as this:</p>
<pre class="verbatim"><ol><li>    C&lt;$a E&lt;lt&gt;=E&lt;gt&gt; $b&gt;</li></ol></pre><p>The multiple-bracket form does not affect the interpretation of the contents of
the formatting code, only how it must end.  That means that the examples above
are also exactly the same as this:</p>
<pre class="verbatim"><ol><li>    C&lt;&lt; $a E&lt;lt&gt;=E&lt;gt&gt; $b &gt;&gt;</li></ol></pre><p>As a further example, this means that if you wanted to put these bits of
code in <code class="inline"><span class="w">C</span></code>
 (code) style:</p>
<pre class="verbatim"><ol><li>    open(X, "&gt;&gt;thing.dat") || die $!</li><li>    $foo-&gt;bar();</li></ol></pre><p>you could do it like so:</p>
<pre class="verbatim"><ol><li>    C&lt;&lt;&lt; open(X, "&gt;&gt;thing.dat") || die $! &gt;&gt;&gt;</li><li>    C&lt;&lt; $foo-&gt;bar(); &gt;&gt;</li></ol></pre><p>which is presumably easier to read than the old way:</p>
<pre class="verbatim"><ol><li>    C&lt;open(X, "E&lt;gt&gt;E&lt;gt&gt;thing.dat") || die $!&gt;</li><li>    C&lt;$foo-E&lt;gt&gt;bar();&gt;</li></ol></pre><p>This is currently supported by pod2text (Pod::Text), pod2man (Pod::Man),
and any other pod2xxx or Pod::Xxxx translators that use
Pod::Parser 1.093 or later, or Pod::Tree 1.02 or later.</p>
<a name="The-Intent"></a><h2>The Intent
</h2>
<p>The intent is simplicity of use, not power of expression.  Paragraphs
look like paragraphs (block format), so that they stand out
visually, and so that I could run them through <code class="inline"><span class="w">fmt</span></code>
 easily to reformat
them (that's F7 in my version of <b>vi</b>, or Esc Q in my version of
<b>emacs</b>).  I wanted the translator to always leave the <code class="inline">'</code> and <code class="inline">`</code> and
<code class="inline">"</code> quotes alone, in verbatim mode, so I could slurp in a
working program, shift it over four spaces, and have it print out, er,
verbatim.  And presumably in a monospace font.</p>
<p>The Pod format is not necessarily sufficient for writing a book.  Pod
is just meant to be an idiot-proof common source for nroff, HTML,
TeX, and other markup languages, as used for online
documentation.  Translators exist for <b>pod2text</b>, <b>pod2html</b>,
<b>pod2man</b> (that's for nroff(1) and troff(1)), <b>pod2latex</b>, and
<b>pod2fm</b>.  Various others are available in CPAN.</p>
<a name="Embedding-Pods-in-Perl-Modules"></a><h2>Embedding Pods in Perl Modules
</h2>
<p>You can embed Pod documentation in your Perl modules and scripts.  Start
your documentation with an empty line, a "=head1" command at the
beginning, and end it with a "=cut" command and an empty line.  The
<b>perl</b> executable will ignore the Pod text.  You can place a Pod
statement where <b>perl</b> expects the beginning of a new statement, but
not within a statement, as that would result in an error.  See any of
the supplied library modules for examples.</p>
<p>If you're going to put your Pod at the end of the file, and you're using
an <code class="inline"><a name="__END__"></a>__END__</code>
 or <code class="inline"><a name="__DATA__"></a>__DATA__</code>
 cut mark, make sure to put an empty line there
before the first Pod command.</p>
<pre class="verbatim"><ol><li><a name="__END__"></a>  __END__</li><li></li><li><span class="q">  =head1 NAME</span></li><li></li><li><span class="q">  Time::Local - efficiently compute time from local and GMT time</span></li></ol></pre><p>Without that empty line before the "=head1", many translators wouldn't
have recognized the "=head1" as starting a Pod block.</p>
<a name="Hints-for-Writing-Pod"></a><h2>Hints for Writing Pod</h2>
<ul>
<li>
<p>The <b>podchecker</b> command is provided for checking Pod syntax for errors
and warnings.  For example, it checks for completely blank lines in
Pod blocks and for unknown commands and formatting codes.  You should
still also pass your document through one or more translators and proofread
the result, or print out the result and proofread that.  Some of the
problems found may be bugs in the translators, which you may or may not
wish to work around.</p>
</li>
<li>
<p>If you're more familiar with writing in HTML than with writing in Pod, you
can try your hand at writing documentation in simple HTML, and converting
it to Pod with the experimental <a href="http://search.cpan.org/perldoc/Pod::HTML2Pod">Pod::HTML2Pod</a> module,
(available in CPAN), and looking at the resulting code.  The experimental
<a href="http://search.cpan.org/perldoc/Pod::PXML">Pod::PXML</a> module in CPAN might also be useful.</p>
</li>
<li>
<p>Many older Pod translators require the lines before every Pod
command and after every Pod command (including "=cut"!) to be a blank
line.  Having something like this:</p>
<pre class="verbatim"><ol><li> # - - - - - - - - - - - -</li><li> =item $firecracker-&gt;boom()</li><li></li><li> This noisily detonates the firecracker object.</li><li> =cut</li><li> sub boom {</li><li> ...</li></ol></pre><p>...will make such Pod translators completely fail to see the Pod block
at all.</p>
<p>Instead, have it like this:</p>
<pre class="verbatim"><ol><li> # - - - - - - - - - - - -</li><li></li><li> =item $firecracker-&gt;boom()</li><li></li><li> This noisily detonates the firecracker object.</li><li></li><li> =cut</li><li></li><li> sub boom {</li><li> ...</li></ol></pre></li>
<li>
<p>Some older Pod translators require paragraphs (including command
paragraphs like "=head2 Functions") to be separated by <i>completely</i>
empty lines.  If you have an apparently empty line with some spaces
on it, this might not count as a separator for those translators, and
that could cause odd formatting.</p>
</li>
<li>
<p>Older translators might add wording around an L&lt;&gt; link, so that
<code class="inline"><span class="w">L</span><span class="q">&lt;Foo::Bar&gt;</span></code>
 may become "the Foo::Bar manpage", for example.
So you shouldn't write things like <code class="inline">the L&lt;foo&gt;
documentation</code>, if you want the translated document to read sensibly.
Instead, write <code class="inline"><span class="w">the</span> <span class="w">L</span>&lt;<span class="w">Foo::Bar</span>|<span class="w">Foo::Bar</span>&gt; <span class="w">documentation</span></code>
 or
<code class="inline"><span class="w">L</span>&lt;<span class="w">the</span> <span class="w">Foo::Bar</span> <span class="w">documentation</span>|<span class="w">Foo::Bar</span>&gt;</code>
, to control how the
link comes out.</p>
</li>
<li>
<p>Going past the 70th column in a verbatim block might be ungracefully
wrapped by some formatters.</p>
</li>
</ul>
<a name="SEE-ALSO"></a><h1>SEE ALSO</h1>
<p><a href="perlpodspec.html">perlpodspec</a>, <a href="perlsyn.html#PODs%3a-Embedded-Documentation">PODs: Embedded Documentation in perlsyn</a>,
<a href="perlnewmod.html">perlnewmod</a>, <a href="perldoc.html">perldoc</a>, <a href="pod2html.html">pod2html</a>, <a href="pod2man.html">pod2man</a>, <a href="podchecker.html">podchecker</a>.</p>
<a name="AUTHOR"></a><h1>AUTHOR</h1>
<p>Larry Wall, Sean M. Burke</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="#DESCRIPTION">DESCRIPTION</a><ul><li><a href="#Ordinary-Paragraph">Ordinary Paragraph
</a><li><a href="#Verbatim-Paragraph">Verbatim Paragraph
 </a><li><a href="#Command-Paragraph">Command Paragraph
</a><li><a href="#Formatting-Codes">Formatting Codes
 
 </a><li><a href="#The-Intent">The Intent
</a><li><a href="#Embedding-Pods-in-Perl-Modules">Embedding Pods in Perl Modules
</a><li><a href="#Hints-for-Writing-Pod">Hints for Writing Pod</a></ul><li><a href="#SEE-ALSO">SEE ALSO</a><li><a href="#AUTHOR">AUTHOR</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    = 'perlpod';
  perldoc.pageAddress = 'perlpod.html';
  perldoc.contentPage = 1;
  explorePerl.render();
  explorePerl.addEvents('explore_anchor');
</script>
    
  </body>
</html>