From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

MONSIEURP / Pod-Reader-1.020 / bin / podreader 

            

              
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140

              
#!/usr/bin/env perl
use warnings;
use autodie;
use strict;
use 5.10.1;
use Term::ANSIColor qw#colored#;
use Carp qw#croak#;
use Getopt::Long;
use Pod::Usage;
use constant E_ERROR => colored('ERROR', 'red');
if ($ENV{PAGER} =~ m/more/) {
    croak "$0 doesn't work with 'more' set as a PAGER.\n"
    . "Please switch to a different one (less or most for instance).";
}
my $opts = {};
my @args = ('help|h', 'man|m');
GetOptions($opts, @args);
$opts->{help} and pod2usage(-verbose => 1, exitval => -1);
$opts->{man}  and pod2usage(-verbose => 2, exitval => -1);
my @searchdirs = ();
if (scalar @ARGV > 0) {
    for my $dir (@ARGV) {
        if (! -d $dir) {
            pod2usage(
                -msg     => E_ERROR . "! $dir is not a directory!\n",
                -verbose => 1,
                -exitval => -1
            );
        }
    }
    push @searchdirs, grep { -d $_ } @ARGV;
} else {
    local @INC = @INC;
    pop @INC if $INC[-1] eq '.';
    push @searchdirs, grep { -d $_ } @INC;
}
use Pod::Reader;
Pod::Reader->new({
     searchdirs => \@searchdirs
})->run();
__END__
=head1 NAME
podreader - A curses TUI to read Perl POD from.
podreader is a curses TUI that displays a list of Perl modules. When a module is
selected, the perldoc(1) command is called to display its documentation.
=cut
=head1 VERSION
Version 1.020
=cut
=head1 SYNOPSIS
podreader [-hm] [/dir1 /dir2 ...]
  -m|--man          display man page
  -h|--help         display help
  [directory list]  search .pm files in given directories (optional)
  podreader looks for .pm files in @INC by default.
=cut
=head1 KEYSTROKES
Use the following keystrokes to navigate around the UI.
=over 5
=item Up/Down/j/k
Move the cursor up or down.
=item Enter/Space/l
Confirm selection.
=item Ctrl+q
Quit the UI.
=item /
Small search box to look for a module in the list. Type a string and hit enter.
=item n or N
Go to the next/previous result in the list (if any).
=back
=cut
=head1 MOUSE
Mouse support is enabled and should work. Click on a file in the list to
display its documentation (if it exists of course).
=cut
=head1 SEE ALSO
perldoc(1)
=cut
=head1 AUTHOR
Patrice Clement <monsieurp at cpan.org>
=cut
=head1 LICENSE AND COPYRIGHT
This software is copyright (c) 2021 by Patrice Clement.
This is free software, licensed under the (three-clause) BSD License.
See the LICENSE file.
=cut