File: faqpods

package info (click to toggle)
pmtools 2.2.0-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 388 kB
  • sloc: perl: 803; makefile: 10
file content (79 lines) | stat: -rwxr-xr-x 1,891 bytes parent folder | download | duplicates (3)
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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
#!/usr/bin/env perl
# faqpods - print out the paths to the faqs
# 
# this is a perl program not a shell script
# so that we can use the correct perl 

# ------ pragmas
use strict;
use warnings;

use Config;

our $VERSION = '2.2.0';

my $foundcore = 0;
open(PROG, "$^X -S basepods |") || die "can't fork: $!";
while (<PROG>) {
    if (/perlfaq/) {
        print $_;
        $foundcore = 1;
    }
}

unless ($foundcore) {
    my $lib = $Config{'vendorlib'};
    opendir(LIB, $lib) || die "$0: can't opendir $lib: $!\n";
    while ($_ = readdir(LIB)) {
        print "$lib/$_\n" if /perlfaq.*\.pod$/;
    }
} 

__END__

=head1 NAME

faqpods - print out pod paths for the standard perl faqs

=head1 DESCRIPTION

This program uses your configuration's C<installprivlib> directory
to look up the full paths to those pod pages.  Any files in that
directory whose names start in C<perlfaq> will be printed to the standard
output, one per line.  This is normally used in backticks to produce
a list of filenames for other commands.

=head1 EXAMPLES

    $ podgrep typeglob `faqpods`
    ....

You can also run this using alternate perl binaries, like so:

    $ podgrep -i thread `filsperl faqpods`
    ....

=head1 SEE ALSO

basepods(1), modpods(1), pods(1), sitepod(1), podpath(1), and stdpod(1).

=head1 AUTHORS and COPYRIGHTS

Copyright (C) 1999 Tom Christiansen.

Copyright (C) 2006-2014, 2018 Mark Leighton Fisher.

=head1 LICENSE

This is free software; you can redistribute it and/or modify it
under the terms of either:
(a) the GNU General Public License as published by the Free
Software Foundation; either version 1, or (at your option) any
later version, or
(b) the Perl "Artistic License".
(This is the Perl 5 licensing scheme.)

Please note this is a change from the
original pmtools-1.00 (still available on CPAN),
as pmtools-1.00 were licensed only under the
Perl "Artistic License".