FM / man3

/usr/local/share/man/man3

Name	Size	Mode	Actions
App::Prove.3pm	10508	0444	edit dl rm
App::Prove::State.3pm	6005	0444	edit dl rm
App::Prove::State::Result.3pm	5619	0444	edit dl rm
App::Prove::State::Result::Test.3pm	5051	0444	edit dl rm
AppConfig.3pm	35289	0444	edit dl rm
AppConfig::Args.3pm	7992	0444	edit dl rm
AppConfig::CGI.3pm	6609	0444	edit dl rm
AppConfig::File.3pm	12614	0444	edit dl rm
AppConfig::Getopt.3pm	7444	0444	edit dl rm
AppConfig::State.3pm	24972	0444	edit dl rm
AppConfig::Sys.3pm	6695	0444	edit dl rm
Archive::Tar.3pm	44061	0444	edit dl rm
Archive::Tar::File.3pm	11083	0444	edit dl rm
Archive::Zip.3pm	69985	0444	edit dl rm
Archive::Zip::FAQ.3pm	18437	0444	edit dl rm
Archive::Zip::MemberRead.3pm	6734	0444	edit dl rm
Archive::Zip::Tree.3pm	2875	0444	edit dl rm
B::COW.3pm	5163	0444	edit dl rm
Canary::Stability.3pm	3727	0444	edit dl rm
CDB_File.3pm	14318	0444	edit dl rm
common::sense.3pm	0	0444	edit dl rm
Compress::Raw::Bzip2.3pm	13463	0444	edit dl rm
Compress::Raw::Zlib.3pm	42082	0444	edit dl rm
Compress::Zlib.3pm	38719	0444	edit dl rm
CPAN::Meta.3pm	15923	0444	edit dl rm
CPAN::Meta::Converter.3pm	6594	0444	edit dl rm
CPAN::Meta::Feature.3pm	4322	0444	edit dl rm
CPAN::Meta::History.3pm	7855	0444	edit dl rm
CPAN::Meta::History::Meta_1_0.3pm	9973	0444	edit dl rm
CPAN::Meta::History::Meta_1_1.3pm	12410	0444	edit dl rm
CPAN::Meta::History::Meta_1_2.3pm	22224	0444	edit dl rm
CPAN::Meta::History::Meta_1_3.3pm	23974	0444	edit dl rm
CPAN::Meta::History::Meta_1_4.3pm	24565	0444	edit dl rm
CPAN::Meta::Merge.3pm	5285	0444	edit dl rm
CPAN::Meta::Prereqs.3pm	7380	0444	edit dl rm
CPAN::Meta::Requirements.3pm	12308	0444	edit dl rm
CPAN::Meta::Spec.3pm	45592	0444	edit dl rm
CPAN::Meta::Validator.3pm	4215	0444	edit dl rm
CPAN::Meta::YAML.3pm	4230	0444	edit dl rm
Crypt::OpenSSL::Random.3pm	5634	0444	edit dl rm
Curses.3pm	37580	0444	edit dl rm
Curses::UI.3pm	15619	0444	edit dl rm
Curses::UI::Buttonbox.3pm	8908	0444	edit dl rm
Curses::UI::Calendar.3pm	8203	0444	edit dl rm
Curses::UI::Checkbox.3pm	6509	0444	edit dl rm
Curses::UI::Color.3pm	5903	0444	edit dl rm
Curses::UI::Common.3pm	6498	0444	edit dl rm
Curses::UI::Container.3pm	9041	0444	edit dl rm
Curses::UI::Dialog::Basic.3pm	5213	0444	edit dl rm
Curses::UI::Dialog::Calendar.3pm	4761	0444	edit dl rm
Curses::UI::Dialog::Dirbrowser.3pm	5369	0444	edit dl rm
Curses::UI::Dialog::Error.3pm	4307	0444	edit dl rm
Curses::UI::Dialog::Filebrowser.3pm	6889	0444	edit dl rm
Curses::UI::Dialog::Progress.3pm	5774	0444	edit dl rm
Curses::UI::Dialog::Question.3pm	5277	0444	edit dl rm
Curses::UI::Dialog::Status.3pm	4765	0444	edit dl rm
Curses::UI::Label.3pm	7333	0444	edit dl rm
Curses::UI::Listbox.3pm	11988	0444	edit dl rm
Curses::UI::Menubar.3pm	8110	0444	edit dl rm
Curses::UI::Notebook.3pm	9140	0444	edit dl rm
Curses::UI::PasswordEntry.3pm	3743	0444	edit dl rm
Curses::UI::Popupmenu.3pm	7431	0444	edit dl rm
Curses::UI::Progressbar.3pm	5891	0444	edit dl rm
Curses::UI::Radiobuttonbox.3pm	4069	0444	edit dl rm
Curses::UI::Searchable.3pm	6668	0444	edit dl rm
Curses::UI::TextEditor.3pm	14171	0444	edit dl rm
Curses::UI::TextEntry.3pm	3623	0444	edit dl rm
Curses::UI::TextViewer.3pm	3670	0444	edit dl rm
Curses::UI::Tutorial.3pm	8555	0444	edit dl rm
Curses::UI::Widget.3pm	25675	0444	edit dl rm
Curses::UI::Window.3pm	5084	0444	edit dl rm
Cwd.3pm	7183	0444	edit dl rm
Date::Format.3pm	7291	0444	edit dl rm
Date::Language.3pm	3809	0444	edit dl rm
Date::Language::Bulgarian.3pm	3675	0444	edit dl rm
Date::Language::Hungarian.3pm	3091	0444	edit dl rm
Date::Parse.3pm	5402	0444	edit dl rm
Digest::SHA.3pm	25759	0444	edit dl rm
Expect.3pm	60229	0444	edit dl rm
ExtUtils::CBuilder.3pm	11923	0444	edit dl rm
ExtUtils::CBuilder::Platform::Windows.3pm	3117	0444	edit dl rm
ExtUtils::Command.3pm	5942	0444	edit dl rm
ExtUtils::Command::MM.3pm	5723	0444	edit dl rm
ExtUtils::Liblist.3pm	12679	0444	edit dl rm
ExtUtils::MakeMaker.3pm	79357	0444	edit dl rm
ExtUtils::MakeMaker::Config.3pm	2587	0444	edit dl rm
ExtUtils::MakeMaker::FAQ.3pm	26829	0444	edit dl rm
ExtUtils::MakeMaker::Locale.3pm	11168	0444	edit dl rm
ExtUtils::MakeMaker::Tutorial.3pm	8389	0444	edit dl rm
ExtUtils::Manifest.3pm	11961	0444	edit dl rm
ExtUtils::Mkbootstrap.3pm	3459	0444	edit dl rm
ExtUtils::Mksymlists.3pm	6699	0444	edit dl rm
ExtUtils::MM.3pm	2829	0444	edit dl rm
ExtUtils::MM_AIX.3pm	3044	0444	edit dl rm
ExtUtils::MM_Any.3pm	31129	0444	edit dl rm
ExtUtils::MM_BeOS.3pm	2798	0444	edit dl rm
ExtUtils::MM_Cygwin.3pm	3569	0444	edit dl rm
ExtUtils::MM_Darwin.3pm	2688	0444	edit dl rm
ExtUtils::MM_DOS.3pm	3021	0444	edit dl rm
ExtUtils::MM_MacOS.3pm	2987	0444	edit dl rm
ExtUtils::MM_NW5.3pm	3200	0444	edit dl rm
ExtUtils::MM_OS2.3pm	2886	0444	edit dl rm
ExtUtils::MM_QNX.3pm	2942	0444	edit dl rm
ExtUtils::MM_Unix.3pm	21419	0444	edit dl rm
ExtUtils::MM_UWIN.3pm	3051	0444	edit dl rm
ExtUtils::MM_VMS.3pm	14900	0444	edit dl rm
ExtUtils::MM_VOS.3pm	2926	0444	edit dl rm
ExtUtils::MM_Win32.3pm	5919	0444	edit dl rm
ExtUtils::MM_Win95.3pm	3276	0444	edit dl rm
ExtUtils::MY.3pm	2764	0444	edit dl rm
ExtUtils::testlib.3pm	2690	0444	edit dl rm
File::GlobMapper.3pm	11447	0444	edit dl rm
File::HomeDir.3pm	18212	0444	edit dl rm
File::HomeDir::Darwin.3pm	3232	0444	edit dl rm
File::HomeDir::Darwin::Carbon.3pm	3517	0444	edit dl rm
File::HomeDir::Darwin::Cocoa.3pm	3446	0444	edit dl rm
File::HomeDir::Driver.3pm	3101	0444	edit dl rm
File::HomeDir::FreeDesktop.3pm	3487	0444	edit dl rm
File::HomeDir::MacOS9.3pm	3499	0444	edit dl rm
File::HomeDir::Test.3pm	3534	0444	edit dl rm
File::HomeDir::Unix.3pm	3638	0444	edit dl rm
File::HomeDir::Windows.3pm	4891	0444	edit dl rm
File::Path.3pm	31030	0444	edit dl rm
File::Slurp.3pm	23626	0444	edit dl rm
File::Spec.3pm	13784	0444	edit dl rm
File::Spec::AmigaOS.3pm	2826	0444	edit dl rm
File::Spec::Cygwin.3pm	3957	0444	edit dl rm
File::Spec::Epoc.3pm	3251	0444	edit dl rm
File::Spec::Functions.3pm	3799	0444	edit dl rm
File::Spec::Mac.3pm	18664	0444	edit dl rm
File::Spec::OS2.3pm	3118	0444	edit dl rm
File::Spec::Unix.3pm	9837	0444	edit dl rm
File::Spec::VMS.3pm	6389	0444	edit dl rm
File::Spec::Win32.3pm	6451	0444	edit dl rm
File::Temp.3pm	36799	0444	edit dl rm
File::Which.3pm	9746	0444	edit dl rm
Getopt::Long.3pm	52647	0444	edit dl rm
HDB.3pm	10947	0444	edit dl rm
HDB::CMDS.3pm	18894	0444	edit dl rm
HDB::Encode.3pm	7863	0444	edit dl rm
HDB::Object.3pm	10057	0444	edit dl rm
HTML::AsSubs.3pm	8586	0444	edit dl rm
HTML::Element.3pm	70793	0444	edit dl rm
HTML::Element::traverse.3pm	15984	0444	edit dl rm
HTML::Form.3pm	28158	0444	edit dl rm
HTML::Parse.3pm	8277	0444	edit dl rm
HTML::Tree.3pm	9982	0444	edit dl rm
HTML::Tree::AboutObjects.3pm	37918	0444	edit dl rm
HTML::Tree::AboutTrees.3pm	58534	0444	edit dl rm
HTML::Tree::Scanning.3pm	34385	0444	edit dl rm
HTML::TreeBuilder.3pm	30138	0444	edit dl rm
HTTP::Tiny.3pm	27709	0444	edit dl rm
IO::AtomicFile.3pm	5381	0444	edit dl rm
IO::Compress::Base.3pm	3506	0444	edit dl rm
IO::Compress::Bzip2.3pm	23260	0444	edit dl rm
IO::Compress::Deflate.3pm	26768	0444	edit dl rm
IO::Compress::FAQ.3pm	26718	0444	edit dl rm
IO::Compress::Gzip.3pm	34489	0444	edit dl rm
IO::Compress::RawDeflate.3pm	27134	0444	edit dl rm
IO::Compress::Zip.3pm	40870	0444	edit dl rm
IO::InnerFile.3pm	6035	0444	edit dl rm
IO::Lines.3pm	3783	0444	edit dl rm
IO::Pty.3pm	8579	0444	edit dl rm
IO::Scalar.3pm	10679	0444	edit dl rm
IO::ScalarArray.3pm	10528	0444	edit dl rm
IO::Stringy.3pm	4049	0444	edit dl rm
IO::Tty.3pm	8348	0444	edit dl rm
IO::Tty::Constant.3pm	10012	0444	edit dl rm
IO::Uncompress::AnyInflate.3pm	32800	0444	edit dl rm
IO::Uncompress::AnyUncompress.3pm	30767	0444	edit dl rm
IO::Uncompress::Base.3pm	3518	0444	edit dl rm
IO::Uncompress::Bunzip2.3pm	29171	0444	edit dl rm
IO::Uncompress::Gunzip.3pm	31719	0444	edit dl rm
IO::Uncompress::Inflate.3pm	29915	0444	edit dl rm
IO::Uncompress::RawInflate.3pm	29563	0444	edit dl rm
IO::Uncompress::Unzip.3pm	31279	0444	edit dl rm
IO::Wrap.3pm	10664	0444	edit dl rm
IO::WrapTie.3pm	14987	0444	edit dl rm
JSON::PP.3pm	50080	0444	edit dl rm
JSON::PP::Boolean.3pm	2667	0444	edit dl rm
JSON::Syck.3pm	8094	0444	edit dl rm
JSON::XS.3pm	89037	0444	edit dl rm
JSON::XS::Boolean.3pm	2857	0444	edit dl rm
lib::core::only.3pm	5647	0444	edit dl rm
local::lib.3pm	31390	0444	edit dl rm
LWP.3pm	28506	0444	edit dl rm
LWP::Authen::Ntlm.3pm	7489	0444	edit dl rm
LWP::ConnCache.3pm	9967	0444	edit dl rm
LWP::Debug.3pm	5608	0444	edit dl rm
LWP::MemberMixin.3pm	4821	0444	edit dl rm
LWP::Protocol.3pm	8350	0444	edit dl rm
LWP::Protocol::https.3pm	5684	0444	edit dl rm
LWP::RobotUA.3pm	9022	0444	edit dl rm
LWP::Simple.3pm	9016	0444	edit dl rm
LWP::UserAgent.3pm	48156	0444	edit dl rm
lwpcook.3pm	14838	0444	edit dl rm
lwptut.3pm	32441	0444	edit dl rm
Module::Build.3pm	44563	0444	edit dl rm
Module::Build::API.3pm	89267	0444	edit dl rm
Module::Build::Authoring.3pm	17363	0444	edit dl rm
Module::Build::Base.3pm	5157	0444	edit dl rm
Module::Build::Bundling.3pm	9999	0444	edit dl rm
Module::Build::Compat.3pm	10885	0444	edit dl rm
Module::Build::ConfigData.3pm	7388	0444	edit dl rm
Module::Build::Cookbook.3pm	25946	0444	edit dl rm
Module::Build::Notes.3pm	4690	0444	edit dl rm
Module::Build::Platform::aix.3pm	4472	0444	edit dl rm
Module::Build::Platform::cygwin.3pm	4505	0444	edit dl rm
Module::Build::Platform::darwin.3pm	4491	0444	edit dl rm
Module::Build::Platform::Default.3pm	4490	0444	edit dl rm
Module::Build::Platform::MacOS.3pm	5398	0444	edit dl rm
Module::Build::Platform::os2.3pm	4474	0444	edit dl rm
Module::Build::Platform::Unix.3pm	4481	0444	edit dl rm
Module::Build::Platform::VMS.3pm	7885	0444	edit dl rm
Module::Build::Platform::VOS.3pm	4477	0444	edit dl rm
Module::Build::Platform::Windows.3pm	4529	0444	edit dl rm
Module::Build::PPMMaker.3pm	4886	0444	edit dl rm
Mozilla::CA.3pm	3571	0444	edit dl rm
Net::CIDR::Lite.3pm	9562	0444	edit dl rm
Net::Cmd.3pm	11545	0444	edit dl rm
Net::Config.3pm	8100	0444	edit dl rm
Net::Domain.3pm	3835	0444	edit dl rm
Net::FTP.3pm	27341	0444	edit dl rm
Net::FTP::dataconn.3pm	3979	0444	edit dl rm
Net::HTTP.3pm	16375	0444	edit dl rm
Net::HTTP::NB.3pm	5394	0444	edit dl rm
Net::HTTPS.3pm	5438	0444	edit dl rm
Net::IP.3pm	27697	0444	edit dl rm
Net::libnetFAQ.3pm	14746	0444	edit dl rm
Net::Netrc.3pm	6729	0444	edit dl rm
Net::NNTP.3pm	23193	0444	edit dl rm
Net::POP3.3pm	12259	0444	edit dl rm
Net::SMTP.3pm	18880	0444	edit dl rm
Net::SSLeay.3pm	349350	0444	edit dl rm
Net::SSLeay::Handle.3pm	9127	0444	edit dl rm
Net::Time.3pm	4524	0444	edit dl rm
ok.3pm	2851	0444	edit dl rm
Parse::CPAN::Meta.3pm	10187	0444	edit dl rm
POD2::DE::local::lib.3pm	22879	0444	edit dl rm
POD2::PT_BR::local::lib.3pm	22762	0444	edit dl rm
Socket.3pm	34078	0444	edit dl rm
Sub::Identify.3pm	5087	0444	edit dl rm
SUPER.3pm	7394	0444	edit dl rm
Switch.3pm	19014	0444	edit dl rm
TAP::Base.3pm	3401	0444	edit dl rm
TAP::Formatter::Base.3pm	6233	0444	edit dl rm
TAP::Formatter::Color.3pm	3717	0444	edit dl rm
TAP::Formatter::Console.3pm	2722	0444	edit dl rm
TAP::Formatter::Console::ParallelSession.3pm	3065	0444	edit dl rm
TAP::Formatter::Console::Session.3pm	2832	0444	edit dl rm
TAP::Formatter::File.3pm	2693	0444	edit dl rm
TAP::Formatter::File::Session.3pm	2847	0444	edit dl rm
TAP::Formatter::Session.3pm	3603	0444	edit dl rm
TAP::Harness.3pm	21300	0444	edit dl rm
TAP::Harness::Beyond.3pm	19118	0444	edit dl rm
TAP::Harness::Env.3pm	5467	0444	edit dl rm
TAP::Object.3pm	4497	0444	edit dl rm
TAP::Parser.3pm	42210	0444	edit dl rm
TAP::Parser::Aggregator.3pm	8023	0444	edit dl rm
TAP::Parser::Grammar.3pm	8647	0444	edit dl rm
TAP::Parser::Iterator.3pm	4993	0444	edit dl rm
TAP::Parser::Iterator::Array.3pm	3771	0444	edit dl rm
TAP::Parser::Iterator::Process.3pm	4601	0444	edit dl rm
TAP::Parser::Iterator::Stream.3pm	3712	0444	edit dl rm
TAP::Parser::IteratorFactory.3pm	6904	0444	edit dl rm
TAP::Parser::Multiplexer.3pm	4646	0444	edit dl rm
TAP::Parser::Result.3pm	7512	0444	edit dl rm
TAP::Parser::Result::Bailout.3pm	3293	0444	edit dl rm
TAP::Parser::Result::Comment.3pm	3118	0444	edit dl rm
TAP::Parser::Result::Plan.3pm	4173	0444	edit dl rm
TAP::Parser::Result::Pragma.3pm	3073	0444	edit dl rm
TAP::Parser::Result::Test.3pm	7114	0444	edit dl rm
TAP::Parser::Result::Unknown.3pm	2973	0444	edit dl rm
TAP::Parser::Result::Version.3pm	3154	0444	edit dl rm
TAP::Parser::Result::YAML.3pm	3086	0444	edit dl rm
TAP::Parser::ResultFactory.3pm	5523	0444	edit dl rm
TAP::Parser::Scheduler.3pm	8113	0444	edit dl rm
TAP::Parser::Scheduler::Job.3pm	4301	0444	edit dl rm
TAP::Parser::Scheduler::Spinner.3pm	3346	0444	edit dl rm
TAP::Parser::Source.3pm	8170	0444	edit dl rm
TAP::Parser::SourceHandler.3pm	7559	0444	edit dl rm
TAP::Parser::SourceHandler::Executable.3pm	5297	0444	edit dl rm
TAP::Parser::SourceHandler::File.3pm	4567	0444	edit dl rm
TAP::Parser::SourceHandler::Handle.3pm	4425	0444	edit dl rm
TAP::Parser::SourceHandler::Perl.3pm	6262	0444	edit dl rm
TAP::Parser::SourceHandler::RawTAP.3pm	4434	0444	edit dl rm
TAP::Parser::YAMLish::Reader.3pm	3995	0444	edit dl rm
TAP::Parser::YAMLish::Writer.3pm	4879	0444	edit dl rm
Template.3pm	27909	0444	edit dl rm
Template::Base.3pm	8149	0444	edit dl rm
Template::Config.3pm	8687	0444	edit dl rm
Template::Constants.3pm	7815	0444	edit dl rm
Template::Context.3pm	26637	0444	edit dl rm
Template::Directive.3pm	4821	0444	edit dl rm
Template::Document.3pm	11829	0444	edit dl rm
Template::Exception.3pm	6763	0444	edit dl rm
Template::FAQ.3pm	14564	0444	edit dl rm
Template::Filters.3pm	9817	0444	edit dl rm
Template::Grammar.3pm	5039	0444	edit dl rm
Template::Iterator.3pm	11413	0444	edit dl rm
Template::Manual.3pm	6317	0444	edit dl rm
Template::Manual::Config.3pm	79504	0444	edit dl rm
Template::Manual::Credits.3pm	8246	0444	edit dl rm
Template::Manual::Directives.3pm	77293	0444	edit dl rm
Template::Manual::Filters.3pm	20810	0444	edit dl rm
Template::Manual::Internals.3pm	23433	0444	edit dl rm
Template::Manual::Intro.3pm	14092	0444	edit dl rm
Template::Manual::Plugins.3pm	13780	0444	edit dl rm
Template::Manual::Syntax.3pm	14549	0444	edit dl rm
Template::Manual::Variables.3pm	33110	0444	edit dl rm
Template::Manual::Views.3pm	25953	0444	edit dl rm
Template::Manual::VMethods.3pm	28195	0444	edit dl rm
Template::Modules.3pm	9827	0444	edit dl rm
Template::Namespace::Constants.3pm	6002	0444	edit dl rm
Template::Parser.3pm	9917	0444	edit dl rm
Template::Plugin.3pm	10937	0444	edit dl rm
Template::Plugin::Assert.3pm	5446	0444	edit dl rm
Template::Plugin::CGI.3pm	6188	0444	edit dl rm
Template::Plugin::Datafile.3pm	6601	0444	edit dl rm
Template::Plugin::Date.3pm	9538	0444	edit dl rm
Template::Plugin::Directory.3pm	11979	0444	edit dl rm
Template::Plugin::Dumper.3pm	6078	0444	edit dl rm
Template::Plugin::File.3pm	13009	0444	edit dl rm
Template::Plugin::Filter.3pm	12936	0444	edit dl rm
Template::Plugin::Format.3pm	4895	0444	edit dl rm
Template::Plugin::HTML.3pm	7823	0444	edit dl rm
Template::Plugin::Image.3pm	11950	0444	edit dl rm
Template::Plugin::Iterator.3pm	5061	0444	edit dl rm
Template::Plugin::Math.3pm	6623	0444	edit dl rm
Template::Plugin::Pod.3pm	4784	0444	edit dl rm
Template::Plugin::Procedural.3pm	5631	0444	edit dl rm
Template::Plugin::Scalar.3pm	5032	0444	edit dl rm
Template::Plugin::String.3pm	17263	0444	edit dl rm
Template::Plugin::Table.3pm	11145	0444	edit dl rm
Template::Plugin::URL.3pm	8080	0444	edit dl rm
Template::Plugin::View.3pm	5479	0444	edit dl rm
Template::Plugin::Wrap.3pm	6433	0444	edit dl rm
Template::Plugins.3pm	9733	0444	edit dl rm
Template::Provider.3pm	14678	0444	edit dl rm
Template::Service.3pm	14813	0444	edit dl rm
Template::Stash.3pm	11983	0444	edit dl rm
Template::Stash::Context.3pm	7130	0444	edit dl rm
Template::Stash::XS.3pm	6644	0444	edit dl rm
Template::Test.3pm	15524	0444	edit dl rm
Template::Toolkit.3pm	9227	0444	edit dl rm
Template::Tools.3pm	5001	0444	edit dl rm
Template::Tools::tpage.3pm	5806	0444	edit dl rm
Template::Tools::ttree.3pm	16567	0444	edit dl rm
Template::Tutorial.3pm	4566	0444	edit dl rm
Template::Tutorial::Datafile.3pm	19539	0444	edit dl rm
Template::Tutorial::Web.3pm	34118	0444	edit dl rm
Template::View.3pm	12618	0444	edit dl rm
Template::VMethods.3pm	4688	0444	edit dl rm
Term::ReadKey.3pm	13029	0444	edit dl rm
Test2.3pm	9556	0444	edit dl rm
Test2::API.3pm	30424	0444	edit dl rm
Test2::API::Breakage.3pm	4988	0444	edit dl rm
Test2::API::Context.3pm	17574	0444	edit dl rm
Test2::API::Instance.3pm	12404	0444	edit dl rm
Test2::API::Stack.3pm	6568	0444	edit dl rm
Test2::Event.3pm	9189	0444	edit dl rm
Test2::Event::Bail.3pm	3470	0444	edit dl rm
Test2::Event::Diag.3pm	3338	0444	edit dl rm
Test2::Event::Exception.3pm	3520	0444	edit dl rm
Test2::Event::Generic.3pm	7662	0444	edit dl rm
Test2::Event::Info.3pm	4261	0444	edit dl rm
Test2::Event::Note.3pm	3323	0444	edit dl rm
Test2::Event::Ok.3pm	4255	0444	edit dl rm
Test2::Event::Plan.3pm	3907	0444	edit dl rm
Test2::Event::Skip.3pm	3665	0444	edit dl rm
Test2::Event::Subtest.3pm	3573	0444	edit dl rm
Test2::Event::Waiting.3pm	3107	0444	edit dl rm
Test2::Formatter.3pm	5208	0444	edit dl rm
Test2::Formatter::TAP.3pm	9255	0444	edit dl rm
Test2::Hub.3pm	16755	0444	edit dl rm
Test2::Hub::Interceptor.3pm	2937	0444	edit dl rm
Test2::Hub::Interceptor::Terminator.3pm	2980	0444	edit dl rm
Test2::Hub::Subtest.3pm	3803	0444	edit dl rm
Test2::IPC.3pm	3324	0444	edit dl rm
Test2::IPC::Driver.3pm	9512	0444	edit dl rm
Test2::IPC::Driver::Files.3pm	3822	0444	edit dl rm
Test2::Transition.3pm	18406	0444	edit dl rm
Test2::Util.3pm	5123	0444	edit dl rm
Test2::Util::ExternalMeta.3pm	5594	0444	edit dl rm
Test2::Util::HashBase.3pm	7463	0444	edit dl rm
Test2::Util::Trace.3pm	5577	0444	edit dl rm
Test::Builder.3pm	26915	0444	edit dl rm
Test::Builder::Formatter.3pm	3656	0444	edit dl rm
Test::Builder::IO::Scalar.3pm	9740	0444	edit dl rm
Test::Builder::Module.3pm	5567	0444	edit dl rm
Test::Builder::Tester.3pm	11550	0444	edit dl rm
Test::Builder::Tester::Color.3pm	3131	0444	edit dl rm
Test::Builder::TodoDiag.3pm	3129	0444	edit dl rm
Test::Fatal.3pm	9303	0444	edit dl rm
Test::HACKING.3pm	9253	0444	edit dl rm
Test::Harness.3pm	11028	0444	edit dl rm
Test::LeakTrace.3pm	10022	0444	edit dl rm
Test::LeakTrace::JA.3pm	12328	0444	edit dl rm
Test::LeakTrace::Script.3pm	5140	0444	edit dl rm
Test::MockModule.3pm	10818	0444	edit dl rm
Test::More.3pm	43215	0444	edit dl rm
Test::More::UTF8.3pm	3602	0444	edit dl rm
Test::RequiresInternet.3pm	3944	0444	edit dl rm
Test::Simple.3pm	9119	0444	edit dl rm
Test::Tester.3pm	15781	0444	edit dl rm
Test::Tester::Capture.3pm	2902	0444	edit dl rm
Test::Tester::CaptureRunner.3pm	2673	0444	edit dl rm
Test::Tutorial.3pm	24261	0444	edit dl rm
Test::use::ok.3pm	3841	0444	edit dl rm
Test::Warnings.3pm	14231	0444	edit dl rm
Text::Glob.3pm	6106	0444	edit dl rm
Text::Template.3pm	65499	0444	edit dl rm
Text::Template::Preprocess.3pm	6270	0444	edit dl rm
Time::Zone.3pm	3413	0444	edit dl rm
TimeDate.3pm	2397	0444	edit dl rm
Try::Tiny.3pm	20343	0444	edit dl rm
Types::Serialiser.3pm	11473	0444	edit dl rm
Types::Serialiser::Error.3pm	2705	0444	edit dl rm
version.3pm	13937	0444	edit dl rm
version::Internals.3pm	30287	0444	edit dl rm
WWW::Mechanize.3pm	68196	0444	edit dl rm
WWW::Mechanize::Cookbook.3pm	7159	0444	edit dl rm
WWW::Mechanize::Examples.3pm	22490	0444	edit dl rm
WWW::Mechanize::FAQ.3pm	24359	0444	edit dl rm
WWW::Mechanize::Image.3pm	6490	0444	edit dl rm
WWW::Mechanize::Link.3pm	6518	0444	edit dl rm
XML::NamespaceSupport.3pm	13052	0444	edit dl rm
XML::Parser.3pm	26296	0444	edit dl rm
XML::Parser::Expat.3pm	26799	0444	edit dl rm
XML::Parser::Style::Debug.3pm	4408	0444	edit dl rm
XML::Parser::Style::Objects.3pm	4888	0444	edit dl rm
XML::Parser::Style::Stream.3pm	5925	0444	edit dl rm
XML::Parser::Style::Subs.3pm	4863	0444	edit dl rm
XML::Parser::Style::Tree.3pm	5529	0444	edit dl rm
XML::SAX.3pm	9229	0444	edit dl rm
XML::SAX::Base.3pm	13704	0444	edit dl rm
XML::SAX::BuildSAXBase.3pm	13700	0444	edit dl rm
XML::SAX::DocumentLocator.3pm	5239	0444	edit dl rm
XML::SAX::Exception.3pm	5622	0444	edit dl rm
XML::SAX::Expat.3pm	6404	0444	edit dl rm
XML::SAX::Intro.3pm	20220	0444	edit dl rm
XML::SAX::ParserFactory.3pm	7919	0444	edit dl rm
XML::SAX::PurePerl.3pm	6172	0444	edit dl rm
XML::SAX::PurePerl::Reader.3pm	4103	0444	edit dl rm
XML::Simple.3pm	65589	0444	edit dl rm
XML::Simple::FAQ.3pm	27223	0444	edit dl rm
YAML.3pm	29980	0444	edit dl rm
YAML::Any.3pm	7487	0444	edit dl rm
YAML::Dumper.3pm	4776	0444	edit dl rm
YAML::Dumper::Base.3pm	4642	0444	edit dl rm
YAML::Error.3pm	4681	0444	edit dl rm
YAML::Loader.3pm	4766	0444	edit dl rm
YAML::Loader::Base.3pm	4642	0444	edit dl rm
YAML::Marshall.3pm	4640	0444	edit dl rm
YAML::Node.3pm	6743	0444	edit dl rm
YAML::Syck.3pm	10806	0444	edit dl rm
YAML::Tag.3pm	4499	0444	edit dl rm
YAML::Types.3pm	4716	0444	edit dl rm

