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

clfs-3.0.0-systemdsystemd
Last change on this file since ec2f02c was ec2f02c, checked in by Chris Staub <chris@…>, 8 years ago

Reorder command explanations to match the actual command

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