📄 ch02_05.htm
字号:
<html><head><title>Documentation (Perl in a Nutshell, 2nd Edition)</title><link rel="stylesheet" type="text/css" href="../style/style1.css" /><meta name="DC.Creator" content="Stephen Spainhour" /><meta name="DC.Format" content="text/xml" scheme="MIME" /><meta name="DC.Language" content="en-US" /><meta name="DC.Publisher" content="O'Reilly & Associates, Inc." /><meta name="DC.Source" scheme="ISBN" content="0596002416L" /><meta name="DC.Subject.Keyword" content="stuff" /><meta name="DC.Title" content="Perl in a Nutshell, 2nd Edition" /><meta name="DC.Type" content="Text.Monograph" /></head><body bgcolor="#ffffff"><img src="gifs/smbanner.gif" usemap="#banner-map" border="0" alt="Book Home" /><map name="banner-map"><area shape="rect" coords="1,-2,616,66" href="index.htm" alt="Java and XSLT" /><area shape="rect" coords="629,-11,726,25" href="jobjects/fsearch.htm" alt="Search this book" /></map><div class="navbar"><table width="684" border="0"><tr><td align="left" valign="top" width="228"><a href="ch02_04.htm"><img src="../gifs/txtpreva.gif" alt="Previous" border="0" /></a></td><td align="center" valign="top" width="228" /><td align="right" valign="top" width="228"><a href="part2.htm"><img src="../gifs/txtnexta.gif" alt="Next" border="0" /></a></td></tr></table></div><h2 class="sect1">2.5. Documentation</h2><p><a name="INDEX-129" /><a name="INDEX-130" /><a name="INDEX-131" />Perl documentation is written in alanguage known as <em class="emphasis">pod</em> (plain old documentation).Pod is a set of simple tags that can be processed to producedocumentation in the style of Unix manpages. There are also severalutility programs available that process pod text and generate outputin different formats. Pod tags can be intermixed with Perl commandsor can be saved in a separate file, which usually has a<em class="emphasis">.pod</em> extension. The pod tags and the utilityprograms that are included in the Perl distribution are described in<a href="ch04_01.htm">Chapter 4, "The Perl Language"</a>.</p><a name="perlnut2-CHP-2-SECT-5.1" /><div class="sect2"><h3 class="sect2">2.5.1. Installing the Documentation</h3><p><a name="INDEX-132" />On Unix, the standard Perlinstallation procedure generates manpages for the Perl documentationfrom their pod format, although your system administrator might alsochoose to install the documentation as HTML files. You can also usethis procedure to generate manpages for CPAN modules when you installthem. You might need to modify your MANPATH environment variable toinclude the path to the Perl manpages, but then you should be able toread the documentation with the <em class="emphasis">man</em> command. Inaddition, Perl comes with its own command,<em class="emphasis">perldoc</em>, which formats the pod documentation anddisplays it. <em class="emphasis">perldoc</em> is particularly useful forreading module documentation, which might not be installed asmanpages; you can also use it for reading the core Perldocumentation.</p><p><a name="INDEX-133" />The ActiveState Win32 port comeswith documentation in HTML format; you can find it in the<em class="emphasis">/docs</em> subdirectory of the distribution.Documentation specific to ActiveState's Perl forWin32 is installed in the <em class="emphasis">/docs/Perl-Win32</em>subdirectory.</p></div><a name="perlnut2-CHP-2-SECT-5.2" /><div class="sect2"><h3 class="sect2">2.5.2. The Perl Manpages</h3><p><a name="INDEX-134" />Perl comes with lots of onlinedocumentation. To make life easier, the manpages are divided intoseparate sections so you don't have to wade throughhundreds of pages of text to find what you are looking for. You canread them with either the <em class="emphasis">man</em> command or<em class="emphasis">perldoc</em>. Run <tt class="literal">man perl</tt> or<tt class="literal">perldoc perl</tt> to read the top-level page. This pagein turn directs you to more specific pages. Or, if you know whichpage you want, you can go directly there by using:</p><blockquote><pre class="code">% man perlvar</pre></blockquote>or:<blockquote><pre class="code">% perldoc perlvar</pre></blockquote><p>The following table lists the sections in a logical order for readingthrough them:</p><a name="ch02-32-fm2xml" /><table border="1" cellpadding="3"><tr><th><p>Section</p></th><th><p>Description</p></th></tr><tr><td><p><em class="citetitle">perl</em></p></td><td><p>Overview (the top level)</p></td></tr><tr><td><p><em class="citetitle">perldelta</em></p></td><td><p>Changes since previous version</p></td></tr><tr><td><p><em class="citetitle">perlfaq</em></p></td><td><p>Frequently asked questions</p></td></tr><tr><td><p><em class="citetitle">perltoc</em></p></td><td><p>Table of contents for Perl documentation</p></td></tr><tr><td><p><em class="citetitle">perldata</em></p></td><td><p>Data structures</p></td></tr><tr><td><p><em class="citetitle">perlsyn</em></p></td><td><p>Syntax</p></td></tr><tr><td><p><em class="citetitle">perlop</em></p></td><td><p>Operators and precedence</p></td></tr><tr><td><p><em class="citetitle">perlre</em></p></td><td><p>Regular expressions</p></td></tr><tr><td><p><em class="citetitle">perlrun</em></p></td><td><p>Execution and options</p></td></tr><tr><td><p><em class="citetitle">perlfunc</em></p></td><td><p>Built-in functions</p></td></tr><tr><td><p><em class="citetitle">perlvar</em></p></td><td><p>Predefined variables</p></td></tr><tr><td><p><em class="citetitle">perlsub</em></p></td><td><p>Subroutines</p></td></tr><tr><td><p><em class="citetitle">perlmod</em></p></td><td><p>How modules work</p></td></tr><tr><td><p><em class="citetitle">perlmodlib</em></p></td><td><p>How to write and use modules</p></td></tr><tr><td><p><em class="citetitle">perlmodinstall</em></p></td><td><p>How to install modules from CPAN</p></td></tr><tr><td><p><em class="citetitle">perlform</em></p></td><td><p>Formats</p></td></tr><tr><td><p><em class="citetitle">perllocale</em></p></td><td><p>Locale support</p></td></tr><tr><td><p><em class="citetitle">perlref</em></p></td><td><p>References</p></td></tr><tr><td><p><em class="citetitle">perldsc</em></p></td><td><p>Data structures introduction</p></td></tr><tr><td><p><em class="citetitle">perllol</em></p></td><td><p>Data structures: lists of lists</p></td></tr><tr><td><p><em class="citetitle">perltoot</em></p></td><td><p>OO tutorial</p></td></tr><tr><td><p><em class="citetitle">perlobj</em></p></td><td><p>Objects</p></td></tr><tr><td><p><em class="citetitle">perltie</em></p></td><td><p>Objects hidden behind simple variables</p></td></tr><tr><td><p><em class="citetitle">perlbot</em></p></td><td><p>OO tricks and examples</p></td></tr><tr><td><p><em class="citetitle">perlipc</em></p></td><td><p>Interprocess communication</p></td></tr><tr><td><p><em class="citetitle">perldebug</em></p></td><td><p>Debugging</p></td></tr><tr><td><p><em class="citetitle">perldiag</em></p></td><td><p>Diagnostic messages</p></td></tr><tr><td><p><em class="citetitle">perlsec</em></p></td><td><p>Security</p></td></tr><tr><td><p><em class="citetitle">perltrap</em></p></td><td><p>Traps for the unwary</p></td></tr><tr><td><p><em class="citetitle">perlport</em></p></td><td><p>Portability guide</p></td></tr><tr><td><p><em class="citetitle">perlstyle</em></p></td><td><p>Style guide</p></td></tr><tr><td><p><em class="citetitle">perlpod</em></p></td><td><p>Plain old documentation</p></td></tr><tr><td><p><em class="citetitle">perlbook</em></p></td><td><p>Book information</p></td></tr><tr><td><p><em class="citetitle">perlembed</em></p></td><td><p>Embedding Perl in your C or C++ application</p></td></tr><tr><td><p><em class="citetitle">perlapio</em></p></td><td><p>Internal I/O abstraction interface</p></td></tr><tr><td><p><em class="citetitle">perlxs</em></p></td><td><p>XS application programming interface</p></td></tr><tr><td><p><em class="citetitle">perlxstut</em></p></td><td><p>XS tutorial</p></td></tr><tr><td><p><em class="citetitle">perlguts</em></p></td><td><p>Internal functions for those doing extensions</p></td></tr><tr><td><p><em class="citetitle">perlcall</em></p></td><td><p>Calling conventions from C</p></td></tr><tr><td><p><em class="citetitle">perlhist</em></p></td><td><p>History records</p></td></tr><tr><td><p><em class="citetitle">perlreftut</em></p></td><td><p>Perl references short introduction</p></td></tr><tr><td><p><em class="citetitle">perlrequick</em></p></td><td><p>Perl regular expressions quick start</p></td></tr><tr><td><p><em class="citetitle">perllexwarn</em></p></td><td><p>Perl warnings and their control</p></td></tr><tr><td><p><em class="citetitle">perldebtut</em></p></td><td><p>Perl debugging tutorial</p></td></tr><tr><td><p><em class="citetitle">perlopentut</em></p></td><td><p>Perl <tt class="literal">open( )</tt> tutorial</p></td></tr><tr><td><p><em class="citetitle">perlretut</em></p></td><td><p>Perl regular expressions tutorial</p></td></tr><tr><td><p><em class="citetitle">perlboot</em></p></td><td><p>Perl OO tutorial for beginners</p></td></tr><tr><td><p><em class="citetitle">perltootc</em></p></td><td><p>Perl OO tutorial, part 2</p></td></tr><tr><td><p><em class="citetitle">perlfork</em></p></td><td><p>Perl <tt class="literal">fork( )</tt> information</p></td></tr><tr><td><p><em class="citetitle">perlnumber</em></p></td><td><p>Perl number semantics</p></td></tr><tr><td><p><em class="citetitle">perlthrtut</em></p></td><td><p>Perl threads tutorial</p></td></tr><tr><td><p><em class="citetitle">perlunicode</em></p></td><td><p>Perl unicode support</p></td></tr><tr><td><p><em class="citetitle">perlebcdic</em></p></td><td><p>Considerations for running Perl on EBCDIC platforms</p></td></tr><tr><td><p><em class="citetitle">perlnewmod</em></p></td><td><p>Perl modules: preparing a new module for distribution</p>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -