Linux SoftwareProgrammingLibrariesPod::Man 2.04

Pod::Man 2.04


Pod::Man is a Perl module to convert POD data to formatted *roff input. SYNOPSIS use Pod::Man; my $parser = Pod::Man->
Developer:   Russ Allbery
      more software by author →
Price:  0.00
License:   Perl Artistic License
File size:   74K
Language:   
OS:   
Rating:   0 /5 (0 votes)
Your vote:  
enlarge screenshot


Pod::Man is a Perl module to convert POD data to formatted *roff input.

SYNOPSIS

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

# Read POD from STDIN and write to STDOUT.
$parser->parse_file (*STDIN);

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

Pod::Man is a module to convert documentation in the POD format (the preferred language for documenting Perl) into *roff input using the man macro set. The resulting *roff code is suitable for display on a terminal using nroff(1), normally via man(1), or printing using troff(1). It is conventionally invoked using the driver script pod2man, but it can also be used directly.
As a derived class from Pod::Simple, Pod::Man supports the same methods and interfaces. See Pod::Simple for all the details.

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::Man 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).

Pod::Man assumes that your *roff formatters have a fixed-width font named CW. If yours is called something else (like CR), use the fixed option to specify it. This generally only matters for troff output for printing. Similarly, you can set the fonts used for bold, italic, and bold italic fixed-width output.

Besides the obvious pod conversions, Pod::Man also takes care of formatting func(), func(3), 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++ look right, puts a little space between double underbars, makes ALLCAPS a teeny bit smaller in troff, and escapes stuff that *roff treats as special so that you don't have to.

Requirements:
  • Perl
    tags pod man  set the  the man  pod simple  fixed width  you don  bold italic  using the  file pod  read pod  *roff input  pod from  and write  

    Download Pod::Man 2.04


     http://ftp.casaafacerilor.ro/mirrors/CPAN/authors/id/R/RR/RRA/podlators-2.0.4.tar.gz


    Authors software

    Term::ANSIColor 1.10 (by Russ Allbery)
    Term::ANSIColor is a color screen output using ANSI escape sequences.

    SYNOPSIS

    use Term::ANSIColor;
    print color 'bold

    Pod::Man 2.04 (by Russ Allbery)
    Pod::Man is a Perl module to convert POD data to formatted *roff input.

    SYNOPSIS

    use Pod::Man;
    my $parser = Pod::Man->

    Pod::PlainText 1.34 (by Russ Allbery)
    Pod::PlainText is a Perl module that can convert POD data to formatted ASCII text.

    SYNOPSIS

    use Pod::PlainText;
    my $pa


    Similar software

    Pod::Man 2.04 (by Russ Allbery)
    Pod::Man is a Perl module to convert POD data to formatted *roff input.

    SYNOPSIS

    use Pod::Man;
    my $parser = Pod::Man->

    Pod::Dsr 1.02 (by Peter Prymmer)
    Pod::Dsr is a Perl module Convert POD data to formatted DSR input

    SYNOPSIS

    use Pod::Dsr;
    my $parser = Pod::Dsr->new (r

    Pod::PlainText 1.34 (by Russ Allbery)
    Pod::PlainText is a Perl module that can convert POD data to formatted ASCII text.

    SYNOPSIS

    use Pod::PlainText;
    my $pa

    Heirloom Documentation Tools 061212 (by Gunnar Ritter)
    The Heirloom Documentation Tools package provides troff, nroff, and related utilities to format manual pages and other documents for

    SVG::Parser 1.01 (by Peter Wainwright)
    SVG::Parser is a Perl module with XML Parser for SVG documents.

    SYNOPSIS

    #!/usr/bin/perl -w
    use strict;
    use SVG::Parser;

    d

    Pod::LaTeX 0.58 (by Tim Jenness)
    Pod::LaTeX is a Perl module to convert Pod data to formatted Latex.

    SYNOPSIS

    use Pod::LaTeX;
    my $parser = Pod::LaTeX->new

    Convert::Morse 0.04 (by Convert::Morse Team)
    Convert::Morse is a package to convert between ASCII text and MORSE alphabet.

    SYNOPSIS

    use Convert::Morse qw(as_ascii as_mo

    Pod::XML 0.96 (by Matt Sergeant)
    Pod::XML is a Perl module to convert POD to XML.

    SYNOPSIS

    use Pod::XML;
    my $parser = Pod::XML->new();
    $parser->parse_fr

    Pfm 1.92.2 (by Ren? Uittenbogaard)
    Pfm is a terminal-based file manager written in Perl, based on PFM.COM for MS-DOS.

    Requirements:
    It makes use of the module Term:

    AnnoCPAN::XMLCGI 0.22 (by Ivan Tubert-Brohman)
    AnnoCPAN::XMLCGI is a Perl module to read XML input through a CGI.pm-like interface.

    SYNOPSYS

    use AnnoCPAN::XMLCGI;


    Other software in this category

    zlib 1.2.3 (by Jean-loup Gailly)
    zlib is designed to be a free, general-purpose, legally unencumbered, lossless data-compression library for use on virtually any comp

    libjpeg v6b (by Independent JPEG Group)
    libjpeg is a library for handling the JPEG (JFIF) image format

    OpenSSL 0.9.7c (by The OpenSSL Project Team)
    The OpenSSL Project is a collaborative effort to develop a robust, commercial-grade, full-featured, and Open Source toolkit implement

    libxml2 2.6.27 (by DV)
    Libxml2 is the XML C parser and toolkit developed for the Gnome project (but usable outside of the Gnome platform), libxml2 library i

    GNU C library 2.4 (by Andreas Jaeger)
    GNU C library (glibc) is one of the most important components of GNU Hurd and most modern Linux distributions.

    GNU C library is us

  •     search


    Featured Software

    jEdit 4.3 pre8
    jEdit is an Open Source text editor written in Java

    Opera 9.02
    Surf the Internet in a safer, faster, and easier way with Opera browser

    GNU Aspell 0.60.4
    GNU Aspell is a Free and Open Source spell checker designed to eventually replace Ispell


    Subscribe in Rojo
    Google Reader
    Add to My Yahoo!

    Add to My AOL
    Subscribe with Bloglines
    Subscribe in NewsGator Online
    Add 'nixbit linux software' to Newsburst from CNET News.com
    del.icio.us nixbit linux software


    Top tags