xref: /onnv-gate/usr/src/cmd/perl/5.8.4/distrib/t/pod/podselect.xr (revision 0:68f95e015346)
1###### begin =include podselect.PL #####
2NAME
3    podselect - print selected sections of pod documentation on standard
4    output
5
6SYNOPSIS
7    podselect [-help] [-man] [-section *section-spec*] [*file* ...]
8
9OPTIONS AND ARGUMENTS
10    -help   Print a brief help message and exit.
11
12    -man    Print the manual page and exit.
13
14    -section *section-spec*
15            Specify a section to include in the output. See the section on
16            "SECTION SPECIFICATIONS" in the Pod::Parser manpage for the
17            format to use for *section-spec*. This option may be given
18            multiple times on the command line.
19
20    *file*  The pathname of a file from which to select sections of pod
21            documentation (defaults to standard input).
22
23DESCRIPTION
24    podselect will read the given input files looking for pod documentation
25    and will print out (in raw pod format) all sections that match one ore
26    more of the given section specifications. If no section specifications
27    are given than all pod sections encountered are output.
28
29    podselect invokes the podselect() function exported by Pod::Select
30    Please see the podselect() entry in the Pod::Select manpage for more
31    details.
32
33SEE ALSO
34    the Pod::Parser manpage and the Pod::Select manpage
35
36AUTHOR
37    Please report bugs using http://rt.cpan.org.
38
39    Brad Appleton <bradapp@enteract.com>
40
41    Based on code for Pod::Text::pod2text(1) written by Tom Christiansen
42    <tchrist@mox.perl.com>
43
44###### end =include podselect.PL #####
45