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

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


  <!--    -->
<ul><li><a href="#NAME">NAME</a><li><a href="#DESCRIPTION">DESCRIPTION</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>perlpodstyle - Perl POD style guide</p>
<a name="DESCRIPTION"></a><h1>DESCRIPTION</h1>
<p>These are general guidelines for how to write POD documentation for Perl
scripts and modules, based on general guidelines for writing good UNIX man
pages.  All of these guidelines are, of course, optional, but following
them will make your documentation more consistent with other documentation
on the system.</p>
<p>The name of the program being documented is conventionally written in bold
(using B&lt;&gt;) wherever it occurs, as are all program options.
Arguments should be written in italics (I&lt;&gt;).  Function names are
traditionally written in italics; if you write a function as function(),
Pod::Man will take care of this for you.  Literal code or commands should
be in C&lt;&gt;.  References to other man pages should be in the form
<code class="inline"><span class="i">manpage</span><span class="s">(</span><span class="w">section</span><span class="s">)</span></code>
 or <code class="inline"><span class="w">L</span><span class="q">&lt;manpage(section)&gt;</span></code>
, and Pod::Man will
automatically format those appropriately.  The second form, with
L&lt;&gt;, is used to request that a POD formatter make a link to the
man page if possible.  As an exception, one normally omits the section
when referring to module documentation since it's not clear what section
module documentation will be in; use <code class="inline"><span class="w">L</span><span class="q">&lt;Module::Name&gt;</span></code>
 for module
references instead.</p>
<p>References to other programs or functions are normally in the form of man
page references so that cross-referencing tools can provide the user with
links and the like.  It's possible to overdo this, though, so be careful not
to clutter your documentation with too much markup.  References to other
programs that are not given as man page references should be enclosed in
B&lt;&gt;.</p>
<p>The major headers should be set out using a <code class="inline"><span class="pd">=head1</span></code>
 directive, and are
historically written in the rather startling ALL UPPER CASE format; this
is not mandatory, but it's strongly recommended so that sections have
consistent naming across different software packages.  Minor headers may
be included using <code class="inline"><span class="pd">=head2</span></code>
, and are typically in mixed case.</p>
<p>The standard sections of a manual page are:</p>
<ul>
<li><a name="NAME"></a><b>NAME</b>
<p>Mandatory section; should be a comma-separated list of programs or
functions documented by this POD page, such as:</p>
<pre class="verbatim"><ol><li>    <span class="w">foo</span><span class="cm">,</span> <span class="w">bar</span> - <span class="w">programs</span> <span class="w">to</span> <a class="l_k" href="functions/do.html">do</a> <span class="w">something</span></li></ol></pre><p>Manual page indexers are often extremely picky about the format of this
section, so don't put anything in it except this line.  Every program or
function documented by this POD page should be listed, separated by a
comma and a space.  For a Perl module, just give the module name.  A
single dash, and only a single dash, should separate the list of programs
or functions from the description.  Do not use any markup such as
C&lt;&gt; or B&lt;&gt; anywhere in this line.  Functions should not be
qualified with <code class="inline"><span class="s">(</span><span class="s">)</span></code>
 or the like.  The description should ideally fit on a
single line, even if a man program replaces the dash with a few tabs.</p>
</li>
<li><a name="SYNOPSIS"></a><b>SYNOPSIS</b>
<p>A short usage summary for programs and functions.  This section is
mandatory for section 3 pages.  For Perl module documentation, it's
usually convenient to have the contents of this section be a verbatim
block showing some (brief) examples of typical ways the module is used.</p>
</li>
<li><a name="DESCRIPTION"></a><b>DESCRIPTION</b>
<p>Extended description and discussion of the program or functions, or the
body of the documentation for man pages that document something else.  If
particularly long, it's a good idea to break this up into subsections
<code class="inline"><span class="pd">=head2</span></code>
 directives like:</p>
<pre class="verbatim"><ol><li>    =<span class="w">head2</span> <span class="w">Normal</span> <span class="w">Usage</span></li><li></li><li>    =<span class="w">head2</span> <span class="w">Advanced</span> <span class="w">Features</span></li><li></li><li>    =<span class="w">head2</span> <span class="w">Writing</span> <span class="w">Configuration</span> <span class="w">Files</span></li></ol></pre><p>or whatever is appropriate for your documentation.</p>
<p>For a module, this is generally where the documentation of the interfaces
provided by the module goes, usually in the form of a list with an
<code class="inline"><span class="pd">=item</span></code>
 for each interface.  Depending on how many interfaces there are,
