File: pod2html.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 (584 lines) | stat: -rw-r--r-- 22,613 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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
  <title>pod2html - 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>pod2html</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;
      
    
    pod2html
  

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


  <!--    -->
<ul><li><a href="#NAME">NAME</a><li><a href="#SYNOPSIS">SYNOPSIS</a><li><a href="#DESCRIPTION">DESCRIPTION</a><li><a href="#ARGUMENTS">ARGUMENTS</a><li><a href="#AUTHOR">AUTHOR</a><li><a href="#BUGS">BUGS</a><li><a href="#SEE-ALSO">SEE ALSO</a><li><a href="#COPYRIGHT">COPYRIGHT</a></ul><a name="NAME"></a><h1>NAME</h1>
<p>pod2html - convert .pod files to .html files</p>
<a name="SYNOPSIS"></a><h1>SYNOPSIS</h1>
<pre class="verbatim"><ol><li>    <span class="w">pod2html</span> --<span class="w">help</span> --<span class="w">htmldir</span>=<span class="q">&lt;name&gt;</span> --<span class="w">htmlroot</span>=<span class="q">&lt;URL&gt;</span></li><li>             --<span class="w">infile</span>=<span class="q">&lt;name&gt;</span> --<span class="w">outfile</span>=<span class="q">&lt;name&gt;</span></li><li>             --<span class="w">podpath</span>=<span class="q">&lt;name&gt;</span><span class="co">:</span>...<span class="co">:</span><span class="q">&lt;name&gt;</span> --<span class="w">podroot</span>=<span class="q">&lt;name&gt;</span></li><li>             --<span class="w">cachedir</span>=<span class="q">&lt;name&gt;</span> --<span class="w">flush</span> --<span class="w">recurse</span> --<span class="w">norecurse</span></li><li>             --<span class="w">quiet</span> --<span class="w">noquiet</span> --<span class="w">verbose</span> --<span class="w">noverbose</span></li><li>             --<a class="l_k" href="functions/index.html">index</a> --<span class="w">noindex</span> --<span class="w">backlink</span> --<span class="w">nobacklink</span></li><li>             --<span class="w">header</span> --<span class="w">noheader</span> --<span class="w">poderrors</span> --<span class="w">nopoderrors</span></li><li>             --<span class="w">css</span>=<span class="q">&lt;URL&gt;</span> --<span class="w">title</span>=<span class="q">&lt;name&gt;</span></li></ol></pre><a name="DESCRIPTION"></a><h1>DESCRIPTION</h1>
<p>Converts files from pod format (see <a href="perlpod.html">perlpod</a>) to HTML format.</p>
<a name="ARGUMENTS"></a><h1>ARGUMENTS</h1>
<p>pod2html takes the following arguments:</p>
<ul>
<li><a name="help"></a><b>help</b>
<pre class="verbatim"><ol><li>  --<span class="w">help</span></li></ol></pre><p>Displays the usage message.</p>
</li>
<li><a name="htmldir"></a><b>htmldir</b>
<pre class="verbatim"><ol><li>  --<span class="w">htmldir</span>=<span class="w">name</span></li></ol></pre><p>Sets the directory to which all cross references in the resulting HTML file
will be relative. Not passing this causes all links to be absolute since this
is the value that tells Pod::Html the root of the documentation tree.</p>
<p>Do not use this and --htmlroot in the same call to pod2html; they are mutually
exclusive.</p>
</li>
<li><a name="htmlroot"></a><b>htmlroot</b>
<pre class="verbatim"><ol><li>  --<span class="w">htmlroot</span>=<span class="w">URL</span></li></ol></pre><p>Sets the base URL for the HTML files.  When cross-references are made, the
HTML root is prepended to the URL.</p>
<p>Do not use this if relative links are desired: use --htmldir instead.</p>
<p>Do not pass both this and --htmldir to pod2html; they are mutually exclusive.</p>
</li>
<li><a name="infile"></a><b>infile</b>
<pre class="verbatim"><ol><li>  --<span class="w">infile</span>=<span class="w">name</span></li></ol></pre><p>Specify the pod file to convert.  Input is taken from STDIN if no
infile is specified.</p>
</li>
<li><a name="outfile"></a><b>outfile</b>
<pre class="verbatim"><ol><li>  --<span class="w">outfile</span>=<span class="w">name</span></li></ol></pre><p>Specify the HTML file to create.  Output goes to STDOUT if no outfile
is specified.</p>
</li>
<li><a name="podroot"></a><b>podroot</b>
<pre class="verbatim"><ol><li>  --<span class="w">podroot</span>=<span class="w">name</span></li></ol></pre><p>Specify the base directory for finding library pods.</p>
</li>
<li><a name="podpath"></a><b>podpath</b>
<pre class="verbatim"><ol><li>  --podpath=name:...:name</li></ol></pre><p>Specify which subdirectories of the podroot contain pod files whose
HTML converted forms can be linked-to in cross-references.</p>
</li>
<li><a name="cachedir"></a><b>cachedir</b>
<pre class="verbatim"><ol><li>  --<span class="w">cachedir</span>=<span class="w">name</span></li></ol></pre><p>Specify which directory is used for storing cache. Default directory is the
current working directory.</p>
</li>
<li><a name="flush"></a><b>flush</b>
<pre class="verbatim"><ol><li>  --<span class="w">flush</span></li></ol></pre><p>Flush the cache.</p>
</li>
<li><a name="backlink"></a><b>backlink</b>
<pre class="verbatim"><ol><li>  --<span class="w">backlink</span></li></ol></pre><p>Turn =head1 directives into links pointing to the top of the HTML file.</p>
</li>
<li><a name="nobacklink"></a><b>nobacklink</b>
<pre class="verbatim"><ol><li>  --<span class="w">nobacklink</span></li></ol></pre><p>Do not turn =head1 directives into links pointing to the top of the HTML file
(default behaviour).</p>
</li>
<li><a name="header"></a><b>header</b>
<pre class="verbatim"><ol><li>  --<span class="w">header</span></li></ol></pre><p>Create header and footer blocks containing the text of the "NAME" section.</p>
</li>
<li><a name="noheader"></a><b>noheader</b>
<pre class="verbatim"><ol><li>  --<span class="w">noheader</span></li></ol></pre><p>Do not create header and footer blocks containing the text of the "NAME"
section (default behaviour).</p>
</li>
<li><a name="poderrors"></a><b>poderrors</b>
<pre class="verbatim"><ol><li>  --<span class="w">poderrors</span></li></ol></pre><p>Include a "POD ERRORS" section in the outfile if there were any POD errors in
the infile (default behaviour).</p>
</li>
<li><a name="nopoderrors"></a><b>nopoderrors</b>
<pre class="verbatim"><ol><li>  --<span class="w">nopoderrors</span></li></ol></pre><p>Do not include a "POD ERRORS" section in the outfile if there were any POD
errors in the infile.</p>
</li>
<li><a name="index"></a><b>index</b>
<pre class="verbatim"><ol><li>  --<a class="l_k" href="functions/index.html">index</a></li></ol></pre><p>Generate an index at the top of the HTML file (default behaviour).</p>
</li>
<li><a name="noindex"></a><b>noindex</b>
<pre class="verbatim"><ol><li>  --<span class="w">noindex</span></li></ol></pre><p>Do not generate an index at the top of the HTML file.</p>
</li>
<li><a name="recurse"></a><b>recurse</b>
<pre class="verbatim"><ol><li>  --<span class="w">recurse</span></li></ol></pre><p>Recurse into subdirectories specified in podpath (default behaviour).</p>
</li>
<li><a name="norecurse"></a><b>norecurse</b>
<pre class="verbatim"><ol><li>  --<span class="w">norecurse</span></li></ol></pre><p>Do not recurse into subdirectories specified in podpath.</p>
</li>
<li><a name="css"></a><b>css</b>
<pre class="verbatim"><ol><li>  --<span class="w">css</span>=<span class="w">URL</span></li></ol></pre><p>Specify the URL of cascading style sheet to link from resulting HTML file.
Default is none style sheet.</p>
</li>
<li><a name="title"></a><b>title</b>
<pre class="verbatim"><ol><li>  --<span class="w">title</span>=<span class="w">title</span></li></ol></pre><p>Specify the title of the resulting HTML file.</p>
</li>
<li><a name="quiet"></a><b>quiet</b>
<pre class="verbatim"><ol><li>  --<span class="w">quiet</span></li></ol></pre><p>Don't display mostly harmless warning messages.</p>
</li>
<li><a name="noquiet"></a><b>noquiet</b>
<pre class="verbatim"><ol><li>  --<span class="w">noquiet</span></li></ol></pre><p>Display mostly harmless warning messages (default behaviour). But this is not
the same as "verbose" mode.</p>
</li>
<li><a name="verbose"></a><b>verbose</b>
<pre class="verbatim"><ol><li>  --<span class="w">verbose</span></li></ol></pre><p>Display progress messages.</p>
</li>
<li><a name="noverbose"></a><b>noverbose</b>
<pre class="verbatim"><ol><li>  --<span class="w">noverbose</span></li></ol></pre><p>Do not display progress messages (default behaviour).</p>
</li>
</ul>
<a name="AUTHOR"></a><h1>AUTHOR</h1>
<p>Tom Christiansen, &lt;tchrist@perl.com&gt;.</p>
<a name="BUGS"></a><h1>BUGS</h1>
<p>See <a href="Pod/Html.html">Pod::Html</a> for a list of known bugs in the translator.</p>
<a name="SEE-ALSO"></a><h1>SEE ALSO</h1>
<p><a href="perlpod.html">perlpod</a>, <a href="Pod/Html.html">Pod::Html</a></p>
<a name="COPYRIGHT"></a><h1>COPYRIGHT</h1>
<p>This program is distributed under the Artistic License.</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="#ARGUMENTS">ARGUMENTS</a><li><a href="#AUTHOR">AUTHOR</a><li><a href="#BUGS">BUGS</a><li><a href="#SEE-ALSO">SEE ALSO</a><li><a href="#COPYRIGHT">COPYRIGHT</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    = 'pod2html';
  perldoc.pageAddress = 'pod2html.html';
  perldoc.contentPage = 1;
  explorePerl.render();
  explorePerl.addEvents('explore_anchor');
</script>
    
  </body>
</html>