/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/Test::More.3pm (43215B)
.\" 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 .\" ======================================================================== .\" .IX Title "Test::More 3" .TH Test::More 3 "2016-10-20" "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" Test::More \- yet another framework for writing test scripts .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 5 \& use Test::More tests => 23; \& # or \& use Test::More skip_all => $reason; \& # or \& use Test::More; # see done_testing() \& \& require_ok( \*(AqSome::Module\*(Aq ); \& \& # Various ways to say "ok" \& ok($got eq $expected, $test_name); \& \& is ($got, $expected, $test_name); \& isnt($got, $expected, $test_name); \& \& # Rather than print STDERR "# here\*(Aqs what went wrong\en" \& diag("here\*(Aqs what went wrong"); \& \& like ($got, qr/expected/, $test_name); \& unlike($got, qr/expected/, $test_name); \& \& cmp_ok($got, \*(Aq==\*(Aq, $expected, $test_name); \& \& is_deeply($got_complex_structure, $expected_complex_structure, $test_name); \& \& SKIP: { \& skip $why, $how_many unless $have_some_feature; \& \& ok( foo(), $test_name ); \& is( foo(42), 23, $test_name ); \& }; \& \& TODO: { \& local $TODO = $why; \& \& ok( foo(), $test_name ); \& is( foo(42), 23, $test_name ); \& }; \& \& can_ok($module, @methods); \& isa_ok($object, $class); \& \& pass($test_name); \& fail($test_name); \& \& BAIL_OUT($why); \& \& # UNIMPLEMENTED!!! \& my @status = Test::More::status; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fB\s-1STOP\s0!\fR If you're just getting started writing tests, have a look at Test::Simple first. This is a drop in replacement for Test::Simple which you can switch to once you get the hang of basic testing. .PP The purpose of this module is to provide a wide range of testing utilities. Various ways to say \*(L"ok\*(R" with better diagnostics, facilities to skip tests, test future features and compare complicated data structures. While you can do almost anything with a simple \&\f(CW\*(C`ok()\*(C'\fR function, it doesn't provide good diagnostic output. .SS "I love it when a plan comes together" .IX Subsection "I love it when a plan comes together" Before anything else, you need a testing plan. This basically declares how many tests your script is going to run to protect against premature failure. .PP The preferred way to do this is to declare a plan when you \f(CW\*(C`use Test::More\*(C'\fR. .PP .Vb 1 \& use Test::More tests => 23; .Ve .PP There are cases when you will not know beforehand how many tests your script is going to run. In this case, you can declare your tests at the end. .PP .Vb 1 \& use Test::More; \& \& ... run your tests ... \& \& done_testing( $number_of_tests_run ); .Ve .PP \&\fB\s-1NOTE\s0\fR \f(CW\*(C`done_testing()\*(C'\fR should never be called in an \f(CW\*(C`END { ... }\*(C'\fR block. .PP Sometimes you really don't know how many tests were run, or it's too difficult to calculate. In which case you can leave off \&\f(CW$number_of_tests_run\fR. .PP In some cases, you'll want to completely skip an entire testing script. .PP .Vb 1 \& use Test::More skip_all => $skip_reason; .Ve .PP Your script will declare a skip with the reason why you skipped and exit immediately with a zero (success). See Test::Harness for details. .PP If you want to control what functions Test::More will export, you have to use the 'import' option. For example, to import everything but 'fail', you'd do: .PP .Vb 1 \& use Test::More tests => 23, import => [\*(Aq!fail\*(Aq]; .Ve .PP Alternatively, you can use the \f(CW\*(C`plan()\*(C'\fR function. Useful for when you have to calculate the number of tests. .PP .Vb 2 \& use Test::More; \& plan tests => keys %Stuff * 3; .Ve .PP or for deciding between running the tests at all: .PP .Vb 7 \& use Test::More; \& if( $^O eq \*(AqMacOS\*(Aq ) { \& plan skip_all => \*(AqTest irrelevant on MacOS\*(Aq; \& } \& else { \& plan tests => 42; \& } .Ve .IP "\fBdone_testing\fR" 4 .IX Item "done_testing" .Vb 2 \& done_testing(); \& done_testing($number_of_tests); .Ve .Sp If you don't know how many tests you're going to run, you can issue the plan when you're done running tests. .Sp \&\f(CW$number_of_tests\fR is the same as \f(CW\*(C`plan()\*(C'\fR, it's the number of tests you expected to run. You can omit this, in which case the number of tests you ran doesn't matter, just the fact that your tests ran to conclusion. .Sp This is safer than and replaces the \*(L"no_plan\*(R" plan. .Sp \&\fBNote:\fR You must never put \f(CW\*(C`done_testing()\*(C'\fR inside an \f(CW\*(C`END { ... }\*(C'\fR block. The plan is there to ensure your test does not exit before testing has completed. If you use an \s-1END\s0 block you completely bypass this protection. .SS "Test names" .IX Subsection "Test names" By convention, each test is assigned a number in order. This is largely done automatically for you. However, it's often very useful to assign a name to each test. Which would you rather see: .PP .Vb 3 \& ok 4 \& not ok 5 \& ok 6 .Ve .PP or .PP .Vb 3 \& ok 4 \- basic multi\-variable \& not ok 5 \- simple exponential \& ok 6 \- force == mass * acceleration .Ve .PP The later gives you some idea of what failed. It also makes it easier to find the test in your script, simply search for \*(L"simple exponential\*(R". .PP All test functions take a name argument. It's optional, but highly suggested that you use it. .SS "I'm ok, you're not ok." .IX Subsection "I'm ok, you're not ok." The basic purpose of this module is to print out either \*(L"ok #\*(R" or \*(L"not ok #\*(R" depending on if a given test succeeded or failed. Everything else is just gravy. .PP All of the following print \*(L"ok\*(R" or \*(L"not ok\*(R" depending on if the test succeeded or failed. They all also return true or false, respectively. .IP "\fBok\fR" 4 .IX Item "ok" .Vb 1 \& ok($got eq $expected, $test_name); .Ve .Sp This simply evaluates any expression (\f(CW\*(C`$got eq $expected\*(C'\fR is just a simple example) and uses that to determine if the test succeeded or failed. A true expression passes, a false one fails. Very simple. .Sp For example: .Sp .Vb 4 \& ok( $exp{9} == 81, \*(Aqsimple exponential\*(Aq ); \& ok( Film\->can(\*(Aqdb_Main\*(Aq), \*(Aqset_db()\*(Aq ); \& ok( $p\->tests == 4, \*(Aqsaw tests\*(Aq ); \& ok( !grep(!defined $_, @items), \*(Aqall items defined\*(Aq ); .Ve .Sp (Mnemonic: \*(L"This is ok.\*(R") .Sp \&\f(CW$test_name\fR is a very short description of the test that will be printed out. It makes it very easy to find a test in your script when it fails and gives others an idea of your intentions. \f(CW$test_name\fR is optional, but we \fBvery\fR strongly encourage its use. .Sp Should an \f(CW\*(C`ok()\*(C'\fR fail, it will produce some diagnostics: .Sp .Vb 3 \& not ok 18 \- sufficient mucus \& # Failed test \*(Aqsufficient mucus\*(Aq \& # in foo.t at line 42. .Ve .Sp This is the same as Test::Simple's \f(CW\*(C`ok()\*(C'\fR routine. .IP "\fBis\fR" 4 .IX Item "is" .PD 0 .IP "\fBisnt\fR" 4 .IX Item "isnt" .PD .Vb 2 \& is ( $got, $expected, $test_name ); \& isnt( $got, $expected, $test_name ); .Ve .Sp Similar to \f(CW\*(C`ok()\*(C'\fR, \f(CW\*(C`is()\*(C'\fR and \f(CW\*(C`isnt()\*(C'\fR compare their two arguments with \f(CW\*(C`eq\*(C'\fR and \f(CW\*(C`ne\*(C'\fR respectively and use the result of that to determine if the test succeeded or failed. So these: .Sp .Vb 2 \& # Is the ultimate answer 42? \& is( ultimate_answer(), 42, "Meaning of Life" ); \& \& # $foo isn\*(Aqt empty \& isnt( $foo, \*(Aq\*(Aq, "Got some foo" ); .Ve .Sp are similar to these: .Sp .Vb 2 \& ok( ultimate_answer() eq 42, "Meaning of Life" ); \& ok( $foo ne \*(Aq\*(Aq, "Got some foo" ); .Ve .Sp \&\f(CW\*(C`undef\*(C'\fR will only ever match \f(CW\*(C`undef\*(C'\fR. So you can test a value against \f(CW\*(C`undef\*(C'\fR like this: .Sp .Vb 1 \& is($not_defined, undef, "undefined as expected"); .Ve .Sp (Mnemonic: \*(L"This is that.\*(R" \*(L"This isn't that.\*(R") .Sp So why use these? They produce better diagnostics on failure. \f(CW\*(C`ok()\*(C'\fR cannot know what you are testing for (beyond the name), but \f(CW\*(C`is()\*(C'\fR and \&\f(CW\*(C`isnt()\*(C'\fR know what the test was and why it failed. For example this test: .Sp .Vb 2 \& my $foo = \*(Aqwaffle\*(Aq; my $bar = \*(Aqyarblokos\*(Aq; \& is( $foo, $bar, \*(AqIs foo the same as bar?\*(Aq ); .Ve .Sp Will produce something like this: .Sp .Vb 5 \& not ok 17 \- Is foo the same as bar? \& # Failed test \*(AqIs foo the same as bar?\*(Aq \& # in foo.t at line 139. \& # got: \*(Aqwaffle\*(Aq \& # expected: \*(Aqyarblokos\*(Aq .Ve .Sp So you can figure out what went wrong without rerunning the test. .Sp You are encouraged to use \f(CW\*(C`is()\*(C'\fR and \f(CW\*(C`isnt()\*(C'\fR over \f(CW\*(C`ok()\*(C'\fR where possible, however do not be tempted to use them to find out if something is true or false! .Sp .Vb 2 \& # XXX BAD! \& is( exists $brooklyn{tree}, 1, \*(AqA tree grows in Brooklyn\*(Aq ); .Ve .Sp This does not check if \f(CW\*(C`exists $brooklyn{tree}\*(C'\fR is true, it checks if it returns 1. Very different. Similar caveats exist for false and 0. In these cases, use \f(CW\*(C`ok()\*(C'\fR. .Sp .Vb 1 \& ok( exists $brooklyn{tree}, \*(AqA tree grows in Brooklyn\*(Aq ); .Ve .Sp A simple call to \f(CW\*(C`isnt()\*(C'\fR usually does not provide a strong test but there are cases when you cannot say much more about a value than that it is different from some other value: .Sp .Vb 1 \& new_ok $obj, "Foo"; \& \& my $clone = $obj\->clone; \& isa_ok $obj, "Foo", "Foo\->clone"; \& \& isnt $obj, $clone, "clone() produces a different object"; .Ve .Sp For those grammatical pedants out there, there's an \f(CW\*(C`isn\*(Aqt()\*(C'\fR function which is an alias of \f(CW\*(C`isnt()\*(C'\fR. .IP "\fBlike\fR" 4 .IX Item "like" .Vb 1 \& like( $got, qr/expected/, $test_name ); .Ve .Sp Similar to \f(CW\*(C`ok()\*(C'\fR, \f(CW\*(C`like()\*(C'\fR matches \f(CW$got\fR against the regex \f(CW\*(C`qr/expected/\*(C'\fR. .Sp So this: .Sp .Vb 1 \& like($got, qr/expected/, \*(Aqthis is like that\*(Aq); .Ve .Sp is similar to: .Sp .Vb 1 \& ok( $got =~ m/expected/, \*(Aqthis is like that\*(Aq); .Ve .Sp (Mnemonic \*(L"This is like that\*(R".) .Sp The second argument is a regular expression. It may be given as a regex reference (i.e. \f(CW\*(C`qr//\*(C'\fR) or (for better compatibility with older perls) as a string that looks like a regex (alternative delimiters are currently not supported): .Sp .Vb 1 \& like( $got, \*(Aq/expected/\*(Aq, \*(Aqthis is like that\*(Aq ); .Ve .Sp Regex options may be placed on the end (\f(CW\*(Aq/expected/i\*(Aq\fR). .Sp Its advantages over \f(CW\*(C`ok()\*(C'\fR are similar to that of \f(CW\*(C`is()\*(C'\fR and \f(CW\*(C`isnt()\*(C'\fR. Better diagnostics on failure. .IP "\fBunlike\fR" 4 .IX Item "unlike" .Vb 1 \& unlike( $got, qr/expected/, $test_name ); .Ve .Sp Works exactly as \f(CW\*(C`like()\*(C'\fR, only it checks if \f(CW$got\fR \fBdoes not\fR match the given pattern. .IP "\fBcmp_ok\fR" 4 .IX Item "cmp_ok" .Vb 1 \& cmp_ok( $got, $op, $expected, $test_name ); .Ve .Sp Halfway between \f(CW\*(C`ok()\*(C'\fR and \f(CW\*(C`is()\*(C'\fR lies \f(CW\*(C`cmp_ok()\*(C'\fR. This allows you to compare two arguments using any binary perl operator. The test passes if the comparison is true and fails otherwise. .Sp .Vb 2 \& # ok( $got eq $expected ); \& cmp_ok( $got, \*(Aqeq\*(Aq, $expected, \*(Aqthis eq that\*(Aq ); \& \& # ok( $got == $expected ); \& cmp_ok( $got, \*(Aq==\*(Aq, $expected, \*(Aqthis == that\*(Aq ); \& \& # ok( $got && $expected ); \& cmp_ok( $got, \*(Aq&&\*(Aq, $expected, \*(Aqthis && that\*(Aq ); \& ...etc... .Ve .Sp Its advantage over \f(CW\*(C`ok()\*(C'\fR is when the test fails you'll know what \f(CW$got\fR and \f(CW$expected\fR were: .Sp .Vb 5 \& not ok 1 \& # Failed test in foo.t at line 12. \& # \*(Aq23\*(Aq \& # && \& # undef .Ve .Sp It's also useful in those cases where you are comparing numbers and \&\f(CW\*(C`is()\*(C'\fR's use of \f(CW\*(C`eq\*(C'\fR will interfere: .Sp .Vb 1 \& cmp_ok( $big_hairy_number, \*(Aq==\*(Aq, $another_big_hairy_number ); .Ve .Sp It's especially useful when comparing greater-than or smaller-than relation between values: .Sp .Vb 1 \& cmp_ok( $some_value, \*(Aq<=\*(Aq, $upper_limit ); .Ve .IP "\fBcan_ok\fR" 4 .IX Item "can_ok" .Vb 2 \& can_ok($module, @methods); \& can_ok($object, @methods); .Ve .Sp Checks to make sure the \f(CW$module\fR or \f(CW$object\fR can do these \f(CW@methods\fR (works with functions, too). .Sp .Vb 1 \& can_ok(\*(AqFoo\*(Aq, qw(this that whatever)); .Ve .Sp is almost exactly like saying: .Sp .Vb 4 \& ok( Foo\->can(\*(Aqthis\*(Aq) && \& Foo\->can(\*(Aqthat\*(Aq) && \& Foo\->can(\*(Aqwhatever\*(Aq) \& ); .Ve .Sp only without all the typing and with a better interface. Handy for quickly testing an interface. .Sp No matter how many \f(CW@methods\fR you check, a single \f(CW\*(C`can_ok()\*(C'\fR call counts as one test. If you desire otherwise, use: .Sp .Vb 3 \& foreach my $meth (@methods) { \& can_ok(\*(AqFoo\*(Aq, $meth); \& } .Ve .IP "\fBisa_ok\fR" 4 .IX Item "isa_ok" .Vb 3 \& isa_ok($object, $class, $object_name); \& isa_ok($subclass, $class, $object_name); \& isa_ok($ref, $type, $ref_name); .Ve .Sp Checks to see if the given \f(CW\*(C`$object\->isa($class)\*(C'\fR. Also checks to make sure the object was defined in the first place. Handy for this sort of thing: .Sp .Vb 2 \& my $obj = Some::Module\->new; \& isa_ok( $obj, \*(AqSome::Module\*(Aq ); .Ve .Sp where you'd otherwise have to write .Sp .Vb 2 \& my $obj = Some::Module\->new; \& ok( defined $obj && $obj\->isa(\*(AqSome::Module\*(Aq) ); .Ve .Sp to safeguard against your test script blowing up. .Sp You can also test a class, to make sure that it has the right ancestor: .Sp .Vb 1 \& isa_ok( \*(AqVole\*(Aq, \*(AqRodent\*(Aq ); .Ve .Sp It works on references, too: .Sp .Vb 1 \& isa_ok( $array_ref, \*(AqARRAY\*(Aq ); .Ve .Sp The diagnostics of this test normally just refer to 'the object'. If you'd like them to be more specific, you can supply an \f(CW$object_name\fR (for example 'Test customer'). .IP "\fBnew_ok\fR" 4 .IX Item "new_ok" .Vb 3 \& my $obj = new_ok( $class ); \& my $obj = new_ok( $class => \e@args ); \& my $obj = new_ok( $class => \e@args, $object_name ); .Ve .Sp A convenience function which combines creating an object and calling \&\f(CW\*(C`isa_ok()\*(C'\fR on that object. .Sp It is basically equivalent to: .Sp .Vb 2 \& my $obj = $class\->new(@args); \& isa_ok $obj, $class, $object_name; .Ve .Sp If \f(CW@args\fR is not given, an empty list will be used. .Sp This function only works on \f(CW\*(C`new()\*(C'\fR and it assumes \f(CW\*(C`new()\*(C'\fR will return just a single object which isa \f(CW$class\fR. .IP "\fBsubtest\fR" 4 .IX Item "subtest" .Vb 1 \& subtest $name => \e&code, @args; .Ve .Sp \&\f(CW\*(C`subtest()\*(C'\fR runs the &code as its own little test with its own plan and its own result. The main test counts this as a single test using the result of the whole subtest to determine if its ok or not ok. .Sp For example... .Sp .Vb 1 \& use Test::More tests => 3; \& \& pass("First test"); \& \& subtest \*(AqAn example subtest\*(Aq => sub { \& plan tests => 2; \& \& pass("This is a subtest"); \& pass("So is this"); \& }; \& \& pass("Third test"); .Ve .Sp This would produce. .Sp .Vb 8 \& 1..3 \& ok 1 \- First test \& # Subtest: An example subtest \& 1..2 \& ok 1 \- This is a subtest \& ok 2 \- So is this \& ok 2 \- An example subtest \& ok 3 \- Third test .Ve .Sp A subtest may call \f(CW\*(C`skip_all\*(C'\fR. No tests will be run, but the subtest is considered a skip. .Sp .Vb 4 \& subtest \*(Aqskippy\*(Aq => sub { \& plan skip_all => \*(Aqcuz I said so\*(Aq; \& pass(\*(Aqthis test will never be run\*(Aq); \& }; .Ve .Sp Returns true if the subtest passed, false otherwise. .Sp Due to how subtests work, you may omit a plan if you desire. This adds an implicit \f(CW\*(C`done_testing()\*(C'\fR to the end of your subtest. The following two subtests are equivalent: .Sp .Vb 5 \& subtest \*(Aqsubtest with implicit done_testing()\*(Aq, sub { \& ok 1, \*(Aqsubtests with an implicit done testing should work\*(Aq; \& ok 1, \*(Aq... and support more than one test\*(Aq; \& ok 1, \*(Aq... no matter how many tests are run\*(Aq; \& }; \& \& subtest \*(Aqsubtest with explicit done_testing()\*(Aq, sub { \& ok 1, \*(Aqsubtests with an explicit done testing should work\*(Aq; \& ok 1, \*(Aq... and support more than one test\*(Aq; \& ok 1, \*(Aq... no matter how many tests are run\*(Aq; \& done_testing(); \& }; .Ve .Sp Extra arguments given to \f(CW\*(C`subtest\*(C'\fR are passed to the callback. For example: .Sp .Vb 4 \& sub my_subtest { \& my $range = shift; \& ... \& } \& \& for my $range (1, 10, 100, 1000) { \& subtest "testing range $range", \e&my_subtest, $range; \& } .Ve .IP "\fBpass\fR" 4 .IX Item "pass" .PD 0 .IP "\fBfail\fR" 4 .IX Item "fail" .PD .Vb 2 \& pass($test_name); \& fail($test_name); .Ve .Sp Sometimes you just want to say that the tests have passed. Usually the case is you've got some complicated condition that is difficult to wedge into an \f(CW\*(C`ok()\*(C'\fR. In this case, you can simply use \f(CW\*(C`pass()\*(C'\fR (to declare the test ok) or fail (for not ok). They are synonyms for \&\f(CWok(1)\fR and \f(CWok(0)\fR. .Sp Use these very, very, very sparingly. .SS "Module tests" .IX Subsection "Module tests" Sometimes you want to test if a module, or a list of modules, can successfully load. For example, you'll often want a first test which simply loads all the modules in the distribution to make sure they work before going on to do more complicated testing. .PP For such purposes we have \f(CW\*(C`use_ok\*(C'\fR and \f(CW\*(C`require_ok\*(C'\fR. .IP "\fBrequire_ok\fR" 4 .IX Item "require_ok" .Vb 2 \& require_ok($module); \& require_ok($file); .Ve .Sp Tries to \f(CW\*(C`require\*(C'\fR the given \f(CW$module\fR or \f(CW$file\fR. If it loads successfully, the test will pass. Otherwise it fails and displays the load error. .Sp \&\f(CW\*(C`require_ok\*(C'\fR will guess whether the input is a module name or a filename. .Sp No exception will be thrown if the load fails. .Sp .Vb 2 \& # require Some::Module \& require_ok "Some::Module"; \& \& # require "Some/File.pl"; \& require_ok "Some/File.pl"; \& \& # stop testing if any of your modules will not load \& for my $module (@module) { \& require_ok $module or BAIL_OUT "Can\*(Aqt load $module"; \& } .Ve .IP "\fBuse_ok\fR" 4 .IX Item "use_ok" .Vb 2 \& BEGIN { use_ok($module); } \& BEGIN { use_ok($module, @imports); } .Ve .Sp Like \f(CW\*(C`require_ok\*(C'\fR, but it will \f(CW\*(C`use\*(C'\fR the \f(CW$module\fR in question and only loads modules, not files. .Sp If you just want to test a module can be loaded, use \f(CW\*(C`require_ok\*(C'\fR. .Sp If you just want to load a module in a test, we recommend simply using \&\f(CW\*(C`use\*(C'\fR directly. It will cause the test to stop. .Sp It's recommended that you run \f(CW\*(C`use_ok()\*(C'\fR inside a \s-1BEGIN\s0 block so its functions are exported at compile-time and prototypes are properly honored. .Sp If \f(CW@imports\fR are given, they are passed through to the use. So this: .Sp .Vb 1 \& BEGIN { use_ok(\*(AqSome::Module\*(Aq, qw(foo bar)) } .Ve .Sp is like doing this: .Sp .Vb 1 \& use Some::Module qw(foo bar); .Ve .Sp Version numbers can be checked like so: .Sp .Vb 2 \& # Just like "use Some::Module 1.02" \& BEGIN { use_ok(\*(AqSome::Module\*(Aq, 1.02) } .Ve .Sp Don't try to do this: .Sp .Vb 2 \& BEGIN { \& use_ok(\*(AqSome::Module\*(Aq); \& \& ...some code that depends on the use... \& ...happening at compile time... \& } .Ve .Sp because the notion of \*(L"compile-time\*(R" is relative. Instead, you want: .Sp .Vb 2 \& BEGIN { use_ok(\*(AqSome::Module\*(Aq) } \& BEGIN { ...some code that depends on the use... } .Ve .Sp If you want the equivalent of \f(CW\*(C`use Foo ()\*(C'\fR, use a module but not import anything, use \f(CW\*(C`require_ok\*(C'\fR. .Sp .Vb 1 \& BEGIN { require_ok "Foo" } .Ve .SS "Complex data structures" .IX Subsection "Complex data structures" Not everything is a simple eq check or regex. There are times you need to see if two data structures are equivalent. For these instances Test::More provides a handful of useful functions. .PP \&\fB\s-1NOTE\s0\fR I'm not quite sure what will happen with filehandles. .IP "\fBis_deeply\fR" 4 .IX Item "is_deeply" .Vb 1 \& is_deeply( $got, $expected, $test_name ); .Ve .Sp Similar to \f(CW\*(C`is()\*(C'\fR, except that if \f(CW$got\fR and \f(CW$expected\fR are references, it does a deep comparison walking each data structure to see if they are equivalent. If the two structures are different, it will display the place where they start differing. .Sp \&\f(CW\*(C`is_deeply()\*(C'\fR compares the dereferenced values of references, the references themselves (except for their type) are ignored. This means aspects such as blessing and ties are not considered \*(L"different\*(R". .Sp \&\f(CW\*(C`is_deeply()\*(C'\fR currently has very limited handling of function reference and globs. It merely checks if they have the same referent. This may improve in the future. .Sp Test::Differences and Test::Deep provide more in-depth functionality along these lines. .Sp \&\fB\s-1NOTE\s0\fR \fIis_deeply()\fR has limitations when it comes to comparing strings and refs: .Sp .Vb 4 \& my $path = path(\*(Aq.\*(Aq); \& my $hash = {}; \& is_deeply( $path, "$path" ); # ok \& is_deeply( $hash, "$hash" ); # fail .Ve .Sp This happens because is_deeply will unoverload all arguments unconditionally. It is probably best not to use is_deeply with overloading. For legacy reasons this is not likely to ever be fixed. If you would like a much better tool for this you should see Test2::Suite Specifically Test2::Tools::Compare has an \f(CW\*(C`is()\*(C'\fR function that works like \f(CW\*(C`is_deeply\*(C'\fR with many improvements. .SS "Diagnostics" .IX Subsection "Diagnostics" If you pick the right test function, you'll usually get a good idea of what went wrong when it failed. But sometimes it doesn't work out that way. So here we have ways for you to write your own diagnostic messages which are safer than just \f(CW\*(C`print STDERR\*(C'\fR. .IP "\fBdiag\fR" 4 .IX Item "diag" .Vb 1 \& diag(@diagnostic_message); .Ve .Sp Prints a diagnostic message which is guaranteed not to interfere with test output. Like \f(CW\*(C`print\*(C'\fR \f(CW@diagnostic_message\fR is simply concatenated together. .Sp Returns false, so as to preserve failure. .Sp Handy for this sort of thing: .Sp .Vb 2 \& ok( grep(/foo/, @users), "There\*(Aqs a foo user" ) or \& diag("Since there\*(Aqs no foo, check that /etc/bar is set up right"); .Ve .Sp which would produce: .Sp .Vb 4 \& not ok 42 \- There\*(Aqs a foo user \& # Failed test \*(AqThere\*(Aqs a foo user\*(Aq \& # in foo.t at line 52. \& # Since there\*(Aqs no foo, check that /etc/bar is set up right. .Ve .Sp You might remember \f(CW\*(C`ok() or diag()\*(C'\fR with the mnemonic \f(CW\*(C`open() or die()\*(C'\fR. .Sp \&\fB\s-1NOTE\s0\fR The exact formatting of the diagnostic output is still changing, but it is guaranteed that whatever you throw at it won't interfere with the test. .IP "\fBnote\fR" 4 .IX Item "note" .Vb 1 \& note(@diagnostic_message); .Ve .Sp Like \f(CW\*(C`diag()\*(C'\fR, except the message will not be seen when the test is run in a harness. It will only be visible in the verbose \s-1TAP\s0 stream. .Sp Handy for putting in notes which might be useful for debugging, but don't indicate a problem. .Sp .Vb 1 \& note("Tempfile is $tempfile"); .Ve .IP "\fBexplain\fR" 4 .IX Item "explain" .Vb 1 \& my @dump = explain @diagnostic_message; .Ve .Sp Will dump the contents of any references in a human readable format. Usually you want to pass this into \f(CW\*(C`note\*(C'\fR or \f(CW\*(C`diag\*(C'\fR. .Sp Handy for things like... .Sp .Vb 1 \& is_deeply($have, $want) || diag explain $have; .Ve .Sp or .Sp .Vb 2 \& note explain \e%args; \& Some::Class\->method(%args); .Ve .SS "Conditional tests" .IX Subsection "Conditional tests" Sometimes running a test under certain conditions will cause the test script to die. A certain function or method isn't implemented (such as \f(CW\*(C`fork()\*(C'\fR on MacOS), some resource isn't available (like a net connection) or a module isn't available. In these cases it's necessary to skip tests, or declare that they are supposed to fail but will work in the future (a todo test). .PP For more details on the mechanics of skip and todo tests see Test::Harness. .PP The way Test::More handles this is with a named block. Basically, a block of tests which can be skipped over or made todo. It's best if I just show you... .IP "\fB\s-1SKIP: BLOCK\s0\fR" 4 .IX Item "SKIP: BLOCK" .Vb 2 \& SKIP: { \& skip $why, $how_many if $condition; \& \& ...normal testing code goes here... \& } .Ve .Sp This declares a block of tests that might be skipped, \f(CW$how_many\fR tests there are, \f(CW$why\fR and under what \f(CW$condition\fR to skip them. An example is the easiest way to illustrate: .Sp .Vb 2 \& SKIP: { \& eval { require HTML::Lint }; \& \& skip "HTML::Lint not installed", 2 if $@; \& \& my $lint = new HTML::Lint; \& isa_ok( $lint, "HTML::Lint" ); \& \& $lint\->parse( $html ); \& is( $lint\->errors, 0, "No errors found in HTML" ); \& } .Ve .Sp If the user does not have HTML::Lint installed, the whole block of code \fIwon't be run at all\fR. Test::More will output special ok's which Test::Harness interprets as skipped, but passing, tests. .Sp It's important that \f(CW$how_many\fR accurately reflects the number of tests in the \s-1SKIP\s0 block so the # of tests run will match up with your plan. If your plan is \f(CW\*(C`no_plan\*(C'\fR \f(CW$how_many\fR is optional and will default to 1. .Sp It's perfectly safe to nest \s-1SKIP\s0 blocks. Each \s-1SKIP\s0 block must have the label \f(CW\*(C`SKIP\*(C'\fR, or Test::More can't work its magic. .Sp You don't skip tests which are failing because there's a bug in your program, or for which you don't yet have code written. For that you use \s-1TODO. \s0 Read on. .IP "\fB\s-1TODO: BLOCK\s0\fR" 4 .IX Item "TODO: BLOCK" .Vb 2 \& TODO: { \& local $TODO = $why if $condition; \& \& ...normal testing code goes here... \& } .Ve .Sp Declares a block of tests you expect to fail and \f(CW$why\fR. Perhaps it's because you haven't fixed a bug or haven't finished a new feature: .Sp .Vb 2 \& TODO: { \& local $TODO = "URI::Geller not finished"; \& \& my $card = "Eight of clubs"; \& is( URI::Geller\->your_card, $card, \*(AqIs THIS your card?\*(Aq ); \& \& my $spoon; \& URI::Geller\->bend_spoon; \& is( $spoon, \*(Aqbent\*(Aq, "Spoon bending, that\*(Aqs original" ); \& } .Ve .Sp With a todo block, the tests inside are expected to fail. Test::More will run the tests normally, but print out special flags indicating they are \*(L"todo\*(R". Test::Harness will interpret failures as being ok. Should anything succeed, it will report it as an unexpected success. You then know the thing you had todo is done and can remove the \&\s-1TODO\s0 flag. .Sp The nice part about todo tests, as opposed to simply commenting out a block of tests, is it's like having a programmatic todo list. You know how much work is left to be done, you're aware of what bugs there are, and you'll know immediately when they're fixed. .Sp Once a todo test starts succeeding, simply move it outside the block. When the block is empty, delete it. .IP "\fBtodo_skip\fR" 4 .IX Item "todo_skip" .Vb 2 \& TODO: { \& todo_skip $why, $how_many if $condition; \& \& ...normal testing code... \& } .Ve .Sp With todo tests, it's best to have the tests actually run. That way you'll know when they start passing. Sometimes this isn't possible. Often a failing test will cause the whole program to die or hang, even inside an \f(CW\*(C`eval BLOCK\*(C'\fR with and using \f(CW\*(C`alarm\*(C'\fR. In these extreme cases you have no choice but to skip over the broken tests entirely. .Sp The syntax and behavior is similar to a \f(CW\*(C`SKIP: BLOCK\*(C'\fR except the tests will be marked as failing but todo. Test::Harness will interpret them as passing. .IP "When do I use \s-1SKIP\s0 vs. \s-1TODO\s0?" 4 .IX Item "When do I use SKIP vs. TODO?" \&\fBIf it's something the user might not be able to do\fR, use \s-1SKIP.\s0 This includes optional modules that aren't installed, running under an \s-1OS\s0 that doesn't have some feature (like \f(CW\*(C`fork()\*(C'\fR or symlinks), or maybe you need an Internet connection and one isn't available. .Sp \&\fBIf it's something the programmer hasn't done yet\fR, use \s-1TODO. \s0 This is for any code you haven't written yet, or bugs you have yet to fix, but want to put tests in your testing script (always a good idea). .SS "Test control" .IX Subsection "Test control" .IP "\fB\s-1BAIL_OUT\s0\fR" 4 .IX Item "BAIL_OUT" .Vb 1 \& BAIL_OUT($reason); .Ve .Sp Indicates to the harness that things are going so badly all testing should terminate. This includes the running of any additional test scripts. .Sp This is typically used when testing cannot continue such as a critical module failing to compile or a necessary external utility not being available such as a database connection failing. .Sp The test will exit with 255. .Sp For even better control look at Test::Most. .SS "Discouraged comparison functions" .IX Subsection "Discouraged comparison functions" The use of the following functions is discouraged as they are not actually testing functions and produce no diagnostics to help figure out what went wrong. They were written before \f(CW\*(C`is_deeply()\*(C'\fR existed because I couldn't figure out how to display a useful diff of two arbitrary data structures. .PP These functions are usually used inside an \f(CW\*(C`ok()\*(C'\fR. .PP .Vb 1 \& ok( eq_array(\e@got, \e@expected) ); .Ve .PP \&\f(CW\*(C`is_deeply()\*(C'\fR can do that better and with diagnostics. .PP .Vb 1 \& is_deeply( \e@got, \e@expected ); .Ve .PP They may be deprecated in future versions. .IP "\fBeq_array\fR" 4 .IX Item "eq_array" .Vb 1 \& my $is_eq = eq_array(\e@got, \e@expected); .Ve .Sp Checks if two arrays are equivalent. This is a deep check, so multi-level structures are handled correctly. .IP "\fBeq_hash\fR" 4 .IX Item "eq_hash" .Vb 1 \& my $is_eq = eq_hash(\e%got, \e%expected); .Ve .Sp Determines if the two hashes contain the same keys and values. This is a deep check. .IP "\fBeq_set\fR" 4 .IX Item "eq_set" .Vb 1 \& my $is_eq = eq_set(\e@got, \e@expected); .Ve .Sp Similar to \f(CW\*(C`eq_array()\*(C'\fR, except the order of the elements is \fBnot\fR important. This is a deep check, but the irrelevancy of order only applies to the top level. .Sp .Vb 1 \& ok( eq_set(\e@got, \e@expected) ); .Ve .Sp Is better written: .Sp .Vb 1 \& is_deeply( [sort @got], [sort @expected] ); .Ve .Sp \&\fB\s-1NOTE\s0\fR By historical accident, this is not a true set comparison. While the order of elements does not matter, duplicate elements do. .Sp \&\fB\s-1NOTE\s0\fR \f(CW\*(C`eq_set()\*(C'\fR does not know how to deal with references at the top level. The following is an example of a comparison which might not work: .Sp .Vb 1 \& eq_set([\e1, \e2], [\e2, \e1]); .Ve .Sp Test::Deep contains much better set comparison functions. .SS "Extending and Embedding Test::More" .IX Subsection "Extending and Embedding Test::More" Sometimes the Test::More interface isn't quite enough. Fortunately, Test::More is built on top of Test::Builder which provides a single, unified backend for any test library to use. This means two test libraries which both use \fBcan\fR be used together in the same program>. .PP If you simply want to do a little tweaking of how the tests behave, you can access the underlying Test::Builder object like so: .IP "\fBbuilder\fR" 4 .IX Item "builder" .Vb 1 \& my $test_builder = Test::More\->builder; .Ve .Sp Returns the Test::Builder object underlying Test::More for you to play with. .SH "EXIT CODES" .IX Header "EXIT CODES" If all your tests passed, Test::Builder will exit with zero (which is normal). If anything failed it will exit with how many failed. If you run less (or more) tests than you planned, the missing (or extras) will be considered failures. If no tests were ever run Test::Builder will throw a warning and exit with 255. If the test died, even after having successfully completed all its tests, it will still be considered a failure and will exit with 255. .PP So the exit codes are... .PP .Vb 3 \& 0 all tests successful \& 255 test died or all passed but wrong # of tests run \& any other number how many failed (including missing or extras) .Ve .PP If you fail more than 254 tests, it will be reported as 254. .PP \&\fB\s-1NOTE\s0\fR This behavior may go away in future versions. .SH "COMPATIBILITY" .IX Header "COMPATIBILITY" Test::More works with Perls as old as 5.8.1. .PP Thread support is not very reliable before 5.10.1, but that's because threads are not very reliable before 5.10.1. .PP Although Test::More has been a core module in versions of Perl since 5.6.2, Test::More has evolved since then, and not all of the features you're used to will be present in the shipped version of Test::More. If you are writing a module, don't forget to indicate in your package metadata the minimum version of Test::More that you require. For instance, if you want to use \f(CW\*(C`done_testing()\*(C'\fR but want your test script to run on Perl 5.10.0, you will need to explicitly require Test::More > 0.88. .PP Key feature milestones include: .IP "subtests" 4 .IX Item "subtests" Subtests were released in Test::More 0.94, which came with Perl 5.12.0. Subtests did not implicitly call \f(CW\*(C`done_testing()\*(C'\fR until 0.96; the first Perl with that fix was Perl 5.14.0 with 0.98. .ie n .IP """done_testing()""" 4 .el .IP "\f(CWdone_testing()\fR" 4 .IX Item "done_testing()" This was released in Test::More 0.88 and first shipped with Perl in 5.10.1 as part of Test::More 0.92. .ie n .IP """cmp_ok()""" 4 .el .IP "\f(CWcmp_ok()\fR" 4 .IX Item "cmp_ok()" Although \f(CW\*(C`cmp_ok()\*(C'\fR was introduced in 0.40, 0.86 fixed an important bug to make it safe for overloaded objects; the fixed first shipped with Perl in 5.10.1 as part of Test::More 0.92. .ie n .IP """new_ok()"" ""note()"" and ""explain()""" 4 .el .IP "\f(CWnew_ok()\fR \f(CWnote()\fR and \f(CWexplain()\fR" 4 .IX Item "new_ok() note() and explain()" These were was released in Test::More 0.82, and first shipped with Perl in 5.10.1 as part of Test::More 0.92. .PP There is a full version history in the Changes file, and the Test::More versions included as core can be found using Module::CoreList: .PP .Vb 1 \& $ corelist \-a Test::More .Ve .SH "CAVEATS and NOTES" .IX Header "CAVEATS and NOTES" .ie n .IP "utf8 / ""Wide character in print""" 4 .el .IP "utf8 / ``Wide character in print''" 4 .IX Item "utf8 / Wide character in print" If you use utf8 or other non-ASCII characters with Test::More you might get a \*(L"Wide character in print\*(R" warning. Using \&\f(CW\*(C`binmode STDOUT, ":utf8"\*(C'\fR will not fix it. Test::Builder (which powers Test::More) duplicates \s-1STDOUT\s0 and \s-1STDERR. \s0 So any changes to them, including changing their output disciplines, will not be seem by Test::More. .Sp One work around is to apply encodings to \s-1STDOUT\s0 and \s-1STDERR\s0 as early as possible and before Test::More (or any other Test module) loads. .Sp .Vb 2 \& use open \*(Aq:std\*(Aq, \*(Aq:encoding(utf8)\*(Aq; \& use Test::More; .Ve .Sp A more direct work around is to change the filehandles used by Test::Builder. .Sp .Vb 4 \& my $builder = Test::More\->builder; \& binmode $builder\->output, ":encoding(utf8)"; \& binmode $builder\->failure_output, ":encoding(utf8)"; \& binmode $builder\->todo_output, ":encoding(utf8)"; .Ve .IP "Overloaded objects" 4 .IX Item "Overloaded objects" String overloaded objects are compared \fBas strings\fR (or in \f(CW\*(C`cmp_ok()\*(C'\fR's case, strings or numbers as appropriate to the comparison op). This prevents Test::More from piercing an object's interface allowing better blackbox testing. So if a function starts returning overloaded objects instead of bare strings your tests won't notice the difference. This is good. .Sp However, it does mean that functions like \f(CW\*(C`is_deeply()\*(C'\fR cannot be used to test the internals of string overloaded objects. In this case I would suggest Test::Deep which contains more flexible testing functions for complex data structures. .IP "Threads" 4 .IX Item "Threads" Test::More will only be aware of threads if \f(CW\*(C`use threads\*(C'\fR has been done \&\fIbefore\fR Test::More is loaded. This is ok: .Sp .Vb 2 \& use threads; \& use Test::More; .Ve .Sp This may cause problems: .Sp .Vb 2 \& use Test::More \& use threads; .Ve .Sp 5.8.1 and above are supported. Anything below that has too many bugs. .SH "HISTORY" .IX Header "HISTORY" This is a case of convergent evolution with Joshua Pritikin's Test module. I was largely unaware of its existence when I'd first written my own \f(CW\*(C`ok()\*(C'\fR routines. This module exists because I can't figure out how to easily wedge test names into Test's interface (along with a few other problems). .PP The goal here is to have a testing utility that's simple to learn, quick to use and difficult to trip yourself up with while still providing more flexibility than the existing Test.pm. As such, the names of the most common routines are kept tiny, special cases and magic side-effects are kept to a minimum. \s-1WYSIWYG.\s0 .SH "SEE ALSO" .IX Header "SEE ALSO" .SS "" .IX Subsection "" .SS "\s-1ALTERNATIVES\s0" .IX Subsection "ALTERNATIVES" Test::Simple if all this confuses you and you just want to write some tests. You can upgrade to Test::More later (it's forward compatible). .PP Test::Legacy tests written with Test.pm, the original testing module, do not play well with other testing libraries. Test::Legacy emulates the Test.pm interface and does play well with others. .SS "\s-1TESTING FRAMEWORKS\s0" .IX Subsection "TESTING FRAMEWORKS" Fennec The Fennec framework is a testers toolbox. It uses Test::Builder under the hood. It brings enhancements for forking, defining state, and mocking. Fennec enhances several modules to work better together than they would if you loaded them individually on your own. .PP Fennec::Declare Provides enhanced (Devel::Declare) syntax for Fennec. .SS "\s-1ADDITIONAL LIBRARIES\s0" .IX Subsection "ADDITIONAL LIBRARIES" Test::Differences for more ways to test complex data structures. And it plays well with Test::More. .PP Test::Class is like xUnit but more perlish. .PP Test::Deep gives you more powerful complex data structure testing. .PP Test::Inline shows the idea of embedded testing. .PP Mock::Quick The ultimate mocking library. Easily spawn objects defined on the fly. Can also override, block, or reimplement packages as needed. .PP Test::FixtureBuilder Quickly define fixture data for unit tests. .SS "\s-1OTHER COMPONENTS\s0" .IX Subsection "OTHER COMPONENTS" Test::Harness is the test runner and output interpreter for Perl. It's the thing that powers \f(CW\*(C`make test\*(C'\fR and where the \f(CW\*(C`prove\*(C'\fR utility comes from. .SS "\s-1BUNDLES\s0" .IX Subsection "BUNDLES" Test::Most Most commonly needed test functions and features. .SH "AUTHORS" .IX Header "AUTHORS" Michael G Schwern with much inspiration from Joshua Pritikin's Test module and lots of help from Barrie Slaymaker, Tony Bowden, blackstar.co.uk, chromatic, Fergal Daly and the perl-qa gang. .SH "MAINTAINERS" .IX Header "MAINTAINERS" .IP "Chad Granum " 4 .IX Item "Chad Granum " .SH "BUGS" .IX Header "BUGS" See \fIhttps://github.com/Test\-More/test\-more/issues\fR to report and view bugs. .SH "SOURCE" .IX Header "SOURCE" The source code repository for Test::More can be found at \&\fIhttp://github.com/Test\-More/test\-more/\fR. .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2001\-2008 by Michael G Schwern . .PP This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. .PP See \fIhttp://www.perl.com/perl/misc/Artistic.html\fR