source: general/prog/perl-modules.xml@ 7094a58

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 7.10 7.4 7.5 7.6 7.6-blfs 7.6-systemd 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gnome kde5-13430 kde5-14269 kde5-14686 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts krejzi/svn lazarus lxqt nosym perl-modules plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition systemd-11177 systemd-13485 trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since 7094a58 was 7094a58, checked in by Andrew Benton <andy@…>, 12 years ago

replace Xorriso with Libisoburn

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@10027 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 44.9 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY perl_modules_md5sums_download_http "&sources-anduin-http;/perl-modules/">
8 <!ENTITY perl_modules_md5sums_download_ftp "&sources-anduin-ftp;/perl-modules/">
9]>
10
11<sect1 id="perl-modules" xreflabel="Perl modules">
12 <?dbhtml filename="perl-modules.html" ?>
13
14 <sect1info>
15 <othername>$LastChangedBy$</othername>
16 <date>$Date$</date>
17 </sect1info>
18
19 <title>Perl Modules</title>
20
21 <indexterm zone="perl-modules">
22 <primary sortas="a-Perl-modules">Perl modules</primary>
23 </indexterm>
24
25 <sect2 role="package">
26 <title>Introduction to Perl Modules</title>
27
28 <para>The <application>Perl</application> module packages add useful
29 objects to the <application>Perl</application> language. Modules utilized
30 by packages throughout BLFS are listed here, along with their dependencies.
31 Installation of the modules shown on this page should be accomplished by
32 installing the listed dependencies (from the bottom and working up to the
33 top) and then the desired module. Most references to
34 <application>Perl</application> modules are in the form of Module,
35 Module::SubName or Module::Sub::Name, though sometimes you'll see Module,
36 Module-SubName or Module-Sub-Name. The references on this page that reflect
37 an external URL are in the latter form, as these are the official package
38 names.</para>
39
40 <itemizedlist spacing="compact">
41 <listitem>
42 <para>Download MD5 sums (HTTP):
43 <ulink url="&perl_modules_md5sums_download_http;"/></para>
44 </listitem>
45 <listitem>
46 <para>Download MD5 sums (FTP):
47 <ulink url="&perl_modules_md5sums_download_ftp;"/></para>
48 </listitem>
49 </itemizedlist>
50
51 <note>
52 <para>Some dependencies, such as the
53 <ulink url="http://search.cpan.org/~dwheeler/Test-Pod/">Test-Pod</ulink>
54 module, are used by several of the listed dependencies of the main
55 module and perhaps also the module being installed. Dependencies such as
56 this are only listed once in the dependency chain for each main module
57 (typically near the bottom-most dependency) to avoid redundancy and
58 additional clutter in the instructions.</para>
59 </note>
60
61 <!-- Archive::Zip -->
62 <bridgehead renderas="sect3" id="perl-archive-zip"
63 xreflabel="Archive::Zip-&Archive-Zip-version;">
64 Archive::Zip-&Archive-Zip-version;</bridgehead>
65
66 <indexterm zone="perl-modules perl-archive-zip">
67 <primary sortas="g-Archive-Zip">Archive::Zip</primary>
68 </indexterm>
69
70 <para>The Archive::Zip module allows a <application>Perl</application>
71 program to create, manipulate, read, and write Zip archive files.</para>
72
73 <itemizedlist spacing='compact'>
74 <listitem>
75 <para><ulink
76 url="http://www.cpan.org/authors/id/A/AD/ADAMK/Archive-Zip-&Archive-Zip-version;.tar.gz">
77 Archive::Zip-&Archive-Zip-version;</ulink>
78 (uses the standard <xref linkend="perl-standard-install"/>)</para>
79 </listitem>
80 </itemizedlist>
81
82 <!-- Date::Manip -->
83 <bridgehead renderas="sect3" id="perl-date-manip"
84 xreflabel="Date::Manip-&Date-Manip-version;">
85 Date::Manip-&Date-Manip-version;</bridgehead>
86
87 <indexterm zone="perl-modules perl-date-manip">
88 <primary sortas="g-Date-Manip">Date::Manip</primary>
89 </indexterm>
90
91 <para>Date::Manip is a set of routines designed to make any common
92 date/time manipulation easy to do. Operations such as comparing two times,
93 calculating a time a given amount of time from another, or parsing
94 international times are all easily done. From the very beginning, the
95 main focus of Date::Manip has been to be able to do ANY desired date/time
96 operation easily.</para>
97
98 <itemizedlist spacing='compact'>
99 <listitem>
100 <para><ulink
101 url="http://cpan.org/authors/id/S/SB/SBECK/Date-Manip-&Date-Manip-version;.tar.gz">
102 Date::Manip-&Date-Manip-version;</ulink>
103 (uses the standard <xref linkend="perl-standard-install"/>)</para>
104 </listitem>
105 </itemizedlist>
106
107 <!-- ExtUtils::Depends -->
108 <bridgehead renderas="sect3" id="perl-extutils-depends"
109 xreflabel="ExtUtils::Depends-&ExtUtils-Depends-version;">
110 ExtUtils::Depends-&ExtUtils-Depends-version;</bridgehead>
111
112 <indexterm zone="perl-modules perl-extutils-depends">
113 <primary sortas="g-ExtUtils-Depends">ExtUtils::Depends</primary>
114 </indexterm>
115
116 <para>
117 ExtUtils::Depends tries to make it easy to build Perl extensions that use
118 functions and typemaps provided by other perl extensions. This means that
119 a perl extension is treated like a shared library that provides also a C
120 and an XS interface besides the perl one.
121 </para>
122
123 <itemizedlist spacing='compact'>
124 <listitem>
125 <para>
126 <ulink url="http://www.cpan.org/authors/id/F/FL/FLORA/ExtUtils-Depends-&ExtUtils-Depends-version;.tar.gz">
127 ExtUtils::Depends-&ExtUtils-Depends-version;</ulink>
128 (uses the standard <xref linkend="perl-standard-install"/>)</para>
129 </listitem>
130 </itemizedlist>
131
132 <!-- ExtUtils::PkgConfig -->
133 <bridgehead renderas="sect3" id="perl-extutils-pkgconfig"
134 xreflabel="ExtUtils::PkgConfig-&ExtUtils-PkgConfig-version;">
135 ExtUtils::PkgConfig-&ExtUtils-PkgConfig-version;</bridgehead>
136
137 <indexterm zone="perl-modules perl-extutils-depends">
138 <primary sortas="g-ExtUtils-PkgConfig">ExtUtils::PkgConfig</primary>
139 </indexterm>
140
141 <para>
142 ExtUtils::PkgConfig is a very simplistic interface to
143 <xref linkend="pkgconfig"/>, intended for use in the Makefile.PL of perl
144 extensions which bind libraries that <application>pkgconfig</application>
145 knows.
146 </para>
147
148 <itemizedlist spacing='compact'>
149 <listitem>
150 <para>
151 <ulink url="http://www.cpan.org/authors/id/T/TS/TSCH/ExtUtils-PkgConfig-&ExtUtils-PkgConfig-version;.tar.gz">
152 ExtUtils::PkgConfig-&ExtUtils-PkgConfig-version;</ulink>
153 (uses the standard <xref linkend="perl-standard-install"/>) Requires:
154 </para>
155 <itemizedlist>
156 <listitem>
157 <para><xref linkend="perl-extutils-depends"/></para>
158 </listitem>
159 </itemizedlist>
160 </listitem>
161 </itemizedlist>
162
163 <!-- Finance::Quote -->
164 <bridgehead renderas="sect3" id="perl-finance-quote"
165 xreflabel="Finance::Quote-&Finance-Quote-version;">
166 Finance::Quote-&Finance-Quote-version;</bridgehead>
167
168 <indexterm zone="perl-modules perl-finance-quote">
169 <primary sortas="g-Finance-Quote">Finance::Quote</primary>
170 </indexterm>
171
172 <para>Finance::Quote is used to get stock quotes from various Internet
173 sources, including Yahoo! Finance, Fidelity Investments, and the Australian
174 Stock Exchange. There are two methods of using this module &ndash; a
175 functional interface that is depreciated, and an object-orientated method
176 that provides greater flexibility and stability. With the exception of
177 straight currency exchange rates, all information is returned as a
178 two-dimensional hash (or a reference to such a hash, if called in a scalar
179 context).</para>
180
181 <para>After you've installed the package, issue
182 <command>perldoc Finance::Quote</command> for full information.
183 Alternatively, you can issue <command>perldoc lib/Finance/Quote.pm</command>
184 after unpacking the distribution tarball and changing into the top-level
185 directory. The module and dependencies are installed using the
186 standard <application>Perl</application> module
187 <xref linkend="perl-standard-install"/>.</para>
188
189 <note>
190 <para>To run the regression test suite, you'll need a working Internet
191 connection and then create a symbolic link to the
192 <filename class='directory'>test</filename> directory using the following
193 command after unpacking the tarball and changing into the root directory
194 of the source tree:</para>
195
196<screen><userinput>ln -s test t</userinput></screen>
197
198 <para>Some tests will fail depending on certain conditions. See the
199 <filename>INSTALL</filename> file for full details.</para>
200 </note>
201
202 <itemizedlist spacing='compact'>
203 <listitem>
204 <para><ulink
205 url="http://search.cpan.org/CPAN/authors/id/E/EC/ECOCODE/Finance-Quote-&Finance-Quote-version;.tar.gz">
206 Finance::Quote-&Finance-Quote-version;</ulink></para>
207
208 <itemizedlist>
209 <listitem>
210 <para><xref linkend="perl-html-tableextract"/></para>
211 </listitem>
212 <listitem>
213 <para><xref linkend="perl-lwp"/></para>
214 </listitem>
215 </itemizedlist>
216
217 </listitem>
218 </itemizedlist>
219
220 <!-- Finance::QuoteHist
221 <bridgehead renderas="sect3" id="perl-finance-quotehist"
222 xreflabel="Finance::QuoteHist-&Finance-QuoteHist-version;">
223 Finance::QuoteHist-&Finance-QuoteHist-version;</bridgehead>
224
225 <indexterm zone="perl-modules perl-finance-quotehist">
226 <primary sortas="g-Finance-QuoteHist">Finance::QuoteHist</primary>
227 </indexterm>
228
229 <para>The Finance::QuoteHist bundle is several modules designed to fetch
230 historical stock quotes from the web. The module and dependencies are
231 installed using the standard <application>Perl</application> module
232 <xref linkend="perl-standard-install"/>.</para>
233
234 <itemizedlist spacing='compact'>
235 <listitem>
236 <para><ulink
237 url="http://cpan.org/authors/id/M/MS/MSISK/Finance-QuoteHist-&Finance-QuoteHist-version;.tar.gz">
238 Finance-QuoteHist-&Finance-QuoteHist-version;</ulink></para>
239
240 <itemizedlist>
241 <listitem>
242 <para><xref linkend="perl-html-tableextract"/></para>
243 </listitem>
244 <listitem>
245 <para><xref linkend="perl-lwp"/></para>
246 </listitem>
247 <listitem>
248 <para><xref linkend="perl-date-manip"/></para>
249 </listitem>
250 <listitem>
251 <para id="perl-text-csv"><ulink
252 url="http://cpan.org/authors/id/M/MA/MAKAMAKA/Text-CSV-&Text-CSV-version;.tar.gz">
253 Text-CSV-&Text-CSV-version;</ulink></para>
254 <indexterm zone="perl-modules perl-text-csv">
255 <primary sortas="g-Text-CSV">Text::CSV</primary>
256 </indexterm>
257 </listitem>
258 <listitem>
259 <para id="perl-text-csv_xs"><ulink
260 url="http://cpan.org/authors/id/H/HM/HMBRAND/Text-CSV_XS-&Text-CSV_XS-version;.tgz">
261 Text-CSV_XS-&Text-CSV_XS-version; (optional)</ulink></para>
262 <indexterm zone="perl-modules perl-text-csv_xs">
263 <primary sortas="g-Text-CSV_XS">Text::CSV_XS</primary>
264 </indexterm>
265 </listitem>
266 </itemizedlist>
267
268 </listitem>
269 </itemizedlist>
270 -->
271
272 <!-- Glib -->
273 <bridgehead renderas="sect3" id="perl-glib"
274 xreflabel="Glib-&Glib-perl-version;">
275 Glib-&Glib-perl-version;</bridgehead>
276
277 <indexterm zone="perl-modules perl-extutils-depends">
278 <primary sortas="g-Glib">Glib</primary>
279 </indexterm>
280
281 <para>
282 This module is a <application>Perl</application> wrapper around
283 <application>Glib</application> that attempts to provide a perlish
284 interface while remaining as true as possible to the underlying C API, so
285 that any reference materials you can find on using GLib may still apply to
286 using the libraries from perl.
287 </para>
288
289 <itemizedlist spacing='compact'>
290 <listitem>
291 <para>
292 <ulink url="http://www.cpan.org/authors/id/X/XA/XAOC/Glib-&Glib-perl-version;.tar.gz">
293 Glib-&Glib-perl-version;</ulink>
294 (uses the standard <xref linkend="perl-standard-install"/>) Requires:
295 </para>
296 <itemizedlist>
297 <listitem>
298 <para><xref linkend="perl-extutils-pkgconfig"/></para>
299 </listitem>
300 </itemizedlist>
301 </listitem>
302 </itemizedlist>
303
304 <!-- HTML::Parser -->
305 <bridgehead renderas="sect3" id="perl-html-parser"
306 xreflabel="HTML::Parser-&HTML-Parser-version;">
307 HTML::Parser-&HTML-Parser-version;</bridgehead>
308
309 <indexterm zone="perl-modules perl-html-parser">
310 <primary sortas="g-HTML-Parser">HTML::Parser</primary>
311 </indexterm>
312
313 <para>The HTML::Parser distribution is a collection of modules that parse
314 and extract information from HTML documents. The modules listed below are
315 installed using the standard <application>Perl</application> module
316 <xref linkend="perl-standard-install"/>.</para>
317
318 <itemizedlist spacing='compact'>
319 <listitem>
320 <para><ulink
321 url="http://cpan.org/authors/id/G/GA/GAAS/HTML-Parser-&HTML-Parser-version;.tar.gz">
322 HTML::Parser-&HTML-Parser-version;</ulink></para>
323
324 <itemizedlist>
325 <listitem>
326 <para id="perl-html-tagset"><ulink
327 url="http://search.cpan.org/~petdance/HTML-Tagset/">
328 HTML-Tagset</ulink></para>
329 <indexterm zone="perl-modules perl-html-tagset">
330 <primary sortas="g-HTML-Tagset">HTML::Tagset</primary>
331 </indexterm>
332
333 <itemizedlist>
334 <listitem>
335 <para><ulink url="http://search.cpan.org/~dwheeler/Test-Pod/">
336 Test-Pod</ulink> (optionally used during the tests)</para>
337 </listitem>
338 </itemizedlist>
339
340 </listitem>
341 <listitem>
342 <para><xref linkend="perl-lwp"/> (run-time requirement for the
343 included HTML::HeadParser module)</para>
344 </listitem>
345 </itemizedlist>
346
347 </listitem>
348 </itemizedlist>
349
350 <!-- HTML::TableExtract -->
351 <bridgehead renderas="sect3" id="perl-html-tableextract"
352 xreflabel="HTML::TableExtract-&HTML-TableExtract-version;">
353 HTML::TableExtract-&HTML-TableExtract-version;</bridgehead>
354
355 <indexterm zone="perl-modules perl-html-tableextract">
356 <primary sortas="g-HTML-TableExtract">HTML::TableExtract</primary>
357 </indexterm>
358
359 <para>HTML::TableExtract is a module that simplifies the extraction of the
360 content contained in tables within HTML documents, extracted either as
361 text or encoded element trees. Tables of note may be specified using
362 Headers, Depth, Count, Attributes, or some combination of the four. The
363 module and dependencies are installed using the standard
364 <application>Perl</application> module
365 <xref linkend="perl-standard-install"/>.</para>
366
367 <itemizedlist spacing='compact'>
368 <listitem>
369 <para><ulink
370 url="http://cpan.org/authors/id/M/MS/MSISK/HTML-TableExtract-&HTML-TableExtract-version;.tar.gz">
371 HTML::TableExtract-&HTML-TableExtract-version;</ulink></para>
372
373 <itemizedlist>
374 <listitem>
375 <para id="perl-html-element-extended"><ulink
376 url="http://search.cpan.org/~msisk/HTML-Element-Extended/">
377 HTML-Element-Extended</ulink></para>
378 <indexterm zone="perl-modules perl-html-element-extended">
379 <primary sortas="g-HTML-Element-Extended">HTML::Element::Extended</primary>
380 </indexterm>
381
382 <itemizedlist>
383 <listitem>
384 <para id="perl-html-tree"><ulink
385 url="http://search.cpan.org/~jfearn/HTML-Tree/">
386 HTML-Tree</ulink></para>
387 <indexterm zone="perl-modules perl-html-tree">
388 <primary sortas="g-HTML-Tree">HTML::Tree</primary>
389 </indexterm>
390
391 <itemizedlist>
392 <listitem>
393 <para><xref linkend="perl-html-parser"/></para>
394 </listitem>
395 <listitem>
396 <para><ulink url="http://search.cpan.org/~dwheeler/Test-Pod/">
397 Test-Pod</ulink> (optionally used during the tests)</para>
398 </listitem>
399 </itemizedlist>
400
401 </listitem>
402 </itemizedlist>
403
404 </listitem>
405 <listitem>
406 <para><ulink url="http://search.cpan.org/~petdance/Test-Pod-Coverage/">
407 Test-Pod-Coverage</ulink> (optionally used during the tests)</para>
408 </listitem>
409 </itemizedlist>
410
411 </listitem>
412 </itemizedlist>
413
414 <!-- LWP -->
415 <bridgehead renderas="sect3" id="perl-lwp"
416 xreflabel="libwww-perl-&LWP-version;">
417 libwww-perl-&LWP-version; (a.k.a. LWP)</bridgehead>
418
419 <indexterm zone="perl-modules perl-lwp">
420 <primary sortas="g-libwww-perl">libwww-perl</primary>
421 </indexterm>
422
423 <para>The libwww-perl (LWP) collection is a set of
424 <application>Perl</application> modules which provide a simple and
425 consistent application programming interface to the World-Wide Web. The
426 main focus of the library is to provide classes and functions that allow
427 you to write WWW clients. The library also contains modules that are of
428 more general use and even classes that help you implement simple HTTP
429 servers. The LWP collection and all its <application>Perl</application>
430 module dependencies are installed using the standard
431 <application>Perl</application> module
432 <xref linkend="perl-standard-install"/>.</para>
433
434 <itemizedlist spacing='compact'>
435 <listitem>
436 <para><ulink
437 url="http://cpan.org/authors/id/G/GA/GAAS/libwww-perl-&LWP-version;.tar.gz">
438 libwww-perl-&LWP-version;</ulink></para>
439
440 <itemizedlist>
441 <listitem>
442 <para><xref linkend="perl-uri"/></para>
443 </listitem>
444 <listitem>
445 <para><xref linkend="perl-html-parser"/></para>
446 </listitem>
447 <listitem>
448 <para>
449 <ulink url="http://search.cpan.org/~nanis/Crypt-SSLeay/">
450 Crypt-SSLeay</ulink> (optional, for HTTPS
451 support)</para>
452
453 <itemizedlist>
454 <listitem>
455 <para><xref linkend="openssl"/></para>
456 </listitem>
457 <listitem>
458 <para>A <quote>testcover</quote> <filename>Makefile</filename>
459 target is created (which creates a
460 <command>/usr/bin/testcover</command> script) if the <ulink
461 url="http://cpan.org/authors/id/S/SM/SMPETERS/ExtUtils-MakeMaker-Coverage-0.05.tar.gz">
462 Extutils-MakeMaker-Coverage</ulink> module is installed.</para>
463 </listitem>
464 </itemizedlist>
465
466 </listitem>
467 </itemizedlist>
468
469 </listitem>
470 </itemizedlist>
471
472 <!-- Module::Info
473 <bridgehead renderas="sect3" id="perl-module-info"
474 xreflabel="Module::Info-&Module-Info-version;">
475 Module::Info-&Module-Info-version;</bridgehead>
476
477 <indexterm zone="perl-modules perl-module-info">
478 <primary sortas="g-Module-Info">Module::Info</primary>
479 </indexterm>
480
481 <para>The Module::Info module is quite useful for tasks other than just
482 support of other modules. It can be used from the command-line to tell you
483 if a particular module is included in, or has been installed into your
484 <application>Perl</application> installation. Additionally, Module::Info
485 can tell you what version of a module is installed and what dependencies
486 are required for it. You can even use Module::Info to gather dependencies
487 of uninstalled modules. The Module::Info module and dependencies install
488 using the standard <application>Perl</application> module
489 <xref linkend="perl-standard-install"/>.</para>
490
491 <itemizedlist spacing='compact'>
492 <listitem>
493 <para><ulink
494 url="http://www.cpan.org/authors/id/M/MB/MBARBON/Module-Info-&Module-Info-version;.tar.gz">
495 Module-Info-&Module-Info-version;</ulink></para>
496
497 <itemizedlist>
498 <listitem>
499 <para><xref linkend="perl-test-pod-coverage"/>
500 (optionally used during the tests)</para>
501 </listitem>
502 <listitem>
503 <para><xref linkend="perl-test-pod"/>
504 (optionally used during the tests)</para>
505 </listitem>
506 </itemizedlist>
507
508 </listitem>
509 </itemizedlist>
510 -->
511
512 <!-- Module::Signature
513 <bridgehead renderas="sect3" id="perl-module-signature"
514 xreflabel="Module::Signature-&Module-Signature-version;">
515 Module::Signature-&Module-Signature-version;</bridgehead>
516
517 <indexterm zone="perl-modules perl-module-signature">
518 <primary sortas="g-Module-Signature">Module::Signature</primary>
519 </indexterm>
520
521 <para>The Module::Signature module is used to check and create
522 <filename>SIGNATURE</filename> files for CPAN distributions. After
523 installing Module::Signature you can verify the content of a distribution
524 tarball (if it includes a <filename>SIGNATURE</filename> file) by unpacking
525 the tarball, changing into the newly created directory and issuing the
526 command <command>cpansign -v</command>. It will check each file's
527 integrity, as well as the signature's validity. Note that some of the
528 dependencies appear to be circular, however, they are only run-time
529 conflicts and you should be able to fully utilize them as long as
530 everything is installed. Module::Signature and the dependency modules are
531 installed using the standard <application>Perl</application>
532 module <xref linkend="perl-standard-install"/>.</para>
533
534 <itemizedlist spacing='compact'>
535 <listitem>
536 <para><ulink
537 url="http://cpan.org/authors/id/A/AU/AUDREYT/Module-Signature-&Module-Signature-version;.tar.gz">
538 Module-Signature-&Module-Signature-version;</ulink></para>
539
540 <itemizedlist>
541 <listitem>
542 <para><xref linkend="perl-text-diff"/></para>
543 </listitem>
544 <listitem>
545 <para id="perl-par-dist"><ulink
546 url="http://cpan.org/authors/id/S/SM/SMUELLER/PAR-Dist-&PAR-Dist-version;.tar.gz">
547 PAR-Dist-&PAR-Dist-version;</ulink></para>
548 <indexterm zone="perl-modules perl-par-dist">
549 <primary sortas="g-PAR-Dist">PAR::Dist</primary>
550 </indexterm>
551
552 <itemizedlist>
553 <listitem>
554 <para><xref linkend="perl-archive-zip"/></para>
555 </listitem>
556 <listitem>
557 <para><xref linkend="perl-lwp"/></para>
558 </listitem>
559 <listitem>
560 <para><xref linkend="perl-module-signature"/></para>
561 </listitem>
562 </itemizedlist>
563 </listitem>
564
565 <listitem>
566 <para><xref linkend="gnupg"/></para>
567 </listitem>
568 </itemizedlist>
569
570 </listitem>
571 </itemizedlist>
572 -->
573
574 <!-- Net::DNS -->
575 <bridgehead renderas="sect3" id="perl-net-dns"
576 xreflabel="Net::DNS-&Net-DNS-version;">
577 Net::DNS-&Net-DNS-version;</bridgehead>
578
579 <indexterm zone="perl-modules perl-net-dns">
580 <primary sortas="g-Net-DNS">Net::DNS</primary>
581 </indexterm>
582
583 <para>Net::DNS is a DNS resolver implemented in
584 <application>Perl</application>. It can be used to perform nearly any type
585 of DNS query from a <application>Perl</application> script. The Net::DNS
586 module and all its dependencies are installed using the standard
587 <application>Perl</application> module
588 <xref linkend="perl-standard-install"/>.</para>
589
590 <itemizedlist spacing='compact'>
591 <listitem>
592 <para><ulink
593 url="http://cpan.org/authors/id/O/OL/OLAF/Net-DNS-&Net-DNS-version;.tar.gz">
594 Net::DNS-&Net-DNS-version;</ulink></para>
595
596 <itemizedlist>
597 <listitem>
598 <para id="perl-digest-hmac"><ulink
599 url="http://search.cpan.org/~gaas/Digest-HMAC/">
600 Digest-HMAC</ulink></para>
601 <indexterm zone="perl-modules perl-digest-hmac">
602 <primary sortas="g-Digest-HMAC">Digest::HMAC</primary>
603 </indexterm>
604
605 <itemizedlist>
606 <listitem>
607 <para id="perl-digest-sha1"><ulink
608 url="http://search.cpan.org/~mshelor/Digest-SHA/">
609 Digest-SHA</ulink></para>
610 <indexterm zone="perl-modules perl-digest-sha1">
611 <primary sortas="g-Digest-SHA1">Digest::SHA1</primary>
612 </indexterm>
613 </listitem>
614 </itemizedlist>
615
616 </listitem>
617 <listitem>
618 <para id="perl-net-ip"><ulink
619 url="http://search.cpan.org/~manu/Net-IP/">
620 Net-IP</ulink></para>
621 <indexterm zone="perl-modules perl-net-ip">
622 <primary sortas="g-Net-IP">Net::IP</primary>
623 </indexterm>
624 </listitem>
625 <listitem>
626 <para id="perl-io-socket-inet6"><ulink
627 url="http://search.cpan.org/~gbarr/IO/lib/IO/Socket/INET.pm">
628 IO-Socket-INET</ulink> (required for
629 IPv6 support)</para>
630 <indexterm zone="perl-modules perl-io-socket-inet6">
631 <primary sortas="g-IO-Socket-INET6">IO::Socket::INET6</primary>
632 </indexterm>
633
634 <itemizedlist>
635 <listitem>
636 <para id="perl-socket6"><ulink
637 url="http://search.cpan.org/~umemoto/Socket6/">
638 Socket6</ulink></para>
639 <indexterm zone="perl-modules perl-socket6">
640 <primary sortas="g-Socket6">Socket6</primary>
641 </indexterm>
642 </listitem>
643 </itemizedlist>
644
645 </listitem>
646 <listitem>
647 <para id="perl-digest-bubblebabble"><ulink
648 url="http://search.cpan.org/~btrott/Digest-BubbleBabble/">
649 Digest-BubbleBabble</ulink></para>
650 <indexterm zone="perl-modules perl-digest-bubblebabble">
651 <primary sortas="g-Digest-BubbleBabble">Digest::BubbleBabble</primary>
652 </indexterm>
653 </listitem>
654 <listitem>
655 <para><ulink url="http://search.cpan.org/~dwheeler/Test-Pod/">
656 Test-Pod</ulink> (optionally used during the tests)</para>
657 </listitem>
658 </itemizedlist>
659
660 </listitem>
661 </itemizedlist>
662
663
664 <!-- Pod::Coverage
665 <bridgehead renderas="sect3" id="perl-pod-coverage"
666 xreflabel="Pod::Coverage-&Pod-Coverage-version;">
667 Pod::Coverage-&Pod-Coverage-version;</bridgehead>
668
669 <indexterm zone="perl-modules perl-pod-coverage">
670 <primary sortas="g-Pod-Coverage">Pod::Coverage</primary>
671 </indexterm>
672
673 <para>The Pod::Coverage module is a <application>Perl</application> library
674 used to check if the documentation of a module is comprehensive. All the
675 dependencies are installed using the standard
676 <application>Perl</application> module
677 <xref linkend="perl-standard-install"/>.</para>
678
679 <itemizedlist spacing='compact'>
680 <listitem>
681 <para><ulink
682 url="http://www.cpan.org/authors/id/R/RC/RCLAMP/Pod-Coverage-&Pod-Coverage-version;.tar.gz">
683 Pod-Coverage-&Pod-Coverage-version;</ulink></para>
684
685 <itemizedlist>
686 <listitem>
687 <para id="perl-devel-symdump"><ulink
688 url="http://www.cpan.org/authors/id/A/AN/ANDK/Devel-Symdump-&Devel-Symdump-version;.tar.gz">
689 Devel-Symdump-&Devel-Symdump-version;</ulink></para>
690 <indexterm zone="perl-modules perl-devel-symdump">
691 <primary sortas="g-Devel-Symdump">Devel::Symdump</primary>
692 </indexterm>
693
694 <itemizedlist>
695 <listitem>
696 <para><xref linkend="perl-test-pod-coverage"/>
697 (optionally used during the tests, and is a circular
698 dependency)</para>
699 </listitem>
700 <listitem>
701 <para><xref linkend="perl-test-pod"/>
702 (optionally used during the tests)</para>
703 </listitem>
704 </itemizedlist>
705
706 </listitem>
707 </itemizedlist>
708
709 </listitem>
710 </itemizedlist>
711 -->
712
713 <!-- SGMLSpm -->
714 <bridgehead renderas="sect3" id="perl-sgmlspm"
715 xreflabel="SGMLSpm-&SGMLSpm-version;">
716 SGMLSpm-&SGMLSpm-version;</bridgehead>
717
718 <indexterm zone="perl-modules perl-sgmlspm">
719 <primary sortas="g-SGMLSpm">SGMLSpm</primary>
720 </indexterm>
721
722 <para>The SGMLSpm module is a <application>Perl</application> library
723 used for parsing the output from James Clark's SGMLS and NSGMLS
724 parsers. The module is installed using the standard
725 <application>Perl</application> module
726 <xref linkend="perl-standard-install"/>.</para>
727
728 <itemizedlist spacing='compact'>
729 <listitem>
730 <para><ulink
731 url="http://search.cpan.org/CPAN/authors/id/R/RA/RAAB/SGMLSpm-&SGMLSpm-version;.tar.gz">
732 SGMLSpm-&SGMLSpm-version;</ulink></para>
733 </listitem>
734 </itemizedlist>
735
736 <!-- Test::Pod
737 <bridgehead renderas="sect3" id="perl-test-pod"
738 xreflabel="Test::Pod-&Test-Pod-version;">
739 Test::Pod-&Test-Pod-version;</bridgehead>
740
741 <indexterm zone="perl-modules perl-test-pod">
742 <primary sortas="g-Test-Pod">Test::Pod</primary>
743 </indexterm>
744
745 <para>The Test:Pod module is (most of the time, optionally) used by other
746 modules during the build process to check the validity of POD (Plain Old
747 Documentation) files. The Test::Pod module is typically included by module
748 authors to automatically find and check all POD files in a module
749 distribution. This module is installed using the standard
750 <application>Perl</application> module
751 <xref linkend="perl-standard-install"/>.</para>
752
753 <itemizedlist spacing='compact'>
754 <listitem>
755 <para><ulink
756 url="http://www.cpan.org/authors/id/D/DW/DWHEELER/Test-Pod-&Test-Pod-version;.tar.gz">
757 Test-Pod-&Test-Pod-version;</ulink></para>
758 </listitem>
759 </itemizedlist>
760 -->
761
762 <!-- Test::Pod::Coverage
763 <bridgehead renderas="sect3" id="perl-test-pod-coverage"
764 xreflabel="Test::Pod::Coverage-&Test-Pod-Coverage-version;">
765 Test::Pod::Coverage-&Test-Pod-Coverage-version;</bridgehead>
766
767 <indexterm zone="perl-modules perl-test-pod-coverage">
768 <primary sortas="g-Test-Pod-Coverage">Test::Pod::Coverage</primary>
769 </indexterm>
770
771 <para>The Test::Pod::Coverage module is used to check files in a
772 distribution for POD coverage. It is normally used by developers to
773 ensure their projects are adequately covered with POD and it is also used
774 in the test suites of many module distributions. This module and the
775 dependency are installed using the standard
776 <application>Perl</application> module
777 <xref linkend="perl-standard-install"/>.</para>
778
779 <itemizedlist spacing='compact'>
780 <listitem>
781 <para><ulink
782 url="http://cpan.org/authors/id/P/PE/PETDANCE/Test-Pod-Coverage-&Test-Pod-Coverage-version;.tar.gz">
783 Test-Pod-Coverage-&Test-Pod-Coverage-version;</ulink></para>
784
785 <itemizedlist>
786 <listitem>
787 <para><xref linkend="perl-pod-coverage"/></para>
788 </listitem>
789 </itemizedlist>
790
791 </listitem>
792 </itemizedlist>
793 -->
794
795 <!-- Text::Diff
796 <bridgehead renderas="sect3" id="perl-text-diff"
797 xreflabel="Text::Diff-&Text-Diff-version;">
798 Text::Diff-&Text-Diff-version;</bridgehead>
799
800 <indexterm zone="perl-modules perl-text-diff">
801 <primary sortas="g-Text-Diff">Text::Diff</primary>
802 </indexterm>
803
804 <para>Text::Diff is used to perform diffs on files and record sets. It
805 provides a basic set of services akin to the GNU <command>diff</command>
806 utility. It is not anywhere near as feature complete as GNU
807 <command>diff</command>, but it is better integrated with
808 <application>Perl</application> and available on all platforms. Text::Diff
809 is often faster than shelling out to a system's <command>diff</command>
810 executable for small files, and generally slower on larger files. The
811 modules listed below are installed using the standard
812 <application>Perl</application> module
813 <xref linkend="perl-standard-install"/>.</para>
814
815 <itemizedlist spacing='compact'>
816 <listitem>
817 <para><ulink
818 url="http://cpan.org/authors/id/R/RB/RBS/Text-Diff-&Text-Diff-version;.tar.gz">
819 Text-Diff-&Text-Diff-version;</ulink></para>
820
821 <itemizedlist>
822 <listitem>
823 <para id="perl-algorithm-diff"><ulink
824 url="http://cpan.org/authors/id/T/TY/TYEMQ/Algorithm-Diff-&Algorithm-Diff-version;.tar.gz">
825 Algorithm-Diff-&Algorithm-Diff-version;</ulink></para>
826 <indexterm zone="perl-modules perl-algorithm-diff">
827 <primary sortas="g-Algorithm-Diff">Algorithm::Diff</primary>
828 </indexterm>
829 </listitem>
830 </itemizedlist>
831
832 </listitem>
833 </itemizedlist>
834 -->
835
836 <!-- Tk
837 <bridgehead renderas="sect3" id="tk-perl"
838 xreflabel="Tk-Perl-&Tk-Perl-version;">
839 Tk-&Tk-Perl-version;</bridgehead>
840
841 <indexterm zone="perl-modules tk-perl">
842 <primary sortas="g-Tk">Tk</primary>
843 </indexterm>
844
845 <para>The <application>Tk</application> module is a
846 <application>Perl</application> interface to the
847 <application>Tk</application> package. The goal of this release is Unicode
848 support via <application>Perl</application>'s and
849 core-<application>Tk</application>'s use of UTF-8. Tk-&Tk-Perl-version;
850 builds and loads into a threaded <application>Perl</application> but is NOT
851 yet thread safe. The module is installed using the standard
852 <application>Perl</application> module
853 <xref linkend="perl-standard-install"/>.</para>
854
855 <itemizedlist spacing='compact'>
856 <listitem>
857 <para><ulink
858 url="http://www.cpan.org/authors/id/S/SR/SREZIC/Tk-&Tk-Perl-version;.tar.gz">
859 Tk-&Tk-Perl-version;</ulink></para>
860
861 <itemizedlist>
862 <listitem>
863 <para><xref linkend="tk"/> and <xref linkend="libjpeg"/></para>
864 </listitem>
865 </itemizedlist>
866
867 </listitem>
868 </itemizedlist>
869 -->
870
871 <!-- URI -->
872 <bridgehead renderas="sect3" id="perl-uri"
873 xreflabel="URI-&URI-version;">
874 URI-&URI-version;</bridgehead>
875
876 <indexterm zone="perl-modules perl-uri">
877 <primary sortas="g-URI">URI</primary>
878 </indexterm>
879
880 <para>
881 This module implements the URI class. Objects of this class represent
882 "Uniform Resource Identifier references" as specified in RFC 2396 (and
883 updated by RFC 2732). A Uniform Resource Identifier is a compact string of
884 characters that identifies an abstract or physical resource. A Uniform
885 Resource Identifier can be further classified as either a Uniform Resource
886 Locator (URL) or a Uniform Resource Name (URN). The distinction between
887 URL and URN does not matter to the URI class interface. A "URI-reference"
888 is a URI that may have additional information attached in the form of a
889 fragment identifier.
890 </para>
891
892 <itemizedlist spacing='compact'>
893 <listitem>
894 <para>
895 <ulink url="http://www.cpan.org/authors/id/G/GA/GAAS/URI-&URI-version;.tar.gz">
896 URI-&URI-version;</ulink>
897 (uses the standard <xref linkend="perl-standard-install"/>)</para>
898 </listitem>
899 </itemizedlist>
900
901 <!-- XML::Parser -->
902 <bridgehead renderas="sect3" id="perl-xml-parser"
903 xreflabel="XML::Parser-&XML-Parser-version;">
904 XML::Parser-&XML-Parser-version;</bridgehead>
905
906 <indexterm zone="perl-modules perl-xml-parser">
907 <primary sortas="g-XML-Parser">XML::Parser</primary>
908 </indexterm>
909
910 <para>The XML::Parser module is a <application>Perl</application> extension
911 interface to James Clark's XML parser,
912 <application>expat</application>. The module is installed using the
913 standard <application>Perl</application> module
914 <xref linkend="perl-standard-install"/>.</para>
915
916 <itemizedlist spacing='compact'>
917 <listitem>
918 <para><ulink
919 url="http://search.cpan.org/CPAN/authors/id/T/TO/TODDR/XML-Parser-&XML-Parser-version;.tar.gz">
920 XML::Parser-&XML-Parser-version;</ulink></para>
921
922 <itemizedlist>
923 <listitem>
924 <para><xref linkend="expat"/></para>
925 </listitem>
926 </itemizedlist>
927 <itemizedlist>
928 <listitem>
929 <para><xref linkend="perl-lwp"/>
930 (optionally used during the tests)</para>
931 </listitem>
932 </itemizedlist>
933
934 </listitem>
935 </itemizedlist>
936
937 <!-- XML::Simple -->
938 <bridgehead renderas="sect3" id="perl-xml-simple"
939 xreflabel="XML::Simple-&XML-Simple-version;">
940 XML::Simple-&XML-Simple-version;</bridgehead>
941
942 <indexterm zone="perl-modules perl-xml-simple">
943 <primary sortas="g-XML-Simple">XML::Simple</primary>
944 </indexterm>
945
946 <para>The XML::Simple module is a <application>Perl</application> extension
947 that provides an easy API to read and write XML (especially config files).
948 The module and all dependencies are installed using the standard
949 <application>Perl</application> module
950 <xref linkend="perl-standard-install"/>.</para>
951
952 <itemizedlist spacing='compact'>
953 <listitem>
954 <para><ulink
955 url="http://cpan.org/authors/id/G/GR/GRANTM/XML-Simple-&XML-Simple-version;.tar.gz">
956 XML::Simple-&XML-Simple-version;</ulink></para>
957
958 <itemizedlist>
959 <listitem>
960 <para>One of the following four modules must be installed:</para>
961
962 <itemizedlist>
963 <listitem>
964 <para id="perl-xml-sax"><ulink
965 url="http://search.cpan.org/~grantm/XML-SAX/">
966 XML-SAX</ulink></para>
967 <indexterm zone="perl-modules perl-xml-sax">
968 <primary sortas="g-XML-SAX">XML::SAX</primary>
969 </indexterm>
970
971 <itemizedlist>
972 <listitem>
973 <para id="perl-xml-namespacesupport"><ulink
974 url="http://search.cpan.org/~perigrin/XML-NamespaceSupport/">
975 XML-NamespaceSupport</ulink></para>
976 <indexterm zone="perl-modules perl-xml-namespacesupport">
977 <primary sortas="g-XML-NamespaceSupport">XML::NamespaceSupport</primary>
978 </indexterm>
979 </listitem>
980 </itemizedlist>
981
982 </listitem>
983 <listitem>
984 <para id="perl-xml-sax-expat"><ulink
985 url="http://search.cpan.org/~bjoern/XML-SAX-Expat/">
986 XML-SAX-Expat</ulink></para>
987 <indexterm zone="perl-modules perl-xml-sax-expat">
988 <primary sortas="g-XML-SAX-Expat">XML::SAX::Expat</primary>
989 </indexterm>
990 </listitem>
991 <listitem>
992 <para id="perl-xml-libxml"><ulink
993 url="http://search.cpan.org/~shlomif/XML-LibXML/">
994 XML-LibXML</ulink></para>
995 <indexterm zone="perl-modules perl-xml-libxml">
996 <primary sortas="g-XML-LibXML">XML::LibXML</primary>
997 </indexterm>
998 </listitem>
999 <listitem>
1000 <para><xref linkend="perl-xml-parser"/></para>
1001 </listitem>
1002 </itemizedlist>
1003
1004 </listitem>
1005 <listitem>
1006 <para id="perl-tie-ixhash"><ulink
1007 url="http://search.cpan.org/~chorny/Tie-IxHash/">
1008 Tie-IxHash</ulink></para>
1009 <indexterm zone="perl-modules perl-tie-ixhash">
1010 <primary sortas="g-Tie-IxHash">Tie::IxHash</primary>
1011 </indexterm>
1012 </listitem>
1013 </itemizedlist>
1014
1015 </listitem>
1016 </itemizedlist>
1017
1018
1019
1020 <!-- YAML
1021 <bridgehead renderas="sect3" id="perl-yaml"
1022 xreflabel="YAML-&YAML-version;">
1023 YAML-&YAML-version;</bridgehead>
1024
1025 <indexterm zone="perl-modules perl-yaml">
1026 <primary sortas="g-YAML">YAML</primary>
1027 </indexterm>
1028
1029 <para>The <application>YAML</application> modules implement a
1030 <application>YAML</application> Loader and Dumper based on the
1031 <application>YAML</application> 1.0 specification
1032 <ulink url="http://www.yaml.org/spec/"/>.
1033 <application>YAML</application> is a generic data serialization language
1034 that is optimized for human readability. It can be used to express the data
1035 structures of most modern programming languages. The module and
1036 dependencies are installed using the standard
1037 <application>Perl</application> module
1038 <xref linkend="perl-standard-install"/>.</para>
1039
1040 <note>
1041 <para>The <application>YAML</application>,
1042 <application>Test::Base</application> and
1043 <application>Spiffy</application> modules will install UTF-8
1044 encoded manual pages. To modify the manual pages so that non-UTF-8
1045 encoded pages are installed, issue the following commands (before
1046 any other build commands):</para>
1047
1048<screen><literal>For <application>Spiffy</application>: <command>sed -i 's,\xc3\xb6,o,' lib/Spiffy.pm</command>
1049
1050For <application>Test::Base</application>: <command>sed -i 's,\xc3\xb6,o,' \
1051 lib/Test/Base{,/Filter}.pm \
1052 lib/Module/Install/TestBase.pm</command>
1053
1054For <application>YAML</application>: <command>sed -i 's,\xc3\xb6,o,' \
1055 ysh \
1056 lib{,/Test}/YAML.pm \
1057 lib/YAML/{Types,Node,Error,Marshall,Tag,Base}.pm \
1058 lib/YAML/{Loader,Dumper}{,/Base}.pm</command></literal></screen>
1059
1060 </note>
1061
1062 <itemizedlist spacing='compact'>
1063 <listitem>
1064 <para><ulink
1065 url="http://cpan.org/authors/id/I/IN/INGY/YAML-&YAML-version;.tar.gz">
1066 YAML-&YAML-version;</ulink></para>
1067
1068 <itemizedlist>
1069 <listitem>
1070 <para id="perl-test-base"><ulink
1071 url="http://cpan.org/authors/id/I/IN/INGY/Test-Base-&Test-Base-version;.tar.gz">
1072 Test-Base-&Test-Base-version;</ulink>
1073 (optionally used during the tests)</para>
1074 <indexterm zone="perl-modules perl-test-base">
1075 <primary sortas="g-Test-Base">Test::Base</primary>
1076 </indexterm>
1077
1078 <itemizedlist>
1079 <listitem>
1080 <para id="perl-spiffy"><ulink
1081 url="http://cpan.org/authors/id/I/IN/INGY/Spiffy-&Spiffy-version;.tar.gz">
1082 Spiffy-&Spiffy-version;</ulink></para>
1083 <indexterm zone="perl-modules perl-spiffy">
1084 <primary sortas="g-Spiffy">Spiffy</primary>
1085 </indexterm>
1086 </listitem>
1087 </itemizedlist>
1088
1089 </listitem>
1090 <listitem>
1091 <para><xref linkend="perl-text-diff"/>
1092 (optionally used during the tests)</para>
1093 </listitem>
1094 </itemizedlist>
1095
1096 </listitem>
1097 </itemizedlist>
1098 -->
1099
1100
1101 </sect2>
1102
1103 <sect2 role="installation" id="perl-standard-install"
1104 xreflabel="build and installation instructions">
1105 <title>Standard Installation of Perl Modules</title>
1106
1107 <para>Install <application>Perl</application> modules by running the
1108 following commands:</para>
1109
1110<screen><userinput>perl Makefile.PL &amp;&amp;
1111make &amp;&amp;
1112make test</userinput></screen>
1113
1114 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
1115
1116<screen role="root"><userinput>make install</userinput></screen>
1117
1118 <note>
1119
1120 <para>When reinstalling a <application>Perl</application> module,
1121 sometimes older versions of the module being reinstalled are in other
1122 directories specified in <parameter>@INC</parameter>. To delete all
1123 other versions of the module being reinstalled (not simply older ones)
1124 set the <varname>UNINST</varname> variable:</para>
1125
1126<screen><userinput>make install UNINST=1</userinput></screen>
1127 </note>
1128
1129 </sect2>
1130
1131 <sect2 role="installation">
1132 <title>(Alternate) Auto Installation of Perl Modules.</title>
1133
1134 <para>There is an alternate way of installing the modules using the
1135 <command>cpan</command> shell <command>install</command> command. The
1136 command automatically downloads the source from the CPAN archive, extracts
1137 it, runs the compilation, testing and installation commands mentioned
1138 above, and removes the build source tree. You may still need to install
1139 dependent library packages before running the automated installation
1140 method.</para>
1141
1142 <para>The first time you run <command>cpan</command>, you'll be prompted
1143 to enter some information regarding download locations and methods. This
1144 information is retained in files located in
1145 <filename class='directory'>~/.cpan</filename>. Start the
1146 <command>cpan</command> shell by issuing '<command>cpan</command>' as the
1147 <systemitem class="username">root</systemitem> user. Any module may now be
1148 installed from the
1149 <emphasis role='underlined'><prompt>cpan&gt;&nbsp;</prompt></emphasis>
1150 prompt with the command:</para>
1151
1152<screen role="root"><userinput>install <replaceable>&lt;Module::Name&gt;</replaceable></userinput></screen>
1153
1154 <para>For additional commands and help, issue '<command>help</command>'
1155 from the
1156 <emphasis role='underlined'><prompt>cpan&gt;&nbsp;</prompt></emphasis>
1157 prompt.</para>
1158
1159 <para>Alternatively, for scripted or non-interactive installations, use the
1160 following syntax as the
1161 <systemitem class="username">root</systemitem> user to install one or more
1162 modules:</para>
1163
1164<screen role="root"><userinput>cpan -i <replaceable>&lt;Module1::Name&gt; &lt;Module2::Name&gt;</replaceable></userinput></screen>
1165
1166 <para>Review the <filename>cpan.1</filename> man page for additional
1167 parameters you can pass to <command>cpan</command> on the command
1168 line.</para>
1169
1170 </sect2>
1171
1172</sect1>
Note: See TracBrowser for help on using the repository browser.