Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

module::install::readmefrompod(3pm) [debian man page]

Module::Install::ReadmeFromPod(3pm)			User Contributed Perl Documentation		       Module::Install::ReadmeFromPod(3pm)

NAME

       Module::Install::ReadmeFromPod - A Module::Install extension to automatically convert POD to a README

SYNOPSIS

	 # In Makefile.PL

	 use inc::Module::Install;
	 author 'Vestan Pants';
	 license 'perl';
	 readme_from 'lib/Some/Module.pm';
	 readme_from 'lib/Some/Module.pm', { clean => 1, format => 'htm', output_file => 'SomeModule.html' };

       A "README" file will be generated from the POD of the indicated module file.

       Note that the author will need to make sure "Module::Install::ReadmeFromPod" is installed before running the "Makefile.PL".  (The extension
       will be bundled into the user-side distribution).

DESCRIPTION

       Module::Install::ReadmeFromPod is a Module::Install extension that generates a "README" file automatically from an indicated file
       containing POD, whenever the author runs "Makefile.PL". Several output formats are supported: plain-text, HTML, PDF or manpage.

COMMANDS

       This plugin adds the following Module::Install command:

       "readme_from"
	   Does nothing on the user-side. On the author-side it will generate a "README" file.

	     readme_from 'lib/Some/Module.pm';

	   If a second parameter is set to a true value then the "README" will be removed at "make distclean".

	     readme_from 'lib/Some/Module.pm', 1;

	   A third parameter can be used to determine the format of the "README" file.

	     readme_from 'lib/Some/Module.pm', 1, 'htm';

	   Valid formats for this third parameter are:

	   txt, text
	       Produce a plain-text "README" file using Pod::Text. The 'txt' format is the default.

	   htm, html
	       Produce an HTML "README.htm" file using Pod::Html.

	   man Produce a "README.1" manpage using Pod::Man.

	   pdf Produce a PDF "README.pdf" file with App::pod2pdf if this module is installed.

	   A fourth parameter can be used to supply an output filename.

	     readme_from 'lib/Some/Module.pm', 0, 'pdf', 'SomeModule.pdf';

	   Finally, you can pass additional arguments to the POD formatter that handles the requested format.

	     my @options = ( 'release' => 1.03, 'section' => 8 ); # options for Pod::Man
	     readme_from 'lib/Some/Module.pm', 1, 'man', undef, @options;

	   But instead of passing this long list of optional arguments to readme_from, you should probably pass these arguments as a named hashref
	   for clarity.

	     my @options = ( 'release' => 1.03, 'section' => 8 );
	     readme_from 'lib/Some/Module.pm', {clean => 1, format => 'man', output_file => undef, options => @options};

	   If you use the "all_from" command, "readme_from" will default to that value.

	     all_from 'lib/Some/Module.pm';
	     readme_from;	       # Create README from lib/Some/Module.pm
	     readme_from '','clean';   # Put a empty string before 'clean'

AUTHOR

       Chris "BinGOs" Williams

LICENSE

       Copyright X Chris Williams

       This module may be used, modified, and distributed under the same terms as Perl itself. Please see the license that came with your Perl
       distribution for details.

SEE ALSO

       Module::Install

       Pod::Text

       Pod::Html

       Pod::Man

       App::pod2pdf

perl v5.14.2							    2012-02-25				       Module::Install::ReadmeFromPod(3pm)

Check Out this Related Man Page

Module::Install::Admin(3)				User Contributed Perl Documentation				 Module::Install::Admin(3)

NAME

       Module::Install::Admin - Author-side manager for Module::Install

SYNOPSIS

       In a Module::Install extension module:

	   sub extension_method {
	       my $self = shift;
	       $self->admin->some_method(@args);
	   }

       As an one-liner:

	   % perl "-MModule::Install::Admin" -e'&some_method(@args);'

       The two snippets above are really shorthands for

	   $some_obj->some_method(@args)

       where $some_obj is the singleton object of a class under the "Module::Install::Admin::*" namespace that provides the method "some_method".
       See "METHODS" for a list of built-in methods.

DESCRIPTION

       This module implements the internal mechanism for initializing, including and managing extensions, and should only be of interest to
       extension developers; it is never included under a distribution's inc/ directory, nor are any of the Module::Install::Admin::* extensions.

       For normal usage of Module::Install, please see Module::Install and "COOKBOOK / EXAMPLES" in Module::Install instead.

   Bootstrapping
       When someone runs a Makefile.PL that has "use inc::Module::Install", and there is no inc/ in the current directory, Module::Install will
       load this module bootstrap itself, through the steps below:

       o   First, Module/Install.pm is POD-stripped and copied from @INC to inc/.  This should only happen on the author's side, never on the end-
	   user side.

       o   Reload inc/Module/Install.pm if the current file is somewhere else.	This ensures that the included version of inc/Module/Install.pm is
	   always preferred over the installed version.

       o   Look at inc/Module/Install/*.pm and load all of them.

       o   Set up a "main::AUTOLOAD" function to delegate missing function calls to "Module::Install::Admin::load" -- again, this should only
	   happen at the author's side.

       o   Provide a "Module::Install::purge_self" function for removing included files under inc/.

METHODS

SEE ALSO

       Module::Install

AUTHORS

       Audrey Tang <autrijus@autrijus.org>

COPYRIGHT

       Copyright 2003, 2004 by Audrey Tang <autrijus@autrijus.org>.

       This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

       See <http://www.perl.com/perl/misc/Artistic.html>

perl v5.16.3							    2012-03-01						 Module::Install::Admin(3)
Man Page