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

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 6.3 6.3-rc1 6.3-rc2 6.3-rc3 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 a8d33f07 was 3b37f7e8, checked in by Randy McMurchy <randy@…>, 17 years ago

Updated to GnuCash-2.2.0

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@7014 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 61.5 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 <xref linkend="perl-test-pod"/>
53 module, are used by several of the listed dependencies of the main
54 module and perhaps also the module being installed. Dependencies such as
55 this are only listed once in the dependency chain for each main module
56 (typically near the bottom-most dependency) to avoid redundancy and
57 additional clutter in the instructions.</para>
58 </note>
59
60 <!-- This is info for the Test::Builder::Tester module which may very well
61 be obsolete now. The packages that need it apparently also now need
62 Test::More-0.62 which is a core Perl module in an updated version. To
63 install the Test::More-0.62 version you must install the
64 Test::Simple-0.62 module which will overwrite the Perl core stuff.
65 The Test::Simple-0.62 module now includes the Test::Builder::Tester
66 module. Perl versions starting with Perl-5.9.x will have this module
67 include in the core at which time Test::Builder::Tester can be forever
68 removed from this page as it will then also be a core module.
69
70 <para id="perl-test-builder-tester"><ulink
71 url="http://cpan.org/authors/id/M/MA/MARKF/Test-Builder-Tester-&Test-Builder-Tester-version;.tar.gz">
72 Test-Builder-Tester-&Test-Builder-Tester-version;</ulink></para>
73 <indexterm zone="perl-modules perl-test-builder-tester">
74 <primary sortas="g-Test-Builder-Tester">Test::Builder::Tester</primary>
75 </indexterm>
76 -->
77
78 <!-- Archive::Zip -->
79 <bridgehead renderas="sect3" id="perl-archive-zip"
80 xreflabel="Archive::Zip-&Archive-Zip-version;">
81 Archive::Zip-&Archive-Zip-version;</bridgehead>
82
83 <indexterm zone="perl-modules perl-archive-zip">
84 <primary sortas="g-Archive-Zip">Archive::Zip</primary>
85 </indexterm>
86
87 <para>The Archive::Zip module allows a <application>Perl</application>
88 program to create, manipulate, read, and write Zip archive files. The
89 modules listed below are installed using the standard
90 <application>Perl</application> module
91 <xref linkend="perl-standard-install"/>.</para>
92
93 <itemizedlist spacing='compact'>
94 <listitem>
95 <para><ulink
96 url="http://cpan.org/authors/id/A/AD/ADAMK/Archive-Zip-&Archive-Zip-version;.tar.gz">
97 Archive-Zip-&Archive-Zip-version;</ulink></para>
98
99 <itemizedlist>
100 <listitem>
101 <para><xref linkend="perl-compress-zlib"/></para>
102 </listitem>
103 <listitem>
104 <para><xref linkend="perl-test-pod"/>
105 (optionally used during the tests)</para>
106 </listitem>
107 </itemizedlist>
108
109 </listitem>
110 </itemizedlist>
111
112 <!-- Compress::Zlib -->
113 <bridgehead renderas="sect3" id="perl-compress-zlib"
114 xreflabel="Compress::Zlib-&Compress-Zlib-version;">
115 Compress::Zlib-&Compress-Zlib-version;</bridgehead>
116
117 <indexterm zone="perl-modules perl-compress-zlib">
118 <primary sortas="g-Compress-Zlib">Compress::Zlib</primary>
119 </indexterm>
120
121 <para>The Compress::Zlib module provides a <application>Perl</application>
122 interface to the <application>Zlib</application> compression library. Most
123 of the functionality provided by <application>Zlib</application> is
124 available in Compress::Zlib. The module can be split into two general areas
125 of functionality, namely in-memory compression/decompression and read/write
126 access to gzip files. This module and all the dependencies are installed
127 using the standard <xref linkend="perl-standard-install"/>.</para>
128
129 <note>
130 <para>The Compress::Raw::Zlib module requires the following
131 <command>sed</command> after untarring the distribution tarball (before
132 any other build commands) to use the system-installed copy of
133 <application>Zlib</application>.</para>
134
135<screen><userinput>sed -i -e "s|BUILD_ZLIB\s*= True|BUILD_ZLIB = False|" \
136 -e "s|INCLUDE\s*= ./zlib-src|INCLUDE = /usr/include|" \
137 -e "s|LIB\s*= ./zlib-src|LIB = /usr/lib|" \
138 config.in</userinput></screen>
139 </note>
140
141 <itemizedlist spacing='compact'>
142 <listitem>
143 <para><ulink
144 url="http://cpan.org/authors/id/P/PM/PMQS/Compress-Zlib-&Compress-Zlib-version;.tar.gz">
145 Compress-Zlib-&Compress-Zlib-version;</ulink>
146 (uses the standard <xref linkend="perl-standard-install"/>)</para>
147
148 <itemizedlist>
149 <listitem>
150 <para><ulink
151 url="http://cpan.org/authors/id/P/PM/PMQS/IO-Compress-Zlib-&IO-Compress-Zlib-version;.tar.gz">
152 IO-Compress-Zlib-&IO-Compress-Zlib-version;</ulink></para>
153
154 <itemizedlist>
155 <listitem>
156 <para><ulink
157 url="http://cpan.org/authors/id/P/PM/PMQS/Compress-Raw-Zlib-&Compress-Raw-Zlib-version;.tar.gz">
158 Compress-Raw-Zlib-&Compress-Raw-Zlib-version;</ulink></para>
159
160 <itemizedlist>
161 <listitem>
162 <para><ulink
163 url="http://cpan.org/authors/id/P/PM/PMQS/IO-Compress-Base-&IO-Compress-Base-version;.tar.gz">
164 IO-Compress-Base-&IO-Compress-Base-version;</ulink></para>
165 </listitem>
166 </itemizedlist>
167
168 </listitem>
169 <listitem>
170 <para><ulink
171 url="http://cpan.org/authors/id/P/PM/PMQS/IO-Compress-Bzip2-&IO-Compress-Bzip2-version;.tar.gz">
172 IO-Compress-Bzip2-&IO-Compress-Bzip2-version;</ulink> (used during the tests)</para>
173
174 <itemizedlist>
175 <listitem>
176 <para><ulink
177 url="http://cpan.org/authors/id/P/PM/PMQS/Compress-Raw-Bzip2-&Compress-Raw-Bzip2-version;.tar.gz">
178 Compress-Raw-Bzip2-&Compress-Raw-Bzip2-version;</ulink></para>
179
180 <itemizedlist>
181 <listitem>
182 <para><ulink
183 url="http://cpan.org/authors/id/P/PM/PMQS/IO-Compress-Base-&IO-Compress-Base-version;.tar.gz">
184 IO-Compress-Base-&IO-Compress-Base-version;</ulink></para>
185 </listitem>
186 </itemizedlist>
187
188 </listitem>
189 </itemizedlist>
190
191 </listitem>
192 </itemizedlist>
193
194 </listitem>
195 </itemizedlist>
196
197 </listitem>
198 </itemizedlist>
199
200 <!-- Date::Manip -->
201 <bridgehead renderas="sect3" id="perl-date-manip"
202 xreflabel="Date::Manip-&DateManip-version;">
203 Date::Manip-&DateManip-version;</bridgehead>
204
205 <indexterm zone="perl-modules perl-date-manip">
206 <primary sortas="g-Date-Manip">Date::Manip</primary>
207 </indexterm>
208
209 <para>Date::Manip is a set of routines designed to make any common
210 date/time manipulation easy to do. Operations such as comparing two times,
211 calculating a time a given amount of time from another, or parsing
212 international times are all easily done. From the very beginning, the
213 main focus of Date::Manip has been to be able to do ANY desired date/time
214 operation easily.</para>
215
216 <itemizedlist spacing='compact'>
217 <listitem>
218 <para><ulink
219 url="http://cpan.org/authors/id/S/SB/SBECK/DateManip-&DateManip-version;.tar.gz">
220 DateManip-&DateManip-version;</ulink>
221 (uses the standard <xref linkend="perl-standard-install"/>)</para>
222 </listitem>
223 </itemizedlist>
224
225 <!-- Finance::Quote -->
226 <bridgehead renderas="sect3" id="perl-finance-quote"
227 xreflabel="Finance::Quote-&Finance-Quote-version;">
228 Finance::Quote-&Finance-Quote-version;</bridgehead>
229
230 <indexterm zone="perl-modules perl-finance-quote">
231 <primary sortas="g-Finance-Quote">Finance::Quote</primary>
232 </indexterm>
233
234 <para>Finance::Quote is used to get stock quotes from various Internet
235 sources, including Yahoo! Finance, Fidelity Investments, and the Australian
236 Stock Exchange. There are two methods of using this module &ndash; a
237 functional interface that is depreciated, and an object-orientated method
238 that provides greater flexibility and stability. With the exception of
239 straight currency exchange rates, all information is returned as a
240 two-dimensional hash (or a reference to such a hash, if called in a scalar
241 context).</para>
242
243 <para>After you've installed the package, issue
244 <command>perldoc Finance::Quote</command> for full information.
245 Alternatively, you can issue <command>perldoc lib/Finance/Quote.pm</command>
246 after unpacking the distribution tarball and changing into the top-level
247 directory. The module and dependencies are installed using the
248 standard <application>Perl</application> module
249 <xref linkend="perl-standard-install"/>.</para>
250
251 <note>
252 <para>To run the regression test suite, you'll need a working Internet
253 connection and then create a symbolic link to the
254 <filename class='directory'>test</filename> directory using the following
255 command after unpacking the tarball and changing into the root directory
256 of the source tree:</para>
257
258<screen><userinput>ln -s test t</userinput></screen>
259
260 <para>Some tests will fail depending on certain conditions. See the
261 <filename>INSTALL</filename> file for full details.</para>
262 </note>
263
264 <itemizedlist spacing='compact'>
265 <listitem>
266 <para><ulink
267 url="http://cpan.org/authors/id/P/PJ/PJF/Finance-Quote-&Finance-Quote-version;.tar.gz">
268 Finance-Quote-&Finance-Quote-version;</ulink></para>
269
270 <itemizedlist>
271 <listitem>
272 <para><xref linkend="perl-html-tableextract"/></para>
273 </listitem>
274 <listitem>
275 <para><xref linkend="perl-lwp"/></para>
276 </listitem>
277 </itemizedlist>
278
279 </listitem>
280 </itemizedlist>
281
282 <!-- Finance::QuoteHist -->
283 <bridgehead renderas="sect3" id="perl-finance-quotehist"
284 xreflabel="Finance::QuoteHist-&Finance-QuoteHist-version;">
285 Finance::QuoteHist-&Finance-QuoteHist-version;</bridgehead>
286
287 <indexterm zone="perl-modules perl-finance-quotehist">
288 <primary sortas="g-Finance-QuoteHist">Finance::QuoteHist</primary>
289 </indexterm>
290
291 <para>The Finance::QuoteHist bundle is several modules designed to fetch
292 historical stock quotes from the web. The module and dependencies are
293 installed using the standard <application>Perl</application> module
294 <xref linkend="perl-standard-install"/>.</para>
295
296 <itemizedlist spacing='compact'>
297 <listitem>
298 <para><ulink
299 url="http://cpan.org/authors/id/M/MS/MSISK/Finance-QuoteHist-&Finance-QuoteHist-version;.tar.gz">
300 Finance-QuoteHist-&Finance-QuoteHist-version;</ulink></para>
301
302 <itemizedlist>
303 <listitem>
304 <para><xref linkend="perl-html-tableextract"/></para>
305 </listitem>
306 <listitem>
307 <para><xref linkend="perl-lwp"/></para>
308 </listitem>
309 <listitem>
310 <para><xref linkend="perl-date-manip"/></para>
311 </listitem>
312 <listitem>
313 <para id="perl-text-csv_pp"><ulink
314 url="http://cpan.org/authors/id/M/MA/MAKAMAKA/Text-CSV_PP-&Text-CSV_PP-version;.tar.gz">
315 Text-CSV_PP-&Text-CSV_PP-version;</ulink></para>
316 <indexterm zone="perl-modules perl-text-csv_pp">
317 <primary sortas="g-Text-CSV_PP">Text::CSV_PP</primary>
318 </indexterm>
319 </listitem>
320 <listitem>
321 <para id="perl-text-csv_xs"><ulink
322 url="http://cpan.org/authors/id/J/JW/JWIED/Text-CSV_XS-&Text-CSV_XS-version;.tar.gz">
323 Text-CSV_XS-&Text-CSV_XS-version; (optional)</ulink></para>
324 <indexterm zone="perl-modules perl-text-csv_xs">
325 <primary sortas="g-Text-CSV_XS">Text::CSV_XS</primary>
326 </indexterm>
327 </listitem>
328 </itemizedlist>
329
330 </listitem>
331 </itemizedlist>
332
333 <!-- HTML::Parser -->
334 <bridgehead renderas="sect3" id="perl-html-parser"
335 xreflabel="HTML::Parser-&HTML-Parser-version;">
336 HTML::Parser-&HTML-Parser-version;</bridgehead>
337
338 <indexterm zone="perl-modules perl-html-parser">
339 <primary sortas="g-HTML-Parser">HTML::Parser</primary>
340 </indexterm>
341
342 <para>The HTML::Parser distribution is a collection of modules that parse
343 and extract information from HTML documents. The modules listed below are
344 installed using the standard <application>Perl</application> module
345 <xref linkend="perl-standard-install"/>.</para>
346
347 <itemizedlist spacing='compact'>
348 <listitem>
349 <para><ulink
350 url="http://cpan.org/authors/id/G/GA/GAAS/HTML-Parser-&HTML-Parser-version;.tar.gz">
351 HTML-Parser-&HTML-Parser-version;</ulink></para>
352
353 <itemizedlist>
354 <listitem>
355 <para id="perl-html-tagset"><ulink
356 url="http://cpan.org/authors/id/P/PE/PETDANCE/HTML-Tagset-&HTML-Tagset-version;.tar.gz">
357 HTML-Tagset-&HTML-Tagset-version;</ulink></para>
358 <indexterm zone="perl-modules perl-html-tagset">
359 <primary sortas="g-HTML-Tagset">HTML::Tagset</primary>
360 </indexterm>
361
362 <itemizedlist>
363 <listitem>
364 <para><xref linkend="perl-test-pod"/>
365 (optionally used during the tests)</para>
366 </listitem>
367 </itemizedlist>
368
369 </listitem>
370 <listitem>
371 <para><xref linkend="perl-lwp"/> (run-time requirement for the
372 included HTML::HeadParser module)</para>
373 </listitem>
374 </itemizedlist>
375
376 </listitem>
377 </itemizedlist>
378
379 <!-- HTML::TableExtract -->
380 <bridgehead renderas="sect3" id="perl-html-tableextract"
381 xreflabel="HTML::TableExtract-&HTML-TableExtract-version;">
382 HTML::TableExtract-&HTML-TableExtract-version;</bridgehead>
383
384 <indexterm zone="perl-modules perl-html-tableextract">
385 <primary sortas="g-HTML-TableExtract">HTML::TableExtract</primary>
386 </indexterm>
387
388 <para>HTML::TableExtract is a module that simplifies the extraction of the
389 content contained in tables within HTML documents, extracted either as
390 text or encoded element trees. Tables of note may be specified using
391 Headers, Depth, Count, Attributes, or some combination of the four. The
392 module and dependencies are installed using the standard
393 <application>Perl</application> module
394 <xref linkend="perl-standard-install"/>.</para>
395
396 <itemizedlist spacing='compact'>
397 <listitem>
398 <para><ulink
399 url="http://cpan.org/authors/id/M/MS/MSISK/HTML-TableExtract-&HTML-TableExtract-version;.tar.gz">
400 HTML-TableExtract-&HTML-TableExtract-version;</ulink></para>
401
402 <itemizedlist>
403 <listitem>
404 <para id="perl-html-element-extended"><ulink
405 url="http://cpan.org/authors/id/M/MS/MSISK/HTML-Element-Extended-&HTML-Element-Extended-version;.tar.gz">
406 HTML-Element-Extended-&HTML-Element-Extended-version;</ulink></para>
407 <indexterm zone="perl-modules perl-html-element-extended">
408 <primary sortas="g-HTML-Element-Extended">HTML::Element::Extended</primary>
409 </indexterm>
410
411 <itemizedlist>
412 <listitem>
413 <para id="perl-html-tree"><ulink
414 url="http://cpan.org/authors/id/P/PE/PETEK/HTML-Tree-&HTML-Tree-version;.tar.gz">
415 HTML-Tree-&HTML-Tree-version;</ulink></para>
416 <indexterm zone="perl-modules perl-html-tree">
417 <primary sortas="g-HTML-Tree">HTML::Tree</primary>
418 </indexterm>
419
420 <itemizedlist>
421 <listitem>
422 <para><xref linkend="perl-html-parser"/></para>
423 </listitem>
424 <listitem>
425 <para><xref linkend="perl-test-pod"/>
426 (optionally used during the tests)</para>
427 </listitem>
428 </itemizedlist>
429
430 </listitem>
431 </itemizedlist>
432
433 </listitem>
434 <listitem>
435 <para><xref linkend="perl-test-pod-coverage"/>
436 (optionally used during the tests)</para>
437 </listitem>
438 </itemizedlist>
439
440 </listitem>
441 </itemizedlist>
442
443 <!-- LWP -->
444 <bridgehead renderas="sect3" id="perl-lwp"
445 xreflabel="libwww-perl-&LWP-version;">
446 libwww-perl-&LWP-version; (a.k.a. LWP)</bridgehead>
447
448 <indexterm zone="perl-modules perl-lwp">
449 <primary sortas="g-libwww-perl">libwww-perl</primary>
450 </indexterm>
451
452 <para>The libwww-perl (LWP) collection is a set of
453 <application>Perl</application> modules which provide a simple and
454 consistent application programming interface to the World-Wide Web. The
455 main focus of the library is to provide classes and functions that allow
456 you to write WWW clients. The library also contains modules that are of
457 more general use and even classes that help you implement simple HTTP
458 servers. The LWP collection and all its <application>Perl</application>
459 module dependencies are installed using the standard
460 <application>Perl</application> module
461 <xref linkend="perl-standard-install"/>.</para>
462
463 <itemizedlist spacing='compact'>
464 <listitem>
465 <para><ulink
466 url="http://cpan.org/authors/id/G/GA/GAAS/libwww-perl-&LWP-version;.tar.gz">
467 libwww-perl-&LWP-version;</ulink></para>
468
469 <itemizedlist>
470 <listitem>
471 <para id="perl-uri"><ulink
472 url="http://cpan.org/authors/id/G/GA/GAAS/URI-&URI-version;.tar.gz">
473 URI-&URI-version;</ulink></para>
474 <indexterm zone="perl-modules perl-uri">
475 <primary sortas="g-URI">URI</primary>
476 </indexterm>
477
478 <itemizedlist>
479 <listitem>
480 <para id="perl-business-isbn"><ulink
481 url="http://cpan.org/authors/id/B/BD/BDFOY/Business-ISBN-&Business-ISBN-version;.tar.gz">
482 Business-ISBN-&Business-ISBN-version;</ulink> (optional, only
483 used during the test suite)</para>
484 <indexterm zone="perl-modules perl-business-isbn">
485 <primary sortas="g-Business-ISBN">Business::ISBN</primary>
486 </indexterm>
487
488 <itemizedlist>
489 <listitem>
490 <para>LWP::Simple is required for many of the tests. This
491 is a circular dependency.</para>
492 </listitem>
493 <listitem>
494 <para id="perl-business-isbn-data"><ulink
495 url="http://cpan.org/authors/id/B/BD/BDFOY/Business-ISBN-Data-&Business-ISBN-Data-version;.tar.gz">
496 Business-ISBN-Data-&Business-ISBN-Data-version;</ulink></para>
497 <indexterm zone="perl-modules perl-business-isbn-data">
498 <primary sortas="g-Business-ISBN-Data">Business::ISBN::Data</primary>
499 </indexterm>
500
501 <itemizedlist>
502 <listitem>
503 <para id="perl-test-prereq"><ulink
504 url="http://cpan.org/authors/id/B/BD/BDFOY/Test-Prereq-&Test-Prereq-version;.tar.gz">
505 Test-Prereq-&Test-Prereq-version;</ulink> (you may need
506 to set up your CPAN access parameters by issuing the
507 command <command>perl -MCPAN -e shell</command> before
508 running the test suite, else the tests may hang)</para>
509 <indexterm zone="perl-modules perl-test-prereq">
510 <primary sortas="g-Test-Prereq">Test::Prereq</primary>
511 </indexterm>
512
513 <itemizedlist>
514 <listitem>
515 <para><xref linkend="perl-module-info"/></para>
516 </listitem>
517 <listitem>
518 <para><xref linkend="perl-module-build"/> (optional)</para>
519 </listitem>
520 <listitem>
521 <para id="perl-module-corelist"><ulink
522 url="http://cpan.org/authors/id/R/RG/RGARCIA/Module-CoreList-&Module-Corelist-version;.tar.gz">
523 Module-CoreList-&Module-Corelist-version;</ulink></para>
524 <indexterm zone="perl-modules perl-module-corelist">
525 <primary sortas="g-Module-Corelist">Module::Corelist</primary>
526 </indexterm>
527
528 <itemizedlist>
529 <listitem>
530 <para><xref linkend="perl-test-pod"/>
531 (optionally used during the tests)</para>
532 </listitem>
533 </itemizedlist>
534
535 </listitem>
536 </itemizedlist>
537
538 </listitem>
539 <listitem>
540 <para><xref linkend="perl-test-pod-coverage"/>
541 (optionally used during the tests)</para>
542 </listitem>
543 </itemizedlist>
544
545 </listitem>
546 </itemizedlist>
547
548 </listitem>
549 </itemizedlist>
550
551 </listitem>
552 <listitem>
553 <para><xref linkend="perl-html-parser"/></para>
554 </listitem>
555 <listitem>
556 <para><xref linkend="perl-compress-zlib"/></para>
557 </listitem>
558 <listitem>
559 <para id="perl-crypt-ssleay"
560 xreflabel="Crypt::SSLeay-&Crypt-SSLeay-version;"><ulink
561 url="http://cpan.org/authors/id/D/DL/DLAND/Crypt-SSLeay-&Crypt-SSLeay-version;.tar.gz">
562 Crypt-SSLeay-&Crypt-SSLeay-version;</ulink> (optional, for HTTPS
563 support)</para>
564 <indexterm zone="perl-modules perl-crypt-ssleay">
565 <primary sortas="g-Crypt-SSLeay">Crypt::SSLeay</primary>
566 </indexterm>
567
568 <itemizedlist>
569 <listitem>
570 <para><xref linkend="openssl"/></para>
571 </listitem>
572 <listitem>
573 <para>A <quote>testcover</quote> <filename>Makefile</filename>
574 target is created (which creates a
575 <command>/usr/bin/testcover</command> script) if the <ulink
576 url="http://cpan.org/authors/id/S/SM/SMPETERS/ExtUtils-MakeMaker-Coverage-0.05.tar.gz">
577 Extutils::MakeMaker::Coverage</ulink> module is installed.</para>
578 </listitem>
579 </itemizedlist>
580
581 </listitem>
582 </itemizedlist>
583
584 </listitem>
585 </itemizedlist>
586
587 <!-- Module::Build -->
588 <bridgehead renderas="sect3" id="perl-module-build"
589 xreflabel="Module::Build-&Module-Build-version;">
590 Module::Build-&Module-Build-version;</bridgehead>
591
592 <indexterm zone="perl-modules perl-module-build">
593 <primary sortas="g-Module-Build">Module::Build</primary>
594 </indexterm>
595
596 <para>The Module::Build module is a system for building, testing, and
597 installing <application>Perl</application> modules. It is meant to be an
598 alternative to ExtUtils::MakeMaker. Developers may alter the behavior of
599 the module through subclassing in a much more straightforward way than with
600 MakeMaker. It also does not require a <command>make</command> command on
601 your system. Most of the Module::Build code is
602 pure-<application>Perl</application> and written in a very cross-platform
603 way.</para>
604
605 <para>The Module::Build module (as well as any other
606 <application>Perl</application> module that uses the Module::Build build
607 system) uses <xref linkend="perl-module-build-install"/>. All the
608 dependencies are installed using the standard
609 <application>Perl</application> module
610 <xref linkend="perl-standard-install"/>.</para>
611
612 <itemizedlist spacing='compact'>
613 <listitem>
614 <para><ulink
615 url="http://cpan.org/authors/id/K/KW/KWILLIAMS/Module-Build-&Module-Build-version;.tar.gz">
616 Module-Build-&Module-Build-version;</ulink></para>
617
618 <itemizedlist>
619 <listitem>
620 <para id="perl-extutils-parsexs"><ulink
621 url="http://cpan.org/authors/id/K/KW/KWILLIAMS/ExtUtils-ParseXS-&ExtUtils-ParseXS-version;.tar.gz">
622 ExtUtils-ParseXS-&ExtUtils-ParseXS-version;</ulink></para>
623 <indexterm zone="perl-modules perl-extutils-parsexs">
624 <primary sortas="g-ExtUtils-ParseXS">ExtUtils::ParseXS</primary>
625 </indexterm>
626
627 <itemizedlist>
628 <listitem>
629 <para id="perl-extutils-cbuilder"><ulink
630 url="http://cpan.org/authors/id/K/KW/KWILLIAMS/ExtUtils-CBuilder-&ExtUtils-CBuilder-version;.tar.gz">
631 ExtUtils-CBuilder-&ExtUtils-CBuilder-version;</ulink></para>
632 <indexterm zone="perl-modules perl-extutils-cbuilder">
633 <primary sortas="g-ExtUtils-CBuilder">ExtUtils::CBuilder</primary>
634 </indexterm>
635 </listitem>
636 </itemizedlist>
637
638 </listitem>
639 <listitem>
640 <para id="perl-archive-tar"><ulink
641 url="http://cpan.org/authors/id/K/KA/KANE/Archive-Tar-&Archive-Tar-version;.tar.gz">
642 Archive-Tar-&Archive-Tar-version;</ulink></para>
643 <indexterm zone="perl-modules perl-archive-tar">
644 <primary sortas="g-Archive-Tar">Archive::Tar</primary>
645 </indexterm>
646
647 <itemizedlist>
648 <listitem>
649 <para id="perl-io-zlib"><ulink
650 url="http://cpan.org/authors/id/T/TO/TOMHUGHES/IO-Zlib-&IO-Zlib-version;.tar.gz">
651 IO-Zlib-&IO-Zlib-version;</ulink></para>
652 <indexterm zone="perl-modules perl-io-zlib">
653 <primary sortas="g-IO-Zlib">IO::Zlib</primary>
654 </indexterm>
655
656 <itemizedlist>
657 <listitem>
658 <para><xref linkend="perl-compress-zlib"/></para>
659 </listitem>
660 </itemizedlist>
661
662 </listitem>
663 <listitem>
664 <para><xref linkend="perl-text-diff"/></para>
665 </listitem>
666 </itemizedlist>
667
668 </listitem>
669 <listitem>
670 <para id="perl-pod-readme"><ulink
671 url="http://cpan.org/authors/id/R/RR/RRWO/Pod-Readme-&Pod-Readme-version;.tar.gz">
672 Pod-Readme-&Pod-Readme-version;</ulink> (optionally used to create
673 a <filename>README</filename> file when creating a new module
674 distribution)</para>
675 <indexterm zone="perl-modules perl-pod-readme">
676 <primary sortas="g-Pod-Readme">Pod::Readme</primary>
677 </indexterm>
678
679 <itemizedlist>
680 <listitem>
681 <para id="perl-test-portability-files"><ulink
682 url="http://cpan.org/authors/id/S/SA/SAPER/Test-Portability-Files-&Test-Portability-Files-version;.tar.gz">
683 Test-Portability-Files-&Test-Portability-Files-version;</ulink>
684 (optionally used during the tests)</para>
685 <indexterm zone="perl-modules perl-test-portability-files">
686 <primary sortas="g-Test-Portability-Files">Test::Portability::Files</primary>
687 </indexterm>
688 </listitem>
689 <listitem>
690 <para><xref linkend="perl-test-pod-coverage"/>
691 (optionally used during the tests)</para>
692 </listitem>
693 <listitem>
694 <para><xref linkend="perl-test-pod"/>
695 (optionally used during the tests)</para>
696 </listitem>
697 </itemizedlist>
698
699 </listitem>
700 <listitem>
701 <para><xref linkend="perl-module-signature"/> (required to use the
702 Module::Build <quote>distsign</quote> run-time method and
703 optionally used during the tests)</para>
704 </listitem>
705 <listitem>
706 <para><xref linkend="perl-yaml"/> (optional, provides additional
707 features to <application>Module::Build</application>)</para>
708 </listitem>
709 </itemizedlist>
710
711 </listitem>
712 </itemizedlist>
713
714 <bridgehead renderas="sect4" id="perl-module-build-install"
715 xreflabel="modified build instructions">Module::Build Build and
716 Installation Instructions</bridgehead>
717
718<screen><userinput>perl Build.PL &amp;&amp;
719./Build &amp;&amp;
720./Build test</userinput></screen>
721
722 <para>Now, as the <systemitem class='username'>root</systemitem> user:</para>
723
724<screen role='root'><userinput>./Build install</userinput></screen>
725
726 <!-- Module::Info -->
727 <bridgehead renderas="sect3" id="perl-module-info"
728 xreflabel="Module::Info-&Module-Info-version;">
729 Module::Info-&Module-Info-version;</bridgehead>
730
731 <indexterm zone="perl-modules perl-module-info">
732 <primary sortas="g-Module-Info">Module::Info</primary>
733 </indexterm>
734
735 <para>The Module::Info module is quite useful for tasks other than just
736 support of other modules. It can be used from the command-line to tell you
737 if a particular module is included in, or has been installed into your
738 <application>Perl</application> installation. Additionally, Module::Info
739 can tell you what version of a module is installed and what dependencies
740 are required for it. You can even use Module::Info to gather dependencies
741 of uninstalled modules. The Module::Info module and dependencies install
742 using the standard <application>Perl</application> module
743 <xref linkend="perl-standard-install"/>.</para>
744
745 <itemizedlist spacing='compact'>
746 <listitem>
747 <para><ulink
748 url="http://cpan.org/authors/id/M/MB/MBARBON/Module-Info-&Module-Info-version;.tar.gz">
749 Module-Info-&Module-Info-version;</ulink></para>
750
751 <itemizedlist>
752 <listitem>
753 <para id="perl-version-module"><ulink
754 url="http://cpan.org/authors/id/J/JP/JPEACOCK/version-&version-perl-version;.tar.gz">
755 version-&version-perl-version;</ulink>
756 (optionally used during the tests)</para>
757 <indexterm zone="perl-modules perl-version-module">
758 <primary sortas="g-version">version</primary>
759 </indexterm>
760
761 <itemizedlist>
762 <listitem>
763 <para><xref linkend="perl-module-build"/> (optional)</para>
764 </listitem>
765 </itemizedlist>
766
767 </listitem>
768 <listitem>
769 <para><xref linkend="perl-test-pod"/>
770 (optionally used during the tests)</para>
771 </listitem>
772 </itemizedlist>
773
774 </listitem>
775 </itemizedlist>
776
777 <!-- Module::Signature -->
778 <bridgehead renderas="sect3" id="perl-module-signature"
779 xreflabel="Module::Signature-&Module-Signature-version;">
780 Module::Signature-&Module-Signature-version;</bridgehead>
781
782 <indexterm zone="perl-modules perl-module-signature">
783 <primary sortas="g-Module-Signature">Module::Signature</primary>
784 </indexterm>
785
786 <para>The Module::Signature module is used to check and create
787 <filename>SIGNATURE</filename> files for CPAN distributions. After
788 installing Module::Signature you can verify the content of a distribution
789 tarball (if it includes a <filename>SIGNATURE</filename> file) by unpacking
790 the tarball, changing into the newly created directory and issuing the
791 command <command>cpansign -v</command>. It will check each file's
792 integrity, as well as the signature's validity. Note that some of the
793 dependencies appear to be circular, however, they are only run-time
794 conflicts and you should be able to fully utilize them as long as
795 everything is installed. Module::Signature and the dependency modules are
796 installed using the standard <application>Perl</application>
797 module <xref linkend="perl-standard-install"/>.</para>
798
799 <itemizedlist spacing='compact'>
800 <listitem>
801 <para><ulink
802 url="http://cpan.org/authors/id/A/AU/AUDREYT/Module-Signature-&Module-Signature-version;.tar.gz">
803 Module-Signature-&Module-Signature-version;</ulink></para>
804
805 <itemizedlist>
806 <listitem>
807 <para><xref linkend="perl-text-diff"/></para>
808 </listitem>
809 <listitem>
810 <para id="perl-par-dist"><ulink
811 url="http://cpan.org/authors/id/S/SM/SMUELLER/PAR-Dist-&PAR-Dist-version;.tar.gz">
812 PAR-Dist-&PAR-Dist-version;</ulink></para>
813 <indexterm zone="perl-modules perl-par-dist">
814 <primary sortas="g-PAR-Dist">PAR::Dist</primary>
815 </indexterm>
816
817 <itemizedlist>
818 <listitem>
819 <para><xref linkend="perl-archive-zip"/></para>
820 </listitem>
821 <listitem>
822 <para><xref linkend="perl-lwp"/></para>
823 </listitem>
824 <listitem>
825 <para><xref linkend="perl-module-signature"/></para>
826 </listitem>
827 </itemizedlist>
828
829 </listitem>
830 <listitem>
831 <para id="perl-digest-sha"><ulink
832 url="http://cpan.org/authors/id/M/MS/MSHELOR/Digest-SHA-&Digest-SHA-version;.tar.gz">
833 Digest-SHA-&Digest-SHA-version;</ulink></para>
834 <indexterm zone="perl-modules perl-digest-sha">
835 <primary sortas="g-Digest-SHA">Digest::SHA</primary>
836 </indexterm>
837
838 <itemizedlist>
839 <listitem>
840 <para><xref linkend="perl-test-pod-coverage"/>
841 (optionally used during the tests)</para>
842 </listitem>
843 </itemizedlist>
844
845 </listitem>
846 <listitem>
847 <para><xref linkend="gnupg"/></para>
848 </listitem>
849 </itemizedlist>
850
851 </listitem>
852 </itemizedlist>
853
854 <!-- Net::DNS -->
855 <bridgehead renderas="sect3" id="perl-net-dns"
856 xreflabel="Net-DNS-&Net-DNS-version;">
857 Net::DNS-&Net-DNS-version;</bridgehead>
858
859 <indexterm zone="perl-modules perl-net-dns">
860 <primary sortas="g-Net-DNS">Net::DNS</primary>
861 </indexterm>
862
863 <para>Net::DNS is a DNS resolver implemented in
864 <application>Perl</application>. It can be used to perform nearly any type
865 of DNS query from a <application>Perl</application> script. The Net::DNS
866 module and all its dependencies are installed using the standard
867 <application>Perl</application> module
868 <xref linkend="perl-standard-install"/>.</para>
869
870 <itemizedlist spacing='compact'>
871 <listitem>
872 <para><ulink
873 url="http://cpan.org/authors/id/O/OL/OLAF/Net-DNS-&Net-DNS-version;.tar.gz">
874 Net-DNS-&Net-DNS-version;</ulink></para>
875
876 <itemizedlist>
877 <listitem>
878 <para id="perl-digest-hmac"><ulink
879 url="http://cpan.org/authors/id/G/GA/GAAS/Digest-HMAC-&Digest-HMAC-version;.tar.gz">
880 Digest-HMAC-&Digest-HMAC-version;</ulink></para>
881 <indexterm zone="perl-modules perl-digest-hmac">
882 <primary sortas="g-Digest-HMAC">Digest::HMAC</primary>
883 </indexterm>
884
885 <itemizedlist>
886 <listitem>
887 <para id="perl-digest-sha1"><ulink
888 url="http://cpan.org/authors/id/G/GA/GAAS/Digest-SHA1-&Digest-SHA1-version;.tar.gz">
889 Digest-SHA1-&Digest-SHA1-version;</ulink></para>
890 <indexterm zone="perl-modules perl-digest-sha1">
891 <primary sortas="g-Digest-SHA1">Digest::SHA1</primary>
892 </indexterm>
893 </listitem>
894 </itemizedlist>
895
896 </listitem>
897 <listitem>
898 <para id="perl-net-ip"><ulink
899 url="http://cpan.org/authors/id/M/MA/MANU/Net-IP-&Net-IP-version;.tar.gz">
900 Net-IP-&Net-IP-version;</ulink></para>
901 <indexterm zone="perl-modules perl-net-ip">
902 <primary sortas="g-Net-IP">Net::IP</primary>
903 </indexterm>
904 </listitem>
905 <listitem>
906 <para id="perl-io-socket-inet6"><ulink
907 url="http://cpan.org/authors/id/M/MO/MONDEJAR/IO-Socket-INET6-&IO-Socket-INET6-version;.tar.gz">
908 IO-Socket-INET6-&IO-Socket-INET6-version;</ulink> (required for
909 IPv6 support)</para>
910 <indexterm zone="perl-modules perl-io-socket-inet6">
911 <primary sortas="g-IO-Socket-INET6">IO::Socket::INET6</primary>
912 </indexterm>
913
914 <itemizedlist>
915 <listitem>
916 <para id="perl-socket6"><ulink
917 url="http://cpan.org/authors/id/U/UM/UMEMOTO/Socket6-&Socket6-version;.tar.gz">
918 Socket6-&Socket6-version;</ulink></para>
919 <indexterm zone="perl-modules perl-socket6">
920 <primary sortas="g-Socket6">Socket6</primary>
921 </indexterm>
922 </listitem>
923 </itemizedlist>
924
925 </listitem>
926 <listitem>
927 <para id="perl-digest-bubblebabble"><ulink
928 url="http://cpan.org/authors/id/B/BT/BTROTT/Digest-BubbleBabble-&Digest-BubbleBabble-version;.tar.gz">
929 Digest-BubbleBabble-&Digest-BubbleBabble-version;</ulink></para>
930 <indexterm zone="perl-modules perl-digest-bubblebabble">
931 <primary sortas="g-Digest-BubbleBabble">Digest::BubbleBabble</primary>
932 </indexterm>
933 </listitem>
934 <listitem>
935 <para><xref linkend="perl-test-pod"/> (optional, only used during the test suite)</para>
936 </listitem>
937 </itemizedlist>
938
939 </listitem>
940 </itemizedlist>
941
942
943 <!-- Pod::Coverage -->
944 <bridgehead renderas="sect3" id="perl-pod-coverage"
945 xreflabel="Pod::Coverage-&Pod-Coverage-version;">
946 Pod::Coverage-&Pod-Coverage-version;</bridgehead>
947
948 <indexterm zone="perl-modules perl-pod-coverage">
949 <primary sortas="g-Pod-Coverage">Pod::Coverage</primary>
950 </indexterm>
951
952 <para>The Pod::Coverage module is a <application>Perl</application> library
953 used to check if the documentation of a module is comprehensive. This
954 module can use the Module::Build
955 <xref linkend="perl-module-build-install"/>, but is not required. All the
956 dependencies are installed using the standard
957 <application>Perl</application> module
958 <xref linkend="perl-standard-install"/>.</para>
959
960 <itemizedlist spacing='compact'>
961 <listitem>
962 <para><ulink
963 url="http://cpan.org/authors/id/R/RC/RCLAMP/Pod-Coverage-&Pod-Coverage-version;.tar.gz">
964 Pod-Coverage-&Pod-Coverage-version;</ulink></para>
965
966 <itemizedlist>
967 <listitem>
968 <para id="perl-devel-symdump"><ulink
969 url="http://cpan.org/authors/id/A/AN/ANDK/Devel-Symdump-&Devel-Symdump-version;.tar.gz">
970 Devel-Symdump-&Devel-Symdump-version;</ulink></para>
971 <indexterm zone="perl-modules perl-devel-symdump">
972 <primary sortas="g-Devel-Symdump">Devel::Symdump</primary>
973 </indexterm>
974
975 <itemizedlist>
976 <listitem>
977 <para><xref linkend="perl-test-pod-coverage"/>
978 (optionally used during the tests, and is a circular
979 dependency)</para>
980 </listitem>
981 <listitem>
982 <para><xref linkend="perl-test-pod"/>
983 (optionally used during the tests)</para>
984 </listitem>
985 </itemizedlist>
986
987 </listitem>
988 <listitem>
989 <para><xref linkend="perl-module-build"/> (optional)</para>
990 </listitem>
991 </itemizedlist>
992
993 </listitem>
994 </itemizedlist>
995
996 <!-- SGMLSpm -->
997 <bridgehead renderas="sect3" id="perl-sgmlspm"
998 xreflabel="SGMLSpm-&SGMLSpm-version;">
999 SGMLSpm-&SGMLSpm-version;</bridgehead>
1000
1001 <indexterm zone="perl-modules perl-sgmlspm">
1002 <primary sortas="g-SGMLSpm">SGMLSpm</primary>
1003 </indexterm>
1004
1005 <para>The SGMLSpm module is a <application>Perl</application> library
1006 used for parsing the output from James Clark's SGMLS and NSGMLS
1007 parsers. This module requires modified installation instructions, shown
1008 below.</para>
1009
1010 <itemizedlist spacing='compact'>
1011 <listitem>
1012 <para><ulink
1013 url="http://cpan.org/authors/id/D/DM/DMEGG/SGMLSpm-&SGMLSpm-version;.tar.gz">
1014 SGMLSpm-&SGMLSpm-version;</ulink></para>
1015 </listitem>
1016 </itemizedlist>
1017
1018 <para>If your system's <application>Perl</application> version is different
1019 than &lfs-perl-version;, you'll need to modify the <command>sed</command>
1020 command below to reflect the version you have installed.</para>
1021
1022<screen><userinput>sed -i -e "s@/usr/local/bin@/usr/bin@" \
1023 -e "s@/usr/local/lib/perl5@/usr/lib/perl5/site_perl/&lfs-perl-version;@" \
1024 -e "s@/usr/local/lib/www/docs@/usr/share/doc/perl5@" \
1025 Makefile</userinput></screen>
1026
1027 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
1028
1029<screen role="root"><userinput>make install &amp;&amp;
1030install -v -m755 -d /usr/share/doc/perl5 &amp;&amp;
1031make install_html &amp;&amp;
1032rm -v -f /usr/share/doc/perl5/SGMLSpm/sample.pl &amp;&amp;
1033install -v -m644 DOC/sample.pl /usr/share/doc/perl5/SGMLSpm</userinput></screen>
1034
1035 <!-- Test::Pod -->
1036 <bridgehead renderas="sect3" id="perl-test-pod"
1037 xreflabel="Test::Pod-&Test-Pod-version;">
1038 Test::Pod-&Test-Pod-version;</bridgehead>
1039
1040 <indexterm zone="perl-modules perl-test-pod">
1041 <primary sortas="g-Test-Pod">Test::Pod</primary>
1042 </indexterm>
1043
1044 <para>The Test:Pod module is (most of the time, optionally) used by other
1045 modules during the build process to check the validity of POD (Plain Old
1046 Documentation) files. The Test::Pod module is typically included by module
1047 authors to automatically find and check all POD files in a module
1048 distribution. This module and all the dependencies are installed using
1049 the standard <application>Perl</application> module
1050 <xref linkend="perl-standard-install"/>.</para>
1051
1052 <itemizedlist spacing='compact'>
1053 <listitem>
1054 <para><ulink
1055 url="http://cpan.org/authors/id/P/PE/PETDANCE/Test-Pod-&Test-Pod-version;.tar.gz">
1056 Test-Pod-&Test-Pod-version;</ulink></para>
1057
1058 <itemizedlist>
1059 <listitem>
1060 <para id="perl-pod-simple"><ulink
1061 url="http://cpan.org/authors/id/A/AR/ARANDAL/Pod-Simple-&Pod-Simple-version;.tar.gz">
1062 Pod-Simple-&Pod-Simple-version;</ulink></para>
1063 <indexterm zone="perl-modules perl-pod-simple">
1064 <primary sortas="g-Pod-Simple">Pod::Simple</primary>
1065 </indexterm>
1066
1067 <itemizedlist>
1068 <listitem>
1069 <para id="perl-pod-escapes"><ulink
1070 url="http://cpan.org/authors/id/S/SB/SBURKE/Pod-Escapes-&Pod-Escapes-version;.tar.gz">
1071 Pod-Escapes-&Pod-Escapes-version;</ulink></para>
1072 <indexterm zone="perl-modules perl-pod-escapes">
1073 <primary sortas="g-Pod-Escapes">Pod::Escapes</primary>
1074 </indexterm>
1075 </listitem>
1076 </itemizedlist>
1077
1078 </listitem>
1079 <listitem>
1080 <para><xref linkend="perl-test-simple"/></para>
1081 </listitem>
1082 </itemizedlist>
1083
1084 </listitem>
1085 </itemizedlist>
1086
1087 <!-- Test::Pod::Coverage -->
1088 <bridgehead renderas="sect3" id="perl-test-pod-coverage"
1089 xreflabel="Test::Pod::Coverage-&Test-Pod-Coverage-version;">
1090 Test::Pod::Coverage-&Test-Pod-Coverage-version;</bridgehead>
1091
1092 <indexterm zone="perl-modules perl-test-pod-coverage">
1093 <primary sortas="g-Test-Pod-Coverage">Test::Pod::Coverage</primary>
1094 </indexterm>
1095
1096 <para>The Test::Pod::Coverage module is used to check files in a
1097 distribution for POD coverage. It is normally used by developers to
1098 ensure their projects are adequately covered with POD and it is also used
1099 in the test suites of many module distributions. This module and all the
1100 dependencies are installed using the standard
1101 <application>Perl</application> module
1102 <xref linkend="perl-standard-install"/>.</para>
1103
1104 <itemizedlist spacing='compact'>
1105 <listitem>
1106 <para><ulink
1107 url="http://cpan.org/authors/id/P/PE/PETDANCE/Test-Pod-Coverage-&Test-Pod-Coverage-version;.tar.gz">
1108 Test-Pod-Coverage-&Test-Pod-Coverage-version;</ulink></para>
1109
1110 <itemizedlist>
1111 <listitem>
1112 <para id="perl-test-builder-tester">
1113 <xref linkend="perl-test-simple"/> or
1114 <ulink
1115 url="http://cpan.org/authors/id/M/MA/MARKF/Test-Builder-Tester-&Test-Builder-Tester-version;.tar.gz">
1116 Test-Builder-Tester-&Test-Builder-Tester-version;</ulink></para>
1117 <indexterm zone="perl-modules perl-test-builder-tester">
1118 <primary sortas="g-Test-Builder-Tester">Test::Builder::Tester</primary>
1119 </indexterm>
1120 </listitem>
1121 <listitem>
1122 <para><xref linkend="perl-pod-coverage"/></para>
1123 </listitem>
1124 </itemizedlist>
1125
1126 </listitem>
1127 </itemizedlist>
1128
1129 <!-- Test::Simple -->
1130 <bridgehead renderas="sect3" id="perl-test-simple"
1131 xreflabel="Test::Simple-&Test-Simple-version;">
1132 Test::Simple-&Test-Simple-version;</bridgehead>
1133
1134 <indexterm zone="perl-modules perl-test-simple">
1135 <primary sortas="g-Test-Simple">Test::Simple</primary>
1136 </indexterm>
1137
1138 <para>The Test::Simple module contains utilities designed to assist
1139 developers in creating tests. A version of Test::Simple was installed
1140 during LFS with the <application>Perl</application>-&lfs-perl-version;
1141 installation, however, some of the sub-modules contained in Test::Simple
1142 have been updated (notably, the Test::More module) and these updated
1143 modules are now required by other modules. This updated version of
1144 Test::Simple also now includes the Test:Builder:Tester module, required by
1145 many of the modules on this page. Note that installing this updated
1146 version of Test::Simple will overwrite some files from the original
1147 <application>Perl</application> installation, but there's really nothing to
1148 be alarmed about as these modules are only used by developers creating
1149 tests, or for running the test suites during additional module
1150 installations.</para>
1151
1152 <itemizedlist spacing='compact'>
1153 <listitem>
1154 <para><ulink
1155 url="http://cpan.org/authors/id/M/MS/MSCHWERN/Test-Simple-&Test-Simple-version;.tar.gz">
1156 Test-Simple-&Test-Simple-version;</ulink>
1157 (uses the standard <xref linkend="perl-standard-install"/>)</para>
1158
1159 <itemizedlist>
1160 <listitem>
1161 <para><xref linkend="perl-module-signature"/>
1162 (optionally used during the tests)</para>
1163 </listitem>
1164 <listitem>
1165 <para><xref linkend="perl-test-pod-coverage"/>
1166 (optionally used during the tests, and is circular)</para>
1167 </listitem>
1168 <listitem>
1169 <para><xref linkend="perl-pod-coverage"/>
1170 (optionally used during the tests, and is circular)</para>
1171 </listitem>
1172 </itemizedlist>
1173
1174 </listitem>
1175 </itemizedlist>
1176
1177 <!-- Text::Diff -->
1178 <bridgehead renderas="sect3" id="perl-text-diff"
1179 xreflabel="Text::Diff-&Text-Diff-version;">
1180 Text::Diff-&Text-Diff-version;</bridgehead>
1181
1182 <indexterm zone="perl-modules perl-text-diff">
1183 <primary sortas="g-Text-Diff">Text::Diff</primary>
1184 </indexterm>
1185
1186 <para>Text::Diff is used to perform diffs on files and record sets. It
1187 provides a basic set of services akin to the GNU <command>diff</command>
1188 utility. It is not anywhere near as feature complete as GNU
1189 <command>diff</command>, but it is better integrated with
1190 <application>Perl</application> and available on all platforms. Text::Diff
1191 is often faster than shelling out to a system's <command>diff</command>
1192 executable for small files, and generally slower on larger files. The
1193 modules listed below are installed using the standard
1194 <application>Perl</application> module
1195 <xref linkend="perl-standard-install"/>.</para>
1196
1197 <itemizedlist spacing='compact'>
1198 <listitem>
1199 <para><ulink
1200 url="http://cpan.org/authors/id/R/RB/RBS/Text-Diff-&Text-Diff-version;.tar.gz">
1201 Text-Diff-&Text-Diff-version;</ulink></para>
1202
1203 <itemizedlist>
1204 <listitem>
1205 <para id="perl-algorithm-diff"><ulink
1206 url="http://cpan.org/authors/id/T/TY/TYEMQ/Algorithm-Diff-&Algorithm-Diff-version;.tar.gz">
1207 Algorithm-Diff-&Algorithm-Diff-version;</ulink></para>
1208 <indexterm zone="perl-modules perl-algorithm-diff">
1209 <primary sortas="g-Algorithm-Diff">Algorithm::Diff</primary>
1210 </indexterm>
1211 </listitem>
1212 </itemizedlist>
1213
1214 </listitem>
1215 </itemizedlist>
1216
1217 <!-- Tk -->
1218 <bridgehead renderas="sect3" id="tk-perl"
1219 xreflabel="Tk-Perl-&Tk-Perl-version;">
1220 Tk-&Tk-Perl-version;</bridgehead>
1221
1222 <indexterm zone="perl-modules tk-perl">
1223 <primary sortas="g-Tk">Tk</primary>
1224 </indexterm>
1225
1226 <para>The <application>Tk</application> module is a
1227 <application>Perl</application> interface to the
1228 <application>Tk</application> package. The goal of this release is Unicode
1229 support via <application>Perl</application>'s and
1230 core-<application>Tk</application>'s use of UTF-8. Tk-&Tk-Perl-version;
1231 builds and loads into a threaded <application>Perl</application> but is NOT
1232 yet thread safe. The module is installed using the standard
1233 <application>Perl</application> module
1234 <xref linkend="perl-standard-install"/>.</para>
1235
1236 <itemizedlist spacing='compact'>
1237 <listitem>
1238 <para><ulink
1239 url="http://cpan.org/authors/id/N/NI/NI-S/Tk-&Tk-Perl-version;.tar.gz">
1240 Tk-&Tk-Perl-version;</ulink></para>
1241
1242 <itemizedlist>
1243 <listitem>
1244 <para><xref linkend="tk"/> and <xref linkend="libjpeg"/></para>
1245 </listitem>
1246 </itemizedlist>
1247
1248 </listitem>
1249 </itemizedlist>
1250
1251 <!-- XML::Parser -->
1252 <bridgehead renderas="sect3" id="perl-xml-parser"
1253 xreflabel="XML::Parser-&XML-Parser-version;">
1254 XML::Parser-&XML-Parser-version;</bridgehead>
1255
1256 <indexterm zone="perl-modules perl-xml-parser">
1257 <primary sortas="g-XML-Parser">XML::Parser</primary>
1258 </indexterm>
1259
1260 <para>The XML::Parser module is a <application>Perl</application> extension
1261 interface to James Clark's XML parser,
1262 <application>expat</application>. The module is installed using the
1263 standard <application>Perl</application> module
1264 <xref linkend="perl-standard-install"/>.</para>
1265
1266 <itemizedlist spacing='compact'>
1267 <listitem>
1268 <para><ulink
1269 url="http://cpan.org/authors/id/M/MS/MSERGEANT/XML-Parser-&XML-Parser-version;.tar.gz">
1270 XML-Parser-&XML-Parser-version;</ulink></para>
1271
1272 <itemizedlist>
1273 <listitem>
1274 <para><xref linkend="expat"/></para>
1275 </listitem>
1276 </itemizedlist>
1277 <itemizedlist>
1278 <listitem>
1279 <para><xref linkend="perl-lwp"/>
1280 (optionally used during the tests)</para>
1281 </listitem>
1282 </itemizedlist>
1283
1284 </listitem>
1285 </itemizedlist>
1286
1287 <!-- XML::Simple -->
1288 <bridgehead renderas="sect3" id="perl-xml-simple"
1289 xreflabel="XML::Simple-&XML-Simple-version;">
1290 XML::Simple-&XML-Simple-version;</bridgehead>
1291
1292 <indexterm zone="perl-modules perl-xml-simple">
1293 <primary sortas="g-XML-Simple">XML::Simple</primary>
1294 </indexterm>
1295
1296 <para>The XML::Simple module is a <application>Perl</application> extension
1297 that provides an easy API to read and write XML (especially config files).
1298 The module and all dependencies are installed using the standard
1299 <application>Perl</application> module
1300 <xref linkend="perl-standard-install"/>.</para>
1301
1302 <itemizedlist spacing='compact'>
1303 <listitem>
1304 <para><ulink
1305 url="http://cpan.org/authors/id/G/GR/GRANTM/XML-Simple-&XML-Simple-version;.tar.gz">
1306 XML-Simple-&XML-Simple-version;</ulink></para>
1307
1308 <itemizedlist>
1309 <listitem>
1310 <para>One of the following four modules must be installed:</para>
1311
1312 <itemizedlist>
1313 <listitem>
1314 <para id="perl-xml-sax"><ulink
1315 url="http://cpan.org/authors/id/G/GR/GRANTM/XML-SAX-&XML-SAX-version;.tar.gz">
1316 XML-SAX-&XML-SAX-version;</ulink></para>
1317 <indexterm zone="perl-modules perl-xml-sax">
1318 <primary sortas="g-XML-SAX">XML::SAX</primary>
1319 </indexterm>
1320
1321 <itemizedlist>
1322 <listitem>
1323 <para id="perl-xml-namespacesupport"><ulink
1324 url="http://cpan.org/authors/id/R/RB/RBERJON/XML-NamespaceSupport-&XML-NamespaceSupport-version;.tar.gz">
1325 XML-NamespaceSupport-&XML-NamespaceSupport-version;</ulink></para>
1326 <indexterm zone="perl-modules perl-xml-namespacesupport">
1327 <primary sortas="g-XML-NamespaceSupport">XML::NamespaceSupport</primary>
1328 </indexterm>
1329 </listitem>
1330 </itemizedlist>
1331
1332 </listitem>
1333 <listitem>
1334 <para id="perl-xml-sax-expat"><ulink
1335 url="http://cpan.org/authors/id/B/BJ/BJOERN/XML-SAX-Expat-&XML-SAX-Expat-version;.tar.gz">
1336 XML-SAX-Expat-&XML-SAX-Expat-version;</ulink></para>
1337 <indexterm zone="perl-modules perl-xml-sax-expat">
1338 <primary sortas="g-XML-SAX-Expat">XML::SAX::Expat</primary>
1339 </indexterm>
1340 </listitem>
1341 <listitem>
1342 <para id="perl-xml-libxml"><ulink
1343 url="http://cpan.org/authors/id/P/PA/PAJAS/XML-LibXML-&XML-LibXML-version;.tar.gz">
1344 XML-LibXML-&XML-LibXML-version;</ulink></para>
1345 <indexterm zone="perl-modules perl-xml-libxml">
1346 <primary sortas="g-XML-LibXML">XML::LibXML</primary>
1347 </indexterm>
1348 </listitem>
1349 <listitem>
1350 <para><xref linkend="perl-xml-parser"/></para>
1351 </listitem>
1352 </itemizedlist>
1353
1354 </listitem>
1355 <listitem>
1356 <para id="perl-tie-ixhash"><ulink
1357 url="http://cpan.org/authors/id/G/GS/GSAR/Tie-IxHash-&Tie-IxHash-version;.tar.gz">
1358 Tie-IxHash-&Tie-IxHash-version;</ulink></para>
1359 <indexterm zone="perl-modules perl-tie-ixhash">
1360 <primary sortas="g-Tie-IxHash">Tie::IxHash</primary>
1361 </indexterm>
1362 </listitem>
1363 </itemizedlist>
1364
1365 </listitem>
1366 </itemizedlist>
1367
1368 <!-- YAML -->
1369 <bridgehead renderas="sect3" id="perl-yaml"
1370 xreflabel="YAML-&YAML-version;">
1371 YAML-&YAML-version;</bridgehead>
1372
1373 <indexterm zone="perl-modules perl-yaml">
1374 <primary sortas="g-YAML">YAML</primary>
1375 </indexterm>
1376
1377 <para>The <application>YAML</application> modules implement a
1378 <application>YAML</application> Loader and Dumper based on the
1379 <application>YAML</application> 1.0 specification
1380 <ulink url="http://www.yaml.org/spec/"/>.
1381 <application>YAML</application> is a generic data serialization language
1382 that is optimized for human readability. It can be used to express the data
1383 structures of most modern programming languages. The module and
1384 dependencies are installed using the standard
1385 <application>Perl</application> module
1386 <xref linkend="perl-standard-install"/>.</para>
1387
1388 <note>
1389 <para>The <application>YAML</application>,
1390 <application>Test::Base</application> and
1391 <application>Spiffy</application> modules will install UTF-8
1392 encoded manual pages. To modify the manual pages so that non-UTF-8
1393 encoded pages are installed, issue the following commands (before
1394 any other build commands):</para>
1395
1396<screen><literal>For <application>Spiffy</application>: <command>sed -i 's,\xc3\xb6,o,' lib/Spiffy.pm</command>
1397
1398For <application>Test::Base</application>: <command>sed -i 's,\xc3\xb6,o,' \
1399 lib/Test/Base{,/Filter}.pm \
1400 lib/Module/Install/TestBase.pm</command>
1401
1402For <application>YAML</application>: <command>sed -i 's,\xc3\xb6,o,' \
1403 ysh \
1404 lib{,/Test}/YAML.pm \
1405 lib/YAML/{Types,Node,Error,Marshall,Tag,Base}.pm \
1406 lib/YAML/{Loader,Dumper}{,/Base}.pm</command></literal></screen>
1407
1408 </note>
1409
1410 <itemizedlist spacing='compact'>
1411 <listitem>
1412 <para><ulink
1413 url="http://cpan.org/authors/id/I/IN/INGY/YAML-&YAML-version;.tar.gz">
1414 YAML-&YAML-version;</ulink></para>
1415
1416 <itemizedlist>
1417 <listitem>
1418 <para id="perl-test-base"><ulink
1419 url="http://cpan.org/authors/id/I/IN/INGY/Test-Base-&Test-Base-version;.tar.gz">
1420 Test-Base-&Test-Base-version;</ulink>
1421 (optionally used during the tests)</para>
1422 <indexterm zone="perl-modules perl-test-base">
1423 <primary sortas="g-Test-Base">Test::Base</primary>
1424 </indexterm>
1425
1426 <itemizedlist>
1427 <listitem>
1428 <para id="perl-spiffy"><ulink
1429 url="http://cpan.org/authors/id/I/IN/INGY/Spiffy-&Spiffy-version;.tar.gz">
1430 Spiffy-&Spiffy-version;</ulink></para>
1431 <indexterm zone="perl-modules perl-spiffy">
1432 <primary sortas="g-Spiffy">Spiffy</primary>
1433 </indexterm>
1434 </listitem>
1435 </itemizedlist>
1436
1437 </listitem>
1438 <listitem>
1439 <para><xref linkend="perl-text-diff"/>
1440 (optionally used during the tests)</para>
1441 </listitem>
1442 <listitem>
1443 <para><xref linkend="perl-test-simple"/>
1444 (optionally used during the tests)</para>
1445 </listitem>
1446 </itemizedlist>
1447
1448 </listitem>
1449 </itemizedlist>
1450
1451 </sect2>
1452
1453 <sect2 role="installation" id="perl-standard-install"
1454 xreflabel="build and installation instructions">
1455 <title>Standard Installation of Perl Modules</title>
1456
1457 <para>Install <application>Perl</application> modules by running the
1458 following commands:</para>
1459
1460<screen><userinput>perl Makefile.PL &amp;&amp;
1461make &amp;&amp;
1462make test</userinput></screen>
1463
1464 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
1465
1466<screen role="root"><userinput>make install</userinput></screen>
1467
1468 </sect2>
1469
1470 <sect2 role="installation">
1471 <title>(Alternate) Auto Installation of Perl Modules.</title>
1472
1473 <para>There is an alternate way of installing the modules using the
1474 <command>cpan</command> shell <command>install</command> command. The
1475 command automatically downloads the source from the CPAN archive, extracts
1476 it, runs the compilation, testing and installation commands mentioned
1477 above, and removes the build source tree. You may still need to install
1478 dependent library packages before running the automated installation
1479 method.</para>
1480
1481 <para>The first time you run <command>cpan</command>, you'll be prompted
1482 to enter some information regarding download locations and methods. This
1483 information is retained in files located in
1484 <filename class='directory'>~/.cpan</filename>. Start the
1485 <command>cpan</command> shell by issuing '<command>cpan</command>' as the
1486 <systemitem class="username">root</systemitem> user. Any module may now be
1487 installed from the
1488 <emphasis role='underlined'><prompt>cpan&gt;&nbsp;</prompt></emphasis>
1489 prompt with the command:</para>
1490
1491<screen role="root"><userinput>install <replaceable>&lt;Module::Name&gt;</replaceable></userinput></screen>
1492
1493 <para>For additional commands and help, issue '<command>help</command>'
1494 from the
1495 <emphasis role='underlined'><prompt>cpan&gt;&nbsp;</prompt></emphasis>
1496 prompt.</para>
1497
1498 <para>Alternatively, for scripted or non-interactive installations, use the
1499 following syntax as the
1500 <systemitem class="username">root</systemitem> user to install one or more
1501 modules:</para>
1502
1503<screen role="root"><userinput>cpan -i <replaceable>&lt;Module1::Name&gt; &lt;Module2::Name&gt;</replaceable></userinput></screen>
1504
1505 <para>Review the <filename>cpan.1</filename> man page for additional
1506 parameters you can pass to <command>cpan</command> on the command
1507 line.</para>
1508
1509 </sect2>
1510
1511</sect1>
Note: See TracBrowser for help on using the repository browser.