source: final-system/common/perl.xml@ 1234b225

Last change on this file since 1234b225 was a9b8538, checked in by Chris Staub <chris@…>, 18 years ago

Reverted change to bash and perl testsuite commands to be more in line with most other documentation for those packages

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