chapter06/perl.xml

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