summaryrefslogtreecommitdiff
path: root/t/pod/podselect.xr
blob: c288e91280c8c0c5033587b7cedc674d4d125e9c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
###### begin =include podselect.PL #####
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 the section on
            "SECTION SPECIFICATIONS" in the Pod::Parser manpage 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 the podselect() entry in the Pod::Select manpage for more
    details.

SEE ALSO
    the Pod::Parser manpage and the Pod::Select manpage

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>

###### end =include podselect.PL #####