source: general/prog/perl-modules.xml@ a6af3ab9

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 a6af3ab9 was a6af3ab9, checked in by Ragnar Thomsen <rthomsen@…>, 12 years ago

Update/remove perl modules, remove pdl, libreoffice minor corrections.

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