PageRenderTime 47ms CodeModel.GetById 21ms RepoModel.GetById 0ms app.codeStats 0ms

/IronPython_Main/Runtime/Tests/LinqDlrTests/testenv/perl/lib/pod/perlutil.pod

#
Unknown | 185 lines | 130 code | 55 blank | 0 comment | 0 complexity | 90bb20e479d29df75d2d9d25f341de63 MD5 | raw file
Possible License(s): GPL-2.0, MPL-2.0-no-copyleft-exception, CPL-1.0, CC-BY-SA-3.0, BSD-3-Clause, ISC, AGPL-3.0, LGPL-2.1, Apache-2.0
  1. =head1 NAME
  2. perlutil - utilities packaged with the Perl distribution
  3. =head1 DESCRIPTION
  4. Along with the Perl interpreter itself, the Perl distribution installs a
  5. range of utilities on your system. There are also several utilities
  6. which are used by the Perl distribution itself as part of the install
  7. process. This document exists to list all of these utilities, explain
  8. what they are for and provide pointers to each module's documentation,
  9. if appropriate.
  10. =head2 DOCUMENTATION
  11. =over 3
  12. =item L<perldoc|perldoc>
  13. The main interface to Perl's documentation is C<perldoc>, although
  14. if you're reading this, it's more than likely that you've already found
  15. it. F<perldoc> will extract and format the documentation from any file
  16. in the current directory, any Perl module installed on the system, or
  17. any of the standard documentation pages, such as this one. Use
  18. C<perldoc E<lt>nameE<gt>> to get information on any of the utilities
  19. described in this document.
  20. =item L<pod2man|pod2man> and L<pod2text|pod2text>
  21. If it's run from a terminal, F<perldoc> will usually call F<pod2man> to
  22. translate POD (Plain Old Documentation - see L<perlpod> for an
  23. explanation) into a man page, and then run F<man> to display it; if
  24. F<man> isn't available, F<pod2text> will be used instead and the output
  25. piped through your favourite pager.
  26. =item L<pod2html|pod2html> and L<pod2latex|pod2latex>
  27. As well as these two, there are two other converters: F<pod2html> will
  28. produce HTML pages from POD, and F<pod2latex>, which produces LaTeX
  29. files.
  30. =item L<pod2usage|pod2usage>
  31. If you just want to know how to use the utilities described here,
  32. F<pod2usage> will just extract the "USAGE" section; some of
  33. the utilities will automatically call F<pod2usage> on themselves when
  34. you call them with C<-help>.
  35. =item L<podselect|podselect>
  36. F<pod2usage> is a special case of F<podselect>, a utility to extract
  37. named sections from documents written in POD. For instance, while
  38. utilities have "USAGE" sections, Perl modules usually have "SYNOPSIS"
  39. sections: C<podselect -s "SYNOPSIS" ...> will extract this section for
  40. a given file.
  41. =item L<podchecker|podchecker>
  42. If you're writing your own documentation in POD, the F<podchecker>
  43. utility will look for errors in your markup.
  44. =item L<splain|splain>
  45. F<splain> is an interface to L<perldiag> - paste in your error message
  46. to it, and it'll explain it for you.
  47. =item L<roffitall|roffitall>
  48. The C<roffitall> utility is not installed on your system but lives in
  49. the F<pod/> directory of your Perl source kit; it converts all the
  50. documentation from the distribution to F<*roff> format, and produces a
  51. typeset PostScript or text file of the whole lot.
  52. =back
  53. =head2 CONVERTORS
  54. To help you convert legacy programs to Perl, we've included three
  55. conversion filters:
  56. =over 3
  57. =item L<a2p|a2p>
  58. F<a2p> converts F<awk> scripts to Perl programs; for example, C<a2p -F:>
  59. on the simple F<awk> script C<{print $2}> will produce a Perl program
  60. based around this code:
  61. while (<>) {
  62. ($Fld1,$Fld2) = split(/[:\n]/, $_, 9999);
  63. print $Fld2;
  64. }
  65. =item L<s2p|s2p>
  66. Similarly, F<s2p> converts F<sed> scripts to Perl programs. F<s2p> run
  67. on C<s/foo/bar> will produce a Perl program based around this:
  68. while (<>) {
  69. chomp;
  70. s/foo/bar/g;
  71. print if $printit;
  72. }
  73. =item L<find2perl|find2perl>
  74. Finally, F<find2perl> translates C<find> commands to Perl equivalents which
  75. use the L<File::Find|File::Find> module. As an example,
  76. C<find2perl . -user root -perm 4000 -print> produces the following callback
  77. subroutine for C<File::Find>:
  78. sub wanted {
  79. my ($dev,$ino,$mode,$nlink,$uid,$gid);
  80. (($dev,$ino,$mode,$nlink,$uid,$gid) = lstat($_)) &&
  81. $uid == $uid{'root'}) &&
  82. (($mode & 0777) == 04000);
  83. print("$name\n");
  84. }
  85. =back
  86. As well as these filters for converting other languages, the
  87. L<pl2pm|pl2pm> utility will help you convert old-style Perl 4 libraries to
  88. new-style Perl5 modules.
  89. =head2 Development
  90. There are a set of utilities which help you in developing Perl programs,
  91. and in particular, extending Perl with C.
  92. =over 3
  93. =item L<perlbug|perlbug>
  94. F<perlbug> is the recommended way to report bugs in the perl interpreter
  95. itself or any of the standard library modules back to the developers;
  96. please read through the documentation for F<perlbug> thoroughly before
  97. using it to submit a bug report.
  98. =item L<h2ph|h2ph>
  99. Back before Perl had the XS system for connecting with C libraries,
  100. programmers used to get library constants by reading through the C
  101. header files. You may still see C<require 'syscall.ph'> or similar
  102. around - the F<.ph> file should be created by running F<h2ph> on the
  103. corresponding F<.h> file. See the F<h2ph> documentation for more on how
  104. to convert a whole bunch of header files at ones.
  105. =item L<c2ph|c2ph> and L<pstruct|pstruct>
  106. F<c2ph> and F<pstruct>, which are actually the same program but behave
  107. differently depending on how they are called, provide another way of
  108. getting at C with Perl - they'll convert C structures and union declarations
  109. to Perl code. This is deprecated in favour of F<h2xs> these days.
  110. =item L<h2xs|h2xs>
  111. F<h2xs> converts C header files into XS modules, and will try and write
  112. as much glue between C libraries and Perl modules as it can. It's also
  113. very useful for creating skeletons of pure Perl modules.
  114. =item L<dprofpp|dprofpp>
  115. Perl comes with a profiler, the F<Devel::Dprof> module. The
  116. F<dprofpp> utility analyzes the output of this profiler and tells you
  117. which subroutines are taking up the most run time. See L<Devel::Dprof>
  118. for more information.
  119. =item L<perlcc|perlcc>
  120. F<perlcc> is the interface to the experimental Perl compiler suite.
  121. =back
  122. =head2 SEE ALSO
  123. L<perldoc|perldoc>, L<pod2man|pod2man>, L<perlpod>,
  124. L<pod2html|pod2html>, L<pod2usage|pod2usage>, L<podselect|podselect>,
  125. L<podchecker|podchecker>, L<splain|splain>, L<perldiag>,
  126. L<roffitall|roffitall>, L<a2p|a2p>, L<s2p|s2p>, L<find2perl|find2perl>,
  127. L<File::Find|File::Find>, L<pl2pm|pl2pm>, L<perlbug|perlbug>,
  128. L<h2ph|h2ph>, L<c2ph|c2ph>, L<h2xs|h2xs>, L<dprofpp|dprofpp>,
  129. L<Devel::Dprof>, L<perlcc|perlcc>
  130. =cut