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/Compress::Raw::Zlib.3pm (42082B)

.\" 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 "Compress::Raw::Zlib 3"
.TH Compress::Raw::Zlib 3 "2015-09-26" "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"
Compress::Raw::Zlib \- Low\-Level Interface to zlib compression library
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Compress::Raw::Zlib ;
\&
\&    ($d, $status) = new Compress::Raw::Zlib::Deflate( [OPT] ) ;
\&    $status = $d\->deflate($input, $output) ;
\&    $status = $d\->flush($output [, $flush_type]) ;
\&    $d\->deflateReset() ;
\&    $d\->deflateParams(OPTS) ;
\&    $d\->deflateTune(OPTS) ;
\&    $d\->dict_adler() ;
\&    $d\->crc32() ;
\&    $d\->adler32() ;
\&    $d\->total_in() ;
\&    $d\->total_out() ;
\&    $d\->msg() ;
\&    $d\->get_Strategy();
\&    $d\->get_Level();
\&    $d\->get_BufSize();
\&
\&    ($i, $status) = new Compress::Raw::Zlib::Inflate( [OPT] ) ;
\&    $status = $i\->inflate($input, $output [, $eof]) ;
\&    $status = $i\->inflateSync($input) ;
\&    $i\->inflateReset() ;
\&    $i\->dict_adler() ;
\&    $d\->crc32() ;
\&    $d\->adler32() ;
\&    $i\->total_in() ;
\&    $i\->total_out() ;
\&    $i\->msg() ;
\&    $d\->get_BufSize();
\&
\&    $crc = adler32($buffer [,$crc]) ;
\&    $crc = crc32($buffer [,$crc]) ;
\&
\&    $crc = crc32_combine($crc1, $crc2, $len2);
\&    $adler = adler32_combine($adler1, $adler2, $len2);
\&
\&    my $version = Compress::Raw::Zlib::zlib_version();
\&    my $flags = Compress::Raw::Zlib::zlibCompileFlags();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \fICompress::Raw::Zlib\fR module provides a Perl interface to the \fIzlib\fR
compression library (see \*(L"\s-1AUTHOR\*(R"\s0 for details about where to get
\&\fIzlib\fR).
.SH "Compress::Raw::Zlib::Deflate"
.IX Header "Compress::Raw::Zlib::Deflate"
This section defines an interface that allows in-memory compression using
the \fIdeflate\fR interface provided by zlib.
.PP
Here is a definition of the interface available:
.ie n .SS "\fB($d, \fP\fB$status\fP\fB) = new Compress::Raw::Zlib::Deflate( [\s-1OPT\s0] ) \fP"
.el .SS "\fB($d, \fP\f(CB$status\fP\fB) = new Compress::Raw::Zlib::Deflate( [\s-1OPT\s0] ) \fP"
.IX Subsection "($d, $status) = new Compress::Raw::Zlib::Deflate( [OPT] ) "
Initialises a deflation object.
.PP
If you are familiar with the \fIzlib\fR library, it combines the
features of the \fIzlib\fR functions \f(CW\*(C`deflateInit\*(C'\fR, \f(CW\*(C`deflateInit2\*(C'\fR
and \f(CW\*(C`deflateSetDictionary\*(C'\fR.
.PP
If successful, it will return the initialised deflation object, \f(CW$d\fR
and a \f(CW$status\fR of \f(CW\*(C`Z_OK\*(C'\fR in a list context. In scalar context it
returns the deflation object, \f(CW$d\fR, only.
.PP
If not successful, the returned deflation object, \f(CW$d\fR, will be
\&\fIundef\fR and \f(CW$status\fR will hold the a \fIzlib\fR error code.
.PP
The function optionally takes a number of named options specified as
\&\f(CW\*(C`Name => value\*(C'\fR pairs. This allows individual options to be
tailored without having to specify them all in the parameter list.
.PP
For backward compatibility, it is also possible to pass the parameters
as a reference to a hash containing the name=>value pairs.
.PP
Below is a list of the valid options:
.IP "\fB\-Level\fR" 5
.IX Item "-Level"
Defines the compression level. Valid values are 0 through 9,
\&\f(CW\*(C`Z_NO_COMPRESSION\*(C'\fR, \f(CW\*(C`Z_BEST_SPEED\*(C'\fR, \f(CW\*(C`Z_BEST_COMPRESSION\*(C'\fR, and
\&\f(CW\*(C`Z_DEFAULT_COMPRESSION\*(C'\fR.
.Sp
The default is \f(CW\*(C`Z_DEFAULT_COMPRESSION\*(C'\fR.
.IP "\fB\-Method\fR" 5
.IX Item "-Method"
Defines the compression method. The only valid value at present (and
the default) is \f(CW\*(C`Z_DEFLATED\*(C'\fR.
.IP "\fB\-WindowBits\fR" 5
.IX Item "-WindowBits"
To compress an \s-1RFC 1950\s0 data stream, set \f(CW\*(C`WindowBits\*(C'\fR to a positive
number between 8 and 15.
.Sp
To compress an \s-1RFC 1951\s0 data stream, set \f(CW\*(C`WindowBits\*(C'\fR to \f(CW\*(C`\-MAX_WBITS\*(C'\fR.
.Sp
To compress an \s-1RFC 1952\s0 data stream (i.e. gzip), set \f(CW\*(C`WindowBits\*(C'\fR to
\&\f(CW\*(C`WANT_GZIP\*(C'\fR.
.Sp
For a definition of the meaning and valid values for \f(CW\*(C`WindowBits\*(C'\fR
refer to the \fIzlib\fR documentation for \fIdeflateInit2\fR.
.Sp
Defaults to \f(CW\*(C`MAX_WBITS\*(C'\fR.
.IP "\fB\-MemLevel\fR" 5
.IX Item "-MemLevel"
For a definition of the meaning and valid values for \f(CW\*(C`MemLevel\*(C'\fR
refer to the \fIzlib\fR documentation for \fIdeflateInit2\fR.
.Sp
Defaults to \s-1MAX_MEM_LEVEL.\s0
.IP "\fB\-Strategy\fR" 5
.IX Item "-Strategy"
Defines the strategy used to tune the compression. The valid values are
\&\f(CW\*(C`Z_DEFAULT_STRATEGY\*(C'\fR, \f(CW\*(C`Z_FILTERED\*(C'\fR, \f(CW\*(C`Z_RLE\*(C'\fR, \f(CW\*(C`Z_FIXED\*(C'\fR and
\&\f(CW\*(C`Z_HUFFMAN_ONLY\*(C'\fR.
.Sp
The default is \f(CW\*(C`Z_DEFAULT_STRATEGY\*(C'\fR.
.IP "\fB\-Dictionary\fR" 5
.IX Item "-Dictionary"
When a dictionary is specified \fICompress::Raw::Zlib\fR will automatically
call \f(CW\*(C`deflateSetDictionary\*(C'\fR directly after calling \f(CW\*(C`deflateInit\*(C'\fR. The
Adler32 value for the dictionary can be obtained by calling the method 
\&\f(CW\*(C`$d\->dict_adler()\*(C'\fR.
.Sp
The default is no dictionary.
.IP "\fB\-Bufsize\fR" 5
.IX Item "-Bufsize"
Sets the initial size for the output buffer used by the \f(CW\*(C`$d\->deflate\*(C'\fR
and \f(CW\*(C`$d\->flush\*(C'\fR methods. If the buffer has to be
reallocated to increase the size, it will grow in increments of
\&\f(CW\*(C`Bufsize\*(C'\fR.
.Sp
The default buffer size is 4096.
.IP "\fB\-AppendOutput\fR" 5
.IX Item "-AppendOutput"
This option controls how data is written to the output buffer by the
\&\f(CW\*(C`$d\->deflate\*(C'\fR and \f(CW\*(C`$d\->flush\*(C'\fR methods.
.Sp
If the \f(CW\*(C`AppendOutput\*(C'\fR option is set to false, the output buffers in the
\&\f(CW\*(C`$d\->deflate\*(C'\fR and \f(CW\*(C`$d\->flush\*(C'\fR  methods will be truncated before
uncompressed data is written to them.
.Sp
If the option is set to true, uncompressed data will be appended to the
output buffer in the \f(CW\*(C`$d\->deflate\*(C'\fR and \f(CW\*(C`$d\->flush\*(C'\fR methods.
.Sp
This option defaults to false.
.IP "\fB\-CRC32\fR" 5
.IX Item "-CRC32"
If set to true, a crc32 checksum of the uncompressed data will be
calculated. Use the \f(CW\*(C`$d\->crc32\*(C'\fR method to retrieve this value.
.Sp
This option defaults to false.
.IP "\fB\-ADLER32\fR" 5
.IX Item "-ADLER32"
If set to true, an adler32 checksum of the uncompressed data will be
calculated. Use the \f(CW\*(C`$d\->adler32\*(C'\fR method to retrieve this value.
.Sp
This option defaults to false.
.PP
Here is an example of using the \f(CW\*(C`Compress::Raw::Zlib::Deflate\*(C'\fR optional
parameter list to override the default buffer size and compression
level. All other options will take their default values.
.PP
.Vb 2
\&    my $d = new Compress::Raw::Zlib::Deflate ( \-Bufsize => 300, 
\&                                               \-Level   => Z_BEST_SPEED ) ;
.Ve
.ie n .SS "\fB\fP\fB$status\fP\fB = \fP\fB$d\fP\fB\->deflate($input, \fP\fB$output\fP\fB)\fP"
.el .SS "\fB\fP\f(CB$status\fP\fB = \fP\f(CB$d\fP\fB\->deflate($input, \fP\f(CB$output\fP\fB)\fP"
.IX Subsection "$status = $d->deflate($input, $output)"
Deflates the contents of \f(CW$input\fR and writes the compressed data to
\&\f(CW$output\fR.
.PP
The \f(CW$input\fR and \f(CW$output\fR parameters can be either scalars or scalar
references.
.PP
When finished, \f(CW$input\fR will be completely processed (assuming there
were no errors). If the deflation was successful it writes the deflated
data to \f(CW$output\fR and returns a status value of \f(CW\*(C`Z_OK\*(C'\fR.
.PP
On error, it returns a \fIzlib\fR error code.
.PP
If the \f(CW\*(C`AppendOutput\*(C'\fR option is set to true in the constructor for
the \f(CW$d\fR object, the compressed data will be appended to \f(CW$output\fR. If
it is false, \f(CW$output\fR will be truncated before any compressed data is
written to it.
.PP
\&\fBNote\fR: This method will not necessarily write compressed data to
\&\f(CW$output\fR every time it is called. So do not assume that there has been
an error if the contents of \f(CW$output\fR is empty on returning from
this method. As long as the return code from the method is \f(CW\*(C`Z_OK\*(C'\fR,
the deflate has succeeded.
.ie n .SS "\fB\fP\fB$status\fP\fB = \fP\fB$d\fP\fB\->flush($output [, \fP\fB$flush_type\fP\fB]) \fP"
.el .SS "\fB\fP\f(CB$status\fP\fB = \fP\f(CB$d\fP\fB\->flush($output [, \fP\f(CB$flush_type\fP\fB]) \fP"
.IX Subsection "$status = $d->flush($output [, $flush_type]) "
Typically used to finish the deflation. Any pending output will be
written to \f(CW$output\fR.
.PP
Returns \f(CW\*(C`Z_OK\*(C'\fR if successful.
.PP
Note that flushing can seriously degrade the compression ratio, so it
should only be used to terminate a decompression (using \f(CW\*(C`Z_FINISH\*(C'\fR) or
when you want to create a \fIfull flush point\fR (using \f(CW\*(C`Z_FULL_FLUSH\*(C'\fR).
.PP
By default the \f(CW\*(C`flush_type\*(C'\fR used is \f(CW\*(C`Z_FINISH\*(C'\fR. Other valid values
for \f(CW\*(C`flush_type\*(C'\fR are \f(CW\*(C`Z_NO_FLUSH\*(C'\fR, \f(CW\*(C`Z_PARTIAL_FLUSH\*(C'\fR, \f(CW\*(C`Z_SYNC_FLUSH\*(C'\fR
and \f(CW\*(C`Z_FULL_FLUSH\*(C'\fR. It is strongly recommended that you only set the
\&\f(CW\*(C`flush_type\*(C'\fR parameter if you fully understand the implications of
what it does. See the \f(CW\*(C`zlib\*(C'\fR documentation for details.
.PP
If the \f(CW\*(C`AppendOutput\*(C'\fR option is set to true in the constructor for
the \f(CW$d\fR object, the compressed data will be appended to \f(CW$output\fR. If
it is false, \f(CW$output\fR will be truncated before any compressed data is
written to it.
.ie n .SS "\fB\fP\fB$status\fP\fB = \fP\fB$d\fP\fB\->\fP\f(BIdeflateReset()\fP\fB \fP"
.el .SS "\fB\fP\f(CB$status\fP\fB = \fP\f(CB$d\fP\fB\->\fP\f(BIdeflateReset()\fP\fB \fP"
.IX Subsection "$status = $d->deflateReset() "
This method will reset the deflation object \f(CW$d\fR. It can be used when you
are compressing multiple data streams and want to use the same object to
compress each of them. It should only be used once the previous data stream
has been flushed successfully, i.e. a call to \f(CW\*(C`$d\->flush(Z_FINISH)\*(C'\fR has
returned \f(CW\*(C`Z_OK\*(C'\fR.
.PP
Returns \f(CW\*(C`Z_OK\*(C'\fR if successful.
.ie n .SS "\fB\fP\fB$status\fP\fB = \fP\fB$d\fP\fB\->deflateParams([\s-1OPT\s0])\fP"
.el .SS "\fB\fP\f(CB$status\fP\fB = \fP\f(CB$d\fP\fB\->deflateParams([\s-1OPT\s0])\fP"
.IX Subsection "$status = $d->deflateParams([OPT])"
Change settings for the deflate object \f(CW$d\fR.
.PP
The list of the valid options is shown below. Options not specified
will remain unchanged.
.IP "\fB\-Level\fR" 5
.IX Item "-Level"
Defines the compression level. Valid values are 0 through 9,
\&\f(CW\*(C`Z_NO_COMPRESSION\*(C'\fR, \f(CW\*(C`Z_BEST_SPEED\*(C'\fR, \f(CW\*(C`Z_BEST_COMPRESSION\*(C'\fR, and
\&\f(CW\*(C`Z_DEFAULT_COMPRESSION\*(C'\fR.
.IP "\fB\-Strategy\fR" 5
.IX Item "-Strategy"
Defines the strategy used to tune the compression. The valid values are
\&\f(CW\*(C`Z_DEFAULT_STRATEGY\*(C'\fR, \f(CW\*(C`Z_FILTERED\*(C'\fR and \f(CW\*(C`Z_HUFFMAN_ONLY\*(C'\fR.
.IP "\fB\-BufSize\fR" 5
.IX Item "-BufSize"
Sets the initial size for the output buffer used by the \f(CW\*(C`$d\->deflate\*(C'\fR
and \f(CW\*(C`$d\->flush\*(C'\fR methods. If the buffer has to be
reallocated to increase the size, it will grow in increments of
\&\f(CW\*(C`Bufsize\*(C'\fR.
.ie n .SS "\fB\fP\fB$status\fP\fB = \fP\fB$d\fP\fB\->deflateTune($good_length, \fP\fB$max_lazy\fP\fB, \fP\fB$nice_length\fP\fB, \fP\fB$max_chain\fP\fB)\fP"
.el .SS "\fB\fP\f(CB$status\fP\fB = \fP\f(CB$d\fP\fB\->deflateTune($good_length, \fP\f(CB$max_lazy\fP\fB, \fP\f(CB$nice_length\fP\fB, \fP\f(CB$max_chain\fP\fB)\fP"
.IX Subsection "$status = $d->deflateTune($good_length, $max_lazy, $nice_length, $max_chain)"
Tune the internal settings for the deflate object \f(CW$d\fR. This option is
only available if you are running zlib 1.2.2.3 or better.
.PP
Refer to the documentation in zlib.h for instructions on how to fly
\&\f(CW\*(C`deflateTune\*(C'\fR.
.ie n .SS "\fB\fP\fB$d\fP\fB\->\fP\f(BIdict_adler()\fP\fB\fP"
.el .SS "\fB\fP\f(CB$d\fP\fB\->\fP\f(BIdict_adler()\fP\fB\fP"
.IX Subsection "$d->dict_adler()"
Returns the adler32 value for the dictionary.
.ie n .SS "\fB\fP\fB$d\fP\fB\->\fP\f(BIcrc32()\fP\fB\fP"
.el .SS "\fB\fP\f(CB$d\fP\fB\->\fP\f(BIcrc32()\fP\fB\fP"
.IX Subsection "$d->crc32()"
Returns the crc32 value for the uncompressed data to date.
.PP
If the \f(CW\*(C`CRC32\*(C'\fR option is not enabled in the constructor for this object,
this method will always return 0;
.ie n .SS "\fB\fP\fB$d\fP\fB\->\fP\f(BIadler32()\fP\fB\fP"
.el .SS "\fB\fP\f(CB$d\fP\fB\->\fP\f(BIadler32()\fP\fB\fP"
.IX Subsection "$d->adler32()"
Returns the adler32 value for the uncompressed data to date.
.ie n .SS "\fB\fP\fB$d\fP\fB\->\fP\f(BImsg()\fP\fB\fP"
.el .SS "\fB\fP\f(CB$d\fP\fB\->\fP\f(BImsg()\fP\fB\fP"
.IX Subsection "$d->msg()"
Returns the last error message generated by zlib.
.ie n .SS "\fB\fP\fB$d\fP\fB\->\fP\f(BItotal_in()\fP\fB\fP"
.el .SS "\fB\fP\f(CB$d\fP\fB\->\fP\f(BItotal_in()\fP\fB\fP"
.IX Subsection "$d->total_in()"
Returns the total number of bytes uncompressed bytes input to deflate.
.ie n .SS "\fB\fP\fB$d\fP\fB\->\fP\f(BItotal_out()\fP\fB\fP"
.el .SS "\fB\fP\f(CB$d\fP\fB\->\fP\f(BItotal_out()\fP\fB\fP"
.IX Subsection "$d->total_out()"
Returns the total number of compressed bytes output from deflate.
.ie n .SS "\fB\fP\fB$d\fP\fB\->\fP\f(BIget_Strategy()\fP\fB\fP"
.el .SS "\fB\fP\f(CB$d\fP\fB\->\fP\f(BIget_Strategy()\fP\fB\fP"
.IX Subsection "$d->get_Strategy()"
Returns the deflation strategy currently used. Valid values are
\&\f(CW\*(C`Z_DEFAULT_STRATEGY\*(C'\fR, \f(CW\*(C`Z_FILTERED\*(C'\fR and \f(CW\*(C`Z_HUFFMAN_ONLY\*(C'\fR.
.ie n .SS "\fB\fP\fB$d\fP\fB\->\fP\f(BIget_Level()\fP\fB\fP"
.el .SS "\fB\fP\f(CB$d\fP\fB\->\fP\f(BIget_Level()\fP\fB\fP"
.IX Subsection "$d->get_Level()"
Returns the compression level being used.
.ie n .SS "\fB\fP\fB$d\fP\fB\->\fP\f(BIget_BufSize()\fP\fB\fP"
.el .SS "\fB\fP\f(CB$d\fP\fB\->\fP\f(BIget_BufSize()\fP\fB\fP"
.IX Subsection "$d->get_BufSize()"
Returns the buffer size used to carry out the compression.
.SS "Example"
.IX Subsection "Example"
Here is a trivial example of using \f(CW\*(C`deflate\*(C'\fR. It simply reads standard
input, deflates it and writes it to standard output.
.PP
.Vb 2
\&    use strict ;
\&    use warnings ;
\&
\&    use Compress::Raw::Zlib ;
\&
\&    binmode STDIN;
\&    binmode STDOUT;
\&    my $x = new Compress::Raw::Zlib::Deflate
\&       or die "Cannot create a deflation stream\en" ;
\&
\&    my ($output, $status) ;
\&    while (<>)
\&    {
\&        $status = $x\->deflate($_, $output) ;
\&    
\&        $status == Z_OK
\&            or die "deflation failed\en" ;
\&    
\&        print $output ;
\&    }
\&    
\&    $status = $x\->flush($output) ;
\&    
\&    $status == Z_OK
\&        or die "deflation failed\en" ;
\&    
\&    print $output ;
.Ve
.SH "Compress::Raw::Zlib::Inflate"
.IX Header "Compress::Raw::Zlib::Inflate"
This section defines an interface that allows in-memory uncompression using
the \fIinflate\fR interface provided by zlib.
.PP
Here is a definition of the interface:
.ie n .SS "\fB ($i, \fP\fB$status\fP\fB) = new Compress::Raw::Zlib::Inflate( [\s-1OPT\s0] ) \fP"
.el .SS "\fB ($i, \fP\f(CB$status\fP\fB) = new Compress::Raw::Zlib::Inflate( [\s-1OPT\s0] ) \fP"
.IX Subsection " ($i, $status) = new Compress::Raw::Zlib::Inflate( [OPT] ) "
Initialises an inflation object.
.PP
In a list context it returns the inflation object, \f(CW$i\fR, and the
\&\fIzlib\fR status code (\f(CW$status\fR). In a scalar context it returns the
inflation object only.
.PP
If successful, \f(CW$i\fR will hold the inflation object and \f(CW$status\fR will
be \f(CW\*(C`Z_OK\*(C'\fR.
.PP
If not successful, \f(CW$i\fR will be \fIundef\fR and \f(CW$status\fR will hold the
\&\fIzlib\fR error code.
.PP
The function optionally takes a number of named options specified as
\&\f(CW\*(C`\-Name => value\*(C'\fR pairs. This allows individual options to be
tailored without having to specify them all in the parameter list.
.PP
For backward compatibility, it is also possible to pass the parameters
as a reference to a hash containing the \f(CW\*(C`name=>value\*(C'\fR pairs.
.PP
Here is a list of the valid options:
.IP "\fB\-WindowBits\fR" 5
.IX Item "-WindowBits"
To uncompress an \s-1RFC 1950\s0 data stream, set \f(CW\*(C`WindowBits\*(C'\fR to a positive
number between 8 and 15.
.Sp
To uncompress an \s-1RFC 1951\s0 data stream, set \f(CW\*(C`WindowBits\*(C'\fR to \f(CW\*(C`\-MAX_WBITS\*(C'\fR.
.Sp
To uncompress an \s-1RFC 1952\s0 data stream (i.e. gzip), set \f(CW\*(C`WindowBits\*(C'\fR to
\&\f(CW\*(C`WANT_GZIP\*(C'\fR.
.Sp
To auto-detect and uncompress an \s-1RFC 1950\s0 or \s-1RFC 1952\s0 data stream (i.e.
gzip), set \f(CW\*(C`WindowBits\*(C'\fR to \f(CW\*(C`WANT_GZIP_OR_ZLIB\*(C'\fR.
.Sp
For a full definition of the meaning and valid values for \f(CW\*(C`WindowBits\*(C'\fR
refer to the \fIzlib\fR documentation for \fIinflateInit2\fR.
.Sp
Defaults to \f(CW\*(C`MAX_WBITS\*(C'\fR.
.IP "\fB\-Bufsize\fR" 5
.IX Item "-Bufsize"
Sets the initial size for the output buffer used by the \f(CW\*(C`$i\->inflate\*(C'\fR
method. If the output buffer in this method has to be reallocated to
increase the size, it will grow in increments of \f(CW\*(C`Bufsize\*(C'\fR.
.Sp
Default is 4096.
.IP "\fB\-Dictionary\fR" 5
.IX Item "-Dictionary"
The default is no dictionary.
.IP "\fB\-AppendOutput\fR" 5
.IX Item "-AppendOutput"
This option controls how data is written to the output buffer by the
\&\f(CW\*(C`$i\->inflate\*(C'\fR method.
.Sp
If the option is set to false, the output buffer in the \f(CW\*(C`$i\->inflate\*(C'\fR
method will be truncated before uncompressed data is written to it.
.Sp
If the option is set to true, uncompressed data will be appended to the
output buffer by the \f(CW\*(C`$i\->inflate\*(C'\fR method.
.Sp
This option defaults to false.
.IP "\fB\-CRC32\fR" 5
.IX Item "-CRC32"
If set to true, a crc32 checksum of the uncompressed data will be
calculated. Use the \f(CW\*(C`$i\->crc32\*(C'\fR method to retrieve this value.
.Sp
This option defaults to false.
.IP "\fB\-ADLER32\fR" 5
.IX Item "-ADLER32"
If set to true, an adler32 checksum of the uncompressed data will be
calculated. Use the \f(CW\*(C`$i\->adler32\*(C'\fR method to retrieve this value.
.Sp
This option defaults to false.
.IP "\fB\-ConsumeInput\fR" 5
.IX Item "-ConsumeInput"
If set to true, this option will remove compressed data from the input
buffer of the \f(CW\*(C`$i\->inflate\*(C'\fR method as the inflate progresses.
.Sp
This option can be useful when you are processing compressed data that is
embedded in another file/buffer. In this case the data that immediately
follows the compressed stream will be left in the input buffer.
.Sp
This option defaults to true.
.IP "\fB\-LimitOutput\fR" 5
.IX Item "-LimitOutput"
The \f(CW\*(C`LimitOutput\*(C'\fR option changes the behavior of the \f(CW\*(C`$i\->inflate\*(C'\fR
method so that the amount of memory used by the output buffer can be
limited.
.Sp
When \f(CW\*(C`LimitOutput\*(C'\fR is used the size of the output buffer used will either
be the value of the \f(CW\*(C`Bufsize\*(C'\fR option or the amount of memory already
allocated to \f(CW$output\fR, whichever is larger. Predicting the output size
available is tricky, so don't rely on getting an exact output buffer size.
.Sp
When \f(CW\*(C`LimitOutout\*(C'\fR is not specified \f(CW\*(C`$i\->inflate\*(C'\fR will use as much
memory as it takes to write all the uncompressed data it creates by
uncompressing the input buffer.
.Sp
If \f(CW\*(C`LimitOutput\*(C'\fR is enabled, the \f(CW\*(C`ConsumeInput\*(C'\fR option will also be
enabled.
.Sp
This option defaults to false.
.Sp
See \*(L"The LimitOutput option\*(R" for a discussion on why \f(CW\*(C`LimitOutput\*(C'\fR is
needed and how to use it.
.PP
Here is an example of using an optional parameter to override the default
buffer size.
.PP
.Vb 1
\&    my ($i, $status) = new Compress::Raw::Zlib::Inflate( \-Bufsize => 300 ) ;
.Ve
.ie n .SS "\fB \fP\fB$status\fP\fB = \fP\fB$i\fP\fB\->inflate($input, \fP\fB$output\fP\fB [,$eof]) \fP"
.el .SS "\fB \fP\f(CB$status\fP\fB = \fP\f(CB$i\fP\fB\->inflate($input, \fP\f(CB$output\fP\fB [,$eof]) \fP"
.IX Subsection " $status = $i->inflate($input, $output [,$eof]) "
Inflates the complete contents of \f(CW$input\fR and writes the uncompressed
data to \f(CW$output\fR. The \f(CW$input\fR and \f(CW$output\fR parameters can either be
scalars or scalar references.
.PP
Returns \f(CW\*(C`Z_OK\*(C'\fR if successful and \f(CW\*(C`Z_STREAM_END\*(C'\fR if the end of the
compressed data has been successfully reached.
.PP
If not successful \f(CW$status\fR will hold the \fIzlib\fR error code.
.PP
If the \f(CW\*(C`ConsumeInput\*(C'\fR option has been set to true when the
\&\f(CW\*(C`Compress::Raw::Zlib::Inflate\*(C'\fR object is created, the \f(CW$input\fR parameter
is modified by \f(CW\*(C`inflate\*(C'\fR. On completion it will contain what remains
of the input buffer after inflation. In practice, this means that when
the return status is \f(CW\*(C`Z_OK\*(C'\fR the \f(CW$input\fR parameter will contain an
empty string, and when the return status is \f(CW\*(C`Z_STREAM_END\*(C'\fR the \f(CW$input\fR
parameter will contains what (if anything) was stored in the input buffer
after the deflated data stream.
.PP
This feature is useful when processing a file format that encapsulates
a compressed data stream (e.g. gzip, zip) and there is useful data
immediately after the deflation stream.
.PP
If the \f(CW\*(C`AppendOutput\*(C'\fR option is set to true in the constructor for
this object, the uncompressed data will be appended to \f(CW$output\fR. If
it is false, \f(CW$output\fR will be truncated before any uncompressed data
is written to it.
.PP
The \f(CW$eof\fR parameter needs a bit of explanation.
.PP
Prior to version 1.2.0, zlib assumed that there was at least one trailing
byte immediately after the compressed data stream when it was carrying out
decompression. This normally isn't a problem because the majority of zlib
applications guarantee that there will be data directly after the
compressed data stream.  For example, both gzip (\s-1RFC 1950\s0) and zip both
define trailing data that follows the compressed data stream.
.PP
The \f(CW$eof\fR parameter only needs to be used if \fBall\fR of the following
conditions apply
.IP "1." 5
You are either using a copy of zlib that is older than version 1.2.0 or you
want your application code to be able to run with as many different
versions of zlib as possible.
.IP "2." 5
You have set the \f(CW\*(C`WindowBits\*(C'\fR parameter to \f(CW\*(C`\-MAX_WBITS\*(C'\fR in the constructor
for this object, i.e. you are uncompressing a raw deflated data stream
(\s-1RFC 1951\s0).
.IP "3." 5
There is no data immediately after the compressed data stream.
.PP
If \fBall\fR of these are the case, then you need to set the \f(CW$eof\fR parameter
to true on the final call (and only the final call) to \f(CW\*(C`$i\->inflate\*(C'\fR.
.PP
If you have built this module with zlib >= 1.2.0, the \f(CW$eof\fR parameter is
ignored. You can still set it if you want, but it won't be used behind the
scenes.
.ie n .SS "\fB\fP\fB$status\fP\fB = \fP\fB$i\fP\fB\->inflateSync($input)\fP"
.el .SS "\fB\fP\f(CB$status\fP\fB = \fP\f(CB$i\fP\fB\->inflateSync($input)\fP"
.IX Subsection "$status = $i->inflateSync($input)"
This method can be used to attempt to recover good data from a compressed
data stream that is partially corrupt.
It scans \f(CW$input\fR until it reaches either a \fIfull flush point\fR or the
end of the buffer.
.PP
If a \fIfull flush point\fR is found, \f(CW\*(C`Z_OK\*(C'\fR is returned and \f(CW$input\fR
will be have all data up to the flush point removed. This data can then be
passed to the \f(CW\*(C`$i\->inflate\*(C'\fR method to be uncompressed.
.PP
Any other return code means that a flush point was not found. If more
data is available, \f(CW\*(C`inflateSync\*(C'\fR can be called repeatedly with more
compressed data until the flush point is found.
.PP
Note \fIfull flush points\fR are not present by default in compressed
data streams. They must have been added explicitly when the data stream
was created by calling \f(CW\*(C`Compress::Deflate::flush\*(C'\fR  with \f(CW\*(C`Z_FULL_FLUSH\*(C'\fR.
.ie n .SS "\fB\fP\fB$status\fP\fB = \fP\fB$i\fP\fB\->\fP\f(BIinflateReset()\fP\fB \fP"
.el .SS "\fB\fP\f(CB$status\fP\fB = \fP\f(CB$i\fP\fB\->\fP\f(BIinflateReset()\fP\fB \fP"
.IX Subsection "$status = $i->inflateReset() "
This method will reset the inflation object \f(CW$i\fR. It can be used when you
are uncompressing multiple data streams and want to use the same object to
uncompress each of them.
.PP
Returns \f(CW\*(C`Z_OK\*(C'\fR if successful.
.ie n .SS "\fB\fP\fB$i\fP\fB\->\fP\f(BIdict_adler()\fP\fB\fP"
.el .SS "\fB\fP\f(CB$i\fP\fB\->\fP\f(BIdict_adler()\fP\fB\fP"
.IX Subsection "$i->dict_adler()"
Returns the adler32 value for the dictionary.
.ie n .SS "\fB\fP\fB$i\fP\fB\->\fP\f(BIcrc32()\fP\fB\fP"
.el .SS "\fB\fP\f(CB$i\fP\fB\->\fP\f(BIcrc32()\fP\fB\fP"
.IX Subsection "$i->crc32()"
Returns the crc32 value for the uncompressed data to date.
.PP
If the \f(CW\*(C`CRC32\*(C'\fR option is not enabled in the constructor for this object,
this method will always return 0;
.ie n .SS "\fB\fP\fB$i\fP\fB\->\fP\f(BIadler32()\fP\fB\fP"
.el .SS "\fB\fP\f(CB$i\fP\fB\->\fP\f(BIadler32()\fP\fB\fP"
.IX Subsection "$i->adler32()"
Returns the adler32 value for the uncompressed data to date.
.PP
If the \f(CW\*(C`ADLER32\*(C'\fR option is not enabled in the constructor for this object,
this method will always return 0;
.ie n .SS "\fB\fP\fB$i\fP\fB\->\fP\f(BImsg()\fP\fB\fP"
.el .SS "\fB\fP\f(CB$i\fP\fB\->\fP\f(BImsg()\fP\fB\fP"
.IX Subsection "$i->msg()"
Returns the last error message generated by zlib.
.ie n .SS "\fB\fP\fB$i\fP\fB\->\fP\f(BItotal_in()\fP\fB\fP"
.el .SS "\fB\fP\f(CB$i\fP\fB\->\fP\f(BItotal_in()\fP\fB\fP"
.IX Subsection "$i->total_in()"
Returns the total number of bytes compressed bytes input to inflate.
.ie n .SS "\fB\fP\fB$i\fP\fB\->\fP\f(BItotal_out()\fP\fB\fP"
.el .SS "\fB\fP\f(CB$i\fP\fB\->\fP\f(BItotal_out()\fP\fB\fP"
.IX Subsection "$i->total_out()"
Returns the total number of uncompressed bytes output from inflate.
.ie n .SS "\fB\fP\fB$d\fP\fB\->\fP\f(BIget_BufSize()\fP\fB\fP"
.el .SS "\fB\fP\f(CB$d\fP\fB\->\fP\f(BIget_BufSize()\fP\fB\fP"
.IX Subsection "$d->get_BufSize()"
Returns the buffer size used to carry out the decompression.
.SS "Examples"
.IX Subsection "Examples"
Here is an example of using \f(CW\*(C`inflate\*(C'\fR.
.PP
.Vb 2
\&    use strict ;
\&    use warnings ;
\&    
\&    use Compress::Raw::Zlib;
\&    
\&    my $x = new Compress::Raw::Zlib::Inflate()
\&       or die "Cannot create a inflation stream\en" ;
\&    
\&    my $input = \*(Aq\*(Aq ;
\&    binmode STDIN;
\&    binmode STDOUT;
\&    
\&    my ($output, $status) ;
\&    while (read(STDIN, $input, 4096))
\&    {
\&        $status = $x\->inflate($input, $output) ;
\&    
\&        print $output ;
\&    
\&        last if $status != Z_OK ;
\&    }
\&    
\&    die "inflation failed\en"
\&        unless $status == Z_STREAM_END ;
.Ve
.PP
The next example show how to use the \f(CW\*(C`LimitOutput\*(C'\fR option. Notice the use
of two nested loops in this case. The outer loop reads the data from the
input source \- \s-1STDIN\s0 and the inner loop repeatedly calls \f(CW\*(C`inflate\*(C'\fR until
\&\f(CW$input\fR is exhausted, we get an error, or the end of the stream is
reached. One point worth remembering is by using the \f(CW\*(C`LimitOutput\*(C'\fR option
you also get \f(CW\*(C`ConsumeInput\*(C'\fR set as well \- this makes the code below much
simpler.
.PP
.Vb 2
\&    use strict ;
\&    use warnings ;
\&    
\&    use Compress::Raw::Zlib;
\&    
\&    my $x = new Compress::Raw::Zlib::Inflate(LimitOutput => 1)
\&       or die "Cannot create a inflation stream\en" ;
\&    
\&    my $input = \*(Aq\*(Aq ;
\&    binmode STDIN;
\&    binmode STDOUT;
\&    
\&    my ($output, $status) ;
\&
\&  OUTER:
\&    while (read(STDIN, $input, 4096))
\&    {
\&        do
\&        {
\&            $status = $x\->inflate($input, $output) ;
\&
\&            print $output ;
\&
\&            last OUTER
\&                unless $status == Z_OK || $status == Z_BUF_ERROR ;
\&        }
\&        while ($status == Z_OK && length $input);
\&    }
\&    
\&    die "inflation failed\en"
\&        unless $status == Z_STREAM_END ;
.Ve
.SH "CHECKSUM FUNCTIONS"
.IX Header "CHECKSUM FUNCTIONS"
Two functions are provided by \fIzlib\fR to calculate checksums. For the
Perl interface, the order of the two parameters in both functions has
been reversed. This allows both running checksums and one off
calculations to be done.
.PP
.Vb 2
\&    $crc = adler32($buffer [,$crc]) ;
\&    $crc = crc32($buffer [,$crc]) ;
.Ve
.PP
The buffer parameters can either be a scalar or a scalar reference.
.PP
If the \f(CW$crc\fR parameters is \f(CW\*(C`undef\*(C'\fR, the crc value will be reset.
.PP
If you have built this module with zlib 1.2.3 or better, two more
CRC-related functions are available.
.PP
.Vb 2
\&    $crc = crc32_combine($crc1, $crc2, $len2);
\&    $adler = adler32_combine($adler1, $adler2, $len2);
.Ve
.PP
These functions allow checksums to be merged.
Refer to the \fIzlib\fR documentation for more details.
.SH "Misc"
.IX Header "Misc"
.ie n .SS "my $version = \fICompress::Raw::Zlib::zlib_version()\fP;"
.el .SS "my \f(CW$version\fP = \fICompress::Raw::Zlib::zlib_version()\fP;"
.IX Subsection "my $version = Compress::Raw::Zlib::zlib_version();"
Returns the version of the zlib library.
.ie n .SS "my $flags = \fICompress::Raw::Zlib::zlibCompileFlags()\fP;"
.el .SS "my \f(CW$flags\fP = \fICompress::Raw::Zlib::zlibCompileFlags()\fP;"
.IX Subsection "my $flags = Compress::Raw::Zlib::zlibCompileFlags();"
Returns the flags indicating compile-time options that were used to build 
the zlib library. See the zlib documentation for a description of the flags
returned by \f(CW\*(C`zlibCompileFlags\*(C'\fR.
.PP
Note that when the zlib sources are built along with this module the
\&\f(CW\*(C`sprintf\*(C'\fR flags (bits 24, 25 and 26) should be ignored.
.PP
If you are using zlib 1.2.0 or older, \f(CW\*(C`zlibCompileFlags\*(C'\fR will return 0.
.SH "The LimitOutput option."
.IX Header "The LimitOutput option."
By default \f(CW\*(C`$i\->inflate($input, $output)\*(C'\fR will uncompress \fIall\fR data
in \f(CW$input\fR and write \fIall\fR of the uncompressed data it has generated to
\&\f(CW$output\fR. This makes the interface to \f(CW\*(C`inflate\*(C'\fR much simpler \- if the
method has uncompressed \f(CW$input\fR successfully \fIall\fR compressed data in
\&\f(CW$input\fR will have been dealt with. So if you are reading from an input
source and uncompressing as you go the code will look something like this
.PP
.Vb 2
\&    use strict ;
\&    use warnings ;
\&    
\&    use Compress::Raw::Zlib;
\&    
\&    my $x = new Compress::Raw::Zlib::Inflate()
\&       or die "Cannot create a inflation stream\en" ;
\&    
\&    my $input = \*(Aq\*(Aq ;
\&    
\&    my ($output, $status) ;
\&    while (read(STDIN, $input, 4096))
\&    {
\&        $status = $x\->inflate($input, $output) ;
\&    
\&        print $output ;
\&    
\&        last if $status != Z_OK ;
\&    }
\&    
\&    die "inflation failed\en"
\&        unless $status == Z_STREAM_END ;
.Ve
.PP
The points to note are
.IP "\(bu" 5
The main processing loop in the code handles reading of compressed data
from \s-1STDIN.\s0
.IP "\(bu" 5
The status code returned from \f(CW\*(C`inflate\*(C'\fR will only trigger termination of
the main processing loop if it isn't \f(CW\*(C`Z_OK\*(C'\fR. When \f(CW\*(C`LimitOutput\*(C'\fR has not
been used the \f(CW\*(C`Z_OK\*(C'\fR status means that the end of the compressed
data stream has been reached or there has been an error in uncompression.
.IP "\(bu" 5
After the call to \f(CW\*(C`inflate\*(C'\fR \fIall\fR of the uncompressed data in \f(CW$input\fR
will have been processed. This means the subsequent call to \f(CW\*(C`read\*(C'\fR can
overwrite it's contents without any problem.
.PP
For most use-cases the behavior described above is acceptable (this module
and it's predecessor, \f(CW\*(C`Compress::Zlib\*(C'\fR, have used it for over 10 years
without an issue), but in a few very specific use-cases the amount of
memory required for \f(CW$output\fR can prohibitively large. For example, if the
compressed data stream contains the same pattern repeated thousands of
times, a relatively small compressed data stream can uncompress into
hundreds of megabytes.  Remember \f(CW\*(C`inflate\*(C'\fR will keep allocating memory
until \fIall\fR the uncompressed data has been written to the output buffer \-
the size of \f(CW$output\fR is unbounded.
.PP
The \f(CW\*(C`LimitOutput\*(C'\fR option is designed to help with this use-case.
.PP
The main difference in your code when using \f(CW\*(C`LimitOutput\*(C'\fR is having to
deal with cases where the \f(CW$input\fR parameter still contains some
uncompressed data that \f(CW\*(C`inflate\*(C'\fR hasn't processed yet. The status code
returned from \f(CW\*(C`inflate\*(C'\fR will be \f(CW\*(C`Z_OK\*(C'\fR if uncompression took place and
\&\f(CW\*(C`Z_BUF_ERROR\*(C'\fR if the output buffer is full.
.PP
Below is typical code that shows how to use \f(CW\*(C`LimitOutput\*(C'\fR.
.PP
.Vb 2
\&    use strict ;
\&    use warnings ;
\&    
\&    use Compress::Raw::Zlib;
\&    
\&    my $x = new Compress::Raw::Zlib::Inflate(LimitOutput => 1)
\&       or die "Cannot create a inflation stream\en" ;
\&    
\&    my $input = \*(Aq\*(Aq ;
\&    binmode STDIN;
\&    binmode STDOUT;
\&    
\&    my ($output, $status) ;
\&
\&  OUTER:
\&    while (read(STDIN, $input, 4096))
\&    {
\&        do
\&        {
\&            $status = $x\->inflate($input, $output) ;
\&
\&            print $output ;
\&
\&            last OUTER
\&                unless $status == Z_OK || $status == Z_BUF_ERROR ;
\&        }
\&        while ($status == Z_OK && length $input);
\&    }
\&    
\&    die "inflation failed\en"
\&        unless $status == Z_STREAM_END ;
.Ve
.PP
Points to note this time:
.IP "\(bu" 5
There are now two nested loops in the code: the outer loop for reading the
compressed data from \s-1STDIN,\s0 as before; and the inner loop to carry out the
uncompression.
.IP "\(bu" 5
There are two exit points from the inner uncompression loop.
.Sp
Firstly when \f(CW\*(C`inflate\*(C'\fR has returned a status other than \f(CW\*(C`Z_OK\*(C'\fR or
\&\f(CW\*(C`Z_BUF_ERROR\*(C'\fR.  This means that either the end of the compressed data
stream has been reached (\f(CW\*(C`Z_STREAM_END\*(C'\fR) or there is an error in the
compressed data. In either of these cases there is no point in continuing
with reading the compressed data, so both loops are terminated.
.Sp
The second exit point tests if there is any data left in the input buffer,
\&\f(CW$input\fR \- remember that the \f(CW\*(C`ConsumeInput\*(C'\fR option is automatically
enabled when \f(CW\*(C`LimitOutput\*(C'\fR is used.  When the input buffer has been
exhausted, the outer loop can run again and overwrite a now empty
\&\f(CW$input\fR.
.SH "ACCESSING ZIP FILES"
.IX Header "ACCESSING ZIP FILES"
Although it is possible (with some effort on your part) to use this module
to access .zip files, there are other perl modules available that will do
all the hard work for you. Check out \f(CW\*(C`Archive::Zip\*(C'\fR,
\&\f(CW\*(C`Archive::Zip::SimpleZip\*(C'\fR, \f(CW\*(C`IO::Compress::Zip\*(C'\fR and
\&\f(CW\*(C`IO::Uncompress::Unzip\*(C'\fR.
.SH "FAQ"
.IX Header "FAQ"
.SS "Compatibility with Unix compress/uncompress."
.IX Subsection "Compatibility with Unix compress/uncompress."
This module is not compatible with Unix \f(CW\*(C`compress\*(C'\fR.
.PP
If you have the \f(CW\*(C`uncompress\*(C'\fR program available, you can use this to read
compressed files
.PP
.Vb 4
\&    open F, "uncompress \-c $filename |";
\&    while (<F>)
\&    {
\&        ...
.Ve
.PP
Alternatively, if you have the \f(CW\*(C`gunzip\*(C'\fR program available, you can use
this to read compressed files
.PP
.Vb 4
\&    open F, "gunzip \-c $filename |";
\&    while (<F>)
\&    {
\&        ...
.Ve
.PP
and this to write compress files, if you have the \f(CW\*(C`compress\*(C'\fR program
available
.PP
.Vb 4
\&    open F, "| compress \-c $filename ";
\&    print F "data";
\&    ...
\&    close F ;
.Ve
.SS "Accessing .tar.Z files"
.IX Subsection "Accessing .tar.Z files"
See previous \s-1FAQ\s0 item.
.PP
If the \f(CW\*(C`Archive::Tar\*(C'\fR module is installed and either the \f(CW\*(C`uncompress\*(C'\fR or
\&\f(CW\*(C`gunzip\*(C'\fR programs are available, you can use one of these workarounds to
read \f(CW\*(C`.tar.Z\*(C'\fR files.
.PP
Firstly with \f(CW\*(C`uncompress\*(C'\fR
.PP
.Vb 3
\&    use strict;
\&    use warnings;
\&    use Archive::Tar;
\&
\&    open F, "uncompress \-c $filename |";
\&    my $tar = Archive::Tar\->new(*F);
\&    ...
.Ve
.PP
and this with \f(CW\*(C`gunzip\*(C'\fR
.PP
.Vb 3
\&    use strict;
\&    use warnings;
\&    use Archive::Tar;
\&
\&    open F, "gunzip \-c $filename |";
\&    my $tar = Archive::Tar\->new(*F);
\&    ...
.Ve
.PP
Similarly, if the \f(CW\*(C`compress\*(C'\fR program is available, you can use this to
write a \f(CW\*(C`.tar.Z\*(C'\fR file
.PP
.Vb 4
\&    use strict;
\&    use warnings;
\&    use Archive::Tar;
\&    use IO::File;
\&
\&    my $fh = new IO::File "| compress \-c >$filename";
\&    my $tar = Archive::Tar\->new();
\&    ...
\&    $tar\->write($fh);
\&    $fh\->close ;
.Ve
.SS "Zlib Library Version Support"
.IX Subsection "Zlib Library Version Support"
By default \f(CW\*(C`Compress::Raw::Zlib\*(C'\fR will build with a private copy of version
1.2.5 of the zlib library. (See the \fI\s-1README\s0\fR file for details of
how to override this behaviour)
.PP
If you decide to use a different version of the zlib library, you need to be
aware of the following issues
.IP "\(bu" 5
First off, you must have zlib 1.0.5 or better.
.IP "\(bu" 5
You need to have zlib 1.2.1 or better if you want to use the \f(CW\*(C`\-Merge\*(C'\fR
option with \f(CW\*(C`IO::Compress::Gzip\*(C'\fR, \f(CW\*(C`IO::Compress::Deflate\*(C'\fR and
\&\f(CW\*(C`IO::Compress::RawDeflate\*(C'\fR.
.SH "CONSTANTS"
.IX Header "CONSTANTS"
All the \fIzlib\fR constants are automatically imported when you make use
of \fICompress::Raw::Zlib\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Compress::Zlib, IO::Compress::Gzip, IO::Uncompress::Gunzip, IO::Compress::Deflate, IO::Uncompress::Inflate, IO::Compress::RawDeflate, IO::Uncompress::RawInflate, IO::Compress::Bzip2, IO::Uncompress::Bunzip2, IO::Compress::Lzma, IO::Uncompress::UnLzma, IO::Compress::Xz, IO::Uncompress::UnXz, IO::Compress::Lzop, IO::Uncompress::UnLzop, IO::Compress::Lzf, IO::Uncompress::UnLzf, IO::Uncompress::AnyInflate, IO::Uncompress::AnyUncompress
.PP
IO::Compress::FAQ
.PP
File::GlobMapper, Archive::Zip,
Archive::Tar,
IO::Zlib
.PP
For \s-1RFC 1950, 1951\s0 and 1952 see 
\&\fIhttp://www.faqs.org/rfcs/rfc1950.html\fR,
\&\fIhttp://www.faqs.org/rfcs/rfc1951.html\fR and
\&\fIhttp://www.faqs.org/rfcs/rfc1952.html\fR
.PP
The \fIzlib\fR compression library was written by Jean-loup Gailly
\&\fIgzip@prep.ai.mit.edu\fR and Mark Adler \fImadler@alumni.caltech.edu\fR.
.PP
The primary site for the \fIzlib\fR compression library is
\&\fIhttp://www.zlib.org\fR.
.PP
The primary site for gzip is \fIhttp://www.gzip.org\fR.
.SH "AUTHOR"
.IX Header "AUTHOR"
This module was written by Paul Marquess, \fIpmqs@cpan.org\fR.
.SH "MODIFICATION HISTORY"
.IX Header "MODIFICATION HISTORY"
See the Changes file.
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (c) 2005\-2015 Paul Marquess. All rights reserved.
.PP
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.

cmd: