Commit | Line | Data |
---|---|---|
664bb207 GS |
1 | ###### begin =include podselect.PL ##### |
2 | NAME | |
3 | podselect - print selected sections of pod documentation on standard | |
4 | output | |
5 | ||
6 | SYNOPSIS | |
7 | podselect [-help] [-man] [-section *section-spec*] [*file* ...] | |
8 | ||
9 | OPTIONS 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* | |
bf202ccd JH |
15 | Specify a section to include in the output. See "SECTION |
16 | SPECIFICATIONS" in Pod::Parser for the format to use for | |
17 | *section-spec*. This option may be given multiple times on the | |
18 | command line. | |
664bb207 GS |
19 | |
20 | *file* The pathname of a file from which to select sections of pod | |
21 | documentation (defaults to standard input). | |
22 | ||
23 | DESCRIPTION | |
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 | |
bf202ccd | 30 | Please see "podselect()" in Pod::Select for more details. |
664bb207 GS |
31 | |
32 | SEE ALSO | |
bf202ccd | 33 | Pod::Parser and Pod::Select |
664bb207 GS |
34 | |
35 | AUTHOR | |
36 | Brad Appleton <bradapp@enteract.com> | |
37 | ||
38 | Based on code for Pod::Text::pod2text(1) written by Tom Christiansen | |
39 | <tchrist@mox.perl.com> | |
40 | ||
41 | ###### end =include podselect.PL ##### |