Edit D:\app\Administrator\product\11.2.0\dbhome_1\perl\html\lib\Pod\Html.html
<?xml version="1.0" ?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <title>Pod::Html - module to convert pod files to HTML</title> <meta http-equiv="content-type" content="text/html; charset=utf-8" /> <link rev="made" href="mailto:" /> </head> <body style="background-color: white"> <table border="0" width="100%" cellspacing="0" cellpadding="3"> <tr><td class="block" style="background-color: #cccccc" valign="middle"> <big><strong><span class="block"> Pod::Html - module to convert pod files to HTML</span></strong></big> </td></tr> </table> <!-- INDEX BEGIN --> <div name="index"> <p><a name="__index__"></a></p> <ul> <li><a href="#name">NAME</a></li> <li><a href="#synopsis">SYNOPSIS</a></li> <li><a href="#description">DESCRIPTION</a></li> <li><a href="#functions">FUNCTIONS</a></li> <ul> <li><a href="#pod2html">pod2html</a></li> <li><a href="#htmlify">htmlify</a></li> <li><a href="#anchorify">anchorify</a></li> </ul> <li><a href="#environment">ENVIRONMENT</a></li> <li><a href="#author">AUTHOR</a></li> <li><a href="#see_also">SEE ALSO</a></li> <li><a href="#copyright">COPYRIGHT</a></li> </ul> <hr name="index" /> </div> <!-- INDEX END --> <p> </p> <h1><a name="name">NAME</a></h1> <p>Pod::Html - module to convert pod files to HTML</p> <p> </p> <hr /> <h1><a name="synopsis">SYNOPSIS</a></h1> <pre> use Pod::Html; pod2html([options]);</pre> <p> </p> <hr /> <h1><a name="description">DESCRIPTION</a></h1> <p>Converts files from pod format (see <a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/pod/perlpod.html">the perlpod manpage</a>) to HTML format. It can automatically generate indexes and cross-references, and it keeps a cache of things it knows how to cross-reference.</p> <p> </p> <hr /> <h1><a name="functions">FUNCTIONS</a></h1> <p> </p> <h2><a name="pod2html">pod2html</a></h2> <pre> pod2html("pod2html", "--podpath=lib:ext:pod:vms", "--podroot=/usr/src/perl", "--htmlroot=/perl/nmanual", "--libpods=<a href="//C|\ADE\aime_smenon_perl_090715\perl\html/pod/perlfunc.html">perlfunc</a>:<a href="//C|\ADE\aime_smenon_perl_090715\perl\html/pod/perlguts.html">perlguts</a>:<a href="//C|\ADE\aime_smenon_perl_090715\perl\html/pod/perlvar.html">perlvar</a>:<a href="//C|\ADE\aime_smenon_perl_090715\perl\html/pod/perlrun.html">perlrun</a>:<a href="//C|\ADE\aime_smenon_perl_090715\perl\html/pod/perlop.html">perlop</a>", "--recurse", "--infile=foo.pod", "--outfile=/perl/nmanual/foo.html");</pre> <p>pod2html takes the following arguments:</p> <dl> <dt><strong><a name="backlink" class="item">backlink</a></strong> <dd> <pre> --backlink="Back to Top"</pre> </dd> <dd> <p>Adds "Back to Top" links in front of every <code>head1</code> heading (except for the first). By default, no backlinks are generated.</p> </dd> <dt><strong><a name="cachedir" class="item">cachedir</a></strong> <dd> <pre> --cachedir=name</pre> </dd> <dd> <p>Creates the item and directory caches in the given directory.</p> </dd> <dt><strong><a name="css" class="item">css</a></strong> <dd> <pre> --css=stylesheet</pre> </dd> <dd> <p>Specify the URL of a cascading style sheet. Also disables all HTML/CSS <code>style</code> attributes that are output by default (to avoid conflicts).</p> </dd> <dt><strong><a name="flush" class="item">flush</a></strong> <dd> <pre> --flush</pre> </dd> <dd> <p>Flushes the item and directory caches.</p> </dd> <dt><strong><a name="header" class="item">header</a></strong> <dd> <pre> --header --noheader</pre> </dd> <dd> <p>Creates header and footer blocks containing the text of the <a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/pod/perlfunc.html#name"><code>NAME</code></a> section. By default, no headers are generated.</p> </dd> <dt><strong><a name="help" class="item">help</a></strong> <dd> <pre> --help</pre> </dd> <dd> <p>Displays the usage message.</p> </dd> <dt><strong><a name="hiddendirs" class="item">hiddendirs</a></strong> <dd> <pre> --hiddendirs --nohiddendirs</pre> </dd> <dd> <p>Include hidden directories in the search for POD's in podpath if recurse is set. The default is not to traverse any directory whose name begins with <code>.</code>. See <a href="#podpath">podpath</a> and <a href="#recurse">recurse</a>.</p> </dd> <dd> <p>[This option is for backward compatibility only. It's hard to imagine that one would usefully create a module with a name component beginning with <code>.</code>.]</p> </dd> <dt><strong><a name="htmldir" class="item">htmldir</a></strong> <dd> <pre> --htmldir=name</pre> </dd> <dd> <p>Sets the directory in which the resulting HTML file is placed. This is used to generate relative links to other files. 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> </dd> <dt><strong><a name="htmlroot" class="item">htmlroot</a></strong> <dd> <pre> --htmlroot=name</pre> </dd> <dd> <p>Sets the base URL for the HTML files. When cross-references are made, the HTML root is prepended to the URL.</p> </dd> <dt><strong><a name="index" class="item">index</a></strong> <dd> <pre> --index --noindex</pre> </dd> <dd> <p>Generate an index at the top of the HTML file. This is the default behaviour.</p> </dd> <dt><strong><a name="infile" class="item">infile</a></strong> <dd> <pre> --infile=name</pre> </dd> <dd> <p>Specify the pod file to convert. Input is taken from STDIN if no infile is specified.</p> </dd> <dt><strong><a name="libpods" class="item">libpods</a></strong> <dd> <pre> --libpods=name:...:name</pre> </dd> <dd> <p>List of page names (eg, "perlfunc") which contain linkable <code>=item</code>s.</p> </dd> <dt><strong><a name="netscape" class="item">netscape</a></strong> <dd> <pre> --netscape --nonetscape</pre> </dd> <dd> <p><strong>Deprecated</strong>, has no effect. For backwards compatibility only.</p> </dd> <dt><strong><a name="outfile" class="item">outfile</a></strong> <dd> <pre> --outfile=name</pre> </dd> <dd> <p>Specify the HTML file to create. Output goes to STDOUT if no outfile is specified.</p> </dd> <dt><strong><a name="podpath" class="item">podpath</a></strong> <dd> <pre> --podpath=name:...:name</pre> </dd> <dd> <p>Specify which subdirectories of the podroot contain pod files whose HTML converted forms can be linked to in cross references.</p> </dd> <dt><strong><a name="podroot" class="item">podroot</a></strong> <dd> <pre> --podroot=name</pre> </dd> <dd> <p>Specify the base directory for finding library pods.</p> </dd> <dt><strong><a name="quiet" class="item">quiet</a></strong> <dd> <pre> --quiet --noquiet</pre> </dd> <dd> <p>Don't display <em>mostly harmless</em> warning messages. These messages will be displayed by default. But this is not the same as <a href="#verbose"><code>verbose</code></a> mode.</p> </dd> <dt><strong><a name="recurse" class="item">recurse</a></strong> <dd> <pre> --recurse --norecurse</pre> </dd> <dd> <p>Recurse into subdirectories specified in podpath (default behaviour).</p> </dd> <dt><strong><a name="title" class="item">title</a></strong> <dd> <pre> --title=title</pre> </dd> <dd> <p>Specify the title of the resulting HTML file.</p> </dd> <dt><strong><a name="verbose" class="item">verbose</a></strong> <dd> <pre> --verbose --noverbose</pre> </dd> <dd> <p>Display progress messages. By default, they won't be displayed.</p> </dd> </dl> <p> </p> <h2><a name="htmlify">htmlify</a></h2> <pre> htmlify($heading);</pre> <p>Converts a pod section specification to a suitable section specification for HTML. Note that we keep spaces and special characters except <code>", ?</code> (Netscape problem) and the hyphen (writer's problem...).</p> <p> </p> <h2><a name="anchorify">anchorify</a></h2> <pre> anchorify(@heading);</pre> <p>Similar to <code>htmlify()</code>, but turns non-alphanumerics into underscores. Note that <code>anchorify()</code> is not exported by default.</p> <p> </p> <hr /> <h1><a name="environment">ENVIRONMENT</a></h1> <p>Uses <code>$Config{pod2html}</code> to setup default options.</p> <p> </p> <hr /> <h1><a name="author">AUTHOR</a></h1> <p>Tom Christiansen, <<a href="mailto:tchrist@perl.com">tchrist@perl.com</a>>.</p> <p> </p> <hr /> <h1><a name="see_also">SEE ALSO</a></h1> <p><a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/pod/perlpod.html">the perlpod manpage</a></p> <p> </p> <hr /> <h1><a name="copyright">COPYRIGHT</a></h1> <p>This program is distributed under the Artistic License.</p> <table border="0" width="100%" cellspacing="0" cellpadding="3"> <tr><td class="block" style="background-color: #cccccc" valign="middle"> <big><strong><span class="block"> Pod::Html - module to convert pod files to HTML</span></strong></big> </td></tr> </table> </body> </html>
Ms-Dos/Windows
Unix
Write backup
jsp File Browser version 1.2 by
www.vonloesch.de