README.vms and related updates (from Peter Prymmer <pvhp@best.com>)
[p5sagit/p5-mst-13.2.git] / pod / podselect.PL
CommitLineData
360aca43 1#!/usr/local/bin/perl
2
3use Config;
4use File::Basename qw(&basename &dirname);
933fea7f 5use Cwd;
360aca43 6
7# List explicitly here the variables you want Configure to
8# generate. Metaconfig only looks for shell variables, so you
9# have to mention them as if they were shell variables, not
10# %Config entries. Thus you write
11# $startperl
12# to ensure Configure will look for $Config{startperl}.
13
3b5ca523 14# This forces PL files to create target in same directory as PL file.
15# This is so that make depend always knows where to find PL derivatives.
933fea7f 16$origdir = cwd;
3b5ca523 17chdir(dirname($0));
18($file = basename($0)) =~ s/\.PL$//;
19$file =~ s/\.pl$//
933fea7f 20 if ($^O eq 'VMS' or $^O eq 'os2' or $^O eq 'dos'); # "case-forgiving"
360aca43 21
22open OUT,">$file" or die "Can't create $file: $!";
23
24print "Extracting $file (with variable substitutions)\n";
25
26# In this section, perl variables will be expanded during extraction.
27# You can use $Config{...} to use Configure variables.
28
29print OUT <<"!GROK!THIS!";
30$Config{'startperl'}
31 eval 'exec perl -S \$0 "\$@"'
32 if 0;
33!GROK!THIS!
34
35# In the following, perl variables are not expanded during extraction.
36
37print OUT <<'!NO!SUBS!';
38
39#############################################################################
40# podselect -- command to invoke the podselect function in Pod::Select
41#
27f805f4 42# Copyright (c) 1996-1999 by Bradford Appleton. All rights reserved.
360aca43 43# This file is part of "PodParser". PodParser is free software;
44# you can redistribute it and/or modify it under the same terms
45# as Perl itself.
46#############################################################################
47
48use strict;
49use diagnostics;
50
51=head1 NAME
52
53podselect - print selected sections of pod documentation on standard output
54
55=head1 SYNOPSIS
56
57B<podselect> [B<-help>] [B<-man>] [B<-section>S< >I<section-spec>]
58[I<file>S< >...]
59
60=head1 OPTIONS AND ARGUMENTS
61
62=over 8
63
64=item B<-help>
65
66Print a brief help message and exit.
67
68=item B<-man>
69
70Print the manual page and exit.
71
72=item B<-section>S< >I<section-spec>
73
74Specify a section to include in the output.
75See L<Pod::Parser/"SECTION SPECIFICATIONS">
76for the format to use for I<section-spec>.
77This option may be given multiple times on the command line.
78
79=item I<file>
80
81The pathname of a file from which to select sections of pod
82documentation (defaults to standard input).
83
84=back
85
86=head1 DESCRIPTION
87
88B<podselect> will read the given input files looking for pod
89documentation and will print out (in raw pod format) all sections that
90match one ore more of the given section specifications. If no section
91specifications are given than all pod sections encountered are output.
92
93B<podselect> invokes the B<podselect()> function exported by B<Pod::Select>
94Please see L<Pod::Select/podselect()> for more details.
95
96=head1 SEE ALSO
97
98L<Pod::Parser> and L<Pod::Select>
99
100=head1 AUTHOR
101
102Brad Appleton E<lt>bradapp@enteract.comE<gt>
103
104Based on code for B<Pod::Text::pod2text(1)> written by
105Tom Christiansen E<lt>tchrist@mox.perl.comE<gt>
106
107=cut
108
109use Pod::Select;
110use Pod::Usage;
111use Getopt::Long;
112
113## Define options
114my %options = (
115 "help" => 0,
116 "man" => 0,
117 "sections" => [],
118);
119
120## Parse options
121GetOptions(\%options, "help", "man", "sections|select=s@") || pod2usage(2);
122pod2usage(1) if ($options{help});
123pod2usage(-verbose => 2) if ($options{man});
124
125## Dont default to STDIN if connected to a terminal
126pod2usage(2) if ((@ARGV == 0) && (-t STDIN));
127
128## Invoke podselect().
129if (@{ $options{"sections"} } > 0) {
130 podselect({ -sections => $options{"sections"} }, @ARGV);
131}
132else {
133 podselect(@ARGV);
134}
135
136
137!NO!SUBS!
138
139close OUT or die "Can't close $file: $!";
140chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
141exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';
933fea7f 142chdir $origdir;