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

clfs-3.0.0-systemdsystemd
Last change on this file since 1d869966 was 1d869966, checked in by William Harrington <kb0iic@…>, 9 years ago

Fix perl and perl 32bit instructions for note and remove a redundant command that only should be with the boot method note regarding tests.

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