File: podtoc

package info (click to toggle)
pmtools 1.10%2Bds1-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze, wheezy
  • size: 188 kB
  • ctags: 14
  • sloc: perl: 505; makefile: 11
file content (82 lines) | stat: -rwxr-xr-x 1,532 bytes parent folder | download
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
#!/usr/bin/env perl
# podtoc -- show outline of pods
# tchrist@perl.com

$/ = '';

$inpod = 0;
while (<>) {
    print "$ARGV\n" if $. == 1;
    if ($inpod && /^=cut/) {
	$inpod = 0;
	next;
    } 

    if (! $inpod && /^=(?!cut)\w+/) {
	$inpod = 1;
    } 

    if ($inpod) {
	next unless /^=(?:head|item)/;
	s/=head(\d)/'    ' x ( $1 - 1 )/e;
	s/=item/     * /;
	s/\n+$/\n/;
	print;
    } 


} continue {

    if (eof) {
	$inpod = 0;
	close ARGV;
    }

} 

__END__

=head1 NAME

podtoc - show outline of pods

=head1 DESCRIPTION

This program shows the structure of one or more pod documents.

=head1 EXAMPLES

    $ podtoc `pmpath CGI`
     NAME
     SYNOPSIS
     ABSTRACT
     DESCRIPTION
	 PROGRAMMING STYLE
	 CALLING CGI.PM ROUTINES
	 *  1. Use another name for the argument, if one is available.  For
	    example, -value is an alias for -values.
	 *  2. Change the capitalization, e.g. -Values
    (etc)

=head1 SEE ALSO

pod2man(1), perlpod(1).

=head1 AUTHORS and COPYRIGHTS

Copyright (C) 1999 Tom Christiansen.

Copyright (C) 2006-2008 Mark Leighton Fisher.

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".