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::Zlib.3pm (38719B)

.\" 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::Zlib 3"
.TH Compress::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::Zlib \- Interface to zlib compression library
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Compress::Zlib ;
\&
\&    ($d, $status) = deflateInit( [OPT] ) ;
\&    $status = $d\->deflate($input, $output) ;
\&    $status = $d\->flush([$flush_type]) ;
\&    $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) = inflateInit( [OPT] ) ;
\&    $status = $i\->inflate($input, $output [, $eof]) ;
\&    $status = $i\->inflateSync($input) ;
\&    $i\->dict_adler() ;
\&    $d\->crc32() ;
\&    $d\->adler32() ;
\&    $i\->total_in() ;
\&    $i\->total_out() ;
\&    $i\->msg() ;
\&    $d\->get_BufSize();
\&
\&    $dest = compress($source) ;
\&    $dest = uncompress($source) ;
\&
\&    $gz = gzopen($filename or filehandle, $mode) ;
\&    $bytesread = $gz\->gzread($buffer [,$size]) ;
\&    $bytesread = $gz\->gzreadline($line) ;
\&    $byteswritten = $gz\->gzwrite($buffer) ;
\&    $status = $gz\->gzflush($flush) ;
\&    $offset = $gz\->gztell() ;
\&    $status = $gz\->gzseek($offset, $whence) ;
\&    $status = $gz\->gzclose() ;
\&    $status = $gz\->gzeof() ;
\&    $status = $gz\->gzsetparams($level, $strategy) ;
\&    $errstring = $gz\->gzerror() ; 
\&    $gzerrno
\&
\&    $dest = Compress::Zlib::memGzip($buffer) ;
\&    $dest = Compress::Zlib::memGunzip($buffer) ;
\&
\&    $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();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \fICompress::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).
.PP
The \f(CW\*(C`Compress::Zlib\*(C'\fR module can be split into two general areas of
functionality, namely a simple read/write interface to \fIgzip\fR files
and a low-level in-memory compression/decompression interface.
.PP
Each of these areas will be discussed in the following sections.
.SS "Notes for users of Compress::Zlib version 1"
.IX Subsection "Notes for users of Compress::Zlib version 1"
The main change in \f(CW\*(C`Compress::Zlib\*(C'\fR version 2.x is that it does not now
interface directly to the zlib library. Instead it uses the
\&\f(CW\*(C`IO::Compress::Gzip\*(C'\fR and \f(CW\*(C`IO::Uncompress::Gunzip\*(C'\fR modules for
reading/writing gzip files, and the \f(CW\*(C`Compress::Raw::Zlib\*(C'\fR module for some
low-level zlib access.
.PP
The interface provided by version 2 of this module should be 100% backward
compatible with version 1. If you find a difference in the expected
behaviour please contact the author (See \*(L"\s-1AUTHOR\*(R"\s0). See \*(L"\s-1GZIP INTERFACE\*(R"\s0
.PP
With the creation of the \f(CW\*(C`IO::Compress\*(C'\fR and \f(CW\*(C`IO::Uncompress\*(C'\fR modules no
new features are planned for \f(CW\*(C`Compress::Zlib\*(C'\fR \- the new modules do
everything that \f(CW\*(C`Compress::Zlib\*(C'\fR does and then some. Development on
\&\f(CW\*(C`Compress::Zlib\*(C'\fR will be limited to bug fixes only.
.PP
If you are writing new code, your first port of call should be one of the
new \f(CW\*(C`IO::Compress\*(C'\fR or \f(CW\*(C`IO::Uncompress\*(C'\fR modules.
.SH "GZIP INTERFACE"
.IX Header "GZIP INTERFACE"
A number of functions are supplied in \fIzlib\fR for reading and writing
\&\fIgzip\fR files that conform to \s-1RFC 1952.\s0 This module provides an interface
to most of them.
.PP
If you have previously used \f(CW\*(C`Compress::Zlib\*(C'\fR 1.x, the following
enhancements/changes have been made to the \f(CW\*(C`gzopen\*(C'\fR interface:
.IP "1." 5
If you want to open either \s-1STDIN\s0 or \s-1STDOUT\s0 with \f(CW\*(C`gzopen\*(C'\fR, you can now
optionally use the special filename "\f(CW\*(C`\-\*(C'\fR" as a synonym for \f(CW\*(C`\e*STDIN\*(C'\fR and
\&\f(CW\*(C`\e*STDOUT\*(C'\fR.
.IP "2." 5
In \f(CW\*(C`Compress::Zlib\*(C'\fR version 1.x, \f(CW\*(C`gzopen\*(C'\fR used the zlib library to open
the underlying file. This made things especially tricky when a Perl
filehandle was passed to \f(CW\*(C`gzopen\*(C'\fR. Behind the scenes the numeric C file
descriptor had to be extracted from the Perl filehandle and this passed to
the zlib library.
.Sp
Apart from being non-portable to some operating systems, this made it
difficult to use \f(CW\*(C`gzopen\*(C'\fR in situations where you wanted to extract/create
a gzip data stream that is embedded in a larger file, without having to
resort to opening and closing the file multiple times.
.Sp
It also made it impossible to pass a perl filehandle that wasn't associated
with a real filesystem file, like, say, an \f(CW\*(C`IO::String\*(C'\fR.
.Sp
In \f(CW\*(C`Compress::Zlib\*(C'\fR version 2.x, the \f(CW\*(C`gzopen\*(C'\fR interface has been
completely rewritten to use the IO::Compress::Gzip
for writing gzip files and IO::Uncompress::Gunzip
for reading gzip files. None of the limitations mentioned above apply.
.IP "3." 5
Addition of \f(CW\*(C`gzseek\*(C'\fR to provide a restricted \f(CW\*(C`seek\*(C'\fR interface.
.IP "4." 5
Added \f(CW\*(C`gztell\*(C'\fR.
.PP
A more complete and flexible interface for reading/writing gzip
files/buffers is included with the module \f(CW\*(C`IO\-Compress\-Zlib\*(C'\fR. See
IO::Compress::Gzip and
IO::Uncompress::Gunzip for more details.
.ie n .IP "\fB\fB$gz\fB = gzopen($filename, \f(BI$mode\fB)\fR" 5
.el .IP "\fB\f(CB$gz\fB = gzopen($filename, \f(CB$mode\fB)\fR" 5
.IX Item "$gz = gzopen($filename, $mode)"
.PD 0
.ie n .IP "\fB\fB$gz\fB = gzopen($filehandle, \f(BI$mode\fB)\fR" 5
.el .IP "\fB\f(CB$gz\fB = gzopen($filehandle, \f(CB$mode\fB)\fR" 5
.IX Item "$gz = gzopen($filehandle, $mode)"
.PD
This function opens either the \fIgzip\fR file \f(CW$filename\fR for reading or
writing or attaches to the opened filehandle, \f(CW$filehandle\fR. 
It returns an object on success and \f(CW\*(C`undef\*(C'\fR on failure.
.Sp
When writing a gzip file this interface will \fIalways\fR create the smallest
possible gzip header (exactly 10 bytes). If you want greater control over
what gets stored in the gzip header (like the original filename or a
comment) use IO::Compress::Gzip instead. Similarly if
you want to read the contents of the gzip header use
IO::Uncompress::Gunzip.
.Sp
The second parameter, \f(CW$mode\fR, is used to specify whether the file is
opened for reading or writing and to optionally specify a compression
level and compression strategy when writing. The format of the \f(CW$mode\fR
parameter is similar to the mode parameter to the 'C' function \f(CW\*(C`fopen\*(C'\fR,
so \*(L"rb\*(R" is used to open for reading, \*(L"wb\*(R" for writing and \*(L"ab\*(R" for
appending (writing at the end of the file).
.Sp
To specify a compression level when writing, append a digit between 0
and 9 to the mode string \*(-- 0 means no compression and 9 means maximum
compression.
If no compression level is specified Z_DEFAULT_COMPRESSION is used.
.Sp
To specify the compression strategy when writing, append 'f' for filtered
data, 'h' for Huffman only compression, or 'R' for run-length encoding.
If no strategy is specified Z_DEFAULT_STRATEGY is used.
.Sp
So, for example, \*(L"wb9\*(R" means open for writing with the maximum compression
using the default strategy and \*(L"wb4R\*(R" means open for writing with compression
level 4 and run-length encoding.
.Sp
Refer to the \fIzlib\fR documentation for the exact format of the \f(CW$mode\fR
parameter.
.ie n .IP "\fB\fB$bytesread\fB = \f(BI$gz\fB\->gzread($buffer [, \f(CB$size\fB]) ;\fR" 5
.el .IP "\fB\f(CB$bytesread\fB = \f(CB$gz\fB\->gzread($buffer [, \f(CB$size\fB]) ;\fR" 5
.IX Item "$bytesread = $gz->gzread($buffer [, $size]) ;"
Reads \f(CW$size\fR bytes from the compressed file into \f(CW$buffer\fR. If
\&\f(CW$size\fR is not specified, it will default to 4096. If the scalar
\&\f(CW$buffer\fR is not large enough, it will be extended automatically.
.Sp
Returns the number of bytes actually read. On \s-1EOF\s0 it returns 0 and in
the case of an error, \-1.
.ie n .IP "\fB\fB$bytesread\fB = \f(BI$gz\fB\->gzreadline($line) ;\fR" 5
.el .IP "\fB\f(CB$bytesread\fB = \f(CB$gz\fB\->gzreadline($line) ;\fR" 5
.IX Item "$bytesread = $gz->gzreadline($line) ;"
Reads the next line from the compressed file into \f(CW$line\fR.
.Sp
Returns the number of bytes actually read. On \s-1EOF\s0 it returns 0 and in
the case of an error, \-1.
.Sp
It is legal to intermix calls to \f(CW\*(C`gzread\*(C'\fR and \f(CW\*(C`gzreadline\*(C'\fR.
.Sp
To maintain backward compatibility with version 1.x of this module
\&\f(CW\*(C`gzreadline\*(C'\fR ignores the \f(CW$/\fR variable \- it \fIalways\fR uses the string
\&\f(CW"\en"\fR as the line delimiter.
.Sp
If you want to read a gzip file a line at a time and have it respect the
\&\f(CW$/\fR variable (or \f(CW$INPUT_RECORD_SEPARATOR\fR, or \f(CW$RS\fR when \f(CW\*(C`English\*(C'\fR is
in use) see IO::Uncompress::Gunzip.
.ie n .IP "\fB\fB$byteswritten\fB = \f(BI$gz\fB\->gzwrite($buffer) ;\fR" 5
.el .IP "\fB\f(CB$byteswritten\fB = \f(CB$gz\fB\->gzwrite($buffer) ;\fR" 5
.IX Item "$byteswritten = $gz->gzwrite($buffer) ;"
Writes the contents of \f(CW$buffer\fR to the compressed file. Returns the
number of bytes actually written, or 0 on error.
.ie n .IP "\fB\fB$status\fB = \f(BI$gz\fB\->gzflush($flush_type) ;\fR" 5
.el .IP "\fB\f(CB$status\fB = \f(CB$gz\fB\->gzflush($flush_type) ;\fR" 5
.IX Item "$status = $gz->gzflush($flush_type) ;"
Flushes all pending output into the compressed file.
.Sp
This method takes an optional parameter, \f(CW$flush_type\fR, that controls
how the flushing will be carried out. By default the \f(CW$flush_type\fR
used is \f(CW\*(C`Z_FINISH\*(C'\fR. Other valid values for \f(CW$flush_type\fR are
\&\f(CW\*(C`Z_NO_FLUSH\*(C'\fR, \f(CW\*(C`Z_SYNC_FLUSH\*(C'\fR, \f(CW\*(C`Z_FULL_FLUSH\*(C'\fR and \f(CW\*(C`Z_BLOCK\*(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 \- overuse of \f(CW\*(C`flush\*(C'\fR
can seriously degrade the level of compression achieved. See the \f(CW\*(C`zlib\*(C'\fR
documentation for details.
.Sp
Returns 0 on success.
.ie n .IP "\fB\fB$offset\fB = \f(BI$gz\fB\->\f(BIgztell()\fB ;\fR" 5
.el .IP "\fB\f(CB$offset\fB = \f(CB$gz\fB\->\f(BIgztell()\fB ;\fR" 5
.IX Item "$offset = $gz->gztell() ;"
Returns the uncompressed file offset.
.ie n .IP "\fB\fB$status\fB = \f(BI$gz\fB\->gzseek($offset, \f(CB$whence\fB) ;\fR" 5
.el .IP "\fB\f(CB$status\fB = \f(CB$gz\fB\->gzseek($offset, \f(CB$whence\fB) ;\fR" 5
.IX Item "$status = $gz->gzseek($offset, $whence) ;"
Provides a sub-set of the \f(CW\*(C`seek\*(C'\fR functionality, with the restriction
that it is only legal to seek forward in the compressed file.
It is a fatal error to attempt to seek backward.
.Sp
When opened for writing, empty parts of the file will have \s-1NULL \s0(0x00)
bytes written to them.
.Sp
The \f(CW$whence\fR parameter should be one of \s-1SEEK_SET, SEEK_CUR\s0 or \s-1SEEK_END.\s0
.Sp
Returns 1 on success, 0 on failure.
.ie n .IP "\fB\fB$gz\fB\->gzclose\fR" 5
.el .IP "\fB\f(CB$gz\fB\->gzclose\fR" 5
.IX Item "$gz->gzclose"
Closes the compressed file. Any pending data is flushed to the file
before it is closed.
.Sp
Returns 0 on success.
.ie n .IP "\fB\fB$gz\fB\->gzsetparams($level, \f(BI$strategy\fB\fR" 5
.el .IP "\fB\f(CB$gz\fB\->gzsetparams($level, \f(CB$strategy\fB\fR" 5
.IX Item "$gz->gzsetparams($level, $strategy"
Change settings for the deflate stream \f(CW$gz\fR.
.Sp
The list of the valid options is shown below. Options not specified
will remain unchanged.
.Sp
Note: This method is only available if you are running zlib 1.0.6 or better.
.RS 5
.ie n .IP "\fB\fB$level\fB\fR" 5
.el .IP "\fB\f(CB$level\fB\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.
.ie n .IP "\fB\fB$strategy\fB\fR" 5
.el .IP "\fB\f(CB$strategy\fB\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.
.RE
.RS 5
.RE
.ie n .IP "\fB\fB$gz\fB\->gzerror\fR" 5
.el .IP "\fB\f(CB$gz\fB\->gzerror\fR" 5
.IX Item "$gz->gzerror"
Returns the \fIzlib\fR error message or number for the last operation
associated with \f(CW$gz\fR. The return value will be the \fIzlib\fR error
number when used in a numeric context and the \fIzlib\fR error message
when used in a string context. The \fIzlib\fR error number constants,
shown below, are available for use.
.Sp
.Vb 7
\&    Z_OK
\&    Z_STREAM_END
\&    Z_ERRNO
\&    Z_STREAM_ERROR
\&    Z_DATA_ERROR
\&    Z_MEM_ERROR
\&    Z_BUF_ERROR
.Ve
.ie n .IP "\fB\fB$gzerrno\fB\fR" 5
.el .IP "\fB\f(CB$gzerrno\fB\fR" 5
.IX Item "$gzerrno"
The \f(CW$gzerrno\fR scalar holds the error code associated with the most
recent \fIgzip\fR routine. Note that unlike \f(CW\*(C`gzerror()\*(C'\fR, the error is
\&\fInot\fR associated with a particular file.
.Sp
As with \f(CW\*(C`gzerror()\*(C'\fR it returns an error number in numeric context and
an error message in string context. Unlike \f(CW\*(C`gzerror()\*(C'\fR though, the
error message will correspond to the \fIzlib\fR message when the error is
associated with \fIzlib\fR itself, or the \s-1UNIX\s0 error message when it is
not (i.e. \fIzlib\fR returned \f(CW\*(C`Z_ERRORNO\*(C'\fR).
.Sp
As there is an overlap between the error numbers used by \fIzlib\fR and
\&\s-1UNIX, \s0\f(CW$gzerrno\fR should only be used to check for the presence of
\&\fIan\fR error in numeric context. Use \f(CW\*(C`gzerror()\*(C'\fR to check for specific
\&\fIzlib\fR errors. The \fIgzcat\fR example below shows how the variable can
be used safely.
.SS "Examples"
.IX Subsection "Examples"
Here is an example script which uses the interface. It implements a
\&\fIgzcat\fR function.
.PP
.Vb 2
\&    use strict ;
\&    use warnings ;
\&    
\&    use Compress::Zlib ;
\&    
\&    # use stdin if no files supplied
\&    @ARGV = \*(Aq\-\*(Aq unless @ARGV ;
\&    
\&    foreach my $file (@ARGV) {
\&        my $buffer ;
\&    
\&        my $gz = gzopen($file, "rb") 
\&             or die "Cannot open $file: $gzerrno\en" ;
\&    
\&        print $buffer while $gz\->gzread($buffer) > 0 ;
\&    
\&        die "Error reading from $file: $gzerrno" . ($gzerrno+0) . "\en" 
\&            if $gzerrno != Z_STREAM_END ;
\&        
\&        $gz\->gzclose() ;
\&    }
.Ve
.PP
Below is a script which makes use of \f(CW\*(C`gzreadline\*(C'\fR. It implements a
very simple \fIgrep\fR like script.
.PP
.Vb 2
\&    use strict ;
\&    use warnings ;
\&    
\&    use Compress::Zlib ;
\&    
\&    die "Usage: gzgrep pattern [file...]\en"
\&        unless @ARGV >= 1;
\&    
\&    my $pattern = shift ;
\&    
\&    # use stdin if no files supplied
\&    @ARGV = \*(Aq\-\*(Aq unless @ARGV ;
\&    
\&    foreach my $file (@ARGV) {
\&        my $gz = gzopen($file, "rb") 
\&             or die "Cannot open $file: $gzerrno\en" ;
\&    
\&        while ($gz\->gzreadline($_) > 0) {
\&            print if /$pattern/ ;
\&        }
\&    
\&        die "Error reading from $file: $gzerrno\en" 
\&            if $gzerrno != Z_STREAM_END ;
\&        
\&        $gz\->gzclose() ;
\&    }
.Ve
.PP
This script, \fIgzstream\fR, does the opposite of the \fIgzcat\fR script
above. It reads from standard input and writes a gzip data stream to
standard output.
.PP
.Vb 2
\&    use strict ;
\&    use warnings ;
\&    
\&    use Compress::Zlib ;
\&    
\&    binmode STDOUT;  # gzopen only sets it on the fd
\&    
\&    my $gz = gzopen(\e*STDOUT, "wb")
\&          or die "Cannot open stdout: $gzerrno\en" ;
\&    
\&    while (<>) {
\&        $gz\->gzwrite($_) 
\&          or die "error writing: $gzerrno\en" ;
\&    }
\&
\&    $gz\->gzclose ;
.Ve
.SS "Compress::Zlib::memGzip"
.IX Subsection "Compress::Zlib::memGzip"
This function is used to create an in-memory gzip file with the minimum
possible gzip header (exactly 10 bytes).
.PP
.Vb 2
\&    $dest = Compress::Zlib::memGzip($buffer) 
\&        or die "Cannot compress: $gzerrno\en";
.Ve
.PP
If successful, it returns the in-memory gzip file. Otherwise it returns
\&\f(CW\*(C`undef\*(C'\fR and the \f(CW$gzerrno\fR variable will store the zlib error code.
.PP
The \f(CW$buffer\fR parameter can either be a scalar or a scalar reference.
.PP
See IO::Compress::Gzip for an alternative way to
carry out in-memory gzip compression.
.SS "Compress::Zlib::memGunzip"
.IX Subsection "Compress::Zlib::memGunzip"
This function is used to uncompress an in-memory gzip file.
.PP
.Vb 2
\&    $dest = Compress::Zlib::memGunzip($buffer) 
\&        or die "Cannot uncompress: $gzerrno\en";
.Ve
.PP
If successful, it returns the uncompressed gzip file. Otherwise it
returns \f(CW\*(C`undef\*(C'\fR and the \f(CW$gzerrno\fR variable will store the zlib error
code.
.PP
The \f(CW$buffer\fR parameter can either be a scalar or a scalar reference. The
contents of the \f(CW$buffer\fR parameter are destroyed after calling this function.
.PP
If \f(CW$buffer\fR consists of multiple concatenated gzip data streams only the
first will be uncompressed. Use \f(CW\*(C`gunzip\*(C'\fR with the \f(CW\*(C`MultiStream\*(C'\fR option in
the \f(CW\*(C`IO::Uncompress::Gunzip\*(C'\fR module if you need to deal with concatenated
data streams.
.PP
See IO::Uncompress::Gunzip for an alternative way
to carry out in-memory gzip uncompression.
.SH "COMPRESS/UNCOMPRESS"
.IX Header "COMPRESS/UNCOMPRESS"
Two functions are provided to perform in-memory compression/uncompression of
\&\s-1RFC 1950\s0 data streams. They are called \f(CW\*(C`compress\*(C'\fR and \f(CW\*(C`uncompress\*(C'\fR.
.ie n .IP "\fB\fB$dest\fB = compress($source [, \f(BI$level\fB] ) ;\fR" 5
.el .IP "\fB\f(CB$dest\fB = compress($source [, \f(CB$level\fB] ) ;\fR" 5
.IX Item "$dest = compress($source [, $level] ) ;"
Compresses \f(CW$source\fR. If successful it returns the compressed
data. Otherwise it returns \fIundef\fR.
.Sp
The source buffer, \f(CW$source\fR, can either be a scalar or a scalar
reference.
.Sp
The \f(CW$level\fR parameter 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.
If \f(CW$level\fR is not specified \f(CW\*(C`Z_DEFAULT_COMPRESSION\*(C'\fR will be used.
.ie n .IP "\fB\fB$dest\fB = uncompress($source) ;\fR" 5
.el .IP "\fB\f(CB$dest\fB = uncompress($source) ;\fR" 5
.IX Item "$dest = uncompress($source) ;"
Uncompresses \f(CW$source\fR. If successful it returns the uncompressed
data. Otherwise it returns \fIundef\fR.
.Sp
The source buffer can either be a scalar or a scalar reference.
.PP
Please note: the two functions defined above are \fInot\fR compatible with
the Unix commands of the same name.
.PP
See IO::Deflate and IO::Inflate included with
this distribution for an alternative interface for reading/writing \s-1RFC 1950\s0
files/buffers.
.SH "Deflate Interface"
.IX Header "Deflate Interface"
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) = deflateInit( [\s-1OPT\s0] )\fP"
.el .SS "\fB($d, \fP\f(CB$status\fP\fB) = deflateInit( [\s-1OPT\s0] )\fP"
.IX Subsection "($d, $status) = deflateInit( [OPT] )"
Initialises a deflation stream.
.PP
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 stream, \f(CW$d\fR
and \f(CW$status\fR of \f(CW\*(C`Z_OK\*(C'\fR in a list context. In scalar context it
returns the deflation stream, \f(CW$d\fR, only.
.PP
If not successful, the returned deflation stream (\f(CW$d\fR) will be
\&\fIundef\fR and \f(CW$status\fR will hold the exact \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
The function takes one optional parameter, a reference to a hash.  The
contents of the hash allow the deflation interface to be tailored.
.PP
Here 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 Z_DEFAULT_COMPRESSION.
.IP "\fB\-Method\fR" 5
.IX Item "-Method"
Defines the compression method. The only valid value at present (and
the default) is Z_DEFLATED.
.IP "\fB\-WindowBits\fR" 5
.IX Item "-WindowBits"
To create an \s-1RFC 1950\s0 data stream, set \f(CW\*(C`WindowBits\*(C'\fR to a positive number.
.Sp
To create an \s-1RFC 1951\s0 data stream, set \f(CW\*(C`WindowBits\*(C'\fR to \f(CW\*(C`\-MAX_WBITS\*(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 \fIdeflateInit2\fR.
.Sp
Defaults to \s-1MAX_WBITS.\s0
.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 and \f(CW\*(C`Z_HUFFMAN_ONLY\*(C'\fR.
.Sp
The default is Z_DEFAULT_STRATEGY.
.IP "\fB\-Dictionary\fR" 5
.IX Item "-Dictionary"
When a dictionary is specified \fICompress::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\-\*(C'\fR\fIdict_adler()\fR>.
.Sp
The default is no dictionary.
.IP "\fB\-Bufsize\fR" 5
.IX Item "-Bufsize"
Sets the initial size for the deflation buffer. 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 is 4096.
.PP
Here is an example of using the \f(CW\*(C`deflateInit\*(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
\&    deflateInit( \-Bufsize => 300, 
\&                 \-Level => Z_BEST_SPEED  ) ;
.Ve
.ie n .SS "\fB($out, \fP\fB$status\fP\fB) = \fP\fB$d\fP\fB\->deflate($buffer)\fP"
.el .SS "\fB($out, \fP\f(CB$status\fP\fB) = \fP\f(CB$d\fP\fB\->deflate($buffer)\fP"
.IX Subsection "($out, $status) = $d->deflate($buffer)"
Deflates the contents of \f(CW$buffer\fR. The buffer can either be a scalar
or a scalar reference.  When finished, \f(CW$buffer\fR will be
completely processed (assuming there were no errors). If the deflation
was successful it returns the deflated output, \f(CW$out\fR, and a status
value, \f(CW$status\fR, of \f(CW\*(C`Z_OK\*(C'\fR.
.PP
On error, \f(CW$out\fR will be \fIundef\fR and \f(CW$status\fR will contain the
\&\fIzlib\fR error code.
.PP
In a scalar context \f(CW\*(C`deflate\*(C'\fR will return \f(CW$out\fR only.
.PP
As with the \fIdeflate\fR function in \fIzlib\fR, it is not necessarily the
case that any output will be produced by this method. So don't rely on
the fact that \f(CW$out\fR is empty for an error test.
.ie n .SS "\fB($out, \fP\fB$status\fP\fB) = \fP\fB$d\fP\fB\->\fP\f(BIflush()\fP\fB\fP =head2 \fB($out, \fP\fB$status\fP\fB) = \fP\fB$d\fP\fB\->flush($flush_type)\fP"
.el .SS "\fB($out, \fP\f(CB$status\fP\fB) = \fP\f(CB$d\fP\fB\->\fP\f(BIflush()\fP\fB\fP =head2 \fB($out, \fP\f(CB$status\fP\fB) = \fP\f(CB$d\fP\fB\->flush($flush_type)\fP"
.IX Subsection "($out, $status) = $d->flush() =head2 ($out, $status) = $d->flush($flush_type)"
Typically used to finish the deflation. Any pending output will be
returned via \f(CW$out\fR.
\&\f(CW$status\fR will have a value \f(CW\*(C`Z_OK\*(C'\fR if successful.
.PP
In a scalar context \f(CW\*(C`flush\*(C'\fR will return \f(CW$out\fR only.
.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.
.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 stream \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.
.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(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.
.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::Zlib ;
\&
\&    binmode STDIN;
\&    binmode STDOUT;
\&    my $x = deflateInit()
\&       or die "Cannot create a deflation stream\en" ;
\&
\&    my ($output, $status) ;
\&    while (<>)
\&    {
\&        ($output, $status) = $x\->deflate($_) ;
\&    
\&        $status == Z_OK
\&            or die "deflation failed\en" ;
\&    
\&        print $output ;
\&    }
\&    
\&    ($output, $status) = $x\->flush() ;
\&    
\&    $status == Z_OK
\&        or die "deflation failed\en" ;
\&    
\&    print $output ;
.Ve
.SH "Inflate Interface"
.IX Header "Inflate Interface"
This section defines the interface available that allows in-memory
uncompression using the \fIdeflate\fR interface provided by zlib.
.PP
Here is a definition of the interface:
.ie n .SS "\fB($i, \fP\fB$status\fP\fB) = \fP\f(BIinflateInit()\fP\fB\fP"
.el .SS "\fB($i, \fP\f(CB$status\fP\fB) = \fP\f(BIinflateInit()\fP\fB\fP"
.IX Subsection "($i, $status) = inflateInit()"
Initialises an inflation stream.
.PP
In a list context it returns the inflation stream, \f(CW$i\fR, and the
\&\fIzlib\fR status code in \f(CW$status\fR. In a scalar context it returns the
inflation stream only.
.PP
If successful, \f(CW$i\fR will hold the inflation stream 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 name=>value pairs.
.PP
The function takes one optional parameter, a reference to a hash.  The
contents of the hash allow the deflation interface to be tailored.
.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.
.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
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 \s-1MAX_WBITS.\s0
.IP "\fB\-Bufsize\fR" 5
.IX Item "-Bufsize"
Sets the initial size for the inflation buffer. If the buffer 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.
.PP
Here is an example of using the \f(CW\*(C`inflateInit\*(C'\fR optional parameter to
override the default buffer size.
.PP
.Vb 1
\&    inflateInit( \-Bufsize => 300 ) ;
.Ve
.ie n .SS "\fB($out, \fP\fB$status\fP\fB) = \fP\fB$i\fP\fB\->inflate($buffer)\fP"
.el .SS "\fB($out, \fP\f(CB$status\fP\fB) = \fP\f(CB$i\fP\fB\->inflate($buffer)\fP"
.IX Subsection "($out, $status) = $i->inflate($buffer)"
Inflates the complete contents of \f(CW$buffer\fR. The buffer can either be
a scalar or a scalar reference.
.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. 
If not successful, \f(CW$out\fR will be \fIundef\fR and \f(CW$status\fR will hold
the \fIzlib\fR error code.
.PP
The \f(CW$buffer\fR parameter is modified by \f(CW\*(C`inflate\*(C'\fR. On completion it
will contain what remains of the input buffer after inflation. This
means that \f(CW$buffer\fR will be an empty string when the return status is
\&\f(CW\*(C`Z_OK\*(C'\fR. When the return status is \f(CW\*(C`Z_STREAM_END\*(C'\fR the \f(CW$buffer\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).
.ie n .SS "\fB\fP\fB$status\fP\fB = \fP\fB$i\fP\fB\->inflateSync($buffer)\fP"
.el .SS "\fB\fP\f(CB$status\fP\fB = \fP\f(CB$i\fP\fB\->inflateSync($buffer)\fP"
.IX Subsection "$status = $i->inflateSync($buffer)"
Scans \f(CW$buffer\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$buffer\fR
will be have all data up to the flush point removed. This can then be
passed to the \f(CW\*(C`deflate\*(C'\fR method.
.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.
.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(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.
.SS "Example"
.IX Subsection "Example"
Here is an example of using \f(CW\*(C`inflate\*(C'\fR.
.PP
.Vb 2
\&    use strict ;
\&    use warnings ;
\&    
\&    use Compress::Zlib ;
\&    
\&    my $x = inflateInit()
\&       or die "Cannot create a inflation stream\en" ;
\&    
\&    my $input = \*(Aq\*(Aq ;
\&    binmode STDIN;
\&    binmode STDOUT;
\&    
\&    my ($output, $status) ;
\&    while (read(STDIN, $input, 4096))
\&    {
\&        ($output, $status) = $x\->inflate(\e$input) ;
\&    
\&        print $output 
\&            if $status == Z_OK or $status == Z_STREAM_END ;
\&    
\&        last if $status != Z_OK ;
\&    }
\&    
\&    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::Zlib::zlib_version()\fP;"
.el .SS "my \f(CW$version\fP = \fICompress::Zlib::zlib_version()\fP;"
.IX Subsection "my $version = Compress::Zlib::zlib_version();"
Returns the version of the zlib library.
.SH "CONSTANTS"
.IX Header "CONSTANTS"
All the \fIzlib\fR constants are automatically imported when you make use
of \fICompress::Zlib\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
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) 1995\-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: