t/pod/podselect.xr

   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*
  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
  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
  30     Please see the podselect() entry in the Pod::Select manpage for more
  31     details.
  32
  33 SEE ALSO
  34     the Pod::Parser manpage and the Pod::Select manpage
  35
  36 AUTHOR
  37     Brad Appleton <bradapp@enteract.com>
  38
  39     Based on code for Pod::Text::pod2text(1) written by Tom Christiansen
  40     <tchrist@mox.perl.com>
  41
  42 ###### end =include podselect.PL #####