you may want to put that documentation in separate METHODS, FUNCTIONS,
CLASS METHODS, or INSTANCE METHODS sections instead and save the
DESCRIPTION section for an overview.</p>
</li>
<li><a name="OPTIONS"></a><b>OPTIONS</b>
<p>Detailed description of each of the command-line options taken by the
program.  This should be separate from the description for the use of
parsers like <a href="Pod/Usage.html">Pod::Usage</a>.  This is normally presented as a list, with
each option as a separate <code class="inline"><span class="pd">=item</span></code>
.  The specific option string should be
enclosed in B&lt;&gt;.  Any values that the option takes should be
enclosed in I&lt;&gt;.  For example, the section for the option
<b>--section</b>=<i>manext</i> would be introduced with:</p>
<pre class="verbatim"><ol><li>    =<span class="w">item</span> <span class="w">B</span><span class="q">&lt;--section&gt;</span>=<span class="w">I</span><span class="q">&lt;manext&gt;</span></li></ol></pre><p>Synonymous options (like both the short and long forms) are separated by a
comma and a space on the same <code class="inline"><span class="pd">=item</span></code>
 line, or optionally listed as their
own item with a reference to the canonical name.  For example, since
<b>--section</b> can also be written as <b>-s</b>, the above would be:</p>
<pre class="verbatim"><ol><li>    =item B&lt;-s&gt; I&lt;manext&gt;, B&lt;--section&gt;=I&lt;manext&gt;</li></ol></pre><p>Writing the short option first is recommended because it's easier to read.
The long option is long enough to draw the eye to it anyway and the short
option can otherwise get lost in visual noise.</p>
</li>
<li><a name="RETURN-VALUE"></a><b>RETURN VALUE</b>
<p>What the program or function returns, if successful.  This section can be
omitted for programs whose precise exit codes aren't important, provided
they return 0 on success and non-zero on failure as is standard.  It
should always be present for functions.  For modules, it may be useful to
summarize return values from the module interface here, or it may be more
useful to discuss return values separately in the documentation of each
function or method the module provides.</p>
</li>
<li><a name="ERRORS"></a><b>ERRORS</b>
<p>Exceptions, error return codes, exit statuses, and errno settings.
Typically used for function or module documentation; program documentation
uses DIAGNOSTICS instead.  The general rule of thumb is that errors
printed to <code class="inline"><span class="w">STDOUT</span></code>
 or <code class="inline"><span class="w">STDERR</span></code>
 and intended for the end user are
