Debian Codegraph @

upstream/mageia-cauldron/man1/perlutil.1

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\"
56 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "PERLUTIL 1"
61 .TH PERLUTIL 1 2023-12-22 "perl v5.42.0" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 perlutil \- utilities packaged with the Perl distribution
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 Along with the Perl interpreter itself, the Perl distribution installs a
71 range of utilities on your system. There are also several utilities
72 which are used by the Perl distribution itself as part of the install
73 process. This document exists to list all of these utilities, explain
74 what they are for and provide pointers to each module\*(Aqs documentation,
75 if appropriate.
76 .SH "LIST OF UTILITIES"
77 .IX Header "LIST OF UTILITIES"
78 .SS Documentation
79 .IX Subsection "Documentation"
80 .IP perldoc 3
81 .IX Item "perldoc"
82 The main interface to Perl\*(Aqs documentation is \fIperldoc\fR, although
83 if you\*(Aqre reading this, it\*(Aqs more than likely that you\*(Aqve already found
84 it. \fIperldoc\fR will extract and format the documentation from any file
85 in the current directory, any Perl module installed on the system, or
86 any of the standard documentation pages, such as this one. Use
87 \&\f(CW\*(C`perldoc <name>\*(C'\fR to get information on any of the utilities
88 described in this document.
89 .IP pod2man 3
90 .IX Item "pod2man"
91 .PD 0
92 .IP pod2text 3
93 .IX Item "pod2text"
94 .PD
95 If it\*(Aqs run from a terminal, \fIperldoc\fR will usually call \fIpod2man\fR to
96 translate POD (Plain Old Documentation \- see perlpod for an
97 explanation) into a manpage, and then run \fIman\fR to display it; if
98 \&\fIman\fR isn\*(Aqt available, \fIpod2text\fR will be used instead and the output
99 piped through your favourite pager.
100 .IP pod2html 3
101 .IX Item "pod2html"
102 As well as these two, there is another converter: \fIpod2html\fR will
103 produce HTML pages from POD.
104 .IP pod2usage 3
105 .IX Item "pod2usage"
106 If you just want to know how to use the utilities described here,
107 \&\fIpod2usage\fR will just extract the "USAGE" section; some of
108 the utilities will automatically call \fIpod2usage\fR on themselves when
109 you call them with \f(CW\*(C`\-help\*(C'\fR.
110 .IP podchecker 3
111 .IX Item "podchecker"
112 If you\*(Aqre writing your own documentation in POD, the \fIpodchecker\fR
113 utility will look for errors in your markup.
114 .IP splain 3
115 .IX Item "splain"
116 \&\fIsplain\fR is an interface to perldiag \- paste in your error message
117 to it, and it\*(Aqll explain it for you.
118 .IP \fIroffitall\fR 3
119 .IX Item "roffitall"
120 The \fIroffitall\fR utility is not installed on your system but lives in
121 the \fIpod/\fR directory of your Perl source kit; it converts all the
122 documentation from the distribution to \fI*roff\fR format, and produces a
123 typeset PostScript or text file of the whole lot.
124 .SS Converters
125 .IX Subsection "Converters"
126 .IP pl2pm 3
127 .IX Item "pl2pm"
128 To help you convert legacy programs to more modern Perl, the
129 \&\fIpl2pm\fR utility will help you convert old\-style Perl 4 libraries
130 to new\-style Perl5 modules.
131 .SS Administration
132 .IX Subsection "Administration"
133 .IP libnetcfg 3
134 .IX Item "libnetcfg"
135 To display and change the libnet configuration run the libnetcfg command.
136 .IP perlivp 3
137 .IX Item "perlivp"
138 The \fIperlivp\fR program is set up at Perl source code build time to test
139 the Perl version it was built under. It can be used after running \f(CW\*(C`make
140 install\*(C'\fR (or your platform\*(Aqs equivalent procedure) to verify that perl
141 and its libraries have been installed correctly.
142 .SS Development
143 .IX Subsection "Development"
144 There are a set of utilities which help you in developing Perl programs,
145 and in particular, extending Perl with C.
146 .IP perlbug 3
147 .IX Item "perlbug"
148 \&\fIperlbug\fR used to be the recommended way to report bugs in the perl
149 interpreter itself or any of the standard library modules back to the
150 developers; bug reports and patches should now be submitted to
151 <https://github.com/Perl/perl5/issues>.
152 .IP perlthanks 3
153 .IX Item "perlthanks"
154 This program provides an easy way to send a thank\-you message back to the
155 authors and maintainers of perl. It\*(Aqs just \fIperlbug\fR installed under
156 another name.
157 .IP h2ph 3
158 .IX Item "h2ph"
159 Back before Perl had the XS system for connecting with C libraries,
160 programmers used to get library constants by reading through the C
161 header files. You may still see \f(CW\*(C`require\ \*(Aqsyscall.ph\*(Aq\*(C'\fR or similar
162 around \- the \fI.ph\fR file should be created by running \fIh2ph\fR on the
163 corresponding \fI.h\fR file. See the h2ph documentation for more on how
164 to convert a whole bunch of header files at once.
165 .IP h2xs 3
166 .IX Item "h2xs"
167 \&\fIh2xs\fR converts C header files into XS modules, and will try and write
168 as much glue between C libraries and Perl modules as it can. It\*(Aqs also
169 very useful for creating skeletons of pure Perl modules.
170 .IP enc2xs 3
171 .IX Item "enc2xs"
172 \&\fIenc2xs\fR builds a Perl extension for use by Encode from either
173 Unicode Character Mapping files (.ucm) or Tcl Encoding Files (.enc).
174 Besides being used internally during the build process of the Encode
175 module, you can use \fIenc2xs\fR to add your own encoding to perl.
176 No knowledge of XS is necessary.
177 .IP xsubpp 3
178 .IX Item "xsubpp"
179 \&\fIxsubpp\fR is a compiler to convert Perl XS code into C code.
180 It is typically run by the makefiles created by ExtUtils::MakeMaker.
181 .Sp
182 \&\fIxsubpp\fR will compile XS code into C code by embedding the constructs
183 necessary to let C functions manipulate Perl values and creates the glue
184 necessary to let Perl access those functions.
185 .IP prove 3
186 .IX Item "prove"
187 \&\fIprove\fR is a command\-line interface to the test\-running functionality
188 of Test::Harness. It\*(Aqs an alternative to \f(CW\*(C`make test\*(C'\fR.
189 .IP corelist 3
190 .IX Item "corelist"
191 A command\-line front\-end to Module::CoreList, to query what modules
192 were shipped with given versions of perl.
193 .SS "General tools"
194 .IX Subsection "General tools"
195 A few general\-purpose tools are shipped with perl, mostly because they
196 came along modules included in the perl distribution.
197 .IP encguess 3
198 .IX Item "encguess"
199 \&\fIencguess\fR will attempt to guess the character encoding of files.
200 .IP json_pp 3
201 .IX Item "json_pp"
202 \&\fIjson_pp\fR is a pure Perl JSON converter and formatter.
203 .IP piconv 3
204 .IX Item "piconv"
205 \&\fIpiconv\fR is a Perl version of \fBiconv\fR\|(1), a character encoding converter
206 widely available for various Unixen today. This script was primarily a
207 technology demonstrator for Perl v5.8.0, but you can use piconv in the
208 place of iconv for virtually any case.
209 .IP ptar 3
210 .IX Item "ptar"
211 \&\fIptar\fR is a tar\-like program, written in pure Perl.
212 .IP ptardiff 3
213 .IX Item "ptardiff"
214 \&\fIptardiff\fR is a small utility that produces a diff between an extracted
215 archive and an unextracted one. (Note that this utility requires the
216 Text::Diff module to function properly; this module isn\*(Aqt distributed
217 with perl, but is available from the CPAN.)
218 .IP ptargrep 3
219 .IX Item "ptargrep"
220 \&\fIptargrep\fR is a utility to apply pattern matching to the contents of files
221 in a tar archive.
222 .IP shasum 3
223 .IX Item "shasum"
224 This utility, that comes with the Digest::SHA module, is used to print
225 or verify SHA checksums.
226 .IP streamzip 3
227 .IX Item "streamzip"
228 \&\fIstreamzip\fR compresses data streamed to STDIN into a streamed zip container.
229 .IP zipdetails 3
230 .IX Item "zipdetails"
231 \&\fIzipdetails\fR displays information about the internal record structure of the zip file.
232 It is not concerned with displaying any details of the compressed data stored in the zip file.
233 .SS Installation
234 .IX Subsection "Installation"
235 These utilities help manage extra Perl modules that don\*(Aqt come with the perl
236 distribution.
237 .IP cpan 3
238 .IX Item "cpan"
239 \&\fIcpan\fR is a command\-line interface to CPAN.pm. It allows you to install
240 modules or distributions from CPAN, or just get information about them, and
241 a lot more. It is similar to the command line mode of the CPAN module,
242 .Sp
243 .Vb 1
244 \& perl \-MCPAN \-e shell
245 .Ve
246 .IP instmodsh 3
247 .IX Item "instmodsh"
248 A little interface to ExtUtils::Installed to examine installed modules,
249 validate your packlists and even create a tarball from an installed module.
250 .SH "SEE ALSO"
251 .IX Header "SEE ALSO"
252 perldoc, pod2man, pod2text, pod2html, pod2usage,
253 podchecker, splain, pl2pm,
254 perlbug, h2ph, h2xs, enc2xs,
255 xsubpp, cpan, encguess, instmodsh, json_pp,
256 piconv, prove, corelist, ptar,
257 ptardiff, shasum, streamzip, zipdetails