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     <note><para>Several tests related to zlib will fail due to using
 123     the system version of zlib instead of the internal version.</para></note>
 124
 125     <para>Install the package and clean up:</para>
 126
 127 <screen><userinput remap="install">make install
 128 unset BUILD_ZLIB BUILD_BZIP2</userinput></screen>
 129
 130   </sect2>
 131
 132   <sect2 id="contents-perl" role="content">
 133     <title>Contents of Perl</title>
 134
 135     <segmentedlist>
 136       <segtitle>Installed programs</segtitle>
 137       <segtitle>Installed libraries</segtitle>
 138       <segtitle>Installed directory</segtitle>
 139
 140       <seglistitem>
 141         <seg>c2ph, corelist, cpan, enc2xs, encguess, h2ph, h2xs, instmodsh,
 142         json_pp, libnetcfg, perl, perl&perl-version; (hard link to perl),
 143         perlbug, perldoc, perlivp, perlthanks (hard link to perlbug), piconv,
 144         pl2pm, pod2html, pod2man, pod2text, pod2usage, podchecker, podselect,
 145         prove, pstruct (hard link to c2ph), ptar, ptardiff, ptargrep, shasum,
 146         splain, xsubpp, and zipdetails</seg>
 147         <seg>Many which cannot all be listed here</seg>
 148         <seg>/usr/lib/perl5</seg>
 149       </seglistitem>
 150     </segmentedlist>
 151
 152     <variablelist>
 153       <bridgehead renderas="sect3">Short Descriptions</bridgehead>
 154       <?dbfo list-presentation="list"?>
 155       <?dbhtml list-presentation="table"?>
 156
 157       <varlistentry id="c2ph">
 158         <term><command>c2ph</command></term>
 159         <listitem>
 160           <para>Dumps C structures as generated from
 161           <command>cc -g -S</command></para>
 162           <indexterm zone="ch-system-perl c2ph">
 163             <primary sortas="b-c2ph">c2ph</primary>
 164           </indexterm>
 165         </listitem>
 166       </varlistentry>
 167
 168       <varlistentry id="corelist">
 169         <term><command>corelist</command></term>
 170         <listitem>
 171           <para>A commandline frontend to Module::CoreList</para>
 172           <indexterm zone="ch-system-perl corelist">
 173             <primary sortas="b-corelist">corelist</primary>
 174           </indexterm>
 175         </listitem>
 176       </varlistentry>
 177
 178       <varlistentry id="cpan">
 179         <term><command>cpan</command></term>
 180         <listitem>
 181           <para>Interact with the Comprehensive Perl Archive Network (CPAN)
 182           from the command line</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="enc2xs">
 190         <term><command>enc2xs</command></term>
 191         <listitem>
 192           <para>Builds a Perl extension for the Encode module from either
 193           Unicode Character Mappings or Tcl Encoding Files</para>
 194           <indexterm zone="ch-system-perl enc2xs">
 195             <primary sortas="b-enc2xs">enc2xs</primary>
 196           </indexterm>
 197         </listitem>
 198       </varlistentry>
 199
 200       <varlistentry id="encguess">
 201         <term><command>encguess</command></term>
 202         <listitem>
 203           <para>Guess the encoding type of one or several files</para>
 204           <indexterm zone="ch-system-perl encguess">
 205             <primary sortas="b-encguess">encguess</primary>
 206           </indexterm>
 207         </listitem>
 208       </varlistentry>
 209
 210       <varlistentry id="h2ph">
 211         <term><command>h2ph</command></term>
 212         <listitem>
 213           <para>Converts <filename class="extension">.h</filename> C header
 214           files to <filename class="extension">.ph</filename> Perl header
 215           files</para>
 216           <indexterm zone="ch-system-perl h2ph">
 217             <primary sortas="b-h2ph">h2ph</primary>
 218           </indexterm>
 219         </listitem>
 220       </varlistentry>
 221
 222       <varlistentry id="h2xs">
 223         <term><command>h2xs</command></term>
 224         <listitem>
 225           <para>Converts <filename class="extension">.h</filename> C header
 226           files to Perl extensions</para>
 227           <indexterm zone="ch-system-perl h2xs">
 228             <primary sortas="b-h2xs">h2xs</primary>
 229           </indexterm>
 230         </listitem>
 231       </varlistentry>
 232
 233       <varlistentry id="instmodsh">
 234         <term><command>instmodsh</command></term>
 235         <listitem>
 236           <para>Shell script for examining installed Perl modules,
 237           and can even create a tarball from an installed module</para>
 238           <indexterm zone="ch-system-perl instmodsh">
 239             <primary sortas="b-instmodsh">instmodsh</primary>
 240           </indexterm>
 241         </listitem>
 242       </varlistentry>
 243
 244       <varlistentry id="json_pp">
 245         <term><command>json_pp</command></term>
 246         <listitem>
 247           <para>Converts data between certain input and output formats</para>
 248           <indexterm zone="ch-system-perl json_pp">
 249             <primary sortas="b-json_pp">json_pp</primary>
 250           </indexterm>
 251         </listitem>
 252       </varlistentry>
 253
 254       <varlistentry id="libnetcfg">
 255         <term><command>libnetcfg</command></term>
 256         <listitem>
 257           <para>Can be used to configure the
 258           <filename class="libraryfile">libnet</filename> Perl module</para>
 259           <indexterm zone="ch-system-perl libnetcfg">
 260             <primary sortas="b-libnetcfg">libnetcfg</primary>
 261           </indexterm>
 262         </listitem>
 263       </varlistentry>
 264
 265       <varlistentry id="perl">
 266         <term><command>perl</command></term>
 267         <listitem>
 268           <para>Combines some of the best features of C, <command>sed</command>,
 269           <command>awk</command> and <command>sh</command> into a single
 270           swiss-army language</para>
 271           <indexterm zone="ch-system-perl perl">
 272             <primary sortas="b-perl">perl</primary>
 273           </indexterm>
 274         </listitem>
 275       </varlistentry>
 276
 277       <varlistentry id="perl-version">
 278         <term><command>perl&perl-version;</command></term>
 279         <listitem>
 280           <para>A hard link to <command>perl</command></para>
 281           <indexterm zone="ch-system-perl perl-version">
 282             <primary sortas="b-perl&perl-version;">perl&perl-version;</primary>
 283           </indexterm>
 284         </listitem>
 285       </varlistentry>
 286
 287       <varlistentry id="perlbug">
 288         <term><command>perlbug</command></term>
 289         <listitem>
 290           <para>Used to generate bug reports about Perl, or the modules that come
 291           with it, and mail them</para>
 292           <indexterm zone="ch-system-perl perlbug">
 293             <primary sortas="b-perlbug">perlbug</primary>
 294           </indexterm>
 295         </listitem>
 296       </varlistentry>
 297
 298       <varlistentry id="perldoc">
 299         <term><command>perldoc</command></term>
 300         <listitem>
 301           <para>Displays a piece of documentation in pod format that is embedded
 302           in the Perl installation tree or in a Perl script</para>
 303           <indexterm zone="ch-system-perl perldoc">
 304             <primary sortas="b-perldoc">perldoc</primary>
 305           </indexterm>
 306         </listitem>
 307       </varlistentry>
 308
 309       <varlistentry id="perlivp">
 310         <term><command>perlivp</command></term>
 311         <listitem>
 312           <para>The Perl Installation Verification Procedure; it can be used to
 313           verify that Perl and its libraries have been installed
 314           correctly</para>
 315           <indexterm zone="ch-system-perl perlivp">
 316             <primary sortas="b-perlivp">perlivp</primary>
 317           </indexterm>
 318         </listitem>
 319       </varlistentry>
 320
 321       <varlistentry id="perlthanks">
 322         <term><command>perlthanks</command></term>
 323         <listitem>
 324           <para>Used to generate thank you messages to mail to the Perl
 325           developers</para>
 326           <indexterm zone="ch-system-perl perlthanks">
 327             <primary sortas="b-perlthanks">perlthanks</primary>
 328           </indexterm>
 329         </listitem>
 330       </varlistentry>
 331
 332       <varlistentry id="piconv">
 333         <term><command>piconv</command></term>
 334         <listitem>
 335           <para>A Perl version of the character encoding converter
 336           <command>iconv</command></para>
 337           <indexterm zone="ch-system-perl piconv">
 338             <primary sortas="b-piconv">piconv</primary>
 339           </indexterm>
 340         </listitem>
 341       </varlistentry>
 342
 343       <varlistentry id="pl2pm">
 344         <term><command>pl2pm</command></term>
 345         <listitem>
 346           <para>A rough tool for converting Perl4
 347           <filename class="extension">.pl</filename> files to Perl5
 348           <filename class="extension">.pm</filename> modules</para>
 349           <indexterm zone="ch-system-perl pl2pm">
 350             <primary sortas="b-pl2pm">pl2pm</primary>
 351           </indexterm>
 352         </listitem>
 353       </varlistentry>
 354
 355       <varlistentry id="pod2html">
 356         <term><command>pod2html</command></term>
 357         <listitem>
 358           <para>Converts files from pod format to HTML format</para>
 359           <indexterm zone="ch-system-perl pod2html">
 360             <primary sortas="b-pod2html">pod2html</primary>
 361           </indexterm>
 362         </listitem>
 363       </varlistentry>
 364
 365       <varlistentry id="pod2man">
 366         <term><command>pod2man</command></term>
 367         <listitem>
 368           <para>Converts pod data to formatted *roff input</para>
 369           <indexterm zone="ch-system-perl pod2man">
 370             <primary sortas="b-pod2man">pod2man</primary>
 371           </indexterm>
 372         </listitem>
 373       </varlistentry>
 374
 375       <varlistentry id="pod2text">
 376         <term><command>pod2text</command></term>
 377         <listitem>
 378           <para>Converts pod data to formatted ASCII text</para>
 379           <indexterm zone="ch-system-perl pod2text">
 380             <primary sortas="b-pod2text">pod2text</primary>
 381           </indexterm>
 382         </listitem>
 383       </varlistentry>
 384
 385       <varlistentry id="pod2usage">
 386         <term><command>pod2usage</command></term>
 387         <listitem>
 388           <para>Prints usage messages from embedded pod docs in files</para>
 389           <indexterm zone="ch-system-perl pod2usage">
 390             <primary sortas="b-pod2usage">pod2usage</primary>
 391           </indexterm>
 392         </listitem>
 393       </varlistentry>
 394
 395       <varlistentry id="podchecker">
 396         <term><command>podchecker</command></term>
 397         <listitem>
 398           <para>Checks the syntax of pod format documentation files</para>
 399           <indexterm zone="ch-system-perl podchecker">
 400             <primary sortas="b-podchecker">podchecker</primary>
 401           </indexterm>
 402         </listitem>
 403       </varlistentry>
 404
 405       <varlistentry id="podselect">
 406         <term><command>podselect</command></term>
 407         <listitem>
 408           <para>Displays selected sections of pod documentation</para>
 409           <indexterm zone="ch-system-perl podselect">
 410             <primary sortas="b-podselect">podselect</primary>
 411           </indexterm>
 412         </listitem>
 413       </varlistentry>
 414
 415       <varlistentry id="prove">
 416         <term><command>prove</command></term>
 417         <listitem>
 418           <para>Command line tool for running tests against the Test::Harness
 419           module</para>
 420           <indexterm zone="ch-system-perl prove">
 421             <primary sortas="b-prove">prove</primary>
 422           </indexterm>
 423         </listitem>
 424       </varlistentry>
 425
 426       <varlistentry id="pstruct">
 427         <term><command>pstruct</command></term>
 428         <listitem>
 429           <para>Dumps C structures as generated from <command>cc -g -S</command>
 430           stabs</para>
 431           <indexterm zone="ch-system-perl pstruct">
 432             <primary sortas="b-pstruct">pstruct</primary>
 433           </indexterm>
 434         </listitem>
 435       </varlistentry>
 436
 437       <varlistentry id="ptar">
 438         <term><command>ptar</command></term>
 439         <listitem>
 440           <para>A <command>tar</command>-like program written in Perl</para>
 441           <indexterm zone="ch-system-perl ptar">
 442             <primary sortas="b-ptar">ptar</primary>
 443           </indexterm>
 444         </listitem>
 445       </varlistentry>
 446
 447       <varlistentry id="ptardiff">
 448         <term><command>ptardiff</command></term>
 449         <listitem>
 450           <para>A Perl program that compares an extracted archive with an
 451           unextracted one</para>
 452           <indexterm zone="ch-system-perl ptardiff">
 453             <primary sortas="b-ptardiff">ptardiff</primary>
 454           </indexterm>
 455         </listitem>
 456       </varlistentry>
 457
 458       <varlistentry id="ptargrep">
 459         <term><command>ptargrep</command></term>
 460         <listitem>
 461           <para>A Perl program that applies pattern matching to the contents
 462           of files in a tar archive</para>
 463           <indexterm zone="ch-system-perl ptargrep">
 464             <primary sortas="b-ptargrep">ptargrep</primary>
 465           </indexterm>
 466         </listitem>
 467       </varlistentry>
 468
 469       <varlistentry id="shasum">
 470         <term><command>shasum</command></term>
 471         <listitem>
 472           <para>Prints or checks SHA checksums</para>
 473           <indexterm zone="ch-system-perl shasum">
 474             <primary sortas="b-shasum">shasum</primary>
 475           </indexterm>
 476         </listitem>
 477       </varlistentry>
 478
 479       <varlistentry id="splain">
 480         <term><command>splain</command></term>
 481         <listitem>
 482           <para>Is used to force verbose warning diagnostics in Perl</para>
 483           <indexterm zone="ch-system-perl splain">
 484             <primary sortas="b-splain">splain</primary>
 485           </indexterm>
 486         </listitem>
 487       </varlistentry>
 488
 489       <varlistentry id="xsubpp">
 490         <term><command>xsubpp</command></term>
 491         <listitem>
 492           <para>Converts Perl XS code into C code</para>
 493           <indexterm zone="ch-system-perl xsubpp">
 494             <primary sortas="b-xsubpp">xsubpp</primary>
 495           </indexterm>
 496         </listitem>
 497       </varlistentry>
 498
 499       <varlistentry id="zipdetails">
 500         <term><command>zipdetails</command></term>
 501         <listitem>
 502           <para>Displays details about the internal structure of a Zip file</para>
 503           <indexterm zone="ch-system-perl zipdetails">
 504             <primary sortas="b-zipdetails">zipdetails</primary>
 505           </indexterm>
 506         </listitem>
 507       </varlistentry>
 508
 509     </variablelist>
 510
 511   </sect2>
 512
 513 </sect1>