Edit: /usr/local/share/man/man3/Test2::API.3pm (30424B)

.\" 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 "Test2::API 3"
.TH Test2::API 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"
Test2::API \- Primary interface for writing Test2 based testing tools.
.SH "***INTERNALS NOTE***"
.IX Header "***INTERNALS NOTE***"
\&\fBThe internals of this package are subject to change at any time!\fR The public
methods provided will not change in backwards-incompatible ways (once there is
a stable release), but the underlying implementation details might.
\&\fBDo not break encapsulation here!\fR
.PP
Currently the implementation is to create a single instance of the
Test2::API::Instance Object. All class methods defer to the single
instance. There is no public access to the singleton, and that is intentional.
The class methods provided by this package provide the only functionality
publicly exposed.
.PP
This is done primarily to avoid the problems Test::Builder had by exposing its
singleton. We do not want anyone to replace this singleton, rebless it, or
directly muck with its internals. If you need to do something and cannot
because of the restrictions placed here, then please report it as an issue. If
possible, we will create a way for you to implement your functionality without
exposing things that should not be exposed.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This package exports all the functions necessary to write and/or verify testing
tools. Using these building blocks you can begin writing test tools very
quickly. You are also provided with tools that help you to test the tools you
write.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.SS "\s-1WRITING A TOOL\s0"
.IX Subsection "WRITING A TOOL"
The \f(CW\*(C`context()\*(C'\fR method is your primary interface into the Test2 framework.
.PP
.Vb 2
\&    package My::Ok;
\&    use Test2::API qw/context/;
\&
\&    our @EXPORT = qw/my_ok/;
\&    use base \*(AqExporter\*(Aq;
\&
\&    # Just like ok() from Test::More
\&    sub my_ok($;$) {
\&        my ($bool, $name) = @_;
\&        my $ctx = context(); # Get a context
\&        $ctx\->ok($bool, $name);
\&        $ctx\->release; # Release the context
\&        return $bool;
\&    }
.Ve
.PP
See Test2::API::Context for a list of methods available on the context object.
.SS "\s-1TESTING YOUR TOOLS\s0"
.IX Subsection "TESTING YOUR TOOLS"
The \f(CW\*(C`intercept { ... }\*(C'\fR tool lets you temporarily intercept all events
generated by the test system:
.PP
.Vb 1
\&    use Test2::API qw/intercept/;
\&
\&    use My::Ok qw/my_ok/;
\&
\&    my $events = intercept {
\&        # These events are not displayed
\&        my_ok(1, "pass");
\&        my_ok(0, "fail");
\&    };
\&
\&    my_ok(@$events == 2, "got 2 events, the pass and the fail");
\&    my_ok($events\->[0]\->pass, "first event passed");
\&    my_ok(!$events\->[1]\->pass, "second event failed");
.Ve
.SS "\s-1OTHER API FUNCTIONS\s0"
.IX Subsection "OTHER API FUNCTIONS"
.Vb 9
\&    use Test2::API qw{
\&        test2_init_done
\&        test2_stack
\&        test2_set_is_end
\&        test2_get_is_end
\&        test2_ipc
\&        test2_formatter_set
\&        test2_formatter
\&    };
\&
\&    my $init  = test2_init_done();
\&    my $stack = test2_stack();
\&    my $ipc   = test2_ipc();
\&
\&    test2_formatter_set($FORMATTER)
\&    my $formatter = test2_formatter();
\&
\&    ... And others ...
.Ve
.SH "MAIN API EXPORTS"
.IX Header "MAIN API EXPORTS"
All exports are optional. You must specify subs to import.
.PP
.Vb 1
\&    use Test2::API qw/context intercept run_subtest/;
.Ve
.PP
This is the list of exports that are most commonly needed. If you are simply
writing a tool, then this is probably all you need. If you need something and
you cannot find it here, then you can also look at \*(L"\s-1OTHER API EXPORTS\*(R"\s0.
.PP
These exports lack the 'test2_' prefix because of how important/common they
are. Exports in the \*(L"\s-1OTHER API EXPORTS\*(R"\s0 section have the 'test2_' prefix to
ensure they stand out.
.SS "context(...)"
.IX Subsection "context(...)"
Usage:
.ie n .IP "$ctx = \fIcontext()\fR" 4
.el .IP "\f(CW$ctx\fR = \fIcontext()\fR" 4
.IX Item "$ctx = context()"
.PD 0
.ie n .IP "$ctx = context(%params)" 4
.el .IP "\f(CW$ctx\fR = context(%params)" 4
.IX Item "$ctx = context(%params)"
.PD
.PP
The \f(CW\*(C`context()\*(C'\fR function will always return the current context. If
there is already a context active, it will be returned. If there is not an
active context, one will be generated. When a context is generated it will
default to using the file and line number where the currently running sub was
called from.
.PP
Please see \*(L"\s-1CRITICAL DETAILS\*(R"\s0 in Test2::API::Context for important rules about
what you can and cannot do with a context once it is obtained.
.PP
\&\fBNote\fR This function will throw an exception if you ignore the context object
it returns.
.PP
\&\fBNote\fR On perls 5.14+ a depth check is used to insure there are no context
leaks. This cannot be safely done on older perls due to
<https://rt.perl.org/Public/Bug/Display.html?id=127774>
You can forcefully enable it either by setting \f(CW\*(C`$ENV{T2_CHECK_DEPTH} = 1\*(C'\fR or
\&\f(CW\*(C`$Test2::API::DO_DEPTH_CHECK = 1\*(C'\fR \fB\s-1BEFORE\s0\fR loading Test2::API.
.PP
\fI\s-1OPTIONAL PARAMETERS\s0\fR
.IX Subsection "OPTIONAL PARAMETERS"
.PP
All parameters to \f(CW\*(C`context\*(C'\fR are optional.
.ie n .IP "level => $int" 4
.el .IP "level => \f(CW$int\fR" 4
.IX Item "level => $int"
If you must obtain a context in a sub deeper than your entry point you can use
this to tell it how many \s-1EXTRA\s0 stack frames to look back. If this option is not
provided the default of \f(CW0\fR is used.
.Sp
.Vb 6
\&    sub third_party_tool {
\&        my $sub = shift;
\&        ... # Does not obtain a context
\&        $sub\->();
\&        ...
\&    }
\&
\&    third_party_tool(sub {
\&        my $ctx = context(level => 1);
\&        ...
\&        $ctx\->release;
\&    });
.Ve
.ie n .IP "wrapped => $int" 4
.el .IP "wrapped => \f(CW$int\fR" 4
.IX Item "wrapped => $int"
Use this if you need to write your own tool that wraps a call to \f(CW\*(C`context()\*(C'\fR
with the intent that it should return a context object.
.Sp
.Vb 7
\&    sub my_context {
\&        my %params = ( wrapped => 0, @_ );
\&        $params{wrapped}++;
\&        my $ctx = context(%params);
\&        ...
\&        return $ctx;
\&    }
\&
\&    sub my_tool {
\&        my $ctx = my_context();
\&        ...
\&        $ctx\->release;
\&    }
.Ve
.Sp
If you do not do this, then tools you call that also check for a context will
notice that the context they grabbed was created at the same stack depth, which
will trigger protective measures that warn you and destroy the existing
context.
.ie n .IP "stack => $stack" 4
.el .IP "stack => \f(CW$stack\fR" 4
.IX Item "stack => $stack"
Normally \f(CW\*(C`context()\*(C'\fR looks at the global hub stack. If you are maintaining
your own Test2::API::Stack instance you may pass it in to be used
instead of the global one.
.ie n .IP "hub => $hub" 4
.el .IP "hub => \f(CW$hub\fR" 4
.IX Item "hub => $hub"
Use this parameter if you want to obtain the context for a specific hub instead
of whatever one happens to be at the top of the stack.
.IP "on_init => sub { ... }" 4
.IX Item "on_init => sub { ... }"
This lets you provide a callback sub that will be called \fB\s-1ONLY\s0\fR if your call
to \f(CW\*(C`context()\*(C'\fR generated a new context. The callback \fB\s-1WILL NOT\s0\fR be called if
\&\f(CW\*(C`context()\*(C'\fR is returning an existing context. The only argument passed into
the callback will be the context object itself.
.Sp
.Vb 2
\&    sub foo {
\&        my $ctx = context(on_init => sub { \*(Aqwill run\*(Aq });
\&
\&        my $inner = sub {
\&            # This callback is not run since we are getting the existing
\&            # context from our parent sub.
\&            my $ctx = context(on_init => sub { \*(Aqwill NOT run\*(Aq });
\&            $ctx\->release;
\&        }
\&        $inner\->();
\&
\&        $ctx\->release;
\&    }
.Ve
.IP "on_release => sub { ... }" 4
.IX Item "on_release => sub { ... }"
This lets you provide a callback sub that will be called when the context
instance is released. This callback will be added to the returned context even
if an existing context is returned. If multiple calls to context add callbacks,
then all will be called in reverse order when the context is finally released.
.Sp
.Vb 2
\&    sub foo {
\&        my $ctx = context(on_release => sub { \*(Aqwill run second\*(Aq });
\&
\&        my $inner = sub {
\&            my $ctx = context(on_release => sub { \*(Aqwill run first\*(Aq });
\&
\&            # Neither callback runs on this release
\&            $ctx\->release;
\&        }
\&        $inner\->();
\&
\&        # Both callbacks run here.
\&        $ctx\->release;
\&    }
.Ve
.SS "release($;$)"
.IX Subsection "release($;$)"
Usage:
.ie n .IP "release $ctx;" 4
.el .IP "release \f(CW$ctx\fR;" 4
.IX Item "release $ctx;"
.PD 0
.ie n .IP "release $ctx, ...;" 4
.el .IP "release \f(CW$ctx\fR, ...;" 4
.IX Item "release $ctx, ...;"
.PD
.PP
This is intended as a shortcut that lets you release your context and return a
value in one statement. This function will get your context, and an optional
return value. It will release your context, then return your value. Scalar
context is always assumed.
.PP
.Vb 3
\&    sub tool {
\&        my $ctx = context();
\&        ...
\&
\&        return release $ctx, 1;
\&    }
.Ve
.PP
This tool is most useful when you want to return the value you get from calling
a function that needs to see the current context:
.PP
.Vb 4
\&    my $ctx = context();
\&    my $out = some_tool(...);
\&    $ctx\->release;
\&    return $out;
.Ve
.PP
We can combine the last 3 lines of the above like so:
.PP
.Vb 2
\&    my $ctx = context();
\&    release $ctx, some_tool(...);
.Ve
.SS "context_do(&;@)"
.IX Subsection "context_do(&;@)"
Usage:
.PP
.Vb 3
\&    sub my_tool {
\&        context_do {
\&            my $ctx = shift;
\&
\&            my (@args) = @_;
\&
\&            $ctx\->ok(1, "pass");
\&
\&            ...
\&
\&            # No need to call $ctx\->release, done for you on scope exit.
\&        } @_;
\&    }
.Ve
.PP
Using this inside your test tool takes care of a lot of boilerplate for you. It
will ensure a context is acquired. It will capture and rethrow any exception. It
will insure the context is released when you are done. It preserves the
subroutine call context (array, scalar, void).
.PP
This is the safest way to write a test tool. The only two downsides to this are a
slight performance decrease, and some extra indentation in your source. If the
indentation is a problem for you then you can take a peek at the next section.
.SS "no_context(&;$)"
.IX Subsection "no_context(&;$)"
Usage:
.IP "no_context { ... };" 4
.IX Item "no_context { ... };"
.PD 0
.ie n .IP "no_context { ... } $hid;" 4
.el .IP "no_context { ... } \f(CW$hid\fR;" 4
.IX Item "no_context { ... } $hid;"
.PD
.Vb 4
\&    sub my_tool(&) {
\&        my $code = shift;
\&        my $ctx = context();
\&        ...
\&
\&        no_context {
\&            # Things in here will not see our current context, they get a new
\&            # one.
\&
\&            $code\->();
\&        };
\&
\&        ...
\&        $ctx\->release;
\&    };
.Ve
.PP
This tool will hide a context for the provided block of code. This means any
tools run inside the block will get a completely new context if they acquire
one. The new context will be inherited by tools nested below the one that
acquired it.
.PP
This will normally hide the current context for the top hub. If you need to
hide the context for a different hub you can pass in the optional \f(CW$hid\fR
parameter.
.SS "intercept(&)"
.IX Subsection "intercept(&)"
Usage:
.PP
.Vb 5
\&    my $events = intercept {
\&        ok(1, "pass");
\&        ok(0, "fail");
\&        ...
\&    };
.Ve
.PP
This function takes a codeblock as its only argument, and it has a prototype.
It will execute the codeblock, intercepting any generated events in the
process. It will return an array reference with all the generated event
objects. All events should be subclasses of Test2::Event.
.PP
This is a very low-level subtest tool. This is useful for writing tools which
produce subtests. This is not intended for people simply writing tests.
.SS "run_subtest(...)"
.IX Subsection "run_subtest(...)"
Usage:
.PP
.Vb 1
\&    run_subtest($NAME, \e&CODE, $BUFFERED, @ARGS)
\&
\&    # or
\&
\&    run_subtest($NAME, \e&CODE, \e%PARAMS, @ARGS)
.Ve
.PP
This will run the provided codeblock with the args in \f(CW@args\fR. This codeblock
will be run as a subtest. A subtest is an isolated test state that is condensed
into a single Test2::Event::Subtest event, which contains all events
generated inside the subtest.
.PP
\fI\s-1ARGUMENTS:\s0\fR
.IX Subsection "ARGUMENTS:"
.ie n .IP "$NAME" 4
.el .IP "\f(CW$NAME\fR" 4
.IX Item "$NAME"
The name of the subtest.
.IP "\e&CODE" 4
.IX Item "&CODE"
The code to run inside the subtest.
.ie n .IP "$BUFFERED or \e%PARAMS" 4
.el .IP "\f(CW$BUFFERED\fR or \e%PARAMS" 4
.IX Item "$BUFFERED or %PARAMS"
If this is a simple scalar then it will be treated as a boolean for the
\&'buffered' setting. If this is a hash reference then it will be used as a
parameters hash. The param hash will be used for hub construction (with the
specified keys removed).
.Sp
Keys that are removed and used by run_subtest:
.RS 4
.ie n .IP "'buffered' => $bool" 4
.el .IP "'buffered' => \f(CW$bool\fR" 4
.IX Item "'buffered' => $bool"
Toggle buffered status.
.ie n .IP "'inherit_trace' => $bool" 4
.el .IP "'inherit_trace' => \f(CW$bool\fR" 4
.IX Item "'inherit_trace' => $bool"
Normally the subtest hub is pushed and the sub is allowed to generate its own
root context for the hub. When this setting is turned on a root context will be
created for the hub that shares the same trace as the current context.
.Sp
Set this to true if your tool is producing subtests without user-specified
subs.
.RE
.RS 4
.RE
.ie n .IP "@ARGS" 4
.el .IP "\f(CW@ARGS\fR" 4
.IX Item "@ARGS"
Any extra arguments you want passed into the subtest code.
.PP
\fI\s-1BUFFERED VS UNBUFFERED \s0(\s-1OR STREAMED\s0)\fR
.IX Subsection "BUFFERED VS UNBUFFERED (OR STREAMED)"
.PP
Normally all events inside and outside a subtest are sent to the formatter
immediately by the hub. Sometimes it is desirable to hold off sending events
within a subtest until the subtest is complete. This usually depends on the
formatter being used.
.IP "Things not effected by this flag" 4
.IX Item "Things not effected by this flag"
In both cases events are generated and stored in an array. This array is
eventually used to populate the \f(CW\*(C`subevents\*(C'\fR attribute on the
Test2::Event::Subtest event that is generated at the end of the subtest.
This flag has no effect on this part, it always happens.
.Sp
At the end of the subtest, the final Test2::Event::Subtest event is sent to
the formatter.
.IP "Things that are effected by this flag" 4
.IX Item "Things that are effected by this flag"
The \f(CW\*(C`buffered\*(C'\fR attribute of the Test2::Event::Subtest event will be set to
the value of this flag. This means any formatter, listener, etc which looks at
the event will know if it was buffered.
.IP "Things that are formatter dependant" 4
.IX Item "Things that are formatter dependant"
Events within a buffered subtest may or may not be sent to the formatter as
they happen. If a formatter fails to specify then the default is to \fB\s-1NOT SEND\s0\fR
the events as they are generated, instead the formatter can pull them from the
\&\f(CW\*(C`subevents\*(C'\fR attribute.
.Sp
A formatter can specify by implementing the \f(CW\*(C`hide_buffered()\*(C'\fR method. If this
method returns true then events generated inside a buffered subtest will not be
sent independently of the final subtest event.
.PP
An example of how this is used is the Test2::Formatter::TAP formatter. For
unbuffered subtests the events are rendered as they are generated. At the end
of the subtest, the final subtest event is rendered, but the \f(CW\*(C`subevents\*(C'\fR
attribute is ignored. For buffered subtests the opposite occurs, the events are
\&\s-1NOT\s0 rendered as they are generated, instead the \f(CW\*(C`subevents\*(C'\fR attribute is used
to render them all at once. This is useful when running subtests tests in
parallel, since without it the output from subtests would be interleaved
together.
.SH "OTHER API EXPORTS"
.IX Header "OTHER API EXPORTS"
Exports in this section are not commonly needed. These all have the 'test2_'
prefix to help ensure they stand out. You should look at the \*(L"\s-1MAIN API
EXPORTS\*(R"\s0 section before looking here. This section is one where \*(L"Great power
comes with great responsibility\*(R". It is possible to break things badly if you
are not careful with these.
.PP
All exports are optional. You need to list which ones you want at import time:
.PP
.Vb 1
\&    use Test2::API qw/test2_init_done .../;
.Ve
.SS "\s-1STATUS AND INITIALIZATION STATE\s0"
.IX Subsection "STATUS AND INITIALIZATION STATE"
These provide access to internal state and object instances.
.ie n .IP "$bool = \fItest2_init_done()\fR" 4
.el .IP "\f(CW$bool\fR = \fItest2_init_done()\fR" 4
.IX Item "$bool = test2_init_done()"
This will return true if the stack and \s-1IPC\s0 instances have already been
initialized. It will return false if they have not. Init happens as late as
possible. It happens as soon as a tool requests the \s-1IPC\s0 instance, the
formatter, or the stack.
.ie n .IP "$bool = \fItest2_load_done()\fR" 4
.el .IP "\f(CW$bool\fR = \fItest2_load_done()\fR" 4
.IX Item "$bool = test2_load_done()"
This will simply return the boolean value of the loaded flag. If Test2 has
finished loading this will be true, otherwise false. Loading is considered
complete the first time a tool requests a context.
.IP "\fItest2_set_is_end()\fR" 4
.IX Item "test2_set_is_end()"
.PD 0
.IP "test2_set_is_end($bool)" 4
.IX Item "test2_set_is_end($bool)"
.PD
This is used to toggle Test2's belief that the \s-1END\s0 phase has already started.
With no arguments this will set it to true. With arguments it will set it to
the first argument's value.
.Sp
This is used to prevent the use of \f(CW\*(C`caller()\*(C'\fR in \s-1END\s0 blocks which can cause
segfaults. This is only necessary in some persistent environments that may have
multiple \s-1END\s0 phases.
.ie n .IP "$bool = \fItest2_get_is_end()\fR" 4
.el .IP "\f(CW$bool\fR = \fItest2_get_is_end()\fR" 4
.IX Item "$bool = test2_get_is_end()"
Check if Test2 believes it is the \s-1END\s0 phase.
.ie n .IP "$stack = \fItest2_stack()\fR" 4
.el .IP "\f(CW$stack\fR = \fItest2_stack()\fR" 4
.IX Item "$stack = test2_stack()"
This will return the global Test2::API::Stack instance. If this has not
yet been initialized it will be initialized now.
.ie n .IP "$bool = \fItest2_no_wait()\fR" 4
.el .IP "\f(CW$bool\fR = \fItest2_no_wait()\fR" 4
.IX Item "$bool = test2_no_wait()"
.PD 0
.IP "test2_no_wait($bool)" 4
.IX Item "test2_no_wait($bool)"
.PD
This can be used to get/set the no_wait status. Waiting is turned on by
default. Waiting will cause the parent process/thread to wait until all child
processes and threads are finished before exiting. You will almost never want
to turn this off.
.SS "\s-1BEHAVIOR HOOKS\s0"
.IX Subsection "BEHAVIOR HOOKS"
These are hooks that allow you to add custom behavior to actions taken by Test2
and tools built on top of it.
.IP "test2_add_callback_exit(sub { ... })" 4
.IX Item "test2_add_callback_exit(sub { ... })"
This can be used to add a callback that is called after all testing is done. This
is too late to add additional results, the main use of this callback is to set the
exit code.
.Sp
.Vb 6
\&    test2_add_callback_exit(
\&        sub {
\&            my ($context, $exit, \e$new_exit) = @_;
\&            ...
\&        }
\&    );
.Ve
.Sp
The \f(CW$context\fR passed in will be an instance of Test2::API::Context. The
\&\f(CW$exit\fR argument will be the original exit code before anything modified it.
\&\f(CW$$new_exit\fR is a reference to the new exit code. You may modify this to
change the exit code. Please note that \f(CW$$new_exit\fR may already be different
from \f(CW$exit\fR
.IP "test2_add_callback_post_load(sub { ... })" 4
.IX Item "test2_add_callback_post_load(sub { ... })"
Add a callback that will be called when Test2 is finished loading. This
means the callback will be run once, the first time a context is obtained.
If Test2 has already finished loading then the callback will be run immediately.
.IP "test2_add_callback_context_acquire(sub { ... })" 4
.IX Item "test2_add_callback_context_acquire(sub { ... })"
Add a callback that will be called every time someone tries to acquire a
context. This will be called on \s-1EVERY\s0 call to \f(CW\*(C`context()\*(C'\fR. It gets a single
argument, a reference to the hash of parameters being used the construct the
context. This is your chance to change the parameters by directly altering the
hash.
.Sp
.Vb 4
\&    test2_add_callback_context_acquire(sub {
\&        my $params = shift;
\&        $params\->{level}++;
\&    });
.Ve
.Sp
This is a very scary \s-1API\s0 function. Please do not use this unless you need to.
This is here for Test::Builder and backwards compatibility. This has you
directly manipulate the hash instead of returning a new one for performance
reasons.
.IP "test2_add_callback_context_init(sub { ... })" 4
.IX Item "test2_add_callback_context_init(sub { ... })"
Add a callback that will be called every time a new context is created. The
callback will receive the newly created context as its only argument.
.IP "test2_add_callback_context_release(sub { ... })" 4
.IX Item "test2_add_callback_context_release(sub { ... })"
Add a callback that will be called every time a context is released. The
callback will receive the released context as its only argument.
.ie n .IP "@list = \fItest2_list_context_acquire_callbacks()\fR" 4
.el .IP "\f(CW@list\fR = \fItest2_list_context_acquire_callbacks()\fR" 4
.IX Item "@list = test2_list_context_acquire_callbacks()"
Return all the context acquire callback references.
.ie n .IP "@list = \fItest2_list_context_init_callbacks()\fR" 4
.el .IP "\f(CW@list\fR = \fItest2_list_context_init_callbacks()\fR" 4
.IX Item "@list = test2_list_context_init_callbacks()"
Returns all the context init callback references.
.ie n .IP "@list = \fItest2_list_context_release_callbacks()\fR" 4
.el .IP "\f(CW@list\fR = \fItest2_list_context_release_callbacks()\fR" 4
.IX Item "@list = test2_list_context_release_callbacks()"
Returns all the context release callback references.
.ie n .IP "@list = \fItest2_list_exit_callbacks()\fR" 4
.el .IP "\f(CW@list\fR = \fItest2_list_exit_callbacks()\fR" 4
.IX Item "@list = test2_list_exit_callbacks()"
Returns all the exit callback references.
.ie n .IP "@list = \fItest2_list_post_load_callbacks()\fR" 4
.el .IP "\f(CW@list\fR = \fItest2_list_post_load_callbacks()\fR" 4
.IX Item "@list = test2_list_post_load_callbacks()"
Returns all the post load callback references.
.SS "\s-1IPC AND CONCURRENCY\s0"
.IX Subsection "IPC AND CONCURRENCY"
These let you access, or specify, the \s-1IPC\s0 system internals.
.ie n .IP "$ipc = \fItest2_ipc()\fR" 4
.el .IP "\f(CW$ipc\fR = \fItest2_ipc()\fR" 4
.IX Item "$ipc = test2_ipc()"
This will return the global Test2::IPC::Driver instance. If this has not yet
been initialized it will be initialized now.
.IP "test2_ipc_add_driver($DRIVER)" 4
.IX Item "test2_ipc_add_driver($DRIVER)"
Add an \s-1IPC\s0 driver to the list. This will add the driver to the start of the
list.
.ie n .IP "@drivers = \fItest2_ipc_drivers()\fR" 4
.el .IP "\f(CW@drivers\fR = \fItest2_ipc_drivers()\fR" 4
.IX Item "@drivers = test2_ipc_drivers()"
Get the list of \s-1IPC\s0 drivers.
.ie n .IP "$bool = \fItest2_ipc_polling()\fR" 4
.el .IP "\f(CW$bool\fR = \fItest2_ipc_polling()\fR" 4
.IX Item "$bool = test2_ipc_polling()"
Check if polling is enabled.
.IP "\fItest2_ipc_enable_polling()\fR" 4
.IX Item "test2_ipc_enable_polling()"
Turn on polling. This will cull events from other processes and threads every
time a context is created.
.IP "\fItest2_ipc_disable_polling()\fR" 4
.IX Item "test2_ipc_disable_polling()"
Turn off \s-1IPC\s0 polling.
.IP "\fItest2_ipc_enable_shm()\fR" 4
.IX Item "test2_ipc_enable_shm()"
Turn on \s-1IPC SHM.\s0 Only some \s-1IPC\s0 drivers use this, and most will turn it on
themselves.
.IP "test2_ipc_set_pending($uniq_val)" 4
.IX Item "test2_ipc_set_pending($uniq_val)"
Tell other processes and events that an event is pending. \f(CW$uniq_val\fR should
be a unique value no other thread/process will generate.
.Sp
\&\fBNote:\fR After calling this \f(CW\*(C`test2_ipc_get_pending()\*(C'\fR will return 1. This is
intentional, and not avoidable.
.ie n .IP "$pending = \fItest2_ipc_get_pending()\fR" 4
.el .IP "\f(CW$pending\fR = \fItest2_ipc_get_pending()\fR" 4
.IX Item "$pending = test2_ipc_get_pending()"
This returns \-1 if there is no way to check (assume yes)
.Sp
This returns 0 if there are (most likely) no pending events.
.Sp
This returns 1 if there are (likely) pending events. Upon return it will reset,
nothing else will be able to see that there were pending events.
.SS "\s-1MANAGING FORMATTERS\s0"
.IX Subsection "MANAGING FORMATTERS"
These let you access, or specify, the formatters that can/should be used.
.ie n .IP "$formatter = test2_formatter" 4
.el .IP "\f(CW$formatter\fR = test2_formatter" 4
.IX Item "$formatter = test2_formatter"
This will return the global formatter class. This is not an instance. By
default the formatter is set to Test2::Formatter::TAP.
.Sp
You can override this default using the \f(CW\*(C`T2_FORMATTER\*(C'\fR environment variable.
.Sp
Normally 'Test2::Formatter::' is prefixed to the value in the
environment variable:
.Sp
.Vb 2
\&    $ T2_FORMATTER=\*(AqTAP\*(Aq perl test.t     # Use the Test2::Formatter::TAP formatter
\&    $ T2_FORMATTER=\*(AqFoo\*(Aq perl test.t     # Use the Test2::Formatter::Foo formatter
.Ve
.Sp
If you want to specify a full module name you use the '+' prefix:
.Sp
.Vb 1
\&    $ T2_FORMATTER=\*(Aq+Foo::Bar\*(Aq perl test.t     # Use the Foo::Bar formatter
.Ve
.IP "test2_formatter_set($class_or_instance)" 4
.IX Item "test2_formatter_set($class_or_instance)"
Set the global formatter class. This can only be set once. \fBNote:\fR This will
override anything specified in the 'T2_FORMATTER' environment variable.
.ie n .IP "@formatters = \fItest2_formatters()\fR" 4
.el .IP "\f(CW@formatters\fR = \fItest2_formatters()\fR" 4
.IX Item "@formatters = test2_formatters()"
Get a list of all loaded formatters.
.IP "test2_formatter_add($class_or_instance)" 4
.IX Item "test2_formatter_add($class_or_instance)"
Add a formatter to the list. Last formatter added is used at initialization. If
this is called after initialization a warning will be issued.
.SH "OTHER EXAMPLES"
.IX Header "OTHER EXAMPLES"
See the \f(CW\*(C`/Examples/\*(C'\fR directory included in this distribution.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Test2::API::Context \- Detailed documentation of the context object.
.PP
Test2::IPC \- The \s-1IPC\s0 system used for threading/fork support.
.PP
Test2::Formatter \- Formatters such as \s-1TAP\s0 live here.
.PP
Test2::Event \- Events live in this namespace.
.PP
Test2::Hub \- All events eventually funnel through a hub. Custom hubs are how
\&\f(CW\*(C`intercept()\*(C'\fR and \f(CW\*(C`run_subtest()\*(C'\fR are implemented.
.SH "MAGIC"
.IX Header "MAGIC"
This package has an \s-1END\s0 block. This \s-1END\s0 block is responsible for setting the
exit code based on the test results. This end block also calls the callbacks that
can be added to this package.
.SH "SOURCE"
.IX Header "SOURCE"
The source code repository for Test2 can be found at
\&\fIhttp://github.com/Test\-More/test\-more/\fR.
.SH "MAINTAINERS"
.IX Header "MAINTAINERS"
.IP "Chad Granum <exodist@cpan.org>" 4
.IX Item "Chad Granum <exodist@cpan.org>"
.SH "AUTHORS"
.IX Header "AUTHORS"
.PD 0
.IP "Chad Granum <exodist@cpan.org>" 4
.IX Item "Chad Granum <exodist@cpan.org>"
.PD
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2016 Chad Granum <exodist@cpan.org>.
.PP
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
.PP
See \fIhttp://dev.perl.org/licenses/\fR

cmd: