/usr/local/share/man/man3
NameSizeModeActions
App::Prove.3pm105080444editdlrm
App::Prove::State.3pm60050444editdlrm
App::Prove::State::Result.3pm56190444editdlrm
App::Prove::State::Result::Test.3pm50510444editdlrm
AppConfig.3pm352890444editdlrm
AppConfig::Args.3pm79920444editdlrm
AppConfig::CGI.3pm66090444editdlrm
AppConfig::File.3pm126140444editdlrm
AppConfig::Getopt.3pm74440444editdlrm
AppConfig::State.3pm249720444editdlrm
AppConfig::Sys.3pm66950444editdlrm
Archive::Tar.3pm440610444editdlrm
Archive::Tar::File.3pm110830444editdlrm
Archive::Zip.3pm699850444editdlrm
Archive::Zip::FAQ.3pm184370444editdlrm
Archive::Zip::MemberRead.3pm67340444editdlrm
Archive::Zip::Tree.3pm28750444editdlrm
B::COW.3pm51630444editdlrm
Canary::Stability.3pm37270444editdlrm
CDB_File.3pm143180444editdlrm
common::sense.3pm00444editdlrm
Compress::Raw::Bzip2.3pm134630444editdlrm
Compress::Raw::Zlib.3pm420820444editdlrm
Compress::Zlib.3pm387190444editdlrm
CPAN::Meta.3pm159230444editdlrm
CPAN::Meta::Converter.3pm65940444editdlrm
CPAN::Meta::Feature.3pm43220444editdlrm
CPAN::Meta::History.3pm78550444editdlrm
CPAN::Meta::History::Meta_1_0.3pm99730444editdlrm
CPAN::Meta::History::Meta_1_1.3pm124100444editdlrm
CPAN::Meta::History::Meta_1_2.3pm222240444editdlrm
CPAN::Meta::History::Meta_1_3.3pm239740444editdlrm
CPAN::Meta::History::Meta_1_4.3pm245650444editdlrm
CPAN::Meta::Merge.3pm52850444editdlrm
CPAN::Meta::Prereqs.3pm73800444editdlrm
CPAN::Meta::Requirements.3pm123080444editdlrm
CPAN::Meta::Spec.3pm455920444editdlrm
CPAN::Meta::Validator.3pm42150444editdlrm
CPAN::Meta::YAML.3pm42300444editdlrm
Crypt::OpenSSL::Random.3pm56340444editdlrm
Curses.3pm375800444editdlrm
Curses::UI.3pm156190444editdlrm
Curses::UI::Buttonbox.3pm89080444editdlrm
Curses::UI::Calendar.3pm82030444editdlrm
Curses::UI::Checkbox.3pm65090444editdlrm
Curses::UI::Color.3pm59030444editdlrm
Curses::UI::Common.3pm64980444editdlrm
Curses::UI::Container.3pm90410444editdlrm
Curses::UI::Dialog::Basic.3pm52130444editdlrm
Curses::UI::Dialog::Calendar.3pm47610444editdlrm
Curses::UI::Dialog::Dirbrowser.3pm53690444editdlrm
Curses::UI::Dialog::Error.3pm43070444editdlrm
Curses::UI::Dialog::Filebrowser.3pm68890444editdlrm
Curses::UI::Dialog::Progress.3pm57740444editdlrm
Curses::UI::Dialog::Question.3pm52770444editdlrm
Curses::UI::Dialog::Status.3pm47650444editdlrm
Curses::UI::Label.3pm73330444editdlrm
Curses::UI::Listbox.3pm119880444editdlrm
Curses::UI::Menubar.3pm81100444editdlrm
Curses::UI::Notebook.3pm91400444editdlrm
Curses::UI::PasswordEntry.3pm37430444editdlrm
Curses::UI::Popupmenu.3pm74310444editdlrm
Curses::UI::Progressbar.3pm58910444editdlrm
Curses::UI::Radiobuttonbox.3pm40690444editdlrm
Curses::UI::Searchable.3pm66680444editdlrm
Curses::UI::TextEditor.3pm141710444editdlrm
Curses::UI::TextEntry.3pm36230444editdlrm
Curses::UI::TextViewer.3pm36700444editdlrm
Curses::UI::Tutorial.3pm85550444editdlrm
Curses::UI::Widget.3pm256750444editdlrm
Curses::UI::Window.3pm50840444editdlrm
Cwd.3pm71830444editdlrm
Date::Format.3pm72910444editdlrm
Date::Language.3pm38090444editdlrm
Date::Language::Bulgarian.3pm36750444editdlrm
Date::Language::Hungarian.3pm30910444editdlrm
Date::Parse.3pm54020444editdlrm
Digest::SHA.3pm257590444editdlrm
Expect.3pm602290444editdlrm
ExtUtils::CBuilder.3pm119230444editdlrm
ExtUtils::CBuilder::Platform::Windows.3pm31170444editdlrm
ExtUtils::Command.3pm59420444editdlrm
ExtUtils::Command::MM.3pm57230444editdlrm
ExtUtils::Liblist.3pm126790444editdlrm
ExtUtils::MakeMaker.3pm793570444editdlrm
ExtUtils::MakeMaker::Config.3pm25870444editdlrm
ExtUtils::MakeMaker::FAQ.3pm268290444editdlrm
ExtUtils::MakeMaker::Locale.3pm111680444editdlrm
ExtUtils::MakeMaker::Tutorial.3pm83890444editdlrm
ExtUtils::Manifest.3pm119610444editdlrm
ExtUtils::Mkbootstrap.3pm34590444editdlrm
ExtUtils::Mksymlists.3pm66990444editdlrm
ExtUtils::MM.3pm28290444editdlrm
ExtUtils::MM_AIX.3pm30440444editdlrm
ExtUtils::MM_Any.3pm311290444editdlrm
ExtUtils::MM_BeOS.3pm27980444editdlrm
ExtUtils::MM_Cygwin.3pm35690444editdlrm
ExtUtils::MM_Darwin.3pm26880444editdlrm
ExtUtils::MM_DOS.3pm30210444editdlrm
ExtUtils::MM_MacOS.3pm29870444editdlrm
ExtUtils::MM_NW5.3pm32000444editdlrm
ExtUtils::MM_OS2.3pm28860444editdlrm
ExtUtils::MM_QNX.3pm29420444editdlrm
ExtUtils::MM_Unix.3pm214190444editdlrm
ExtUtils::MM_UWIN.3pm30510444editdlrm
ExtUtils::MM_VMS.3pm149000444editdlrm
ExtUtils::MM_VOS.3pm29260444editdlrm
ExtUtils::MM_Win32.3pm59190444editdlrm
ExtUtils::MM_Win95.3pm32760444editdlrm
ExtUtils::MY.3pm27640444editdlrm
ExtUtils::testlib.3pm26900444editdlrm
File::GlobMapper.3pm114470444editdlrm
File::HomeDir.3pm182120444editdlrm
File::HomeDir::Darwin.3pm32320444editdlrm
File::HomeDir::Darwin::Carbon.3pm35170444editdlrm
File::HomeDir::Darwin::Cocoa.3pm34460444editdlrm
File::HomeDir::Driver.3pm31010444editdlrm
File::HomeDir::FreeDesktop.3pm34870444editdlrm
File::HomeDir::MacOS9.3pm34990444editdlrm
File::HomeDir::Test.3pm35340444editdlrm
File::HomeDir::Unix.3pm36380444editdlrm
File::HomeDir::Windows.3pm48910444editdlrm
File::Path.3pm310300444editdlrm
File::Slurp.3pm236260444editdlrm
File::Spec.3pm137840444editdlrm
File::Spec::AmigaOS.3pm28260444editdlrm
File::Spec::Cygwin.3pm39570444editdlrm
File::Spec::Epoc.3pm32510444editdlrm
File::Spec::Functions.3pm37990444editdlrm
File::Spec::Mac.3pm186640444editdlrm
File::Spec::OS2.3pm31180444editdlrm
File::Spec::Unix.3pm98370444editdlrm
File::Spec::VMS.3pm63890444editdlrm
File::Spec::Win32.3pm64510444editdlrm
File::Temp.3pm367990444editdlrm
File::Which.3pm97460444editdlrm
Getopt::Long.3pm526470444editdlrm
HDB.3pm109470444editdlrm
HDB::CMDS.3pm188940444editdlrm
HDB::Encode.3pm78630444editdlrm
HDB::Object.3pm100570444editdlrm
HTML::AsSubs.3pm85860444editdlrm
HTML::Element.3pm707930444editdlrm
HTML::Element::traverse.3pm159840444editdlrm
HTML::Form.3pm281580444editdlrm
HTML::Parse.3pm82770444editdlrm
HTML::Tree.3pm99820444editdlrm
HTML::Tree::AboutObjects.3pm379180444editdlrm
HTML::Tree::AboutTrees.3pm585340444editdlrm
HTML::Tree::Scanning.3pm343850444editdlrm
HTML::TreeBuilder.3pm301380444editdlrm
HTTP::Tiny.3pm277090444editdlrm
IO::AtomicFile.3pm53810444editdlrm
IO::Compress::Base.3pm35060444editdlrm
IO::Compress::Bzip2.3pm232600444editdlrm
IO::Compress::Deflate.3pm267680444editdlrm
IO::Compress::FAQ.3pm267180444editdlrm
IO::Compress::Gzip.3pm344890444editdlrm
IO::Compress::RawDeflate.3pm271340444editdlrm
IO::Compress::Zip.3pm408700444editdlrm
IO::InnerFile.3pm60350444editdlrm
IO::Lines.3pm37830444editdlrm
IO::Pty.3pm85790444editdlrm
IO::Scalar.3pm106790444editdlrm
IO::ScalarArray.3pm105280444editdlrm
IO::Stringy.3pm40490444editdlrm
IO::Tty.3pm83480444editdlrm
IO::Tty::Constant.3pm100120444editdlrm
IO::Uncompress::AnyInflate.3pm328000444editdlrm
IO::Uncompress::AnyUncompress.3pm307670444editdlrm
IO::Uncompress::Base.3pm35180444editdlrm
IO::Uncompress::Bunzip2.3pm291710444editdlrm
IO::Uncompress::Gunzip.3pm317190444editdlrm
IO::Uncompress::Inflate.3pm299150444editdlrm
IO::Uncompress::RawInflate.3pm295630444editdlrm
IO::Uncompress::Unzip.3pm312790444editdlrm
IO::Wrap.3pm106640444editdlrm
IO::WrapTie.3pm149870444editdlrm
JSON::PP.3pm500800444editdlrm
JSON::PP::Boolean.3pm26670444editdlrm
JSON::Syck.3pm80940444editdlrm
JSON::XS.3pm890370444editdlrm
JSON::XS::Boolean.3pm28570444editdlrm
lib::core::only.3pm56470444editdlrm
local::lib.3pm313900444editdlrm
LWP.3pm285060444editdlrm
LWP::Authen::Ntlm.3pm74890444editdlrm
LWP::ConnCache.3pm99670444editdlrm
LWP::Debug.3pm56080444editdlrm
LWP::MemberMixin.3pm48210444editdlrm
LWP::Protocol.3pm83500444editdlrm
LWP::Protocol::https.3pm56840444editdlrm
LWP::RobotUA.3pm90220444editdlrm
LWP::Simple.3pm90160444editdlrm
LWP::UserAgent.3pm481560444editdlrm
lwpcook.3pm148380444editdlrm
lwptut.3pm324410444editdlrm
Module::Build.3pm445630444editdlrm
Module::Build::API.3pm892670444editdlrm
Module::Build::Authoring.3pm173630444editdlrm
Module::Build::Base.3pm51570444editdlrm
Module::Build::Bundling.3pm99990444editdlrm
Module::Build::Compat.3pm108850444editdlrm
Module::Build::ConfigData.3pm73880444editdlrm
Module::Build::Cookbook.3pm259460444editdlrm
Module::Build::Notes.3pm46900444editdlrm
Module::Build::Platform::aix.3pm44720444editdlrm
Module::Build::Platform::cygwin.3pm45050444editdlrm
Module::Build::Platform::darwin.3pm44910444editdlrm
Module::Build::Platform::Default.3pm44900444editdlrm
Module::Build::Platform::MacOS.3pm53980444editdlrm
Module::Build::Platform::os2.3pm44740444editdlrm
Module::Build::Platform::Unix.3pm44810444editdlrm
Module::Build::Platform::VMS.3pm78850444editdlrm
Module::Build::Platform::VOS.3pm44770444editdlrm
Module::Build::Platform::Windows.3pm45290444editdlrm
Module::Build::PPMMaker.3pm48860444editdlrm
Mozilla::CA.3pm35710444editdlrm
Net::CIDR::Lite.3pm95620444editdlrm
Net::Cmd.3pm115450444editdlrm
Net::Config.3pm81000444editdlrm
Net::Domain.3pm38350444editdlrm
Net::FTP.3pm273410444editdlrm
Net::FTP::dataconn.3pm39790444editdlrm
Net::HTTP.3pm163750444editdlrm
Net::HTTP::NB.3pm53940444editdlrm
Net::HTTPS.3pm54380444editdlrm
Net::IP.3pm276970444editdlrm
Net::libnetFAQ.3pm147460444editdlrm
Net::Netrc.3pm67290444editdlrm
Net::NNTP.3pm231930444editdlrm
Net::POP3.3pm122590444editdlrm
Net::SMTP.3pm188800444editdlrm
Net::SSLeay.3pm3493500444editdlrm
Net::SSLeay::Handle.3pm91270444editdlrm
Net::Time.3pm45240444editdlrm
ok.3pm28510444editdlrm
Parse::CPAN::Meta.3pm101870444editdlrm
POD2::DE::local::lib.3pm228790444editdlrm
POD2::PT_BR::local::lib.3pm227620444editdlrm
Socket.3pm340780444editdlrm
Sub::Identify.3pm50870444editdlrm
SUPER.3pm73940444editdlrm
Switch.3pm190140444editdlrm
TAP::Base.3pm34010444editdlrm
TAP::Formatter::Base.3pm62330444editdlrm
TAP::Formatter::Color.3pm37170444editdlrm
TAP::Formatter::Console.3pm27220444editdlrm
TAP::Formatter::Console::ParallelSession.3pm30650444editdlrm
TAP::Formatter::Console::Session.3pm28320444editdlrm
TAP::Formatter::File.3pm26930444editdlrm
TAP::Formatter::File::Session.3pm28470444editdlrm
TAP::Formatter::Session.3pm36030444editdlrm
TAP::Harness.3pm213000444editdlrm
TAP::Harness::Beyond.3pm191180444editdlrm
TAP::Harness::Env.3pm54670444editdlrm
TAP::Object.3pm44970444editdlrm
TAP::Parser.3pm422100444editdlrm
TAP::Parser::Aggregator.3pm80230444editdlrm
TAP::Parser::Grammar.3pm86470444editdlrm
TAP::Parser::Iterator.3pm49930444editdlrm
TAP::Parser::Iterator::Array.3pm37710444editdlrm
TAP::Parser::Iterator::Process.3pm46010444editdlrm
TAP::Parser::Iterator::Stream.3pm37120444editdlrm
TAP::Parser::IteratorFactory.3pm69040444editdlrm
TAP::Parser::Multiplexer.3pm46460444editdlrm
TAP::Parser::Result.3pm75120444editdlrm
TAP::Parser::Result::Bailout.3pm32930444editdlrm
TAP::Parser::Result::Comment.3pm31180444editdlrm
TAP::Parser::Result::Plan.3pm41730444editdlrm
TAP::Parser::Result::Pragma.3pm30730444editdlrm
TAP::Parser::Result::Test.3pm71140444editdlrm
TAP::Parser::Result::Unknown.3pm29730444editdlrm
TAP::Parser::Result::Version.3pm31540444editdlrm
TAP::Parser::Result::YAML.3pm30860444editdlrm
TAP::Parser::ResultFactory.3pm55230444editdlrm
TAP::Parser::Scheduler.3pm81130444editdlrm
TAP::Parser::Scheduler::Job.3pm43010444editdlrm
TAP::Parser::Scheduler::Spinner.3pm33460444editdlrm
TAP::Parser::Source.3pm81700444editdlrm
TAP::Parser::SourceHandler.3pm75590444editdlrm
TAP::Parser::SourceHandler::Executable.3pm52970444editdlrm
TAP::Parser::SourceHandler::File.3pm45670444editdlrm
TAP::Parser::SourceHandler::Handle.3pm44250444editdlrm
TAP::Parser::SourceHandler::Perl.3pm62620444editdlrm
TAP::Parser::SourceHandler::RawTAP.3pm44340444editdlrm
TAP::Parser::YAMLish::Reader.3pm39950444editdlrm
TAP::Parser::YAMLish::Writer.3pm48790444editdlrm
Template.3pm279090444editdlrm
Template::Base.3pm81490444editdlrm
Template::Config.3pm86870444editdlrm
Template::Constants.3pm78150444editdlrm
Template::Context.3pm266370444editdlrm
Template::Directive.3pm48210444editdlrm
Template::Document.3pm118290444editdlrm
Template::Exception.3pm67630444editdlrm
Template::FAQ.3pm145640444editdlrm
Template::Filters.3pm98170444editdlrm
Template::Grammar.3pm50390444editdlrm
Template::Iterator.3pm114130444editdlrm
Template::Manual.3pm63170444editdlrm
Template::Manual::Config.3pm795040444editdlrm
Template::Manual::Credits.3pm82460444editdlrm
Template::Manual::Directives.3pm772930444editdlrm
Template::Manual::Filters.3pm208100444editdlrm
Template::Manual::Internals.3pm234330444editdlrm
Template::Manual::Intro.3pm140920444editdlrm
Template::Manual::Plugins.3pm137800444editdlrm
Template::Manual::Syntax.3pm145490444editdlrm
Template::Manual::Variables.3pm331100444editdlrm
Template::Manual::Views.3pm259530444editdlrm
Template::Manual::VMethods.3pm281950444editdlrm
Template::Modules.3pm98270444editdlrm
Template::Namespace::Constants.3pm60020444editdlrm
Template::Parser.3pm99170444editdlrm
Template::Plugin.3pm109370444editdlrm
Template::Plugin::Assert.3pm54460444editdlrm
Template::Plugin::CGI.3pm61880444editdlrm
Template::Plugin::Datafile.3pm66010444editdlrm
Template::Plugin::Date.3pm95380444editdlrm
Template::Plugin::Directory.3pm119790444editdlrm
Template::Plugin::Dumper.3pm60780444editdlrm
Template::Plugin::File.3pm130090444editdlrm
Template::Plugin::Filter.3pm129360444editdlrm
Template::Plugin::Format.3pm48950444editdlrm
Template::Plugin::HTML.3pm78230444editdlrm
Template::Plugin::Image.3pm119500444editdlrm
Template::Plugin::Iterator.3pm50610444editdlrm
Template::Plugin::Math.3pm66230444editdlrm
Template::Plugin::Pod.3pm47840444editdlrm
Template::Plugin::Procedural.3pm56310444editdlrm
Template::Plugin::Scalar.3pm50320444editdlrm
Template::Plugin::String.3pm172630444editdlrm
Template::Plugin::Table.3pm111450444editdlrm
Template::Plugin::URL.3pm80800444editdlrm
Template::Plugin::View.3pm54790444editdlrm
Template::Plugin::Wrap.3pm64330444editdlrm
Template::Plugins.3pm97330444editdlrm
Template::Provider.3pm146780444editdlrm
Template::Service.3pm148130444editdlrm
Template::Stash.3pm119830444editdlrm
Template::Stash::Context.3pm71300444editdlrm
Template::Stash::XS.3pm66440444editdlrm
Template::Test.3pm155240444editdlrm
Template::Toolkit.3pm92270444editdlrm
Template::Tools.3pm50010444editdlrm
Template::Tools::tpage.3pm58060444editdlrm
Template::Tools::ttree.3pm165670444editdlrm
Template::Tutorial.3pm45660444editdlrm
Template::Tutorial::Datafile.3pm195390444editdlrm
Template::Tutorial::Web.3pm341180444editdlrm
Template::View.3pm126180444editdlrm
Template::VMethods.3pm46880444editdlrm
Term::ReadKey.3pm130290444editdlrm
Test2.3pm95560444editdlrm
Test2::API.3pm304240444editdlrm
Test2::API::Breakage.3pm49880444editdlrm
Test2::API::Context.3pm175740444editdlrm
Test2::API::Instance.3pm124040444editdlrm
Test2::API::Stack.3pm65680444editdlrm
Test2::Event.3pm91890444editdlrm
Test2::Event::Bail.3pm34700444editdlrm
Test2::Event::Diag.3pm33380444editdlrm
Test2::Event::Exception.3pm35200444editdlrm
Test2::Event::Generic.3pm76620444editdlrm
Test2::Event::Info.3pm42610444editdlrm
Test2::Event::Note.3pm33230444editdlrm
Test2::Event::Ok.3pm42550444editdlrm
Test2::Event::Plan.3pm39070444editdlrm
Test2::Event::Skip.3pm36650444editdlrm
Test2::Event::Subtest.3pm35730444editdlrm
Test2::Event::Waiting.3pm31070444editdlrm
Test2::Formatter.3pm52080444editdlrm
Test2::Formatter::TAP.3pm92550444editdlrm
Test2::Hub.3pm167550444editdlrm
Test2::Hub::Interceptor.3pm29370444editdlrm
Test2::Hub::Interceptor::Terminator.3pm29800444editdlrm
Test2::Hub::Subtest.3pm38030444editdlrm
Test2::IPC.3pm33240444editdlrm
Test2::IPC::Driver.3pm95120444editdlrm
Test2::IPC::Driver::Files.3pm38220444editdlrm
Test2::Transition.3pm184060444editdlrm
Test2::Util.3pm51230444editdlrm
Test2::Util::ExternalMeta.3pm55940444editdlrm
Test2::Util::HashBase.3pm74630444editdlrm
Test2::Util::Trace.3pm55770444editdlrm
Test::Builder.3pm269150444editdlrm
Test::Builder::Formatter.3pm36560444editdlrm
Test::Builder::IO::Scalar.3pm97400444editdlrm
Test::Builder::Module.3pm55670444editdlrm
Test::Builder::Tester.3pm115500444editdlrm
Test::Builder::Tester::Color.3pm31310444editdlrm
Test::Builder::TodoDiag.3pm31290444editdlrm
Test::Fatal.3pm93030444editdlrm
Test::HACKING.3pm92530444editdlrm
Test::Harness.3pm110280444editdlrm
Test::LeakTrace.3pm100220444editdlrm
Test::LeakTrace::JA.3pm123280444editdlrm
Test::LeakTrace::Script.3pm51400444editdlrm
Test::MockModule.3pm108180444editdlrm
Test::More.3pm432150444editdlrm
Test::More::UTF8.3pm36020444editdlrm
Test::RequiresInternet.3pm39440444editdlrm
Test::Simple.3pm91190444editdlrm
Test::Tester.3pm157810444editdlrm
Test::Tester::Capture.3pm29020444editdlrm
Test::Tester::CaptureRunner.3pm26730444editdlrm
Test::Tutorial.3pm242610444editdlrm
Test::use::ok.3pm38410444editdlrm
Test::Warnings.3pm142310444editdlrm
Text::Glob.3pm61060444editdlrm
Text::Template.3pm654990444editdlrm
Text::Template::Preprocess.3pm62700444editdlrm
Time::Zone.3pm34130444editdlrm
TimeDate.3pm23970444editdlrm
Try::Tiny.3pm203430444editdlrm
Types::Serialiser.3pm114730444editdlrm
Types::Serialiser::Error.3pm27050444editdlrm
version.3pm139370444editdlrm
version::Internals.3pm302870444editdlrm
WWW::Mechanize.3pm681960444editdlrm
WWW::Mechanize::Cookbook.3pm71590444editdlrm
WWW::Mechanize::Examples.3pm224900444editdlrm
WWW::Mechanize::FAQ.3pm243590444editdlrm
WWW::Mechanize::Image.3pm64900444editdlrm
WWW::Mechanize::Link.3pm65180444editdlrm
XML::NamespaceSupport.3pm130520444editdlrm
XML::Parser.3pm262960444editdlrm
XML::Parser::Expat.3pm267990444editdlrm
XML::Parser::Style::Debug.3pm44080444editdlrm
XML::Parser::Style::Objects.3pm48880444editdlrm
XML::Parser::Style::Stream.3pm59250444editdlrm
XML::Parser::Style::Subs.3pm48630444editdlrm
XML::Parser::Style::Tree.3pm55290444editdlrm
XML::SAX.3pm92290444editdlrm
XML::SAX::Base.3pm137040444editdlrm
XML::SAX::BuildSAXBase.3pm137000444editdlrm
XML::SAX::DocumentLocator.3pm52390444editdlrm
XML::SAX::Exception.3pm56220444editdlrm
XML::SAX::Expat.3pm64040444editdlrm
XML::SAX::Intro.3pm202200444editdlrm
XML::SAX::ParserFactory.3pm79190444editdlrm
XML::SAX::PurePerl.3pm61720444editdlrm
XML::SAX::PurePerl::Reader.3pm41030444editdlrm
XML::Simple.3pm655890444editdlrm
XML::Simple::FAQ.3pm272230444editdlrm
YAML.3pm299800444editdlrm
YAML::Any.3pm74870444editdlrm
YAML::Dumper.3pm47760444editdlrm
YAML::Dumper::Base.3pm46420444editdlrm
YAML::Error.3pm46810444editdlrm
YAML::Loader.3pm47660444editdlrm
YAML::Loader::Base.3pm46420444editdlrm
YAML::Marshall.3pm46400444editdlrm
YAML::Node.3pm67430444editdlrm
YAML::Syck.3pm108060444editdlrm
YAML::Tag.3pm44990444editdlrm
YAML::Types.3pm47160444editdlrm
Edit: /usr/local/share/man/man3/Module::Build.3pm (44563B)
.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{ . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Module::Build 3" .TH Module::Build 3 "2016-10-25" "perl v5.16.3" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Module::Build \- Build and install Perl modules .SH "SYNOPSIS" .IX Header "SYNOPSIS" Standard process for building & installing modules: .PP .Vb 4 \& perl Build.PL \& ./Build \& ./Build test \& ./Build install .Ve .PP Or, if you're on a platform (like \s-1DOS\s0 or Windows) that doesn't require the \*(L"./\*(R" notation, you can do this: .PP .Vb 4 \& perl Build.PL \& Build \& Build test \& Build install .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\f(CW\*(C`Module::Build\*(C'\fR is a system for building, testing, and installing Perl modules. It is meant to be an alternative to \&\f(CW\*(C`ExtUtils::MakeMaker\*(C'\fR. Developers may alter the behavior of the module through subclassing in a much more straightforward way than with \f(CW\*(C`MakeMaker\*(C'\fR. It also does not require a \f(CW\*(C`make\*(C'\fR on your system \&\- most of the \f(CW\*(C`Module::Build\*(C'\fR code is pure-perl and written in a very cross-platform way. .PP See \*(L"\s-1MOTIVATIONS\*(R"\s0 for more comparisons between \f(CW\*(C`ExtUtils::MakeMaker\*(C'\fR and \f(CW\*(C`Module::Build\*(C'\fR. .PP To install \f(CW\*(C`Module::Build\*(C'\fR, and any other module that uses \&\f(CW\*(C`Module::Build\*(C'\fR for its installation process, do the following: .PP .Vb 4 \& perl Build.PL # \*(AqBuild.PL\*(Aq script creates the \*(AqBuild\*(Aq script \& ./Build # Need ./ to ensure we\*(Aqre using this "Build" script \& ./Build test # and not another one that happens to be in the PATH \& ./Build install .Ve .PP This illustrates initial configuration and the running of three \&'actions'. In this case the actions run are 'build' (the default action), 'test', and 'install'. Other actions defined so far include: .PP .Vb 10 \& build manifest \& clean manifest_skip \& code manpages \& config_data pardist \& diff ppd \& dist ppmdist \& distcheck prereq_data \& distclean prereq_report \& distdir pure_install \& distinstall realclean \& distmeta retest \& distsign skipcheck \& disttest test \& docs testall \& fakeinstall testcover \& help testdb \& html testpod \& install testpodcoverage \& installdeps versioninstall .Ve .PP You can run the 'help' action for a complete list of actions. .SH "GUIDE TO DOCUMENTATION" .IX Header "GUIDE TO DOCUMENTATION" The documentation for \f(CW\*(C`Module::Build\*(C'\fR is broken up into sections: .IP "General Usage (Module::Build)" 4 .IX Item "General Usage (Module::Build)" This is the document you are currently reading. It describes basic usage and background information. Its main purpose is to assist the user who wants to learn how to invoke and control \f(CW\*(C`Module::Build\*(C'\fR scripts at the command line. .IP "Authoring Reference (Module::Build::Authoring)" 4 .IX Item "Authoring Reference (Module::Build::Authoring)" This document describes the structure and organization of \&\f(CW\*(C`Module::Build\*(C'\fR, and the relevant concepts needed by authors who are writing \fIBuild.PL\fR scripts for a distribution or controlling \&\f(CW\*(C`Module::Build\*(C'\fR processes programmatically. .IP "\s-1API\s0 Reference (Module::Build::API)" 4 .IX Item "API Reference (Module::Build::API)" This is a reference to the \f(CW\*(C`Module::Build\*(C'\fR \s-1API.\s0 .IP "Cookbook (Module::Build::Cookbook)" 4 .IX Item "Cookbook (Module::Build::Cookbook)" This document demonstrates how to accomplish many common tasks. It covers general command line usage and authoring of \fIBuild.PL\fR scripts. Includes working examples. .SH "ACTIONS" .IX Header "ACTIONS" There are some general principles at work here. First, each task when building a module is called an \*(L"action\*(R". These actions are listed above; they correspond to the building, testing, installing, packaging, etc., tasks. .PP Second, arguments are processed in a very systematic way. Arguments are always key=value pairs. They may be specified at \f(CW\*(C`perl Build.PL\*(C'\fR time (i.e. \f(CW\*(C`perl Build.PL destdir=/my/secret/place\*(C'\fR), in which case their values last for the lifetime of the \f(CW\*(C`Build\*(C'\fR script. They may also be specified when executing a particular action (i.e. \&\f(CW\*(C`Build test verbose=1\*(C'\fR), in which case their values last only for the lifetime of that command. Per-action command line parameters take precedence over parameters specified at \f(CW\*(C`perl Build.PL\*(C'\fR time. .PP The build process also relies heavily on the \f(CW\*(C`Config.pm\*(C'\fR module. If the user wishes to override any of the values in \f(CW\*(C`Config.pm\*(C'\fR, she may specify them like so: .PP .Vb 1 \& perl Build.PL \-\-config cc=gcc \-\-config ld=gcc .Ve .PP The following build actions are provided by default. .IP "build" 4 .IX Item "build" [version 0.01] .Sp If you run the \f(CW\*(C`Build\*(C'\fR script without any arguments, it runs the \&\f(CW\*(C`build\*(C'\fR action, which in turn runs the \f(CW\*(C`code\*(C'\fR and \f(CW\*(C`docs\*(C'\fR actions. .Sp This is analogous to the \f(CW\*(C`MakeMaker\*(C'\fR \fImake all\fR target. .IP "clean" 4 .IX Item "clean" [version 0.01] .Sp This action will clean up any files that the build process may have created, including the \f(CW\*(C`blib/\*(C'\fR directory (but not including the \&\f(CW\*(C`_build/\*(C'\fR directory and the \f(CW\*(C`Build\*(C'\fR script itself). .IP "code" 4 .IX Item "code" [version 0.20] .Sp This action builds your code base. .Sp By default it just creates a \f(CW\*(C`blib/\*(C'\fR directory and copies any \f(CW\*(C`.pm\*(C'\fR and \f(CW\*(C`.pod\*(C'\fR files from your \f(CW\*(C`lib/\*(C'\fR directory into the \f(CW\*(C`blib/\*(C'\fR directory. It also compiles any \f(CW\*(C`.xs\*(C'\fR files from \f(CW\*(C`lib/\*(C'\fR and places them in \f(CW\*(C`blib/\*(C'\fR. Of course, you need a working C compiler (probably the same one that built perl itself) for the compilation to work properly. .Sp The \f(CW\*(C`code\*(C'\fR action also runs any \f(CW\*(C`.PL\*(C'\fR files in your \fIlib/\fR directory. Typically these create other files, named the same but without the \f(CW\*(C`.PL\*(C'\fR ending. For example, a file \fIlib/Foo/Bar.pm.PL\fR could create the file \fIlib/Foo/Bar.pm\fR. The \f(CW\*(C`.PL\*(C'\fR files are processed first, so any \f(CW\*(C`.pm\*(C'\fR files (or other kinds that we deal with) will get copied correctly. .IP "config_data" 4 .IX Item "config_data" [version 0.26] .Sp \&... .IP "diff" 4 .IX Item "diff" [version 0.14] .Sp This action will compare the files about to be installed with their installed counterparts. For .pm and .pod files, a diff will be shown (this currently requires a 'diff' program to be in your \s-1PATH\s0). For other files like compiled binary files, we simply report whether they differ. .Sp A \f(CW\*(C`flags\*(C'\fR parameter may be passed to the action, which will be passed to the 'diff' program. Consult your 'diff' documentation for the parameters it will accept \- a good one is \f(CW\*(C`\-u\*(C'\fR: .Sp .Vb 1 \& ./Build diff flags=\-u .Ve .IP "dist" 4 .IX Item "dist" [version 0.02] .Sp This action is helpful for module authors who want to package up their module for source distribution through a medium like \s-1CPAN. \s0 It will create a tarball of the files listed in \fI\s-1MANIFEST\s0\fR and compress the tarball using \&\s-1GZIP\s0 compression. .Sp By default, this action will use the \f(CW\*(C`Archive::Tar\*(C'\fR module. However, you can force it to use binary \*(L"tar\*(R" and \*(L"gzip\*(R" executables by supplying an explicit \&\f(CW\*(C`tar\*(C'\fR (and optional \f(CW\*(C`gzip\*(C'\fR) parameter: .Sp .Vb 1 \& ./Build dist \-\-tar C:\epath\eto\etar.exe \-\-gzip C:\epath\eto\ezip.exe .Ve .IP "distcheck" 4 .IX Item "distcheck" [version 0.05] .Sp Reports which files are in the build directory but not in the \&\fI\s-1MANIFEST\s0\fR file, and vice versa. (See manifest for details.) .IP "distclean" 4 .IX Item "distclean" [version 0.05] .Sp Performs the 'realclean' action and then the 'distcheck' action. .IP "distdir" 4 .IX Item "distdir" [version 0.05] .Sp Creates a \*(L"distribution directory\*(R" named \f(CW\*(C`$dist_name\-$dist_version\*(C'\fR (if that directory already exists, it will be removed first), then copies all the files listed in the \fI\s-1MANIFEST\s0\fR file to that directory. This directory is what the distribution tarball is created from. .IP "distinstall" 4 .IX Item "distinstall" [version 0.37] .Sp Performs the 'distdir' action, then switches into that directory and runs a \&\f(CW\*(C`perl Build.PL\*(C'\fR, followed by the 'build' and 'install' actions in that directory. Use \s-1PERL_MB_OPT\s0 or \fI.modulebuildrc\fR to set options that should be applied during subprocesses .IP "distmeta" 4 .IX Item "distmeta" [version 0.21] .Sp Creates the \fI\s-1META\s0.yml\fR file that describes the distribution. .Sp \&\fI\s-1META\s0.yml\fR is a file containing various bits of \fImetadata\fR about the distribution. The metadata includes the distribution name, version, abstract, prerequisites, license, and various other data about the distribution. This file is created as \fI\s-1META\s0.yml\fR in a simplified \s-1YAML\s0 format. .Sp \&\fI\s-1META\s0.yml\fR file must also be listed in \fI\s-1MANIFEST\s0\fR \- if it's not, a warning will be issued. .Sp The current version of the \fI\s-1META\s0.yml\fR specification can be found on \s-1CPAN\s0 as CPAN::Meta::Spec. .IP "distsign" 4 .IX Item "distsign" [version 0.16] .Sp Uses \f(CW\*(C`Module::Signature\*(C'\fR to create a \s-1SIGNATURE\s0 file for your distribution, and adds the \s-1SIGNATURE\s0 file to the distribution's \&\s-1MANIFEST.\s0 .IP "disttest" 4 .IX Item "disttest" [version 0.05] .Sp Performs the 'distdir' action, then switches into that directory and runs a \&\f(CW\*(C`perl Build.PL\*(C'\fR, followed by the 'build' and 'test' actions in that directory. Use \s-1PERL_MB_OPT\s0 or \fI.modulebuildrc\fR to set options that should be applied during subprocesses .IP "docs" 4 .IX Item "docs" [version 0.20] .Sp This will generate documentation (e.g. Unix man pages and \s-1HTML\s0 documents) for any installable items under \fBblib/\fR that contain \s-1POD. \s0 If there are no \f(CW\*(C`bindoc\*(C'\fR or \f(CW\*(C`libdoc\*(C'\fR installation targets defined (as will be the case on systems that don't support Unix manpages) no action is taken for manpages. If there are no \&\f(CW\*(C`binhtml\*(C'\fR or \f(CW\*(C`libhtml\*(C'\fR installation targets defined no action is taken for \s-1HTML\s0 documents. .IP "fakeinstall" 4 .IX Item "fakeinstall" [version 0.02] .Sp This is just like the \f(CW\*(C`install\*(C'\fR action, but it won't actually do anything, it will just report what it \fIwould\fR have done if you had actually run the \f(CW\*(C`install\*(C'\fR action. .IP "help" 4 .IX Item "help" [version 0.03] .Sp This action will simply print out a message that is meant to help you use the build process. It will show you a list of available build actions too. .Sp With an optional argument specifying an action name (e.g. \f(CW\*(C`Build help test\*(C'\fR), the 'help' action will show you any \s-1POD\s0 documentation it can find for that action. .IP "html" 4 .IX Item "html" [version 0.26] .Sp This will generate \s-1HTML\s0 documentation for any binary or library files under \fBblib/\fR that contain \s-1POD. \s0 The \s-1HTML\s0 documentation will only be installed if the install paths can be determined from values in \&\f(CW\*(C`Config.pm\*(C'\fR. You can also supply or override install paths on the command line by specifying \f(CW\*(C`install_path\*(C'\fR values for the \f(CW\*(C`binhtml\*(C'\fR and/or \f(CW\*(C`libhtml\*(C'\fR installation targets. .Sp With an optional \f(CW\*(C`html_links\*(C'\fR argument set to a false value, you can skip the search for other documentation to link to, because that can waste a lot of time if there aren't any links to generate anyway: .Sp .Vb 1 \& ./Build html \-\-html_links 0 .Ve .IP "install" 4 .IX Item "install" [version 0.01] .Sp This action will use \f(CW\*(C`ExtUtils::Install\*(C'\fR to install the files from \&\f(CW\*(C`blib/\*(C'\fR into the system. See \*(L"\s-1INSTALL PATHS\*(R"\s0 for details about how Module::Build determines where to install things, and how to influence this process. .Sp If you want the installation process to look around in \f(CW@INC\fR for other versions of the stuff you're installing and try to delete it, you can use the \f(CW\*(C`uninst\*(C'\fR parameter, which tells \f(CW\*(C`ExtUtils::Install\*(C'\fR to do so: .Sp .Vb 1 \& ./Build install uninst=1 .Ve .Sp This can be a good idea, as it helps prevent multiple versions of a module from being present on your system, which can be a confusing situation indeed. .IP "installdeps" 4 .IX Item "installdeps" [version 0.36] .Sp This action will use the \f(CW\*(C`cpan_client\*(C'\fR parameter as a command to install missing prerequisites. You will be prompted whether to install optional dependencies. .Sp The \f(CW\*(C`cpan_client\*(C'\fR option defaults to 'cpan' but can be set as an option or in \&\fI.modulebuildrc\fR. It must be a shell command that takes a list of modules to install as arguments (e.g. 'cpanp \-i' for \s-1CPANPLUS\s0). If the program part is a relative path (e.g. 'cpan' or 'cpanp'), it will be located relative to the perl program that executed Build.PL. .Sp .Vb 3 \& /opt/perl/5.8.9/bin/perl Build.PL \& ./Build installdeps \-\-cpan_client \*(Aqcpanp \-i\*(Aq \& # installs to 5.8.9 .Ve .IP "manifest" 4 .IX Item "manifest" [version 0.05] .Sp This is an action intended for use by module authors, not people installing modules. It will bring the \fI\s-1MANIFEST\s0\fR up to date with the files currently present in the distribution. You may use a \&\fI\s-1MANIFEST.SKIP\s0\fR file to exclude certain files or directories from inclusion in the \fI\s-1MANIFEST\s0\fR. \fI\s-1MANIFEST.SKIP\s0\fR should contain a bunch of regular expressions, one per line. If a file in the distribution directory matches any of the regular expressions, it won't be included in the \fI\s-1MANIFEST\s0\fR. .Sp The following is a reasonable \fI\s-1MANIFEST.SKIP\s0\fR starting point, you can add your own stuff to it: .Sp .Vb 7 \& ^_build \& ^Build$ \& ^blib \& ~$ \& \e.bak$ \& ^MANIFEST\e.SKIP$ \& CVS .Ve .Sp See the distcheck and skipcheck actions if you want to find out what the \f(CW\*(C`manifest\*(C'\fR action would do, without actually doing anything. .IP "manifest_skip" 4 .IX Item "manifest_skip" [version 0.3608] .Sp This is an action intended for use by module authors, not people installing modules. It will generate a boilerplate \s-1MANIFEST.SKIP\s0 file if one does not already exist. .IP "manpages" 4 .IX Item "manpages" [version 0.28] .Sp This will generate man pages for any binary or library files under \&\fBblib/\fR that contain \s-1POD. \s0 The man pages will only be installed if the install paths can be determined from values in \f(CW\*(C`Config.pm\*(C'\fR. You can also supply or override install paths by specifying there values on the command line with the \f(CW\*(C`bindoc\*(C'\fR and \f(CW\*(C`libdoc\*(C'\fR installation targets. .IP "pardist" 4 .IX Item "pardist" [version 0.2806] .Sp Generates a \s-1PAR\s0 binary distribution for use with \s-1PAR\s0 or PAR::Dist. .Sp It requires that the PAR::Dist module (version 0.17 and up) is installed on your system. .IP "ppd" 4 .IX Item "ppd" [version 0.20] .Sp Build a \s-1PPD\s0 file for your distribution. .Sp This action takes an optional argument \f(CW\*(C`codebase\*(C'\fR which is used in the generated \s-1PPD\s0 file to specify the (usually relative) \s-1URL\s0 of the distribution. By default, this value is the distribution name without any path information. .Sp Example: .Sp .Vb 1 \& ./Build ppd \-\-codebase "MSWin32\-x86\-multi\-thread/Module\-Build\-0.21.tar.gz" .Ve .IP "ppmdist" 4 .IX Item "ppmdist" [version 0.23] .Sp Generates a \s-1PPM\s0 binary distribution and a \s-1PPD\s0 description file. This action also invokes the \f(CW\*(C`ppd\*(C'\fR action, so it can accept the same \&\f(CW\*(C`codebase\*(C'\fR argument described under that action. .Sp This uses the same mechanism as the \f(CW\*(C`dist\*(C'\fR action to tar & zip its output, so you can supply \f(CW\*(C`tar\*(C'\fR and/or \f(CW\*(C`gzip\*(C'\fR parameters to affect the result. .IP "prereq_data" 4 .IX Item "prereq_data" [version 0.32] .Sp This action prints out a Perl data structure of all prerequisites and the versions required. The output can be loaded again using \f(CW\*(C`eval()\*(C'\fR. This can be useful for external tools that wish to query a Build script for prerequisites. .IP "prereq_report" 4 .IX Item "prereq_report" [version 0.28] .Sp This action prints out a list of all prerequisites, the versions required, and the versions actually installed. This can be useful for reviewing the configuration of your system prior to a build, or when compiling data to send for a bug report. .IP "pure_install" 4 .IX Item "pure_install" [version 0.28] .Sp This action is identical to the \f(CW\*(C`install\*(C'\fR action. In the future, though, when \f(CW\*(C`install\*(C'\fR starts writing to the file \&\fI$(\s-1INSTALLARCHLIB\s0)/perllocal.pod\fR, \f(CW\*(C`pure_install\*(C'\fR won't, and that will be the only difference between them. .IP "realclean" 4 .IX Item "realclean" [version 0.01] .Sp This action is just like the \f(CW\*(C`clean\*(C'\fR action, but also removes the \&\f(CW\*(C`_build\*(C'\fR directory and the \f(CW\*(C`Build\*(C'\fR script. If you run the \&\f(CW\*(C`realclean\*(C'\fR action, you are essentially starting over, so you will have to re-create the \f(CW\*(C`Build\*(C'\fR script again. .IP "retest" 4 .IX Item "retest" [version 0.2806] .Sp This is just like the \f(CW\*(C`test\*(C'\fR action, but doesn't actually build the distribution first, and doesn't add \fIblib/\fR to the load path, and therefore will test against a \fIpreviously\fR installed version of the distribution. This can be used to verify that a certain installed distribution still works, or to see whether newer versions of a distribution still pass the old regression tests, and so on. .IP "skipcheck" 4 .IX Item "skipcheck" [version 0.05] .Sp Reports which files are skipped due to the entries in the \&\fI\s-1MANIFEST.SKIP\s0\fR file (See manifest for details) .IP "test" 4 .IX Item "test" [version 0.01] .Sp This will use \f(CW\*(C`Test::Harness\*(C'\fR or \f(CW\*(C`TAP::Harness\*(C'\fR to run any regression tests and report their results. Tests can be defined in the standard places: a file called \f(CW\*(C`test.pl\*(C'\fR in the top-level directory, or several files ending with \f(CW\*(C`.t\*(C'\fR in a \f(CW\*(C`t/\*(C'\fR directory. .Sp If you want tests to be 'verbose', i.e. show details of test execution rather than just summary information, pass the argument \f(CW\*(C`verbose=1\*(C'\fR. .Sp If you want to run tests under the perl debugger, pass the argument \&\f(CW\*(C`debugger=1\*(C'\fR. .Sp If you want to have Module::Build find test files with different file name extensions, pass the \f(CW\*(C`test_file_exts\*(C'\fR argument with an array of extensions, such as \f(CW\*(C`[qw( .t .s .z )]\*(C'\fR. .Sp If you want test to be run by \f(CW\*(C`TAP::Harness\*(C'\fR, rather than \f(CW\*(C`Test::Harness\*(C'\fR, pass the argument \f(CW\*(C`tap_harness_args\*(C'\fR as an array reference of arguments to pass to the TAP::Harness constructor. .Sp In addition, if a file called \f(CW\*(C`visual.pl\*(C'\fR exists in the top-level directory, this file will be executed as a Perl script and its output will be shown to the user. This is a good place to put speed tests or other tests that don't use the \f(CW\*(C`Test::Harness\*(C'\fR format for output. .Sp To override the choice of tests to run, you may pass a \f(CW\*(C`test_files\*(C'\fR argument whose value is a whitespace-separated list of test scripts to run. This is especially useful in development, when you only want to run a single test to see whether you've squashed a certain bug yet: .Sp .Vb 1 \& ./Build test \-\-test_files t/something_failing.t .Ve .Sp You may also pass several \f(CW\*(C`test_files\*(C'\fR arguments separately: .Sp .Vb 1 \& ./Build test \-\-test_files t/one.t \-\-test_files t/two.t .Ve .Sp or use a \f(CW\*(C`glob()\*(C'\fR\-style pattern: .Sp .Vb 1 \& ./Build test \-\-test_files \*(Aqt/01\-*.t\*(Aq .Ve .IP "testall" 4 .IX Item "testall" [version 0.2807] .Sp [Note: the 'testall' action and the code snippets below are currently in alpha stage, see \&\*(L"/www.nntp.perl.org/group/perl.module.build/2007/03/msg584.html\*(R"\*(L" in \*(R"http: ] .Sp Runs the \f(CW\*(C`test\*(C'\fR action plus each of the \f(CW\*(C`test$type\*(C'\fR actions defined by the keys of the \f(CW\*(C`test_types\*(C'\fR parameter. .Sp Currently, you need to define the ACTION_test$type method yourself and enumerate them in the test_types parameter. .Sp .Vb 12 \& my $mb = Module::Build\->subclass( \& code => q( \& sub ACTION_testspecial { shift\->generic_test(type => \*(Aqspecial\*(Aq); } \& sub ACTION_testauthor { shift\->generic_test(type => \*(Aqauthor\*(Aq); } \& ) \& )\->new( \& ... \& test_types => { \& special => \*(Aq.st\*(Aq, \& author => [\*(Aq.at\*(Aq, \*(Aq.pt\*(Aq ], \& }, \& ... .Ve .IP "testcover" 4 .IX Item "testcover" [version 0.26] .Sp Runs the \f(CW\*(C`test\*(C'\fR action using \f(CW\*(C`Devel::Cover\*(C'\fR, generating a code-coverage report showing which parts of the code were actually exercised during the tests. .Sp To pass options to \f(CW\*(C`Devel::Cover\*(C'\fR, set the \f(CW$DEVEL_COVER_OPTIONS\fR environment variable: .Sp .Vb 1 \& DEVEL_COVER_OPTIONS=\-ignore,Build ./Build testcover .Ve .IP "testdb" 4 .IX Item "testdb" [version 0.05] .Sp This is a synonym for the 'test' action with the \f(CW\*(C`debugger=1\*(C'\fR argument. .IP "testpod" 4 .IX Item "testpod" [version 0.25] .Sp This checks all the files described in the \f(CW\*(C`docs\*(C'\fR action and produces \f(CW\*(C`Test::Harness\*(C'\fR\-style output. If you are a module author, this is useful to run before creating a new release. .IP "testpodcoverage" 4 .IX Item "testpodcoverage" [version 0.28] .Sp This checks the pod coverage of the distribution and produces \f(CW\*(C`Test::Harness\*(C'\fR\-style output. If you are a module author, this is useful to run before creating a new release. .IP "versioninstall" 4 .IX Item "versioninstall" [version 0.16] .Sp ** Note: since \f(CW\*(C`only.pm\*(C'\fR is so new, and since we just recently added support for it here too, this feature is to be considered experimental. ** .Sp If you have the \f(CW\*(C`only.pm\*(C'\fR module installed on your system, you can use this action to install a module into the version-specific library trees. This means that you can have several versions of the same module installed and \f(CW\*(C`use\*(C'\fR a specific one like this: .Sp .Vb 1 \& use only MyModule => 0.55; .Ve .Sp To override the default installation libraries in \f(CW\*(C`only::config\*(C'\fR, specify the \f(CW\*(C`versionlib\*(C'\fR parameter when you run the \f(CW\*(C`Build.PL\*(C'\fR script: .Sp .Vb 1 \& perl Build.PL \-\-versionlib /my/version/place/ .Ve .Sp To override which version the module is installed as, specify the \&\f(CW\*(C`version\*(C'\fR parameter when you run the \f(CW\*(C`Build.PL\*(C'\fR script: .Sp .Vb 1 \& perl Build.PL \-\-version 0.50 .Ve .Sp See the \f(CW\*(C`only.pm\*(C'\fR documentation for more information on version-specific installs. .SH "OPTIONS" .IX Header "OPTIONS" .SS "Command Line Options" .IX Subsection "Command Line Options" The following options can be used during any invocation of \f(CW\*(C`Build.PL\*(C'\fR or the Build script, during any action. For information on other options specific to an action, see the documentation for the respective action. .PP \&\s-1NOTE:\s0 There is some preliminary support for options to use the more familiar long option style. Most options can be preceded with the \&\f(CW\*(C`\-\-\*(C'\fR long option prefix, and the underscores changed to dashes (e.g. \f(CW\*(C`\-\-use\-rcfile\*(C'\fR). Additionally, the argument to boolean options is optional, and boolean options can be negated by prefixing them with \&\f(CW\*(C`no\*(C'\fR or \f(CW\*(C`no\-\*(C'\fR (e.g. \f(CW\*(C`\-\-noverbose\*(C'\fR or \f(CW\*(C`\-\-no\-verbose\*(C'\fR). .IP "quiet" 4 .IX Item "quiet" Suppress informative messages on output. .IP "verbose" 4 .IX Item "verbose" Display extra information about the Build on output. \f(CW\*(C`verbose\*(C'\fR will turn off \f(CW\*(C`quiet\*(C'\fR .IP "cpan_client" 4 .IX Item "cpan_client" Sets the \f(CW\*(C`cpan_client\*(C'\fR command for use with the \f(CW\*(C`installdeps\*(C'\fR action. See \f(CW\*(C`installdeps\*(C'\fR for more details. .IP "use_rcfile" 4 .IX Item "use_rcfile" Load the \fI~/.modulebuildrc\fR option file. This option can be set to false to prevent the custom resource file from being loaded. .IP "allow_mb_mismatch" 4 .IX Item "allow_mb_mismatch" Suppresses the check upon startup that the version of Module::Build we're now running under is the same version that was initially invoked when building the distribution (i.e. when the \f(CW\*(C`Build.PL\*(C'\fR script was first run). As of 0.3601, a mismatch results in a warning instead of a fatal error, so this option effectively just suppresses the warning. .IP "debug" 4 .IX Item "debug" Prints Module::Build debugging information to \s-1STDOUT,\s0 such as a trace of executed build actions. .SS "Default Options File (\fI.modulebuildrc\fP)" .IX Subsection "Default Options File (.modulebuildrc)" [version 0.28] .PP When Module::Build starts up, it will look first for a file, \&\fI\f(CI$ENV\fI{\s-1HOME\s0}/.modulebuildrc\fR. If it's not found there, it will look in the \fI.modulebuildrc\fR file in the directories referred to by the environment variables \f(CW\*(C`HOMEDRIVE\*(C'\fR + \f(CW\*(C`HOMEDIR\*(C'\fR, \f(CW\*(C`USERPROFILE\*(C'\fR, \&\f(CW\*(C`APPDATA\*(C'\fR, \f(CW\*(C`WINDIR\*(C'\fR, \f(CW\*(C`SYS$LOGIN\*(C'\fR. If the file exists, the options specified there will be used as defaults, as if they were typed on the command line. The defaults can be overridden by specifying new values on the command line. .PP The action name must come at the beginning of the line, followed by any amount of whitespace and then the options. Options are given the same as they would be on the command line. They can be separated by any amount of whitespace, including newlines, as long there is whitespace at the beginning of each continued line. Anything following a hash mark (\f(CW\*(C`#\*(C'\fR) is considered a comment, and is stripped before parsing. If more than one line begins with the same action name, those lines are merged into one set of options. .PP Besides the regular actions, there are two special pseudo-actions: the key \f(CW\*(C`*\*(C'\fR (asterisk) denotes any global options that should be applied to all actions, and the key 'Build_PL' specifies options to be applied when you invoke \f(CW\*(C`perl Build.PL\*(C'\fR. .PP .Vb 5 \& * verbose=1 # global options \& diff flags=\-u \& install \-\-install_base /home/ken \& \-\-install_path html=/home/ken/docs/html \& installdeps \-\-cpan_client \*(Aqcpanp \-i\*(Aq .Ve .PP If you wish to locate your resource file in a different location, you can set the environment variable \f(CW\*(C`MODULEBUILDRC\*(C'\fR to the complete absolute path of the file containing your options. .SS "Environment variables" .IX Subsection "Environment variables" .IP "\s-1MODULEBUILDRC\s0" 4 .IX Item "MODULEBUILDRC" [version 0.28] .Sp Specifies an alternate location for a default options file as described above. .IP "\s-1PERL_MB_OPT\s0" 4 .IX Item "PERL_MB_OPT" [version 0.36] .Sp Command line options that are applied to Build.PL or any Build action. The string is split as the shell would (e.g. whitespace) and the result is prepended to any actual command-line arguments. .SH "INSTALL PATHS" .IX Header "INSTALL PATHS" [version 0.19] .PP When you invoke Module::Build's \f(CW\*(C`build\*(C'\fR action, it needs to figure out where to install things. The nutshell version of how this works is that default installation locations are determined from \&\fIConfig.pm\fR, and they may be overridden by using the \f(CW\*(C`install_path\*(C'\fR parameter. An \f(CW\*(C`install_base\*(C'\fR parameter lets you specify an alternative installation root like \fI/home/foo\fR, and a \f(CW\*(C`destdir\*(C'\fR lets you specify a temporary installation directory like \fI/tmp/install\fR in case you want to create bundled-up installable packages. .PP Natively, Module::Build provides default installation locations for the following types of installable items: .IP "lib" 4 .IX Item "lib" Usually pure-Perl module files ending in \fI.pm\fR. .IP "arch" 4 .IX Item "arch" \&\*(L"Architecture-dependent\*(R" module files, usually produced by compiling \&\s-1XS, \s0Inline, or similar code. .IP "script" 4 .IX Item "script" Programs written in pure Perl. In order to improve reuse, try to make these as small as possible \- put the code into modules whenever possible. .IP "bin" 4 .IX Item "bin" \&\*(L"Architecture-dependent\*(R" executable programs, i.e. compiled C code or something. Pretty rare to see this in a perl distribution, but it happens. .IP "bindoc" 4 .IX Item "bindoc" Documentation for the stuff in \f(CW\*(C`script\*(C'\fR and \f(CW\*(C`bin\*(C'\fR. Usually generated from the \s-1POD\s0 in those files. Under Unix, these are manual pages belonging to the 'man1' category. .IP "libdoc" 4 .IX Item "libdoc" Documentation for the stuff in \f(CW\*(C`lib\*(C'\fR and \f(CW\*(C`arch\*(C'\fR. This is usually generated from the \s-1POD\s0 in \fI.pm\fR files. Under Unix, these are manual pages belonging to the 'man3' category. .IP "binhtml" 4 .IX Item "binhtml" This is the same as \f(CW\*(C`bindoc\*(C'\fR above, but applies to \s-1HTML\s0 documents. .IP "libhtml" 4 .IX Item "libhtml" This is the same as \f(CW\*(C`libdoc\*(C'\fR above, but applies to \s-1HTML\s0 documents. .PP Four other parameters let you control various aspects of how installation paths are determined: .IP "installdirs" 4 .IX Item "installdirs" The default destinations for these installable things come from entries in your system's \f(CW\*(C`Config.pm\*(C'\fR. You can select from three different sets of default locations by setting the \f(CW\*(C`installdirs\*(C'\fR parameter as follows: .Sp .Vb 2 \& \*(Aqinstalldirs\*(Aq set to: \& core site vendor \& \& uses the following defaults from Config.pm: \& \& lib => installprivlib installsitelib installvendorlib \& arch => installarchlib installsitearch installvendorarch \& script => installscript installsitescript installvendorscript \& bin => installbin installsitebin installvendorbin \& bindoc => installman1dir installsiteman1dir installvendorman1dir \& libdoc => installman3dir installsiteman3dir installvendorman3dir \& binhtml => installhtml1dir installsitehtml1dir installvendorhtml1dir [*] \& libhtml => installhtml3dir installsitehtml3dir installvendorhtml3dir [*] \& \& * Under some OS (eg. MSWin32) the destination for HTML documents is \& determined by the C entry C. .Ve .Sp The default value of \f(CW\*(C`installdirs\*(C'\fR is \*(L"site\*(R". If you're creating vendor distributions of module packages, you may want to do something like this: .Sp .Vb 1 \& perl Build.PL \-\-installdirs vendor .Ve .Sp or .Sp .Vb 1 \& ./Build install \-\-installdirs vendor .Ve .Sp If you're installing an updated version of a module that was included with perl itself (i.e. a \*(L"core module\*(R"), then you may set \&\f(CW\*(C`installdirs\*(C'\fR to \*(L"core\*(R" to overwrite the module in its present location. .Sp (Note that the 'script' line is different from \f(CW\*(C`MakeMaker\*(C'\fR \- unfortunately there's no such thing as \*(L"installsitescript\*(R" or \&\*(L"installvendorscript\*(R" entry in \f(CW\*(C`Config.pm\*(C'\fR, so we use the \&\*(L"installsitebin\*(R" and \*(L"installvendorbin\*(R" entries to at least get the general location right. In the future, if \f(CW\*(C`Config.pm\*(C'\fR adds some more appropriate entries, we'll start using those.) .IP "install_path" 4 .IX Item "install_path" Once the defaults have been set, you can override them. .Sp On the command line, that would look like this: .Sp .Vb 1 \& perl Build.PL \-\-install_path lib=/foo/lib \-\-install_path arch=/foo/lib/arch .Ve .Sp or this: .Sp .Vb 1 \& ./Build install \-\-install_path lib=/foo/lib \-\-install_path arch=/foo/lib/arch .Ve .IP "install_base" 4 .IX Item "install_base" You can also set the whole bunch of installation paths by supplying the \&\f(CW\*(C`install_base\*(C'\fR parameter to point to a directory on your system. For instance, if you set \f(CW\*(C`install_base\*(C'\fR to \*(L"/home/ken\*(R" on a Linux system, you'll install as follows: .Sp .Vb 8 \& lib => /home/ken/lib/perl5 \& arch => /home/ken/lib/perl5/i386\-linux \& script => /home/ken/bin \& bin => /home/ken/bin \& bindoc => /home/ken/man/man1 \& libdoc => /home/ken/man/man3 \& binhtml => /home/ken/html \& libhtml => /home/ken/html .Ve .Sp Note that this is \fIdifferent\fR from how \f(CW\*(C`MakeMaker\*(C'\fR's \f(CW\*(C`PREFIX\*(C'\fR parameter works. \f(CW\*(C`install_base\*(C'\fR just gives you a default layout under the directory you specify, which may have little to do with the \&\f(CW\*(C`installdirs=site\*(C'\fR layout. .Sp The exact layout under the directory you specify may vary by system \- we try to do the \*(L"sensible\*(R" thing on each platform. .IP "destdir" 4 .IX Item "destdir" If you want to install everything into a temporary directory first (for instance, if you want to create a directory tree that a package manager like \f(CW\*(C`rpm\*(C'\fR or \f(CW\*(C`dpkg\*(C'\fR could create a package from), you can use the \f(CW\*(C`destdir\*(C'\fR parameter: .Sp .Vb 1 \& perl Build.PL \-\-destdir /tmp/foo .Ve .Sp or .Sp .Vb 1 \& ./Build install \-\-destdir /tmp/foo .Ve .Sp This will effectively install to \*(L"/tmp/foo/$sitelib\*(R", \&\*(L"/tmp/foo/$sitearch\*(R", and the like, except that it will use \&\f(CW\*(C`File::Spec\*(C'\fR to make the pathnames work correctly on whatever platform you're installing on. .IP "prefix" 4 .IX Item "prefix" Provided for compatibility with \f(CW\*(C`ExtUtils::MakeMaker\*(C'\fR's \s-1PREFIX\s0 argument. \&\f(CW\*(C`prefix\*(C'\fR should be used when you want Module::Build to install your modules, documentation, and scripts in the same place as \&\f(CW\*(C`ExtUtils::MakeMaker\*(C'\fR's \s-1PREFIX\s0 mechanism. .Sp The following are equivalent. .Sp .Vb 2 \& perl Build.PL \-\-prefix /tmp/foo \& perl Makefile.PL PREFIX=/tmp/foo .Ve .Sp Because of the complex nature of the prefixification logic, the behavior of \s-1PREFIX\s0 in \f(CW\*(C`MakeMaker\*(C'\fR has changed subtly over time. Module::Build's \-\-prefix logic is equivalent to the \s-1PREFIX\s0 logic found in \f(CW\*(C`ExtUtils::MakeMaker\*(C'\fR 6.30. .Sp The maintainers of \f(CW\*(C`MakeMaker\*(C'\fR do understand the troubles with the \&\s-1PREFIX\s0 mechanism, and added \s-1INSTALL_BASE\s0 support in version 6.31 of \&\f(CW\*(C`MakeMaker\*(C'\fR, which was released in 2006. .Sp If you don't need to retain compatibility with old versions (pre\-6.31) of \f(CW\*(C`ExtUtils::MakeMaker\*(C'\fR or are starting a fresh Perl installation we recommend you use \&\f(CW\*(C`install_base\*(C'\fR instead (and \f(CW\*(C`INSTALL_BASE\*(C'\fR in \f(CW\*(C`ExtUtils::MakeMaker\*(C'\fR). See \*(L"Installing in the same location as ExtUtils::MakeMaker\*(R" in Module::Build::Cookbook for further information. .SH "MOTIVATIONS" .IX Header "MOTIVATIONS" There are several reasons I wanted to start over, and not just fix what I didn't like about \f(CW\*(C`MakeMaker\*(C'\fR: .IP "\(bu" 4 I don't like the core idea of \f(CW\*(C`MakeMaker\*(C'\fR, namely that \f(CW\*(C`make\*(C'\fR should be involved in the build process. Here are my reasons: .RS 4 .IP "+" 4 When a person is installing a Perl module, what can you assume about their environment? Can you assume they have \f(CW\*(C`make\*(C'\fR? No, but you can assume they have some version of Perl. .IP "+" 4 When a person is writing a Perl module for intended distribution, can you assume that they know how to build a Makefile, so they can customize their build process? No, but you can assume they know Perl, and could customize that way. .RE .RS 4 .Sp For years, these things have been a barrier to people getting the build/install process to do what they want. .RE .IP "\(bu" 4 There are several architectural decisions in \f(CW\*(C`MakeMaker\*(C'\fR that make it very difficult to customize its behavior. For instance, when using \&\f(CW\*(C`MakeMaker\*(C'\fR you do \f(CW\*(C`use ExtUtils::MakeMaker\*(C'\fR, but the object created in \&\f(CW\*(C`WriteMakefile()\*(C'\fR is actually blessed into a package name that's created on the fly, so you can't simply subclass \&\f(CW\*(C`ExtUtils::MakeMaker\*(C'\fR. There is a workaround \f(CW\*(C`MY\*(C'\fR package that lets you override certain \f(CW\*(C`MakeMaker\*(C'\fR methods, but only certain explicitly preselected (by \f(CW\*(C`MakeMaker\*(C'\fR) methods can be overridden. Also, the method of customization is very crude: you have to modify a string containing the Makefile text for the particular target. Since these strings aren't documented, and \fIcan't\fR be documented (they take on different values depending on the platform, version of perl, version of \&\f(CW\*(C`MakeMaker\*(C'\fR, etc.), you have no guarantee that your modifications will work on someone else's machine or after an upgrade of \f(CW\*(C`MakeMaker\*(C'\fR or perl. .IP "\(bu" 4 It is risky to make major changes to \f(CW\*(C`MakeMaker\*(C'\fR, since it does so many things, is so important, and generally works. \f(CW\*(C`Module::Build\*(C'\fR is an entirely separate package so that I can work on it all I want, without worrying about backward compatibility with \f(CW\*(C`MakeMaker\*(C'\fR. .IP "\(bu" 4 Finally, Perl is said to be a language for system administration. Could it really be the case that Perl isn't up to the task of building and installing software? Even if that software is a bunch of \&\f(CW\*(C`.pm\*(C'\fR files that just need to be copied from one place to another? My sense was that we could design a system to accomplish this in a flexible, extensible, and friendly manner. Or die trying. .SH "TO DO" .IX Header "TO DO" The current method of relying on time stamps to determine whether a derived file is out of date isn't likely to scale well, since it requires tracing all dependencies backward, it runs into problems on \&\s-1NFS,\s0 and it's just generally flimsy. It would be better to use an \s-1MD5\s0 signature or the like, if available. See \f(CW\*(C`cons\*(C'\fR for an example. .PP .Vb 2 \& \- append to perllocal.pod \& \- add a \*(Aqplugin\*(Aq functionality .Ve .SH "AUTHOR" .IX Header "AUTHOR" Ken Williams .PP Development questions, bug reports, and patches should be sent to the Module-Build mailing list at . .PP Bug reports are also welcome at . .PP The latest development version is available from the Git repository at .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright (c) 2001\-2006 Ken Williams. All rights reserved. .PP This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fIperl\fR\|(1), Module::Build::Cookbook, Module::Build::Authoring, Module::Build::API, ExtUtils::MakeMaker .PP \&\fI\s-1META\s0.yml\fR Specification: CPAN::Meta::Spec .PP .PP