The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Meta-0.08
River stage zero No dependents
++
/ perl_pod_fix.pl

NAME

perl_pod_fix.pl - fix pods in perl files.

COPYRIGHT

Copyright (C) 2001, 2002 Mark Veltzer; All rights reserved.

LICENSE

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.

DETAILS

        MANIFEST: perl_pod_fix.pl
        PROJECT: meta
        VERSION: 0.04

SYNOPSIS

        perl_pod_fix.pl [options]

DESCRIPTION

This program will fix POD documentation in perl modules or scripts. You need to tell it what type of fix do you want applied.

Some of the fixes are only relevant to modules, some are only relevant to scripts and some for both.

The types of fixes currenly supported:

1. copyright: fix the COPYRIGHT pod. 2. license: fix the LICENSE pod. 3. details: fix the DETAILS pod. 4. author: fix the AUTHOR pod. 5. history: fix the HISTORY pod. 6. see: fix the SEE ALSO pod. 7. options: fix the OPTIONS pod (scripts only). 8. version: fix the VERSION pod (modules only). 9. super: fix the SUPER CLASSES pod (modules only).

You can either fix all files in the change or a single file.

OPTIONS

help (type: bool, default: 0)

display help message

pod (type: bool, default: 0)

display pod options snipplet

man (type: bool, default: 0)

display manual page

quit (type: bool, default: 0)

quit without doing anything

gtk (type: bool, default: 0)

run a gtk ui to get the parameters

license (type: bool, default: 0)

show license and exit

show copyright and exit

description (type: bool, default: 0)

show description and exit

history (type: bool, default: 0)

show history and exit

verbose (type: bool, default: 1)

noisy or quiet ?

all (type: bool, default: 0)

do it for all files in the change ?

fix (type: setx, default: options)

what fix to apply ?

options: copyright - fix the COPYRIGHT tag license - fix the LICENSE tag details - fix the DETAILS tag author - fix the AUTHOR tag history - fix the HISTORY tag see - fix the SEE ALSO tag options - fix the OPTIONS tag version - fix the VERSION tag super - fix the SUPER CLASSES tag

file (type: devf, default: )

what file to fix ?

no free arguments are allowed

BUGS

None.

AUTHOR

        Name: Mark Veltzer
        Email: mailto:veltzer@cpan.org
        WWW: http://www.veltzer.org
        CPAN id: VELTZER

HISTORY

        0.00 MV put all tests in modules
        0.01 MV move tests to modules
        0.02 MV download scripts
        0.03 MV finish papers
        0.04 MV md5 issues

SEE ALSO

Meta::Baseline::Aegis(3), Meta::Baseline::Lang::Perl(3), Meta::Ds::Noset(3), Meta::Info::Enum(3), Meta::Lang::Perl::Perl(3), Meta::Utils::Opts::Opts(3), Meta::Utils::Output(3), Meta::Utils::System(3), strict(3)

TODO

-have this script do checkouts too like documented.

-add options to checkout files if need be.

-add options to just show which changes are going to be made.

-add option to supply a list of files to be fixed.

-add the ability to make several changes simulteneously (using the set type for opts).