Questions tagged [perl-pod]

Plain Old Documentation format. Pod is a simple-to-use markup language used for writing documentation for Perl, Perl programs, and Perl modules.

perlpod

63 questions
3
votes
1 answer

Pod not visible to search.cpan or metacpan, why?

I noticed that my pod links in my WITH section do not work. I looked to see the link was just typoed but clicking the source show's it's not, and that the Pod is there. Why does my pod not work on metacpan.org or search.cpan.org (it appears to with…
xenoterracide
  • 16,274
  • 24
  • 118
  • 243
2
votes
1 answer

How to convert AsciiDoc to Perl POD?

How to convert manpage written in AsciiDoc lightweight markup language automatically into Perl's POD (Plain Old Documentation)? Perhaps something that converts from DocBook to POD (the conversion from AsciiDoc sources to manpage format i.e. troff…
Jakub Narębski
  • 309,089
  • 65
  • 217
  • 230
2
votes
2 answers

perldoc does not display text between section

I have this POD file: =head1 Create professional slideshows with Mojolicious::Plugin::RevealJS =head2 Install and run a Mojolicious server Santa's elf had a problem. He had to write very fast a presentation and show it to a bunch of new…
Dragos Trif
  • 276
  • 1
  • 12
2
votes
2 answers

How can I print only a specific format name in a Perl POD?

I'm trying to extract a portion of a Perl POD and nothing else. If I run the following: use strict; use warnings; use Pod::Simple; use Pod::Text; =head1 podTest normal pod =cut print "normalPod:\n"; my $writeNormalPod =…
Teepeemm
  • 4,331
  • 5
  • 35
  • 58
2
votes
1 answer

How to setting a favicon in pod2html

I documented some perl files with POD and made a webpage with pod2html. Is it possible to set a favicon to that? =pod =encoding UTF-8 =begin pod2html =end pod2html =cut But there is nothing in my html…
Andy A.
  • 1,392
  • 5
  • 15
  • 28
2
votes
1 answer

How can I pass an array from weaver.ini to a Pod::Weaver plugin

So it appears that in order to pass something in weaver.ini the plugin itself requires a Moose attribute. So if I have something like this in weaver.ini [Acknowledgements] contributors = 'test foo' 'foo bar' I need a corresponding attribute in my…
xenoterracide
  • 16,274
  • 24
  • 118
  • 243
2
votes
1 answer

How can I get rid of empty lines Perl's Pod so they don't show up with Pod::Usage?

I have following pod which I used with getopt::long: =head1 SYNOPSIS foo [OPTION]... [URL]... =head1 OPTIONS =over 20 =item B<-h, --help> Print a brief help message and exits. =item B<-i, --input=FILE> Reads from FILE =back =cut and when…
jesper
  • 879
  • 8
  • 21
2
votes
1 answer

pod2man fails with 'No name given for document'

I have a pod2man task which has started failing with a recent update ( now running perl 5.24.0 ). The error output is [ 8s] pod2man < gits-checkup > gits-checkup.1 [ 9s] IO::File=IO(0x1365550) around line 1: No name given for document [ 9s]…
Robert Munteanu
  • 67,031
  • 36
  • 206
  • 278
2
votes
0 answers

Perldoc using wrong encoding for copyright symbol

I've noticed that Pod::Usage pod2man, and even pod2markdown are doing the wrong encoding in their output for certain characters. These programs are encoding the copyright symbol as a single byte 0xA9 which is its Unicode Code Point as well as its…
David W.
  • 105,218
  • 39
  • 216
  • 337
2
votes
2 answers

How can I produce an HTML summary of Perl modules or scripts in a directory?

Is there a tool available that can produce an HTML summary list of perl modules or scripts in a directory tree? Given =head1 NAME wibble.pl - does wibble actions I would like to see something like wibble.pl - does…
justintime
  • 3,601
  • 4
  • 22
  • 37
2
votes
1 answer

No output from Pod::Simple

I'm trying to use Pod::Simple in perl, but I'm not getting any output. I can get output with Pod::Simple::Text. Here is a short test program: use English; use strict; use Pod::Simple; use Pod::Simple::Text; my $pod_document =…
David Levner
  • 341
  • 1
  • 8
2
votes
1 answer

Perl programmatically modify POD at runtime

I've written a convenience library for some scripts I'm working on. It wraps Getopt::Long into something a little simpler, in addition to providing mandatory arguments. As such, the library adds a number of arguments to the script's list of…
EricR
  • 1,487
  • 2
  • 21
  • 42
2
votes
3 answers

How do I get Perl POD in string and print it in page?

I have a POD document. Now, I want to convert that POD to a parsed section like usage/description and get it in a string. Why not pod2usage? This doesn't help me to get the output in string but in STDOUT/file. I am stressing on the point "getting…
Anandan
  • 983
  • 3
  • 13
  • 28
2
votes
1 answer

Why does Test::Spelling mark function/method names as having typos?

Let's say I have this dummy Perl package in test.pm: package test; use strict; use warnings; =head1 DESCRIPTION =head2 env Return the environment name. =cut sub env { return "environment name"; } =head2 hst Return the history file…
battery
  • 511
  • 2
  • 8
1
vote
2 answers

How do I stop pod2html from treating "=head2 open() foo" as a function definition?

I have some POD that looks like =head2 C =over =item C =back The pod2html command turns it into

Chas. Owens
  • 64,182
  • 22
  • 135
  • 226