Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Wednesday, February 10, 2021
 
 

podselect (1)

Name

podselect - print selected sections of pod documentation on standard output

Synopsis

podselect [-help] [-man] [-section section-spec] [file ...]

Description

Perl Programmers Reference Guide                                  PODSELECT(1)



NAME
       podselect - print selected sections of pod documentation on standard
       output

SYNOPSIS
       podselect [-help] [-man] [-section section-spec] [file ...]

OPTIONS AND ARGUMENTS
       -help   Print a brief help message and exit.

       -man    Print the manual page and exit.

       -section section-spec
               Specify a section to include in the output.  See "SECTION
               SPECIFICATIONS" in Pod::Parser for the format to use for
               section-spec.  This option may be given multiple times on the
               command line.

       file    The pathname of a file from which to select sections of pod
               documentation (defaults to standard input).

DESCRIPTION
       podselect will read the given input files looking for pod documentation
       and will print out (in raw pod format) all sections that match one ore
       more of the given section specifications. If no section specifications
       are given than all pod sections encountered are output.

       podselect invokes the podselect() function exported by Pod::Select
       Please see "podselect()" in Pod::Select for more details.


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


       +---------------+-----------------------+
       |ATTRIBUTE TYPE |   ATTRIBUTE VALUE     |
       +---------------+-----------------------+
       |Availability   | runtime/perl-526      |
       +---------------+-----------------------+
       |Stability      | Pass-through volatile |
       +---------------+-----------------------+
SEE ALSO
       Pod::Parser and Pod::Select

AUTHOR
       Please report bugs using <http://rt.cpan.org>.

       Brad Appleton <bradapp@enteract.com>

       Based on code for Pod::Text::pod2text(1) written by Tom Christiansen
       <tchrist@mox.perl.com>



NOTES
       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.26.2.tar.bz2

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



perl v5.26.2                      2018-08-10                      PODSELECT(1)