X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=pod%2Fperldoc.pod;h=92404395c5ad075094868f8bcacbc00616f02b1a;hb=a22f28a4268aa03ce2bafaf594271b8ff764a5f8;hp=e25b5102a547d52c6e9b141ca31f41890f687a84;hpb=1a67fee7d910c67790fff4a69f2f20f7628aa80a;p=p5sagit%2Fp5-mst-13.2.git diff --git a/pod/perldoc.pod b/pod/perldoc.pod index e25b510..9240439 100644 --- a/pod/perldoc.pod +++ b/pod/perldoc.pod @@ -5,7 +5,7 @@ perldoc - Look up Perl documentation in Pod format. =head1 SYNOPSIS -B [B<-h>] [B<-v>] [B<-t>] [B<-u>] [B<-m>] [B<-l>] [B<-F>] +B [B<-h>] [B<-D>] [B<-t>] [B<-u>] [B<-m>] [B<-l>] [B<-F>] [B<-i>] [B<-V>] [B<-T>] [B<-r>] [B<-dI>] [B<-oI>] @@ -13,12 +13,19 @@ B [B<-h>] [B<-v>] [B<-t>] [B<-u>] [B<-m>] [B<-l>] [B<-F>] [B<-wI>] [B<-n>I] [B<-X>] +[B<-L> I] PageName|ModuleName|ProgramName B B<-f> BuiltinFunction +B B<-L> it B<-f> BuiltinFunction + B B<-q> FAQ Keyword +B B<-L> fr B<-q> FAQ Keyword + +B B<-v> PerlVariable + See below for more description of the switches. =head1 DESCRIPTION @@ -43,9 +50,9 @@ documentation, see the L page. Prints out a brief Belp message. -=item B<-v> +=item B<-D> -Describes search for the item in detail (Berbosely). +Bescribes search for the item in Betail. =item B<-t> @@ -80,11 +87,29 @@ Example: perldoc -f sprintf + =item B<-q> I The B<-q> option takes a regular expression as an argument. It will search the Buestion headings in perlfaq[1-9] and print the entries matching -the regular expression. Example: C +the regular expression. + +Example: + + perldoc -q shuffle + + +=item B<-v> I + +The B<-v> option followed by the name of a Perl predefined variable will +extract the documentation of this variable from L. + +Examples: + + perldoc -v '$"' + perldoc -v @+ + perldoc -v DATA + =item B<-T> @@ -115,7 +140,7 @@ Pod::LATEX. =item B<-M> I This specifies the module that you want to try using for formatting the -pod. The class must must at least provide a C method. +pod. The class must at least provide a C method. For example: C. You can specify several classes to try by joining them with commas @@ -145,12 +170,26 @@ whose basename matches the name given on the command line in the file C<$Config{archlib}/pod.idx>. The F file should contain fully qualified filenames, one per line. +=item B<-L> I + +This allows to specify the I for desired language translation. +If Clanguage_codeE> package doesn't exist (or isn't installed +in your system), the switch will be ignored. +All available translation packages should be found under the C +namespace. See L (or L) in order to see how to create and +integrate new localized C pod documentation packages in +L. + =item B The item you want to look up. Nested modules (such as C) are specified either as C or C. You may also give a descriptive name of a page, such as C. +For simple names like 'foo', when the normal search fails to find +a matching page, a search with the "perl" prefix is tried as well. +So "perldoc intro" is enough to find/render "perlintro.pod". + =item B<-n> I Specify replacement for nroff @@ -207,13 +246,24 @@ Having PERLDOCDEBUG set to a positive integer will make perldoc emit even more descriptive output than the C<-v> switch does -- the higher the number, the more it emits. + +=head1 CHANGES + +Up to 3.14_05, the switch B<-v> was used to produce verbose +messages of B operation, which is now enabled by B<-D>. + +=head1 SEE ALSO + +L, L + =head1 AUTHOR -Current maintainer: Sean M. Burke, +Current maintainer: Adriano R. Ferreira Past contributors are: +Sean M. Burke , Kenneth Albanowski , -Andy Dougherty , +Andy Dougherty , and many others. =cut