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

sysvinit
Last change on this file since c1eab93 was c1eab93, checked in by William Harrington <kb0iic@…>, 7 years ago

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