Pod::Dsr 1.02 review

by rbytes.net on

Pod::Dsr is a Perl module Convert POD data to formatted DSR input SYNOPSIS use Pod::Dsr; my $parser = Pod::Dsr->new (r

License: Perl Artistic License
File size: 99K
Developer: Peter Prymmer
0 stars award from rbytes.net

Pod::Dsr is a Perl module Convert POD data to formatted DSR input


use Pod::Dsr;
my $parser = Pod::Dsr->new (release => $VERSION, section => 8);

# Read POD from STDIN and write to STDOUT.

# Read POD from file.pod and write to file.1.
$parser->parse_from_file ('file.pod', 'file.1');

Pod::Dsr is a module to convert documentation in the POD format (the preferred language for documenting Perl) into Digital Standard Runoff (DSR) input. The resulting DSR code is suitable for display on a terminal using RUNOFF(1) and TYPE(1), or printing using RUNOFF(1) and PRINT(1). It is conventionally invoked using the driver script pod2rno, but it can also be used directly.

As a derived class from Pod::Parser, Pod::Dsr supports the same methods and interfaces. See Pod::Parser for all the details; briefly, one creates a new parser with Pod::Dsr->new() and then calls either parse_from_filehandle() or parse_from_file().

new() can take options, in the form of key/value pairs that control the behavior of the parser. See below for details.

If no options are given, Pod::Dsr uses the name of the input file with any trailing .pod, .pm, or .pl stripped as the man page title, to section 1 unless the file ended in .pm in which case it defaults to section 3, to a centered title of "User Contributed Perl Documentation", to a centered footer of the Perl version it is run with, and to a left-hand footer of the modification date of its input (or the current date if given STDIN for input).

Besides the obvious pod conversions, Pod::Dsr also takes care of formatting func(), func(n), and simple variable references like $foo or @bar so you don't have to use code escapes for them; complex expressions like $fred{'stuff'} will still need to be escaped, though. It also translates dashes that aren't used as hyphens into en dashes, makes long dashes--like this--into proper em dashes, fixes "paired quotes," makes C++ and PI look right, puts a little space between double underbars, and escapes stuff that runoff treats as special so that you don't have to.


Pod::Dsr 1.02 search tags