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

sysvinit
Last change on this file since 38640a1 was b27081c4, checked in by Chris Staub <chris@…>, 9 years ago

Put one configure option per line

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