source: general/prog/perl-modules.xml@ 552da8e

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 552da8e was 552da8e, checked in by Randy McMurchy <randy@…>, 13 years ago

Updated Perl module Pod::Coverage to 0.21

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@8720 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 61.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 <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-&Date-Manip-version;">
203 Date::Manip-&Date-Manip-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/Date-Manip-&Date-Manip-version;.tar.gz">
220 Date-Manip-&Date-Manip-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/H/HA/HAMPTON/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"><ulink
314 url="http://cpan.org/authors/id/M/MA/MAKAMAKA/Text-CSV-&Text-CSV-version;.tar.gz">
315 Text-CSV-&Text-CSV-version;</ulink></para>
316 <indexterm zone="perl-modules perl-text-csv">
317 <primary sortas="g-Text-CSV">Text::CSV</primary>
318 </indexterm>
319 </listitem>
320 <listitem>
321 <para id="perl-text-csv_xs"><ulink
322 url="http://cpan.org/authors/id/H/HM/HMBRAND/Text-CSV_XS-&Text-CSV_XS-version;.tgz">
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><xref linkend="perl-uri"/></para>
472 </listitem>
473 <listitem>
474 <para><xref linkend="perl-html-parser"/></para>
475 </listitem>
476 <listitem>
477 <para><xref linkend="perl-compress-zlib"/></para>
478 </listitem>
479 <listitem>
480 <para id="perl-crypt-ssleay"
481 xreflabel="Crypt::SSLeay-&Crypt-SSLeay-version;"><ulink
482 url="http://cpan.org/authors/id/D/DL/DLAND/Crypt-SSLeay-&Crypt-SSLeay-version;.tar.gz">
483 Crypt-SSLeay-&Crypt-SSLeay-version;</ulink> (optional, for HTTPS
484 support)</para>
485 <indexterm zone="perl-modules perl-crypt-ssleay">
486 <primary sortas="g-Crypt-SSLeay">Crypt::SSLeay</primary>
487 </indexterm>
488
489 <itemizedlist>
490 <listitem>
491 <para><xref linkend="openssl"/></para>
492 </listitem>
493 <listitem>
494 <para>A <quote>testcover</quote> <filename>Makefile</filename>
495 target is created (which creates a
496 <command>/usr/bin/testcover</command> script) if the <ulink
497 url="http://cpan.org/authors/id/S/SM/SMPETERS/ExtUtils-MakeMaker-Coverage-0.05.tar.gz">
498 Extutils::MakeMaker::Coverage</ulink> module is installed.</para>
499 </listitem>
500 </itemizedlist>
501
502 </listitem>
503 </itemizedlist>
504
505 </listitem>
506 </itemizedlist>
507
508 <!-- Module::Build -->
509 <bridgehead renderas="sect3" id="perl-module-build"
510 xreflabel="Module::Build-&Module-Build-version;">
511 Module::Build-&Module-Build-version;</bridgehead>
512
513 <indexterm zone="perl-modules perl-module-build">
514 <primary sortas="g-Module-Build">Module::Build</primary>
515 </indexterm>
516
517 <para>The Module::Build module is a system for building, testing, and
518 installing <application>Perl</application> modules. It is meant to be an
519 alternative to ExtUtils::MakeMaker. Developers may alter the behavior of
520 the module through subclassing in a much more straightforward way than with
521 MakeMaker. It also does not require a <command>make</command> command on
522 your system. Most of the Module::Build code is
523 pure-<application>Perl</application> and written in a very cross-platform
524 way.</para>
525
526 <para>The Module::Build module (as well as any other
527 <application>Perl</application> module that uses the Module::Build build
528 system) uses <xref linkend="perl-module-build-install"/>. All the
529 dependencies are installed using the standard
530 <application>Perl</application> module
531 <xref linkend="perl-standard-install"/>.</para>
532
533 <itemizedlist spacing='compact'>
534 <listitem>
535 <para><ulink
536 url="http://cpan.org/authors/id/K/KW/KWILLIAMS/Module-Build-&Module-Build-version;.tar.gz">
537 Module-Build-&Module-Build-version;</ulink></para>
538
539 <itemizedlist>
540 <listitem>
541 <para id="perl-extutils-parsexs"><ulink
542 url="http://cpan.org/authors/id/K/KW/KWILLIAMS/ExtUtils-ParseXS-&ExtUtils-ParseXS-version;.tar.gz">
543 ExtUtils-ParseXS-&ExtUtils-ParseXS-version;</ulink></para>
544 <indexterm zone="perl-modules perl-extutils-parsexs">
545 <primary sortas="g-ExtUtils-ParseXS">ExtUtils::ParseXS</primary>
546 </indexterm>
547
548 <itemizedlist>
549 <listitem>
550 <para id="perl-extutils-cbuilder"><ulink
551 url="http://cpan.org/authors/id/K/KW/KWILLIAMS/ExtUtils-CBuilder-&ExtUtils-CBuilder-version;.tar.gz">
552 ExtUtils-CBuilder-&ExtUtils-CBuilder-version;</ulink></para>
553 <indexterm zone="perl-modules perl-extutils-cbuilder">
554 <primary sortas="g-ExtUtils-CBuilder">ExtUtils::CBuilder</primary>
555 </indexterm>
556 </listitem>
557 </itemizedlist>
558
559 </listitem>
560 <listitem>
561 <para id="perl-archive-tar"><ulink
562 url="http://cpan.org/authors/id/K/KA/KANE/Archive-Tar-&Archive-Tar-version;.tar.gz">
563 Archive-Tar-&Archive-Tar-version;</ulink></para>
564 <indexterm zone="perl-modules perl-archive-tar">
565 <primary sortas="g-Archive-Tar">Archive::Tar</primary>
566 </indexterm>
567
568 <itemizedlist>
569 <listitem>
570 <para id="perl-io-zlib"><ulink
571 url="http://cpan.org/authors/id/T/TO/TOMHUGHES/IO-Zlib-&IO-Zlib-version;.tar.gz">
572 IO-Zlib-&IO-Zlib-version;</ulink></para>
573 <indexterm zone="perl-modules perl-io-zlib">
574 <primary sortas="g-IO-Zlib">IO::Zlib</primary>
575 </indexterm>
576
577 <itemizedlist>
578 <listitem>
579 <para><xref linkend="perl-compress-zlib"/></para>
580 </listitem>
581 </itemizedlist>
582
583 </listitem>
584 <listitem>
585 <para><xref linkend="perl-text-diff"/></para>
586 </listitem>
587 </itemizedlist>
588
589 </listitem>
590 <listitem>
591 <para id="perl-pod-readme"><ulink
592 url="http://cpan.org/authors/id/R/RR/RRWO/Pod-Readme-&Pod-Readme-version;.tar.gz">
593 Pod-Readme-&Pod-Readme-version;</ulink> (optionally used to create
594 a <filename>README</filename> file when creating a new module
595 distribution)</para>
596 <indexterm zone="perl-modules perl-pod-readme">
597 <primary sortas="g-Pod-Readme">Pod::Readme</primary>
598 </indexterm>
599
600 <itemizedlist>
601 <listitem>
602 <para id="perl-test-portability-files"><ulink
603 url="http://cpan.org/authors/id/S/SA/SAPER/Test-Portability-Files-&Test-Portability-Files-version;.tar.gz">
604 Test-Portability-Files-&Test-Portability-Files-version;</ulink>
605 (optionally used during the tests)</para>
606 <indexterm zone="perl-modules perl-test-portability-files">
607 <primary sortas="g-Test-Portability-Files">Test::Portability::Files</primary>
608 </indexterm>
609 </listitem>
610 <listitem>
611 <para><xref linkend="perl-test-pod-coverage"/>
612 (optionally used during the tests)</para>
613 </listitem>
614 <listitem>
615 <para><xref linkend="perl-test-pod"/>
616 (optionally used during the tests)</para>
617 </listitem>
618 </itemizedlist>
619
620 </listitem>
621 <listitem>
622 <para><xref linkend="perl-module-signature"/> (required to use the
623 Module::Build <quote>distsign</quote> run-time method and
624 optionally used during the tests)</para>
625 </listitem>
626 <listitem>
627 <para><xref linkend="perl-yaml"/> (optional, provides additional
628 features to <application>Module::Build</application>)</para>
629 </listitem>
630 </itemizedlist>
631
632 </listitem>
633 </itemizedlist>
634
635 <bridgehead renderas="sect4" id="perl-module-build-install"
636 xreflabel="modified build instructions">Module::Build Build and
637 Installation Instructions</bridgehead>
638
639<screen><userinput>perl Build.PL &amp;&amp;
640./Build &amp;&amp;
641./Build test</userinput></screen>
642
643 <para>Now, as the <systemitem class='username'>root</systemitem> user:</para>
644
645<screen role='root'><userinput>./Build install</userinput></screen>
646
647 <!-- Module::Info -->
648 <bridgehead renderas="sect3" id="perl-module-info"
649 xreflabel="Module::Info-&Module-Info-version;">
650 Module::Info-&Module-Info-version;</bridgehead>
651
652 <indexterm zone="perl-modules perl-module-info">
653 <primary sortas="g-Module-Info">Module::Info</primary>
654 </indexterm>
655
656 <para>The Module::Info module is quite useful for tasks other than just
657 support of other modules. It can be used from the command-line to tell you
658 if a particular module is included in, or has been installed into your
659 <application>Perl</application> installation. Additionally, Module::Info
660 can tell you what version of a module is installed and what dependencies
661 are required for it. You can even use Module::Info to gather dependencies
662 of uninstalled modules. The Module::Info module and dependencies install
663 using the standard <application>Perl</application> module
664 <xref linkend="perl-standard-install"/>.</para>
665
666 <itemizedlist spacing='compact'>
667 <listitem>
668 <para><ulink
669 url="http://cpan.org/authors/id/M/MB/MBARBON/Module-Info-&Module-Info-version;.tar.gz">
670 Module-Info-&Module-Info-version;</ulink></para>
671
672 <itemizedlist>
673 <listitem>
674 <para id="perl-version-module"><ulink
675 url="http://cpan.org/authors/id/J/JP/JPEACOCK/version-&version-perl-version;.tar.gz">
676 version-&version-perl-version;</ulink>
677 (optionally used during the tests)</para>
678 <indexterm zone="perl-modules perl-version-module">
679 <primary sortas="g-version">version</primary>
680 </indexterm>
681
682 <itemizedlist>
683 <listitem>
684 <para><xref linkend="perl-module-build"/> (optional)</para>
685 </listitem>
686 </itemizedlist>
687
688 </listitem>
689 <listitem>
690 <para><xref linkend="perl-test-pod"/>
691 (optionally used during the tests)</para>
692 </listitem>
693 </itemizedlist>
694
695 </listitem>
696 </itemizedlist>
697
698 <!-- Module::Signature -->
699 <bridgehead renderas="sect3" id="perl-module-signature"
700 xreflabel="Module::Signature-&Module-Signature-version;">
701 Module::Signature-&Module-Signature-version;</bridgehead>
702
703 <indexterm zone="perl-modules perl-module-signature">
704 <primary sortas="g-Module-Signature">Module::Signature</primary>
705 </indexterm>
706
707 <para>The Module::Signature module is used to check and create
708 <filename>SIGNATURE</filename> files for CPAN distributions. After
709 installing Module::Signature you can verify the content of a distribution
710 tarball (if it includes a <filename>SIGNATURE</filename> file) by unpacking
711 the tarball, changing into the newly created directory and issuing the
712 command <command>cpansign -v</command>. It will check each file's
713 integrity, as well as the signature's validity. Note that some of the
714 dependencies appear to be circular, however, they are only run-time
715 conflicts and you should be able to fully utilize them as long as
716 everything is installed. Module::Signature and the dependency modules are
717 installed using the standard <application>Perl</application>
718 module <xref linkend="perl-standard-install"/>.</para>
719
720 <itemizedlist spacing='compact'>
721 <listitem>
722 <para><ulink
723 url="http://cpan.org/authors/id/A/AU/AUDREYT/Module-Signature-&Module-Signature-version;.tar.gz">
724 Module-Signature-&Module-Signature-version;</ulink></para>
725
726 <itemizedlist>
727 <listitem>
728 <para><xref linkend="perl-text-diff"/></para>
729 </listitem>
730 <listitem>
731 <para id="perl-par-dist"><ulink
732 url="http://cpan.org/authors/id/S/SM/SMUELLER/PAR-Dist-&PAR-Dist-version;.tar.gz">
733 PAR-Dist-&PAR-Dist-version;</ulink></para>
734 <indexterm zone="perl-modules perl-par-dist">
735 <primary sortas="g-PAR-Dist">PAR::Dist</primary>
736 </indexterm>
737
738 <itemizedlist>
739 <listitem>
740 <para><xref linkend="perl-archive-zip"/></para>
741 </listitem>
742 <listitem>
743 <para><xref linkend="perl-lwp"/></para>
744 </listitem>
745 <listitem>
746 <para><xref linkend="perl-module-signature"/></para>
747 </listitem>
748 </itemizedlist>
749
750 </listitem>
751 <listitem>
752 <para id="perl-digest-sha"><ulink
753 url="http://cpan.org/authors/id/M/MS/MSHELOR/Digest-SHA-&Digest-SHA-version;.tar.gz">
754 Digest-SHA-&Digest-SHA-version;</ulink></para>
755 <indexterm zone="perl-modules perl-digest-sha">
756 <primary sortas="g-Digest-SHA">Digest::SHA</primary>
757 </indexterm>
758
759 <itemizedlist>
760 <listitem>
761 <para><xref linkend="perl-test-pod-coverage"/>
762 (optionally used during the tests)</para>
763 </listitem>
764 </itemizedlist>
765
766 </listitem>
767 <listitem>
768 <para><xref linkend="gnupg"/></para>
769 </listitem>
770 </itemizedlist>
771
772 </listitem>
773 </itemizedlist>
774
775 <!-- Net::DNS -->
776 <bridgehead renderas="sect3" id="perl-net-dns"
777 xreflabel="Net-DNS-&Net-DNS-version;">
778 Net::DNS-&Net-DNS-version;</bridgehead>
779
780 <indexterm zone="perl-modules perl-net-dns">
781 <primary sortas="g-Net-DNS">Net::DNS</primary>
782 </indexterm>
783
784 <para>Net::DNS is a DNS resolver implemented in
785 <application>Perl</application>. It can be used to perform nearly any type
786 of DNS query from a <application>Perl</application> script. The Net::DNS
787 module and all its dependencies are installed using the standard
788 <application>Perl</application> module
789 <xref linkend="perl-standard-install"/>.</para>
790
791 <itemizedlist spacing='compact'>
792 <listitem>
793 <para><ulink
794 url="http://cpan.org/authors/id/O/OL/OLAF/Net-DNS-&Net-DNS-version;.tar.gz">
795 Net-DNS-&Net-DNS-version;</ulink></para>
796
797 <itemizedlist>
798 <listitem>
799 <para id="perl-digest-hmac"><ulink
800 url="http://cpan.org/authors/id/G/GA/GAAS/Digest-HMAC-&Digest-HMAC-version;.tar.gz">
801 Digest-HMAC-&Digest-HMAC-version;</ulink></para>
802 <indexterm zone="perl-modules perl-digest-hmac">
803 <primary sortas="g-Digest-HMAC">Digest::HMAC</primary>
804 </indexterm>
805
806 <itemizedlist>
807 <listitem>
808 <para id="perl-digest-sha1"><ulink
809 url="http://cpan.org/authors/id/G/GA/GAAS/Digest-SHA1-&Digest-SHA1-version;.tar.gz">
810 Digest-SHA1-&Digest-SHA1-version;</ulink></para>
811 <indexterm zone="perl-modules perl-digest-sha1">
812 <primary sortas="g-Digest-SHA1">Digest::SHA1</primary>
813 </indexterm>
814 </listitem>
815 </itemizedlist>
816
817 </listitem>
818 <listitem>
819 <para id="perl-net-ip"><ulink
820 url="http://cpan.org/authors/id/M/MA/MANU/Net-IP-&Net-IP-version;.tar.gz">
821 Net-IP-&Net-IP-version;</ulink></para>
822 <indexterm zone="perl-modules perl-net-ip">
823 <primary sortas="g-Net-IP">Net::IP</primary>
824 </indexterm>
825 </listitem>
826 <listitem>
827 <para id="perl-io-socket-inet6"><ulink
828 url="http://cpan.org/authors/id/M/MO/MONDEJAR/IO-Socket-INET6-&IO-Socket-INET6-version;.tar.gz">
829 IO-Socket-INET6-&IO-Socket-INET6-version;</ulink> (required for
830 IPv6 support)</para>
831 <indexterm zone="perl-modules perl-io-socket-inet6">
832 <primary sortas="g-IO-Socket-INET6">IO::Socket::INET6</primary>
833 </indexterm>
834
835 <itemizedlist>
836 <listitem>
837 <para id="perl-socket6"><ulink
838 url="http://cpan.org/authors/id/U/UM/UMEMOTO/Socket6-&Socket6-version;.tar.gz">
839 Socket6-&Socket6-version;</ulink></para>
840 <indexterm zone="perl-modules perl-socket6">
841 <primary sortas="g-Socket6">Socket6</primary>
842 </indexterm>
843 </listitem>
844 </itemizedlist>
845
846 </listitem>
847 <listitem>
848 <para id="perl-digest-bubblebabble"><ulink
849 url="http://cpan.org/authors/id/B/BT/BTROTT/Digest-BubbleBabble-&Digest-BubbleBabble-version;.tar.gz">
850 Digest-BubbleBabble-&Digest-BubbleBabble-version;</ulink></para>
851 <indexterm zone="perl-modules perl-digest-bubblebabble">
852 <primary sortas="g-Digest-BubbleBabble">Digest::BubbleBabble</primary>
853 </indexterm>
854 </listitem>
855 <listitem>
856 <para><xref linkend="perl-test-pod"/> (optional, only used during the test suite)</para>
857 </listitem>
858 </itemizedlist>
859
860 </listitem>
861 </itemizedlist>
862
863
864 <!-- Pod::Coverage -->
865 <bridgehead renderas="sect3" id="perl-pod-coverage"
866 xreflabel="Pod::Coverage-&Pod-Coverage-version;">
867 Pod::Coverage-&Pod-Coverage-version;</bridgehead>
868
869 <indexterm zone="perl-modules perl-pod-coverage">
870 <primary sortas="g-Pod-Coverage">Pod::Coverage</primary>
871 </indexterm>
872
873 <para>The Pod::Coverage module is a <application>Perl</application> library
874 used to check if the documentation of a module is comprehensive. This
875 module can use the Module::Build
876 <xref linkend="perl-module-build-install"/>, but is not required. All the
877 dependencies are installed using the standard
878 <application>Perl</application> module
879 <xref linkend="perl-standard-install"/>.</para>
880
881 <itemizedlist spacing='compact'>
882 <listitem>
883 <para><ulink
884 url="http://www.cpan.org/authors/id/R/RC/RCLAMP/Pod-Coverage-&Pod-Coverage-version;.tar.gz">
885 Pod-Coverage-&Pod-Coverage-version;</ulink></para>
886
887 <itemizedlist>
888 <listitem>
889 <para id="perl-devel-symdump"><ulink
890 url="http://www.cpan.org/authors/id/A/AN/ANDK/Devel-Symdump-&Devel-Symdump-version;.tar.gz">
891 Devel-Symdump-&Devel-Symdump-version;</ulink></para>
892 <indexterm zone="perl-modules perl-devel-symdump">
893 <primary sortas="g-Devel-Symdump">Devel::Symdump</primary>
894 </indexterm>
895
896 <itemizedlist>
897 <listitem>
898 <para><xref linkend="perl-test-pod-coverage"/>
899 (optionally used during the tests, and is a circular
900 dependency)</para>
901 </listitem>
902 <listitem>
903 <para><xref linkend="perl-test-pod"/>
904 (optionally used during the tests)</para>
905 </listitem>
906 </itemizedlist>
907
908 </listitem>
909 <listitem>
910 <para><xref linkend="perl-module-build"/> (optional)</para>
911 </listitem>
912 </itemizedlist>
913
914 </listitem>
915 </itemizedlist>
916
917 <!-- SGMLSpm -->
918 <bridgehead renderas="sect3" id="perl-sgmlspm"
919 xreflabel="SGMLSpm-&SGMLSpm-version;">
920 SGMLSpm-&SGMLSpm-version;</bridgehead>
921
922 <indexterm zone="perl-modules perl-sgmlspm">
923 <primary sortas="g-SGMLSpm">SGMLSpm</primary>
924 </indexterm>
925
926 <para>The SGMLSpm module is a <application>Perl</application> library
927 used for parsing the output from James Clark's SGMLS and NSGMLS
928 parsers. This module requires modified installation instructions, shown
929 below.</para>
930
931 <itemizedlist spacing='compact'>
932 <listitem>
933 <para><ulink
934 url="http://cpan.org/authors/id/D/DM/DMEGG/SGMLSpm-&SGMLSpm-version;.tar.gz">
935 SGMLSpm-&SGMLSpm-version;</ulink></para>
936 </listitem>
937 </itemizedlist>
938
939 <para>If your system's <application>Perl</application> version is different
940 than &lfs-perl-version;, you'll need to modify the <command>sed</command>
941 command below to reflect the version you have installed.</para>
942
943<screen><userinput>sed -i -e "s@/usr/local/bin@/usr/bin@" \
944 -e "s@/usr/local/lib/perl5@/usr/lib/perl5/site_perl/&lfs-perl-version;@" \
945 -e "s@/usr/local/lib/www/docs@/usr/share/doc/perl5@" \
946 Makefile</userinput></screen>
947
948 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
949
950<screen role="root"><userinput>make install &amp;&amp;
951install -v -m755 -d /usr/share/doc/perl5 &amp;&amp;
952make install_html &amp;&amp;
953rm -v -f /usr/share/doc/perl5/SGMLSpm/sample.pl &amp;&amp;
954install -v -m644 DOC/sample.pl /usr/share/doc/perl5/SGMLSpm</userinput></screen>
955
956 <!-- Test::Pod -->
957 <bridgehead renderas="sect3" id="perl-test-pod"
958 xreflabel="Test::Pod-&Test-Pod-version;">
959 Test::Pod-&Test-Pod-version;</bridgehead>
960
961 <indexterm zone="perl-modules perl-test-pod">
962 <primary sortas="g-Test-Pod">Test::Pod</primary>
963 </indexterm>
964
965 <para>The Test:Pod module is (most of the time, optionally) used by other
966 modules during the build process to check the validity of POD (Plain Old
967 Documentation) files. The Test::Pod module is typically included by module
968 authors to automatically find and check all POD files in a module
969 distribution. This module is installed using the standard
970 <application>Perl</application> module
971 <xref linkend="perl-standard-install"/>.</para>
972
973 <itemizedlist spacing='compact'>
974 <listitem>
975 <para><ulink
976 url="http://www.cpan.org/authors/id/D/DW/DWHEELER/Test-Pod-&Test-Pod-version;.tar.gz">
977 Test-Pod-&Test-Pod-version;</ulink></para>
978 </listitem>
979 </itemizedlist>
980
981 <!-- Test::Pod::Coverage -->
982 <bridgehead renderas="sect3" id="perl-test-pod-coverage"
983 xreflabel="Test::Pod::Coverage-&Test-Pod-Coverage-version;">
984 Test::Pod::Coverage-&Test-Pod-Coverage-version;</bridgehead>
985
986 <indexterm zone="perl-modules perl-test-pod-coverage">
987 <primary sortas="g-Test-Pod-Coverage">Test::Pod::Coverage</primary>
988 </indexterm>
989
990 <para>The Test::Pod::Coverage module is used to check files in a
991 distribution for POD coverage. It is normally used by developers to
992 ensure their projects are adequately covered with POD and it is also used
993 in the test suites of many module distributions. This module and all the
994 dependencies are installed using the standard
995 <application>Perl</application> module
996 <xref linkend="perl-standard-install"/>.</para>
997
998 <itemizedlist spacing='compact'>
999 <listitem>
1000 <para><ulink
1001 url="http://cpan.org/authors/id/P/PE/PETDANCE/Test-Pod-Coverage-&Test-Pod-Coverage-version;.tar.gz">
1002 Test-Pod-Coverage-&Test-Pod-Coverage-version;</ulink></para>
1003
1004 <itemizedlist>
1005 <listitem>
1006 <para id="perl-test-builder-tester">
1007 <xref linkend="perl-test-simple"/> or
1008 <ulink
1009 url="http://cpan.org/authors/id/M/MA/MARKF/Test-Builder-Tester-&Test-Builder-Tester-version;.tar.gz">
1010 Test-Builder-Tester-&Test-Builder-Tester-version;</ulink></para>
1011 <indexterm zone="perl-modules perl-test-builder-tester">
1012 <primary sortas="g-Test-Builder-Tester">Test::Builder::Tester</primary>
1013 </indexterm>
1014 </listitem>
1015 <listitem>
1016 <para><xref linkend="perl-pod-coverage"/></para>
1017 </listitem>
1018 </itemizedlist>
1019
1020 </listitem>
1021 </itemizedlist>
1022
1023 <!-- Test::Simple -->
1024 <bridgehead renderas="sect3" id="perl-test-simple"
1025 xreflabel="Test::Simple-&Test-Simple-version;">
1026 Test::Simple-&Test-Simple-version;</bridgehead>
1027
1028 <indexterm zone="perl-modules perl-test-simple">
1029 <primary sortas="g-Test-Simple">Test::Simple</primary>
1030 </indexterm>
1031
1032 <para>The Test::Simple module contains utilities designed to assist
1033 developers in creating tests. A version of Test::Simple was installed
1034 during LFS with the <application>Perl</application>-&lfs-perl-version;
1035 installation, however, some of the sub-modules contained in Test::Simple
1036 have been updated (notably, the Test::More module) and these updated
1037 modules are now required by other modules. This updated version of
1038 Test::Simple also now includes the Test:Builder:Tester module, required by
1039 many of the modules on this page. Note that installing this updated
1040 version of Test::Simple will overwrite some files from the original
1041 <application>Perl</application> installation, but there's really nothing to
1042 be alarmed about as these modules are only used by developers creating
1043 tests, or for running the test suites during additional module
1044 installations.</para>
1045
1046 <itemizedlist spacing='compact'>
1047 <listitem>
1048 <para><ulink
1049 url="http://cpan.org/authors/id/M/MS/MSCHWERN/Test-Simple-&Test-Simple-version;.tar.gz">
1050 Test-Simple-&Test-Simple-version;</ulink>
1051 (uses the standard <xref linkend="perl-standard-install"/>)</para>
1052
1053 <itemizedlist>
1054 <listitem>
1055 <para><xref linkend="perl-module-signature"/>
1056 (optionally used during the tests)</para>
1057 </listitem>
1058 <listitem>
1059 <para><xref linkend="perl-test-pod-coverage"/>
1060 (optionally used during the tests, and is circular)</para>
1061 </listitem>
1062 <listitem>
1063 <para><xref linkend="perl-pod-coverage"/>
1064 (optionally used during the tests, and is circular)</para>
1065 </listitem>
1066 </itemizedlist>
1067
1068 </listitem>
1069 </itemizedlist>
1070
1071 <!-- Text::Diff -->
1072 <bridgehead renderas="sect3" id="perl-text-diff"
1073 xreflabel="Text::Diff-&Text-Diff-version;">
1074 Text::Diff-&Text-Diff-version;</bridgehead>
1075
1076 <indexterm zone="perl-modules perl-text-diff">
1077 <primary sortas="g-Text-Diff">Text::Diff</primary>
1078 </indexterm>
1079
1080 <para>Text::Diff is used to perform diffs on files and record sets. It
1081 provides a basic set of services akin to the GNU <command>diff</command>
1082 utility. It is not anywhere near as feature complete as GNU
1083 <command>diff</command>, but it is better integrated with
1084 <application>Perl</application> and available on all platforms. Text::Diff
1085 is often faster than shelling out to a system's <command>diff</command>
1086 executable for small files, and generally slower on larger files. The
1087 modules listed below are installed using the standard
1088 <application>Perl</application> module
1089 <xref linkend="perl-standard-install"/>.</para>
1090
1091 <itemizedlist spacing='compact'>
1092 <listitem>
1093 <para><ulink
1094 url="http://cpan.org/authors/id/R/RB/RBS/Text-Diff-&Text-Diff-version;.tar.gz">
1095 Text-Diff-&Text-Diff-version;</ulink></para>
1096
1097 <itemizedlist>
1098 <listitem>
1099 <para id="perl-algorithm-diff"><ulink
1100 url="http://cpan.org/authors/id/T/TY/TYEMQ/Algorithm-Diff-&Algorithm-Diff-version;.tar.gz">
1101 Algorithm-Diff-&Algorithm-Diff-version;</ulink></para>
1102 <indexterm zone="perl-modules perl-algorithm-diff">
1103 <primary sortas="g-Algorithm-Diff">Algorithm::Diff</primary>
1104 </indexterm>
1105 </listitem>
1106 </itemizedlist>
1107
1108 </listitem>
1109 </itemizedlist>
1110
1111 <!-- Tk -->
1112 <bridgehead renderas="sect3" id="tk-perl"
1113 xreflabel="Tk-Perl-&Tk-Perl-version;">
1114 Tk-&Tk-Perl-version;</bridgehead>
1115
1116 <indexterm zone="perl-modules tk-perl">
1117 <primary sortas="g-Tk">Tk</primary>
1118 </indexterm>
1119
1120 <para>The <application>Tk</application> module is a
1121 <application>Perl</application> interface to the
1122 <application>Tk</application> package. The goal of this release is Unicode
1123 support via <application>Perl</application>'s and
1124 core-<application>Tk</application>'s use of UTF-8. Tk-&Tk-Perl-version;
1125 builds and loads into a threaded <application>Perl</application> but is NOT
1126 yet thread safe. The module is installed using the standard
1127 <application>Perl</application> module
1128 <xref linkend="perl-standard-install"/>.</para>
1129
1130 <itemizedlist spacing='compact'>
1131 <listitem>
1132 <para><ulink
1133 url="http://www.cpan.org/authors/id/S/SR/SREZIC/Tk-&Tk-Perl-version;.tar.gz">
1134 Tk-&Tk-Perl-version;</ulink></para>
1135
1136 <itemizedlist>
1137 <listitem>
1138 <para><xref linkend="tk"/> and <xref linkend="libjpeg"/></para>
1139 </listitem>
1140 </itemizedlist>
1141
1142 </listitem>
1143 </itemizedlist>
1144
1145 <!-- URI -->
1146 <bridgehead renderas="sect3" id="perl-uri"
1147 xreflabel="URI-&URI-version;">
1148 URI-&URI-version;</bridgehead>
1149
1150 <indexterm zone="perl-modules perl-uri">
1151 <primary sortas="g-URI">URI</primary>
1152 </indexterm>
1153
1154 <para>The URI module implements the URI class. Objects of this class
1155 represent Uniform Resource Identifier references as specified in
1156 RFC 2396 and updated by RFC 2732 and can be used to access and
1157 manipulate the various components that make up these strings.
1158 The URI module and all its dependencies are installed using
1159 the standard <xref linkend="perl-standard-install"/>.</para>
1160
1161 <itemizedlist spacing='compact'>
1162 <listitem>
1163 <para><ulink
1164 url="http://cpan.org/authors/id/G/GA/GAAS/URI-&URI-version;.tar.gz">
1165 URI-&URI-version;</ulink></para>
1166 <indexterm zone="perl-modules perl-uri">
1167 <primary sortas="g-URI">URI</primary>
1168 </indexterm>
1169 <itemizedlist>
1170 <listitem>
1171 <para id="perl-business-isbn"><ulink
1172 url="http://cpan.org/authors/id/B/BD/BDFOY/Business-ISBN-&Business-ISBN-version;.tar.gz">
1173 Business-ISBN-&Business-ISBN-version;</ulink> (optional, only
1174 used during the test suite)</para>
1175 <indexterm zone="perl-modules perl-business-isbn">
1176 <primary sortas="g-Business-ISBN">Business::ISBN</primary>
1177 </indexterm>
1178
1179 <itemizedlist>
1180 <listitem>
1181 <para>LWP::Simple is required for many of the tests. This
1182 is a circular dependency.</para>
1183 </listitem>
1184 <listitem>
1185 <para id="perl-business-isbn-data"><ulink
1186 url="http://cpan.org/authors/id/B/BD/BDFOY/Business-ISBN-Data-&Business-ISBN-Data-version;.tar.gz">
1187 Business-ISBN-Data-&Business-ISBN-Data-version;</ulink></para>
1188 <indexterm zone="perl-modules perl-business-isbn-data">
1189 <primary sortas="g-Business-ISBN-Data">Business::ISBN::Data</primary>
1190 </indexterm>
1191
1192 <itemizedlist>
1193 <listitem>
1194 <para id="perl-test-prereq"><ulink
1195 url="http://cpan.org/authors/id/B/BD/BDFOY/Test-Prereq-&Test-Prereq-version;.tar.gz">
1196 Test-Prereq-&Test-Prereq-version;</ulink> (you may need
1197 to set up your CPAN access parameters by issuing the
1198 command <command>perl -MCPAN -e shell</command> before
1199 running the test suite, else the tests may hang)</para>
1200 <indexterm zone="perl-modules perl-test-prereq">
1201 <primary sortas="g-Test-Prereq">Test::Prereq</primary>
1202 </indexterm>
1203
1204 <itemizedlist>
1205 <listitem>
1206 <para><xref linkend="perl-module-info"/></para>
1207 </listitem>
1208 <listitem>
1209 <para><xref linkend="perl-module-build"/> (optional)</para>
1210 </listitem>
1211 <listitem>
1212 <para id="perl-module-corelist"><ulink
1213 url="http://cpan.org/authors/id/R/RG/RGARCIA/Module-CoreList-&Module-Corelist-version;.tar.gz">
1214 Module-CoreList-&Module-Corelist-version;</ulink></para>
1215 <indexterm zone="perl-modules perl-module-corelist">
1216 <primary sortas="g-Module-Corelist">Module::Corelist</primary>
1217 </indexterm>
1218 <itemizedlist>
1219 <listitem>
1220 <para><xref linkend="perl-test-pod"/>
1221 (optionally used during the tests)</para>
1222 </listitem>
1223 </itemizedlist>
1224
1225 </listitem>
1226 </itemizedlist>
1227
1228 </listitem>
1229 <listitem>
1230 <para><xref linkend="perl-test-pod-coverage"/>
1231 (optionally used during the tests)</para>
1232 </listitem>
1233 </itemizedlist>
1234
1235 </listitem>
1236 </itemizedlist>
1237
1238 </listitem>
1239 </itemizedlist>
1240
1241 </listitem>
1242 </itemizedlist>
1243
1244 <!-- XML::Parser -->
1245 <bridgehead renderas="sect3" id="perl-xml-parser"
1246 xreflabel="XML::Parser-&XML-Parser-version;">
1247 XML::Parser-&XML-Parser-version;</bridgehead>
1248
1249 <indexterm zone="perl-modules perl-xml-parser">
1250 <primary sortas="g-XML-Parser">XML::Parser</primary>
1251 </indexterm>
1252
1253 <para>The XML::Parser module is a <application>Perl</application> extension
1254 interface to James Clark's XML parser,
1255 <application>expat</application>. The module is installed using the
1256 standard <application>Perl</application> module
1257 <xref linkend="perl-standard-install"/>.</para>
1258
1259 <itemizedlist spacing='compact'>
1260 <listitem>
1261 <para><ulink
1262 url="http://www.cpan.org/authors/id/C/CH/CHORNY/XML-Parser-&XML-Parser-version;.tar.gz">
1263 XML-Parser-&XML-Parser-version;</ulink></para>
1264
1265 <itemizedlist>
1266 <listitem>
1267 <para><xref linkend="expat"/></para>
1268 </listitem>
1269 </itemizedlist>
1270 <itemizedlist>
1271 <listitem>
1272 <para><xref linkend="perl-lwp"/>
1273 (optionally used during the tests)</para>
1274 </listitem>
1275 </itemizedlist>
1276
1277 </listitem>
1278 </itemizedlist>
1279
1280 <!-- XML::Simple -->
1281 <bridgehead renderas="sect3" id="perl-xml-simple"
1282 xreflabel="XML::Simple-&XML-Simple-version;">
1283 XML::Simple-&XML-Simple-version;</bridgehead>
1284
1285 <indexterm zone="perl-modules perl-xml-simple">
1286 <primary sortas="g-XML-Simple">XML::Simple</primary>
1287 </indexterm>
1288
1289 <para>The XML::Simple module is a <application>Perl</application> extension
1290 that provides an easy API to read and write XML (especially config files).
1291 The module and all dependencies are installed using the standard
1292 <application>Perl</application> module
1293 <xref linkend="perl-standard-install"/>.</para>
1294
1295 <itemizedlist spacing='compact'>
1296 <listitem>
1297 <para><ulink
1298 url="http://cpan.org/authors/id/G/GR/GRANTM/XML-Simple-&XML-Simple-version;.tar.gz">
1299 XML-Simple-&XML-Simple-version;</ulink></para>
1300
1301 <itemizedlist>
1302 <listitem>
1303 <para>One of the following four modules must be installed:</para>
1304
1305 <itemizedlist>
1306 <listitem>
1307 <para id="perl-xml-sax"><ulink
1308 url="http://cpan.org/authors/id/G/GR/GRANTM/XML-SAX-&XML-SAX-version;.tar.gz">
1309 XML-SAX-&XML-SAX-version;</ulink></para>
1310 <indexterm zone="perl-modules perl-xml-sax">
1311 <primary sortas="g-XML-SAX">XML::SAX</primary>
1312 </indexterm>
1313
1314 <itemizedlist>
1315 <listitem>
1316 <para id="perl-xml-namespacesupport"><ulink
1317 url="http://cpan.org/authors/id/R/RB/RBERJON/XML-NamespaceSupport-&XML-NamespaceSupport-version;.tar.gz">
1318 XML-NamespaceSupport-&XML-NamespaceSupport-version;</ulink></para>
1319 <indexterm zone="perl-modules perl-xml-namespacesupport">
1320 <primary sortas="g-XML-NamespaceSupport">XML::NamespaceSupport</primary>
1321 </indexterm>
1322 </listitem>
1323 </itemizedlist>
1324
1325 </listitem>
1326 <listitem>
1327 <para id="perl-xml-sax-expat"><ulink
1328 url="http://cpan.org/authors/id/B/BJ/BJOERN/XML-SAX-Expat-&XML-SAX-Expat-version;.tar.gz">
1329 XML-SAX-Expat-&XML-SAX-Expat-version;</ulink></para>
1330 <indexterm zone="perl-modules perl-xml-sax-expat">
1331 <primary sortas="g-XML-SAX-Expat">XML::SAX::Expat</primary>
1332 </indexterm>
1333 </listitem>
1334 <listitem>
1335 <para id="perl-xml-libxml"><ulink
1336 url="http://cpan.org/authors/id/P/PA/PAJAS/XML-LibXML-&XML-LibXML-version;.tar.gz">
1337 XML-LibXML-&XML-LibXML-version;</ulink></para>
1338 <indexterm zone="perl-modules perl-xml-libxml">
1339 <primary sortas="g-XML-LibXML">XML::LibXML</primary>
1340 </indexterm>
1341 </listitem>
1342 <listitem>
1343 <para><xref linkend="perl-xml-parser"/></para>
1344 </listitem>
1345 </itemizedlist>
1346
1347 </listitem>
1348 <listitem>
1349 <para id="perl-tie-ixhash"><ulink
1350 url="http://cpan.org/authors/id/G/GS/GSAR/Tie-IxHash-&Tie-IxHash-version;.tar.gz">
1351 Tie-IxHash-&Tie-IxHash-version;</ulink></para>
1352 <indexterm zone="perl-modules perl-tie-ixhash">
1353 <primary sortas="g-Tie-IxHash">Tie::IxHash</primary>
1354 </indexterm>
1355 </listitem>
1356 </itemizedlist>
1357
1358 </listitem>
1359 </itemizedlist>
1360
1361 <!-- YAML -->
1362 <bridgehead renderas="sect3" id="perl-yaml"
1363 xreflabel="YAML-&YAML-version;">
1364 YAML-&YAML-version;</bridgehead>
1365
1366 <indexterm zone="perl-modules perl-yaml">
1367 <primary sortas="g-YAML">YAML</primary>
1368 </indexterm>
1369
1370 <para>The <application>YAML</application> modules implement a
1371 <application>YAML</application> Loader and Dumper based on the
1372 <application>YAML</application> 1.0 specification
1373 <ulink url="http://www.yaml.org/spec/"/>.
1374 <application>YAML</application> is a generic data serialization language
1375 that is optimized for human readability. It can be used to express the data
1376 structures of most modern programming languages. The module and
1377 dependencies are installed using the standard
1378 <application>Perl</application> module
1379 <xref linkend="perl-standard-install"/>.</para>
1380
1381 <note>
1382 <para>The <application>YAML</application>,
1383 <application>Test::Base</application> and
1384 <application>Spiffy</application> modules will install UTF-8
1385 encoded manual pages. To modify the manual pages so that non-UTF-8
1386 encoded pages are installed, issue the following commands (before
1387 any other build commands):</para>
1388
1389<screen><literal>For <application>Spiffy</application>: <command>sed -i 's,\xc3\xb6,o,' lib/Spiffy.pm</command>
1390
1391For <application>Test::Base</application>: <command>sed -i 's,\xc3\xb6,o,' \
1392 lib/Test/Base{,/Filter}.pm \
1393 lib/Module/Install/TestBase.pm</command>
1394
1395For <application>YAML</application>: <command>sed -i 's,\xc3\xb6,o,' \
1396 ysh \
1397 lib{,/Test}/YAML.pm \
1398 lib/YAML/{Types,Node,Error,Marshall,Tag,Base}.pm \
1399 lib/YAML/{Loader,Dumper}{,/Base}.pm</command></literal></screen>
1400
1401 </note>
1402
1403 <itemizedlist spacing='compact'>
1404 <listitem>
1405 <para><ulink
1406 url="http://cpan.org/authors/id/I/IN/INGY/YAML-&YAML-version;.tar.gz">
1407 YAML-&YAML-version;</ulink></para>
1408
1409 <itemizedlist>
1410 <listitem>
1411 <para id="perl-test-base"><ulink
1412 url="http://cpan.org/authors/id/I/IN/INGY/Test-Base-&Test-Base-version;.tar.gz">
1413 Test-Base-&Test-Base-version;</ulink>
1414 (optionally used during the tests)</para>
1415 <indexterm zone="perl-modules perl-test-base">
1416 <primary sortas="g-Test-Base">Test::Base</primary>
1417 </indexterm>
1418
1419 <itemizedlist>
1420 <listitem>
1421 <para id="perl-spiffy"><ulink
1422 url="http://cpan.org/authors/id/I/IN/INGY/Spiffy-&Spiffy-version;.tar.gz">
1423 Spiffy-&Spiffy-version;</ulink></para>
1424 <indexterm zone="perl-modules perl-spiffy">
1425 <primary sortas="g-Spiffy">Spiffy</primary>
1426 </indexterm>
1427 </listitem>
1428 </itemizedlist>
1429
1430 </listitem>
1431 <listitem>
1432 <para><xref linkend="perl-text-diff"/>
1433 (optionally used during the tests)</para>
1434 </listitem>
1435 <listitem>
1436 <para><xref linkend="perl-test-simple"/>
1437 (optionally used during the tests)</para>
1438 </listitem>
1439 </itemizedlist>
1440
1441 </listitem>
1442 </itemizedlist>
1443
1444 </sect2>
1445
1446 <sect2 role="installation" id="perl-standard-install"
1447 xreflabel="build and installation instructions">
1448 <title>Standard Installation of Perl Modules</title>
1449
1450 <para>Install <application>Perl</application> modules by running the
1451 following commands:</para>
1452
1453<screen><userinput>perl Makefile.PL &amp;&amp;
1454make &amp;&amp;
1455make test</userinput></screen>
1456
1457 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
1458
1459<screen role="root"><userinput>make install</userinput></screen>
1460
1461 <note>
1462
1463 <para>When reinstalling a <application>Perl</application> module,
1464 sometimes older versions of the module being reinstalled are in other
1465 directories specified in <parameter>@INC</parameter>. To delete all
1466 other versions of the module being reinstalled (not simply older ones)
1467 set the <varname>UNINST</varname> variable:</para>
1468
1469<screen><userinput>make install UNINST=1</userinput></screen>
1470 </note>
1471
1472 </sect2>
1473
1474 <sect2 role="installation">
1475 <title>(Alternate) Auto Installation of Perl Modules.</title>
1476
1477 <para>There is an alternate way of installing the modules using the
1478 <command>cpan</command> shell <command>install</command> command. The
1479 command automatically downloads the source from the CPAN archive, extracts
1480 it, runs the compilation, testing and installation commands mentioned
1481 above, and removes the build source tree. You may still need to install
1482 dependent library packages before running the automated installation
1483 method.</para>
1484
1485 <para>The first time you run <command>cpan</command>, you'll be prompted
1486 to enter some information regarding download locations and methods. This
1487 information is retained in files located in
1488 <filename class='directory'>~/.cpan</filename>. Start the
1489 <command>cpan</command> shell by issuing '<command>cpan</command>' as the
1490 <systemitem class="username">root</systemitem> user. Any module may now be
1491 installed from the
1492 <emphasis role='underlined'><prompt>cpan&gt;&nbsp;</prompt></emphasis>
1493 prompt with the command:</para>
1494
1495<screen role="root"><userinput>install <replaceable>&lt;Module::Name&gt;</replaceable></userinput></screen>
1496
1497 <para>For additional commands and help, issue '<command>help</command>'
1498 from the
1499 <emphasis role='underlined'><prompt>cpan&gt;&nbsp;</prompt></emphasis>
1500 prompt.</para>
1501
1502 <para>Alternatively, for scripted or non-interactive installations, use the
1503 following syntax as the
1504 <systemitem class="username">root</systemitem> user to install one or more
1505 modules:</para>
1506
1507<screen role="root"><userinput>cpan -i <replaceable>&lt;Module1::Name&gt; &lt;Module2::Name&gt;</replaceable></userinput></screen>
1508
1509 <para>Review the <filename>cpan.1</filename> man page for additional
1510 parameters you can pass to <command>cpan</command> on the command
1511 line.</para>
1512
1513 </sect2>
1514
1515</sect1>
Note: See TracBrowser for help on using the repository browser.