source: clfs-sysroot/BOOK/final-system/common/perl.xml @ 3349a3a

Last change on this file since 3349a3a was 3349a3a, checked in by Jim Gifford <clfs@…>, 13 years ago

r3669@server (orig r1667): jciccone | 2006-05-27 18:13:38 -0700
Various text and command fixes

  • Property mode set to 100644
File size: 13.7 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3  "http://www.oasis-open.org/docbook/xml/4.4/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    <important os="w1"><para>Information on cross-compiling perl has not been added yet.</para></important>
29
30    <para os="a00">Before starting to configure, create a basic
31    <filename>/etc/hosts</filename> file which will be referenced in one
32    of Perl's configuration files as well as being used used by the testsuite
33    if you run that.</para>
34
35<screen os="a01"><userinput>echo "127.0.0.1 localhost $(hostname)" &gt; /etc/hosts</userinput></screen>
36
37    <para os="a">To have full control over the way Perl is set up, run the
38    interactive <command>Configure</command> script and hand-pick the way
39    this package is built. If the defaults it auto-detects are suitable,
40    prepare Perl for compilation with:</para>
41
42<screen os="b"><userinput>./configure.gnu --prefix=/usr \
43   -Dman1dir=/usr/share/man/man1 \
44   -Dman3dir=/usr/share/man/man3 \
45   -Dpager="/bin/less -isR"</userinput></screen>
46
47    <variablelist os="c">
48      <title>The meaning of the configure option:</title>
49
50      <varlistentry os="c1">
51        <term><parameter>-Dpager="/bin/less -isR"</parameter></term>
52        <listitem>
53          <para>This corrects an error in the way that <command>perldoc</command>
54          invokes the <command>less</command> program.</para>
55        </listitem>
56      </varlistentry>
57      <varlistentry os="c2">
58        <term><parameter>-Dman1dir=/usr/share/man/man1 -Dman3dir=/usr/share/man/man3</parameter></term>
59        <listitem>
60          <para>Since Groff is not installed yet,
61          <command>configure.gnu</command> thinks that we do not want
62          man pages for Perl. Issuing these parameters overrides this decision.</para>
63        </listitem>
64      </varlistentry>
65    </variablelist>
66
67    <para os="d">Compile the package:</para>
68
69<screen os="e"><userinput>make</userinput></screen>
70
71    <para os="h">To test the results, issue:
72    <userinput>make test</userinput>.</para>
73
74    <para os="j">Install the package:</para>
75
76<screen os="k"><userinput>make install</userinput></screen>
77
78  </sect2>
79
80  <sect2 id="contents-perl" role="content">
81    <title>Contents of Perl</title>
82
83    <segmentedlist>
84      <segtitle>Installed programs</segtitle>
85      <segtitle>Installed libraries</segtitle>
86
87      <seglistitem>
88        <seg>a2p, c2ph, dprofpp, enc2xs, find2perl, h2ph, h2xs, libnetcfg,
89        perl, perl&perl-version; (link to perl), perlbug, perlcc, perldoc,
90        perlivp, piconv, pl2pm, pod2html, pod2latex, pod2man, pod2text,
91        pod2usage, podchecker, podselect, psed (link to s2p), pstruct (link
92        to c2ph), s2p, splain, and xsubpp</seg>
93        <seg>Several hundred which cannot all be listed here</seg>
94      </seglistitem>
95    </segmentedlist>
96
97    <variablelist>
98      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
99      <?dbfo list-presentation="list"?>
100      <?dbhtml list-presentation="table"?>
101
102      <varlistentry id="a2p">
103        <term><command>a2p</command></term>
104        <listitem>
105          <para>Translates awk to Perl</para>
106          <indexterm zone="ch-system-perl a2p">
107            <primary sortas="b-a2p">a2p</primary>
108          </indexterm>
109        </listitem>
110      </varlistentry>
111
112      <varlistentry id="c2ph">
113        <term><command>c2ph</command></term>
114        <listitem>
115          <para>Dumps C structures as generated from
116          <command>cc -g -S</command></para>
117          <indexterm zone="ch-system-perl c2ph">
118            <primary sortas="b-c2ph">c2ph</primary>
119          </indexterm>
120        </listitem>
121      </varlistentry>
122
123      <varlistentry id="dprofpp">
124        <term><command>dprofpp</command></term>
125        <listitem>
126          <para>Displays Perl profile data</para>
127          <indexterm zone="ch-system-perl dprofpp">
128            <primary sortas="b-dprofpp">dprofpp</primary>
129          </indexterm>
130        </listitem>
131      </varlistentry>
132
133      <varlistentry id="en2cxs">
134        <term><command>en2cxs</command></term>
135        <listitem>
136          <para>Builds a Perl extension for the Encode module from either
137          Unicode Character Mappings or Tcl Encoding Files</para>
138          <indexterm zone="ch-system-perl en2cxs">
139            <primary sortas="b-en2cxs">en2cxs</primary>
140          </indexterm>
141        </listitem>
142      </varlistentry>
143
144      <varlistentry id="find2perl">
145        <term><command>find2perl</command></term>
146        <listitem>
147          <para>Translates <command>find</command> commands to Perl</para>
148          <indexterm zone="ch-system-perl find2perl">
149            <primary sortas="b-find2perl">find2perl</primary>
150          </indexterm>
151        </listitem>
152      </varlistentry>
153
154      <varlistentry id="h2ph">
155        <term><command>h2ph</command></term>
156        <listitem>
157          <para>Converts <filename class="extension">.h</filename> C header
158          files to <filename class="extension">.ph</filename> Perl header
159          files</para>
160          <indexterm zone="ch-system-perl h2ph">
161            <primary sortas="b-h2ph">h2ph</primary>
162          </indexterm>
163        </listitem>
164      </varlistentry>
165
166      <varlistentry id="h2xs">
167        <term><command>h2xs</command></term>
168        <listitem>
169          <para>Converts <filename class="extension">.h</filename> C header
170          files to Perl extensions</para>
171          <indexterm zone="ch-system-perl h2xs">
172            <primary sortas="b-h2xs">h2xs</primary>
173          </indexterm>
174        </listitem>
175      </varlistentry>
176
177      <varlistentry id="libnetcfg">
178        <term><command>libnetcfg</command></term>
179        <listitem>
180          <para>Can be used to configure the
181          <filename class="libraryfile">libnet</filename></para>
182          <indexterm zone="ch-system-perl libnetcfg">
183            <primary sortas="b-libnetcfg">libnetcfg</primary>
184          </indexterm>
185        </listitem>
186      </varlistentry>
187
188      <varlistentry id="perl">
189        <term><command>perl</command></term>
190        <listitem>
191          <para>Combines some of the best features of C, <command>sed</command>,
192          <command>awk</command> and <command>sh</command> into a single
193          swiss-army language</para>
194          <indexterm zone="ch-system-perl perl">
195            <primary sortas="b-perl">perl</primary>
196          </indexterm>
197        </listitem>
198      </varlistentry>
199
200      <varlistentry id="perl-version">
201        <term><command>perl&perl-version;</command></term>
202        <listitem>
203          <para>A hard link to <command>perl</command></para>
204          <indexterm zone="ch-system-perl perl-version">
205            <primary sortas="b-perl&perl-version;">perl&perl-version;</primary>
206          </indexterm>
207        </listitem>
208      </varlistentry>
209
210      <varlistentry id="perlbug">
211        <term><command>perlbug</command></term>
212        <listitem>
213          <para>Used to generate bug reports about Perl, or the modules that come
214          with it, and mail them</para>
215          <indexterm zone="ch-system-perl perlbug">
216            <primary sortas="b-perlbug">perlbug</primary>
217          </indexterm>
218        </listitem>
219      </varlistentry>
220
221      <varlistentry id="perlcc">
222        <term><command>perlcc</command></term>
223        <listitem>
224          <para>Generates executables from Perl programs</para>
225          <indexterm zone="ch-system-perl perlcc">
226            <primary sortas="b-perlcc">perlcc</primary>
227          </indexterm>
228        </listitem>
229      </varlistentry>
230
231      <varlistentry id="perldoc">
232        <term><command>perldoc</command></term>
233        <listitem>
234          <para>Displays a piece of documentation in pod format that is embedded
235          in the Perl installation tree or in a Perl script</para>
236          <indexterm zone="ch-system-perl perldoc">
237            <primary sortas="b-perldoc">perldoc</primary>
238          </indexterm>
239        </listitem>
240      </varlistentry>
241
242      <varlistentry id="perlivp">
243        <term><command>perlivp</command></term>
244        <listitem>
245          <para>The Perl Installation Verification Procedure; it can be used to
246          verify that Perl and its libraries have been installed
247          correctly</para>
248          <indexterm zone="ch-system-perl perlivp">
249            <primary sortas="b-perlivp">perlivp</primary>
250          </indexterm>
251        </listitem>
252      </varlistentry>
253
254      <varlistentry id="piconv">
255        <term><command>piconv</command></term>
256        <listitem>
257          <para>A Perl version of the character encoding converter
258          <command>iconv</command></para>
259          <indexterm zone="ch-system-perl piconv">
260            <primary sortas="b-piconv">piconv</primary>
261          </indexterm>
262        </listitem>
263      </varlistentry>
264
265      <varlistentry id="pl2pm">
266        <term><command>pl2pm</command></term>
267        <listitem>
268          <para>A rough tool for converting Perl4
269          <filename class="extension">.pl</filename> files to Perl5
270          <filename class="extension">.pm</filename> modules</para>
271          <indexterm zone="ch-system-perl pl2pm">
272            <primary sortas="b-pl2pm">pl2pm</primary>
273          </indexterm>
274        </listitem>
275      </varlistentry>
276
277      <varlistentry id="pod2html">
278        <term><command>pod2html</command></term>
279        <listitem>
280          <para>Converts files from pod format to HTML format</para>
281          <indexterm zone="ch-system-perl pod2html">
282            <primary sortas="b-pod2html">pod2html</primary>
283          </indexterm>
284        </listitem>
285      </varlistentry>
286
287      <varlistentry id="pod2latex">
288        <term><command>pod2latex</command></term>
289        <listitem>
290          <para>Converts files from pod format to LaTeX format</para>
291          <indexterm zone="ch-system-perl pod2latex">
292            <primary sortas="b-pod2latex">pod2latex</primary>
293          </indexterm>
294        </listitem>
295      </varlistentry>
296
297      <varlistentry id="pod2man">
298        <term><command>pod2man</command></term>
299        <listitem>
300          <para>Converts pod data to formatted *roff input</para>
301          <indexterm zone="ch-system-perl pod2man">
302            <primary sortas="b-pod2man">pod2man</primary>
303          </indexterm>
304        </listitem>
305      </varlistentry>
306
307      <varlistentry id="pod2text">
308        <term><command>pod2text</command></term>
309        <listitem>
310          <para>Converts pod data to formatted ASCII text</para>
311          <indexterm zone="ch-system-perl pod2text">
312            <primary sortas="b-pod2text">pod2text</primary>
313          </indexterm>
314        </listitem>
315      </varlistentry>
316
317      <varlistentry id="pod2usage">
318        <term><command>pod2usage</command></term>
319        <listitem>
320          <para>Prints usage messages from embedded pod docs in files</para>
321          <indexterm zone="ch-system-perl pod2usage">
322            <primary sortas="b-pod2usage">pod2usage</primary>
323          </indexterm>
324        </listitem>
325      </varlistentry>
326
327      <varlistentry id="podchecker">
328        <term><command>podchecker</command></term>
329        <listitem>
330          <para>Checks the syntax of pod format documentation files</para>
331          <indexterm zone="ch-system-perl podchecker">
332            <primary sortas="b-podchecker">podchecker</primary>
333          </indexterm>
334        </listitem>
335      </varlistentry>
336
337      <varlistentry id="podselect">
338        <term><command>podselect</command></term>
339        <listitem>
340          <para>Displays selected sections of pod documentation</para>
341          <indexterm zone="ch-system-perl podselect">
342            <primary sortas="b-podselect">podselect</primary>
343          </indexterm>
344        </listitem>
345      </varlistentry>
346
347      <varlistentry id="psed">
348        <term><command>psed</command></term>
349        <listitem>
350          <para>A Perl version of the stream editor <command>sed</command></para>
351          <indexterm zone="ch-system-perl psed">
352            <primary sortas="b-psed">psed</primary>
353          </indexterm>
354        </listitem>
355      </varlistentry>
356
357      <varlistentry id="pstruct">
358        <term><command>pstruct</command></term>
359        <listitem>
360          <para>Dumps C structures as generated from <command>cc -g -S</command>
361          stabs</para>
362          <indexterm zone="ch-system-perl pstruct">
363            <primary sortas="b-pstruct">pstruct</primary>
364          </indexterm>
365        </listitem>
366      </varlistentry>
367
368      <varlistentry id="s2p">
369        <term><command>s2p</command></term>
370        <listitem>
371          <para>Translates <command>sed</command> to Perl</para>
372          <indexterm zone="ch-system-perl s2p">
373            <primary sortas="b-s2p">s2p</primary>
374          </indexterm>
375        </listitem>
376      </varlistentry>
377
378      <varlistentry id="splain">
379        <term><command>splain</command></term>
380        <listitem>
381          <para>Is used to force verbose warning diagnostics in Perl</para>
382          <indexterm zone="ch-system-perl splain">
383            <primary sortas="b-splain">splain</primary>
384          </indexterm>
385        </listitem>
386      </varlistentry>
387
388      <varlistentry id="xsubpp">
389        <term><command>xsubpp</command></term>
390        <listitem>
391          <para>Converts Perl XS code into C code</para>
392          <indexterm zone="ch-system-perl xsubpp">
393            <primary sortas="b-xsubpp">xsubpp</primary>
394          </indexterm>
395        </listitem>
396      </varlistentry>
397
398    </variablelist>
399
400  </sect2>
401
402</sect1>
Note: See TracBrowser for help on using the repository browser.