=encoding utf8 =head1 NAME =begin original Module::Install::ReadmeFromPod - A Module::Install extension to automatically convert POD to a README =end original Module::Install::ReadmeFromPod - PODから READMEの自動変換を行うための Module::Install拡張 =head1 SYNOPSIS =begin original # In Makefile.PL use inc::Module::Install; author 'Vestan Pants'; license 'perl'; readme_from 'lib/Some/Module.pm'; A C file will be generated from the POD of the indicated module file. Note that the author will need to make sure C is installed before running the C. (The extension will be bundled into the user-side distribution). =end original # In Makefile.PL use inc::Module::Install; author 'Vestan Pants'; license 'perl'; readme_from 'lib/Some/Module.pm'; 指定したモジュールファイルの PODから Cが生成されます. 注記 モジュール作者は Makefile.PLを実行する前に Cを インストールしておく必要があります(ユーザ側では拡張モジュールは同梱された ものを利用します). =head1 DESCRIPTION =begin original Module::Install::ReadmeFromPod is a L extension that generates a C file automatically from an indicated file containing POD, whenever the author runs C. =end original Module::Install::ReadmeFromPodは Lの拡張です. モジュール作者が Cを実行したときに指定したファイルに含まれる PODから Cを自動的に生成します. =head1 COMMANDS =begin original This plugin adds the following Module::Install command: =over =item C Does nothing on the user-side. On the author-side it will generate a C file using L from the POD in the file passed as a parameter. readme_from 'lib/Some/Module.pm'; If a second parameter is set to a true value then the C will be removed at C. readme_from 'lib/Some/Module.pm' => 'clean'; If you use the C command, C 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' =back =end original このプラグインは Module::Installに以下に示すコマンドを追加します. =over =item C ユーザ側では何もしません. モジュール作者側では, Lを使って引数として渡されたファイルの POD から Cを生成します. readme_from 'lib/Some/Module.pm'; 第二引数に真となる値が設定された場合は, Cを行った際に Cを削除します. readme_from 'lib/Some/Module.pm' => 'clean'; Cコマンドを使うのであれば, Cは all_fromに指定された値をデフォルトの値とします. all_from 'lib/Some/Module.pm'; readme_from; # lib/Some/Module.pmから READMEを生成します. readme_from '','clean'; # 'clean'の前には空文字列を設定してください. =back =head1 AUTHOR Chris C Williams =head1 LICENSE Copyright E 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. =head1 SEE ALSO L L =cut