Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

Pod::Perldoc::BaseTo (3)

Name

Pod::Perldoc::BaseTo - Base for Pod::Perldoc formatters

Synopsis

package Pod::Perldoc::ToMyFormat;

use parent qw( Pod::Perldoc::BaseTo );
...

Description

Perl Programmers Reference Guide                       Pod::Perldoc::BaseTo(3)



NAME
       Pod::Perldoc::BaseTo - Base for Pod::Perldoc formatters

SYNOPSIS
           package Pod::Perldoc::ToMyFormat;

           use parent qw( Pod::Perldoc::BaseTo );
           ...

DESCRIPTION
       This package is meant as a base of Pod::Perldoc formatters, like
       Pod::Perldoc::ToText, Pod::Perldoc::ToMan, etc.

       It provides default implementations for the methods

           is_pageable
           write_with_binmode
           output_extension
           _perldoc_elem

       The concrete formatter must implement

           new
           parse_from_file


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+-----------------------+
       |ATTRIBUTE TYPE |   ATTRIBUTE VALUE     |
       +---------------+-----------------------+
       |Availability   | runtime/perl-532      |
       +---------------+-----------------------+
       |Stability      | Pass-through volatile |
       +---------------+-----------------------+

SEE ALSO
       perldoc

COPYRIGHT AND DISCLAIMERS
       Copyright (c) 2002-2007 Sean M. Burke.

       This library is free software; you can redistribute it and/or modify it
       under the same terms as Perl itself.

       This program is distributed in the hope that it will be useful, but
       without any warranty; without even the implied warranty of
       merchantability or fitness for a particular purpose.

AUTHOR
       Current maintainer: Mark Allen "<mallen@cpan.org>"

       Past contributions from: brian d foy "<bdfoy@cpan.org>" Adriano R.
       Ferreira "<ferreira@cpan.org>", Sean M. Burke "<sburke@cpan.org>"



NOTES
       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       http://www.cpan.org/src/5.0/perl-5.32.0.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.perl.org/.



perl v5.32.0                      2020-06-14           Pod::Perldoc::BaseTo(3)