documented in DIAGNOSTICS while errors passed internal to the calling
program and intended for other programmers are documented in ERRORS.  When
documenting a function that sets errno, a full list of the possible errno
values should be given here.</p>
</li>
<li><a name="DIAGNOSTICS"></a><b>DIAGNOSTICS</b>
<p>All possible messages the program can print out and what they mean.  You
may wish to follow the same documentation style as the Perl documentation;
see perldiag(1) for more details (and look at the POD source as well).</p>
<p>If applicable, please include details on what the user should do to
correct the error; documenting an error as indicating "the input buffer is
too small" without telling the user how to increase the size of the input
buffer (or at least telling them that it isn't possible) aren't very
useful.</p>
</li>
<li><a name="EXAMPLES"></a><b>EXAMPLES</b>
<p>Give some example uses of the program or function.  Don't skimp; users
often find this the most useful part of the documentation.  The examples
are generally given as verbatim paragraphs.</p>
<p>Don't just present an example without explaining what it does.  Adding a
short paragraph saying what the example will do can increase the value of
the example immensely.</p>
</li>
<li><a name="ENVIRONMENT"></a><b>ENVIRONMENT</b>
<p>Environment variables that the program cares about, normally presented as
a list using <code class="inline"><span class="pd">=over</span></code>
, <code class="inline"><span class="pd">=item</span></code>
, and <code class="inline"><span class="pd">=back</span></code>
.  For example:</p>
<pre class="verbatim"><ol><li>    =over 6</li><li></li><li>    =item HOME</li><li></li><li>    Used to determine the user's home directory.  F&lt;.foorc&gt; in this</li><li>    directory is read for configuration details, if it exists.</li><li></li><li>    =back</li></ol></pre><p>Since environment variables are normally in all uppercase, no additional
special formatting is generally needed; they're glaring enough as it is.</p>
</li>
<li><a name="FILES"></a><b>FILES</b>
<p>All files used by the program or function, normally presented as a list,
and what it uses them for.  File names should be enclosed in F&lt;&gt;.
It's particularly important to document files that will be potentially
modified.</p>
</li>
<li><a name="CAVEATS"></a><b>CAVEATS</b>
<p>Things to take special care with, sometimes called WARNINGS.</p>
</li>
<li><a name="BUGS"></a><b>BUGS</b>
<p>Things that are broken or just don't work quite right.</p>
</li>
<li><a name="RESTRICTIONS"></a><b>RESTRICTIONS</b>
<p>Bugs you don't plan to fix.  :-)</p>
</li>
<li><a name="NOTES"></a><b>NOTES</b>
<p>Miscellaneous commentary.</p>
</li>
<li><a name="AUTHOR"></a><b>AUTHOR</b>
<p>Who wrote it (use AUTHORS for multiple people).  It's a good idea to
include your current e-mail address (or some e-mail address to which bug
reports should be sent) or some other contact information so that users
have a way of contacting you.  Remember that program documentation tends
to roam the wild for far longer than you expect and pick a contact method
that's likely to last.</p>
</li>
<li><a name="HISTORY"></a><b>HISTORY</b>
<p>Programs derived from other sources sometimes have this.  Some people keep
a modification log here, but that usually gets long and is normally better
maintained in a separate file.</p>
</li>
<li><a name="COPYRIGHT-AND-LICENSE"></a><b>COPYRIGHT AND LICENSE</b>
<p>For copyright</p>
<pre class="verbatim"><ol><li>    <span class="w">Copyright</span> <span class="i">YEAR</span><span class="s">(</span><span class="q">s) YOUR NAME(s)</span></li></ol></pre><p>(No, (C) is not needed.  No, "all rights reserved" is not needed.)</p>
<p>For licensing the easiest way is to use the same licensing as Perl itself:</p>
<pre class="verbatim"><ol><li>    <span class="w">This</span> <span class="w">library</span> <span class="w">is</span> <span class="w">free</span> <span class="w">software</span><span class="sc">;</span> <span class="w">you</span> <span class="w">may</span> <span class="w">redistribute</span> <span class="w">it</span> <a class="l_k" href="functions/and.html">and</a><span class="q">/or</span></li><li>    <span class="q">    modify it under the same terms as Perl itself.</span></li></ol></pre><p>This makes it easy for people to use your module with Perl.  Note that
this licensing example is neither an endorsement or a requirement, you are
of course free to choose any licensing.</p>
</li>
<li><a name="SEE-ALSO"></a><b>SEE ALSO</b>
<p>Other man pages to check out, like man(1), man(7), makewhatis(8), or
catman(8).  Normally a simple list of man pages separated by commas, or a
paragraph giving the name of a reference work.  Man page references, if
they use the standard <code class="inline"><span class="i">name</span><span class="s">(</span><span class="w">section</span><span class="s">)</span></code>
 form, don't have to be enclosed in
L&lt;&gt; (although it's recommended), but other things in this section
probably should be when appropriate.</p>
<p>If the package has a mailing list, include a URL or subscription
instructions here.</p>
<p>If the package has a web site, include a URL here.</p>
</li>
</ul>
<p>Documentation of object-oriented libraries or modules may want to use
CONSTRUCTORS and METHODS sections, or CLASS METHODS and INSTANCE METHODS
sections, for detailed documentation of the parts of the library and save
the DESCRIPTION section for an overview.  Large modules with a function
interface may want to use FUNCTIONS for similar reasons.  Some people use
OVERVIEW to summarize the description if it's quite long.</p>
<p>Section ordering varies, although NAME must always be the first section
(you'll break some man page systems otherwise), and NAME, SYNOPSIS,
DESCRIPTION, and OPTIONS generally always occur first and in that order if
present.  In general, SEE ALSO, AUTHOR, and similar material should be
left for last.  Some systems also move WARNINGS and NOTES to last.  The
order given above should be reasonable for most purposes.</p>
<p>Some systems use CONFORMING TO to note conformance to relevant standards
and MT-LEVEL to note safeness for use in threaded programs or signal
handlers.  These headings are primarily useful when documenting parts of a
C library.</p>
<p>Finally, as a general note, try not to use an excessive amount of markup.
As documented here and in <a href="Pod/Man.html">Pod::Man</a>, you can safely leave Perl
variables, function names, man page references, and the like unadorned by
markup and the POD translators will figure it out for you.  This makes it
much easier to later edit the documentation.  Note that many existing
translators will do the wrong thing with e-mail addresses when wrapped in
L&lt;&gt;, so don't do that.</p>
<a name="SEE-ALSO"></a><h1>SEE ALSO</h1>
<p>For additional information that may be more accurate for your specific
system, see either <i>man(5)</i> or <i>man(7)</i> depending on your system manual
section numbering conventions.</p>
<p>This documentation is maintained as part of the podlators distribution.
The current version 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>.</p>
<a name="AUTHOR"></a><h1>AUTHOR</h1>
<p>Russ Allbery &lt;rra@cpan.org&gt;, with large portions of this documentation
taken from the documentation of the original <b>pod2man</b> implementation by
Larry Wall and Tom Christiansen.</p>
<a name="COPYRIGHT-AND-LICENSE"></a><h1>COPYRIGHT AND LICENSE</h1>
<p>Copyright 1999, 2000, 2001, 2004, 2006, 2008, 2010, 2015 Russ Allbery
&lt;rra@cpan.org&gt;</p>
<p>Copying and distribution of this file, with or without modification, are
permitted in any medium without royalty provided the copyright notice and
this notice are preserved.  This file is offered as-is, without any
warranty.</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><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    = 'perlpodstyle';
  perldoc.pageAddress = 'perlpodstyle.html';
  perldoc.contentPage = 1;
  explorePerl.render();
  explorePerl.addEvents('explore_anchor');
</script>
    
  </body>
</html>