source: BOOK/final-system/common/perl.xml@ a5e2198

Last change on this file since a5e2198 was 1b48cb6, checked in by Chris Staub <chris@…>, 10 years ago

More consistently use 'test suite' rather than 'testsuite'
  • Property mode set to 100644
File size: 19.7 KB
RevLine 
[3f8be484]1<?xml version="1.0" encoding="ISO-8859-1"?>
[aa18ac0]2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
[3f8be484]4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6]>
7
8<sect1 id="ch-system-perl" role="wrap">
9 <?dbhtml filename="perl.html"?>
10
11 <title>Perl-&perl-version;</title>
12
13 <indexterm zone="ch-system-perl">
14 <primary sortas="a-Perl">Perl</primary>
15 </indexterm>
16
17 <sect2 role="package">
18 <title/>
19
20 <para>The Perl package contains the Practical Extraction and Report
21 Language.</para>
22
23 </sect2>
24
25 <sect2 role="installation">
26 <title>Installation of Perl</title>
27
[ccd51bc]28 <para os="s3">By default, Perl's Compress::Raw::Zlib module builds and
29 links against its own internal copy of Zlib. The following command will
[7f1773b]30 tell it to use the system-installed Zlib:</para>
[ccd51bc]31
[e74f725]32<screen os="s4"><userinput>sed -i -e '/^BUILD_ZLIB/s/True/False/' \
33 -e '/^INCLUDE/s,\./zlib-src,/usr/include,' \
34 -e '/^LIB/s,\./zlib-src,/usr/lib,' \
35 cpan/Compress-Raw-Zlib/config.in</userinput></screen>
[ccd51bc]36
[d73cf0a]37 <note os="a00">
38 <para>If you are following the boot method you will need to enable the
[ce32b58]39 loopback device:</para>
[d73cf0a]40
[4ff8077d]41<screen><userinput remap="test">ip link set lo up</userinput></screen>
[d73cf0a]42 </note>
43
[ba3910e]44 <para os="a01">Before starting to configure, create a basic
[36da727]45 <filename>/etc/hosts</filename> file which will be referenced by one
[1b48cb6]46 of Perl's configuration files as well as used by the test suite:</para>
[0b1aa01]47
[ba3910e]48<screen os="a02"><userinput remap="test">echo "127.0.0.1 localhost $(hostname)" &gt; /etc/hosts</userinput></screen>
[0b1aa01]49
[cfe892d]50 <para os="a">To have full control over the way Perl is set up, you can
51 run the interactive <command>Configure</command> script and hand-pick
52 the way this package is built. If you prefer instead to use the defaults
53 that Perl auto-detects, prepare Perl for compilation with:</para>
[3f8be484]54
[9bf414b]55<screen os="b"><userinput>./configure.gnu --prefix=/usr \
[42622bd]56 -Dvendorprefix=/usr \
[bbf90e8]57 -Dman1dir=/usr/share/man/man1 \
58 -Dman3dir=/usr/share/man/man3 \
[c33fed0]59 -Dpager="/bin/less -isR" \
[1da2a84]60 -Dusethreads -Duseshrplib</userinput></screen>
[3f8be484]61
[e0e40d3]62 <variablelist os="c">
[3f8be484]63 <title>The meaning of the configure option:</title>
64
[e0e40d3]65 <varlistentry os="c1">
[3f8be484]66 <term><parameter>-Dpager="/bin/less -isR"</parameter></term>
67 <listitem>
[2419c576]68 <para>This ensures that <command>perldoc</command> invokes the
69 <command>less</command> program rather than <command>more</command>,
70 as Less has not yet been installed.</para>
[3f8be484]71 </listitem>
72 </varlistentry>
[1da2a84]73
[bbf90e8]74 <varlistentry os="c2">
75 <term><parameter>-Dman1dir=/usr/share/man/man1 -Dman3dir=/usr/share/man/man3</parameter></term>
76 <listitem>
77 <para>Since Groff is not installed yet,
78 <command>configure.gnu</command> thinks that we do not want
79 man pages for Perl. Issuing these parameters overrides this decision.</para>
80 </listitem>
81 </varlistentry>
[1da2a84]82
[c33fed0]83 <varlistentry os="c3">
84 <term><parameter>-Dusethreads</parameter></term>
85 <listitem>
86 <para>This tells Perl to use threads.</para>
87 </listitem>
88 </varlistentry>
[1da2a84]89
90 <varlistentry os="c4">
91 <term><parameter>-Duseshrplib</parameter></term>
92 <listitem>
93 <para>This tells Perl to build a shared libperl.</para>
94 </listitem>
95 </varlistentry>
96
[3f8be484]97 </variablelist>
98
[e0e40d3]99 <para os="d">Compile the package:</para>
[3f8be484]100
[e0e40d3]101<screen os="e"><userinput>make</userinput></screen>
[3f8be484]102
[686839b]103 <para os="h">To test the results, issue:</para>
104
105<screen os="h2"><userinput remap="test">make test</userinput></screen>
[3f8be484]106
[e0e40d3]107 <para os="j">Install the package:</para>
[3f8be484]108
[e0e40d3]109<screen os="k"><userinput>make install</userinput></screen>
[3f8be484]110
111 </sect2>
112
113 <sect2 id="contents-perl" role="content">
114 <title>Contents of Perl</title>
115
116 <segmentedlist>
117 <segtitle>Installed programs</segtitle>
118 <segtitle>Installed libraries</segtitle>
[61ad0b7f]119 <segtitle>Installed directory</segtitle>
[3f8be484]120
121 <seglistitem>
[427015f]122 <seg>a2p, c2ph, config_data, corelist, cpan, cpan2dist, cpanp,
[2b220db9]123 cpanp-run-perl, enc2xs, find2perl, h2ph, h2xs, instmodsh, json_pp,
[712214c]124 libnetcfg, perl, perl&perl-version; (link to perl), perlbug,
[6dbe056]125 perldoc, perlivp, perlthanks (link to perlbug), piconv, pl2pm, pod2html,
126 pod2latex, pod2man, pod2text, pod2usage, podchecker, podselect, prove,
[2b220db9]127 psed (link to s2p), pstruct (link to c2ph), ptar, ptardiff, ptargrep,
128 s2p, shasum, splain, xsubpp, and zipdetails</seg>
[3f8be484]129 <seg>Several hundred which cannot all be listed here</seg>
[61ad0b7f]130 <seg>/usr/lib/perl5</seg>
[3f8be484]131 </seglistitem>
132 </segmentedlist>
133
134 <variablelist>
135 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
136 <?dbfo list-presentation="list"?>
137 <?dbhtml list-presentation="table"?>
138
139 <varlistentry id="a2p">
140 <term><command>a2p</command></term>
141 <listitem>
142 <para>Translates awk to Perl</para>
143 <indexterm zone="ch-system-perl a2p">
144 <primary sortas="b-a2p">a2p</primary>
145 </indexterm>
146 </listitem>
147 </varlistentry>
148
149 <varlistentry id="c2ph">
150 <term><command>c2ph</command></term>
151 <listitem>
152 <para>Dumps C structures as generated from
153 <command>cc -g -S</command></para>
154 <indexterm zone="ch-system-perl c2ph">
155 <primary sortas="b-c2ph">c2ph</primary>
156 </indexterm>
157 </listitem>
158 </varlistentry>
159
[427015f]160 <varlistentry id="config_data">
161 <term><command>config_data</command></term>
162 <listitem>
163 <para>Queries or changes configuration of Perl modules</para>
164 <indexterm zone="ch-system-perl config_data">
165 <primary sortas="b-config_data">config_data</primary>
166 </indexterm>
167 </listitem>
168 </varlistentry>
169
170 <varlistentry id="corelist">
171 <term><command>corelist</command></term>
172 <listitem>
173 <para>A commandline frontend to Module::CoreList</para>
174 <indexterm zone="ch-system-perl corelist">
175 <primary sortas="b-corelist">corelist</primary>
176 </indexterm>
177 </listitem>
178 </varlistentry>
179
[e29fb58]180 <varlistentry id="cpan">
181 <term><command>cpan</command></term>
182 <listitem>
183 <para>Shell script that provides a command interface to CPAN.pm</para>
184 <indexterm zone="ch-system-perl cpan">
185 <primary sortas="b-cpan">cpan</primary>
186 </indexterm>
187 </listitem>
188 </varlistentry>
189
[427015f]190 <varlistentry id="cpan2dist">
191 <term><command>cpan2dist</command></term>
192 <listitem>
193 <para>The CPANPLUS distribution creator</para>
194 <indexterm zone="ch-system-perl cpan2dist">
195 <primary sortas="b-cpan2dist">cpan2dist</primary>
196 </indexterm>
197 </listitem>
198 </varlistentry>
199
200 <varlistentry id="cpanp">
201 <term><command>cpanp</command></term>
202 <listitem>
203 <para>The CPANPLUS launcher</para>
204 <indexterm zone="ch-system-perl cpanp">
205 <primary sortas="b-cpanp">cpanp</primary>
206 </indexterm>
207 </listitem>
208 </varlistentry>
209
210 <varlistentry id="cpanp-run-perl">
211 <term><command>cpanp-run-perl</command></term>
212 <listitem>
213 <para>Perl script that (description needed)</para>
214 <indexterm zone="ch-system-perl cpanp-run-perl">
215 <primary sortas="b-cpanp-run-perl">cpanp-run-perl</primary>
216 </indexterm>
217 </listitem>
218 </varlistentry>
219
[045e44a]220 <varlistentry id="enc2xs">
221 <term><command>enc2xs</command></term>
222 <listitem>
223 <para>Builds a Perl extension for the Encode module from either
224 Unicode Character Mappings or Tcl Encoding Files</para>
225 <indexterm zone="ch-system-perl enc2xs">
226 <primary sortas="b-enc2xs">enc2xs</primary>
227 </indexterm>
228 </listitem>
229 </varlistentry>
230
[3f8be484]231 <varlistentry id="find2perl">
232 <term><command>find2perl</command></term>
233 <listitem>
234 <para>Translates <command>find</command> commands to Perl</para>
235 <indexterm zone="ch-system-perl find2perl">
236 <primary sortas="b-find2perl">find2perl</primary>
237 </indexterm>
238 </listitem>
239 </varlistentry>
240
241 <varlistentry id="h2ph">
242 <term><command>h2ph</command></term>
243 <listitem>
244 <para>Converts <filename class="extension">.h</filename> C header
245 files to <filename class="extension">.ph</filename> Perl header
246 files</para>
247 <indexterm zone="ch-system-perl h2ph">
248 <primary sortas="b-h2ph">h2ph</primary>
249 </indexterm>
250 </listitem>
251 </varlistentry>
252
253 <varlistentry id="h2xs">
254 <term><command>h2xs</command></term>
255 <listitem>
256 <para>Converts <filename class="extension">.h</filename> C header
257 files to Perl extensions</para>
258 <indexterm zone="ch-system-perl h2xs">
259 <primary sortas="b-h2xs">h2xs</primary>
260 </indexterm>
261 </listitem>
262 </varlistentry>
263
[e29fb58]264 <varlistentry id="instmodsh">
265 <term><command>instmodsh</command></term>
266 <listitem>
267 <para>A shell script for examining installed Perl modules,
268 and can even create a tarball from an installed module</para>
269 <indexterm zone="ch-system-perl instmodsh">
270 <primary sortas="b-instmodsh">instmodsh</primary>
271 </indexterm>
272 </listitem>
273 </varlistentry>
274
[2b220db9]275 <varlistentry id="json_pp">
276 <term><command>json_pp</command></term>
277 <listitem>
278 <para>Converts data between certain input and output formats</para>
279 <indexterm zone="ch-system-perl json_pp">
280 <primary sortas="b-json_pp">json_pp</primary>
281 </indexterm>
282 </listitem>
283 </varlistentry>
284
[427015f]285 <varlistentry id="libnetcfg">
286 <term><command>libnetcfg</command></term>
287 <listitem>
288 <para>Can be used to configure the
289 <filename class="libraryfile">libnet</filename></para>
290 <indexterm zone="ch-system-perl libnetcfg">
291 <primary sortas="b-libnetcfg">libnetcfg</primary>
292 </indexterm>
293 </listitem>
294 </varlistentry>
295
[3f8be484]296 <varlistentry id="perl">
297 <term><command>perl</command></term>
298 <listitem>
299 <para>Combines some of the best features of C, <command>sed</command>,
300 <command>awk</command> and <command>sh</command> into a single
[1e91bbd]301 swiss-army-knife language</para>
[3f8be484]302 <indexterm zone="ch-system-perl perl">
303 <primary sortas="b-perl">perl</primary>
304 </indexterm>
305 </listitem>
306 </varlistentry>
307
308 <varlistentry id="perl-version">
309 <term><command>perl&perl-version;</command></term>
310 <listitem>
311 <para>A hard link to <command>perl</command></para>
312 <indexterm zone="ch-system-perl perl-version">
313 <primary sortas="b-perl&perl-version;">perl&perl-version;</primary>
314 </indexterm>
315 </listitem>
316 </varlistentry>
317
318 <varlistentry id="perlbug">
319 <term><command>perlbug</command></term>
320 <listitem>
321 <para>Used to generate bug reports about Perl, or the modules that come
322 with it, and mail them</para>
323 <indexterm zone="ch-system-perl perlbug">
324 <primary sortas="b-perlbug">perlbug</primary>
325 </indexterm>
326 </listitem>
327 </varlistentry>
328
329 <varlistentry id="perldoc">
330 <term><command>perldoc</command></term>
331 <listitem>
332 <para>Displays a piece of documentation in pod format that is embedded
333 in the Perl installation tree or in a Perl script</para>
334 <indexterm zone="ch-system-perl perldoc">
335 <primary sortas="b-perldoc">perldoc</primary>
336 </indexterm>
337 </listitem>
338 </varlistentry>
339
340 <varlistentry id="perlivp">
341 <term><command>perlivp</command></term>
342 <listitem>
343 <para>The Perl Installation Verification Procedure; it can be used to
344 verify that Perl and its libraries have been installed
345 correctly</para>
346 <indexterm zone="ch-system-perl perlivp">
347 <primary sortas="b-perlivp">perlivp</primary>
348 </indexterm>
349 </listitem>
350 </varlistentry>
351
[6dbe056]352 <varlistentry id="perlthanks">
353 <term><command>perlthanks</command></term>
354 <listitem>
355 <para>Used to generate thank you messages to mail to the Perl
356 developers</para>
357 <indexterm zone="ch-system-perl perlthanks">
358 <primary sortas="b-perlthanks">perlthanks</primary>
359 </indexterm>
360 </listitem>
361 </varlistentry>
362
[3f8be484]363 <varlistentry id="piconv">
364 <term><command>piconv</command></term>
365 <listitem>
366 <para>A Perl version of the character encoding converter
367 <command>iconv</command></para>
368 <indexterm zone="ch-system-perl piconv">
369 <primary sortas="b-piconv">piconv</primary>
370 </indexterm>
371 </listitem>
372 </varlistentry>
373
374 <varlistentry id="pl2pm">
375 <term><command>pl2pm</command></term>
376 <listitem>
377 <para>A rough tool for converting Perl4
378 <filename class="extension">.pl</filename> files to Perl5
379 <filename class="extension">.pm</filename> modules</para>
380 <indexterm zone="ch-system-perl pl2pm">
381 <primary sortas="b-pl2pm">pl2pm</primary>
382 </indexterm>
383 </listitem>
384 </varlistentry>
385
386 <varlistentry id="pod2html">
387 <term><command>pod2html</command></term>
388 <listitem>
389 <para>Converts files from pod format to HTML format</para>
390 <indexterm zone="ch-system-perl pod2html">
391 <primary sortas="b-pod2html">pod2html</primary>
392 </indexterm>
393 </listitem>
394 </varlistentry>
395
396 <varlistentry id="pod2latex">
397 <term><command>pod2latex</command></term>
398 <listitem>
399 <para>Converts files from pod format to LaTeX format</para>
400 <indexterm zone="ch-system-perl pod2latex">
401 <primary sortas="b-pod2latex">pod2latex</primary>
402 </indexterm>
403 </listitem>
404 </varlistentry>
405
406 <varlistentry id="pod2man">
407 <term><command>pod2man</command></term>
408 <listitem>
409 <para>Converts pod data to formatted *roff input</para>
410 <indexterm zone="ch-system-perl pod2man">
411 <primary sortas="b-pod2man">pod2man</primary>
412 </indexterm>
413 </listitem>
414 </varlistentry>
415
416 <varlistentry id="pod2text">
417 <term><command>pod2text</command></term>
418 <listitem>
419 <para>Converts pod data to formatted ASCII text</para>
420 <indexterm zone="ch-system-perl pod2text">
421 <primary sortas="b-pod2text">pod2text</primary>
422 </indexterm>
423 </listitem>
424 </varlistentry>
425
426 <varlistentry id="pod2usage">
427 <term><command>pod2usage</command></term>
428 <listitem>
429 <para>Prints usage messages from embedded pod docs in files</para>
430 <indexterm zone="ch-system-perl pod2usage">
431 <primary sortas="b-pod2usage">pod2usage</primary>
432 </indexterm>
433 </listitem>
434 </varlistentry>
435
436 <varlistentry id="podchecker">
437 <term><command>podchecker</command></term>
438 <listitem>
439 <para>Checks the syntax of pod format documentation files</para>
440 <indexterm zone="ch-system-perl podchecker">
441 <primary sortas="b-podchecker">podchecker</primary>
442 </indexterm>
443 </listitem>
444 </varlistentry>
445
446 <varlistentry id="podselect">
447 <term><command>podselect</command></term>
448 <listitem>
449 <para>Displays selected sections of pod documentation</para>
450 <indexterm zone="ch-system-perl podselect">
451 <primary sortas="b-podselect">podselect</primary>
452 </indexterm>
453 </listitem>
454 </varlistentry>
455
[e29fb58]456 <varlistentry id="prove">
457 <term><command>prove</command></term>
458 <listitem>
459 <para>A command-line tool for running tests against Test::Harness</para>
460 <indexterm zone="ch-system-perl prove">
461 <primary sortas="b-prove">prove</primary>
462 </indexterm>
463 </listitem>
464 </varlistentry>
465
[3f8be484]466 <varlistentry id="psed">
467 <term><command>psed</command></term>
468 <listitem>
469 <para>A Perl version of the stream editor <command>sed</command></para>
470 <indexterm zone="ch-system-perl psed">
471 <primary sortas="b-psed">psed</primary>
472 </indexterm>
473 </listitem>
474 </varlistentry>
475
476 <varlistentry id="pstruct">
477 <term><command>pstruct</command></term>
478 <listitem>
479 <para>Dumps C structures as generated from <command>cc -g -S</command>
480 stabs</para>
481 <indexterm zone="ch-system-perl pstruct">
482 <primary sortas="b-pstruct">pstruct</primary>
483 </indexterm>
484 </listitem>
485 </varlistentry>
486
[427015f]487 <varlistentry id="ptar">
488 <term><command>ptar</command></term>
489 <listitem>
490 <para>A <command>tar</command>-like program written in Perl</para>
491 <indexterm zone="ch-system-perl ptar">
492 <primary sortas="b-ptar">ptar</primary>
493 </indexterm>
494 </listitem>
495 </varlistentry>
496
497 <varlistentry id="ptardiff">
498 <term><command>ptardiff</command></term>
499 <listitem>
500 <para>A Perl program that compares an extracted archive with an
501 unextracted one</para>
502 <indexterm zone="ch-system-perl ptardiff">
503 <primary sortas="b-ptardiff">ptardiff</primary>
504 </indexterm>
505 </listitem>
506 </varlistentry>
507
[2b220db9]508 <varlistentry id="ptargrep">
509 <term><command>ptargrep</command></term>
510 <listitem>
511 <para>A Perl program that applies pattern matching to the contents
512 of files in a tar archive</para>
513 <indexterm zone="ch-system-perl ptargrep">
514 <primary sortas="b-ptargrep">ptargrep</primary>
515 </indexterm>
516 </listitem>
517 </varlistentry>
518
[3f8be484]519 <varlistentry id="s2p">
520 <term><command>s2p</command></term>
521 <listitem>
522 <para>Translates <command>sed</command> to Perl</para>
523 <indexterm zone="ch-system-perl s2p">
524 <primary sortas="b-s2p">s2p</primary>
525 </indexterm>
526 </listitem>
527 </varlistentry>
528
[427015f]529 <varlistentry id="shasum">
530 <term><command>shasum</command></term>
531 <listitem>
532 <para>Prints or checks SHA checksums</para>
533 <indexterm zone="ch-system-perl shasum">
534 <primary sortas="b-shasum">shasum</primary>
535 </indexterm>
536 </listitem>
537 </varlistentry>
538
[3f8be484]539 <varlistentry id="splain">
540 <term><command>splain</command></term>
541 <listitem>
542 <para>Is used to force verbose warning diagnostics in Perl</para>
543 <indexterm zone="ch-system-perl splain">
544 <primary sortas="b-splain">splain</primary>
545 </indexterm>
546 </listitem>
547 </varlistentry>
548
549 <varlistentry id="xsubpp">
550 <term><command>xsubpp</command></term>
551 <listitem>
552 <para>Converts Perl XS code into C code</para>
553 <indexterm zone="ch-system-perl xsubpp">
554 <primary sortas="b-xsubpp">xsubpp</primary>
555 </indexterm>
556 </listitem>
557 </varlistentry>
558
[2b220db9]559 <varlistentry id="zipdetails">
560 <term><command>zipdetails</command></term>
561 <listitem>
562 <para>Displays details about the internal structure of a Zip file</para>
563 <indexterm zone="ch-system-perl zipdetails">
564 <primary sortas="b-zipdetails">zipdetails</primary>
565 </indexterm>
566 </listitem>
567 </varlistentry>
568
[3f8be484]569 </variablelist>
570
571 </sect2>
572
573</sect1>
Note: See TracBrowser for help on using the repository browser.