Stack Overflow
Stack Overflow

Questions tagged [perldoc]

perldoc is part of the perl distribution and allow you look up Perl documentation in POD format.

perldoc

39 questions
24
votes
3 answers

How do I use Unicode characters in Pod and perldoc?

I need to use utf-8 characters in my perl-documentation. If I use: perldoc MyMod.pm I see strange characters. If I use: pod2text MyMod.pm everything is fine. I use Ubuntu/Debian. $…
maletin
  • 585
  • 4
  • 14
13
votes
6 answers

Is there really no better way to document perl code than POD?

I'm a Perl programmer for a long time, but I always have problems with documentation in POD. When I use POD comments in the code, the code is difficult to read. When I use POD comments at the end of file, there is the danger that the documentation…
ulli82
  • 155
  • 4
12
votes
1 answer

Why does perldoc evaluate 'Münster' as 'Muenster'

I have a simple POD text file: $ cat test.pod =encoding UTF-8 Münster It is encoded in UTF-8, as per this literal hex dump of the file: 00000000 3d 65 6e 63 6f 64 69 6e 67 20 55 54 46 2d 38 0a |=encoding UTF-8.| 00000010 0a 4d c3 bc 6e 73 74…
Kaoru
  • 1,540
  • 11
  • 14
7
votes
2 answers

How can I concisely document methods in Perl code?

I favor a kind-of literal programming style with POD comments next to the code they document. Unfortunately this bloats the code, which is not very Perlish ;-) The best way I could find by now is to use Dist::Zilla with Pod::Weaver like…
Jakob
  • 3,570
  • 3
  • 36
  • 49
6
votes
1 answer

perl's pod2usage(-verbose => 2) shows the source code instead of the formatted documentation

According to the documentation of Pod::Usage, with pod2usage(-verbose => 2) "the entire manpage is printed". However, in some cases, the perl source code for the script is displayed instead of the properly formatted manpage. Here's an example: use…
Matthieu Moy
  • 15,151
  • 5
  • 38
  • 65
6
votes
1 answer

Why is perldoc failing here?

Downloaded ActiveState Perl V5.22.3 (tried V5.24, same result) and I can't get perldoc to run! perldoc responds with 'Invalid parameter - -R'. Here's my command window: I'm not having issues running scripts - just perldoc. Thanks in advance for any…
Lou
  • 161
  • 2
  • 2
  • 9
5
votes
2 answers

Where in the documentation does it say that while tests readdir for definedness?

See also: How is "0" result from readdir not false in a while condition?. (Not a duplicate; just closely related.) Where in the documentation does it say that while tests readdir for definedness? For instance, this code #!/usr/bin/perl use…
Chas. Owens
  • 64,182
  • 22
  • 135
  • 226
5
votes
2 answers

How to document parameters in Perl POD

I have this POD: =head1 My code =head2 check Checks something. Parameters: =over 8 =item what to check. =back =cut podchecker doesn't complain. perldoc shows this: My code check Checks something. Parameters: what to…
Robert
  • 7,394
  • 40
  • 45
  • 64
5
votes
1 answer

Vim JSDoc, PHPDoc, JavaDoc, RDoc info

Here is the deal, If you've used Aptana, Eclipse or even Microsoft Expression Web editor, then you've seen that they feature a Balloon Text or Intellisense popup showing hints/info of built-in and custom objects, methods, etc. They get the info…
Jose Elera
  • 938
  • 9
  • 16
5
votes
3 answers

Making apostrophes render correctly in perldoc

I can't figure out how to get apostrophes displaying correctly in my Perl documentation. For example, the text 'test' displays as âtestâ. E<39> also renders as â also I<'> also S<'> also E C<'> renders as "'" (so apparently the terminal…
Brad Mace
  • 27,194
  • 17
  • 102
  • 148
4
votes
7 answers

How can I use perldoc to lookup the %ENV variable?

I find from reading perldoc perlvar, about a thousand lines in is help for %ENV. Is there a way to find that from the command line directly? On my Windows machine, I've tried the following perldoc ENV perldoc %ENV perldoc %%ENV perldoc -r ENV…
piCookie
  • 9,640
  • 2
  • 19
  • 19
4
votes
5 answers

What are the perldoc perlxxx options?

It appears that using perldoc perl gives the list of, e.g. perlre, perlvar, etc. Is this the best place to find the list of what's available as an overview or tutorial or reference manual section? Is there another, better list?
piCookie
  • 9,640
  • 2
  • 19
  • 19
4
votes
3 answers

Should I copy perldoc for inherited methods to the subclass's documentation?

I've written a class foo.pm that collects some data from a web service. Inside foo.pm I have added perldoc to describe the functionality as well as a short guide on the usage. There's a reference for all its methods. I've also written a subclass…
simbabque
  • 53,749
  • 8
  • 73
  • 136
3
votes
1 answer

perldoc not showing documentation for installed perl modules

Installing Perl modules from the Linux command line using the cpan command works fine, such as: $ cpan [Module] and after finishing I can see the module’s documentation via: $ perldoc [Module] But doing this via cfengine, which would just automate…
David Ramirez
  • 216
  • 2
  • 8
3
votes
1 answer

reset default perldoc viewer

I am learning perl now and I find perldoc a very handy tool. Originally perldoc use 'less' as default page viewer. That's fine. But recently perldoc use 'more' as default page viewer. the phenomena: 1. man still use 'less'. 2. env | grep -Ei…
comicosmos
  • 101
  • 1
  • 1
  • 6
1
2 3