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/AppConfig::State.3pm (24972B)

.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "AppConfig::State 3"
.TH AppConfig::State 3 "2015-03-01" "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"
AppConfig::State \- application configuration state
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use AppConfig::State;
\&
\&    my $state = AppConfig::State\->new(\e%cfg);
\&
\&    $state\->define("foo");            # very simple variable definition
\&    $state\->define("bar", \e%varcfg);  # variable specific configuration
\&    $state\->define("foo|bar=i@");     # compact format
\&
\&    $state\->set("foo", 123);          # trivial set/get examples
\&    $state\->get("foo");      
\&
\&    $state\->foo();                    # shortcut variable access 
\&    $state\->foo(456);                 # shortcut variable update
.Ve
.SH "OVERVIEW"
.IX Header "OVERVIEW"
AppConfig::State is a Perl5 module to handle global configuration variables
for perl programs.  It maintains the state of any number of variables,
handling default values, aliasing, validation, update callbacks and 
option arguments for use by other AppConfig::* modules.
.PP
AppConfig::State is distributed as part of the AppConfig bundle.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
.SS "\s-1USING THE\s0 AppConfig::State \s-1MODULE\s0"
.IX Subsection "USING THE AppConfig::State MODULE"
To import and use the AppConfig::State module the following line should 
appear in your Perl script:
.PP
.Vb 1
\&     use AppConfig::State;
.Ve
.PP
The AppConfig::State module is loaded automatically by the \fInew()\fR
constructor of the AppConfig module.
.PP
AppConfig::State is implemented using object-oriented methods.  A 
new AppConfig::State object is created and initialised using the 
\&\fInew()\fR method.  This returns a reference to a new AppConfig::State 
object.
.PP
.Vb 1
\&    my $state = AppConfig::State\->new();
.Ve
.PP
This will create a reference to a new AppConfig::State with all 
configuration options set to their default values.  You can initialise 
the object by passing a reference to a hash array containing 
configuration options:
.PP
.Vb 4
\&    $state = AppConfig::State\->new( {
\&        CASE      => 1,
\&        ERROR     => \e&my_error,
\&    } );
.Ve
.PP
The \fInew()\fR constructor of the AppConfig module automatically passes all 
parameters to the AppConfig::State \fInew()\fR constructor.  Thus, any global 
configuration values and variable definitions for AppConfig::State are 
also applicable to AppConfig.
.PP
The following configuration options may be specified.
.IP "\s-1CASE\s0" 4
.IX Item "CASE"
Determines if the variable names are treated case sensitively.  Any non-zero
value makes case significant when naming variables.  By default, \s-1CASE\s0 is set
to 0 and thus \*(L"Variable\*(R", \*(L"\s-1VARIABLE\*(R"\s0 and \*(L"VaRiAbLe\*(R" are all treated as 
\&\*(L"variable\*(R".
.IP "\s-1CREATE\s0" 4
.IX Item "CREATE"
By default, \s-1CREATE\s0 is turned off meaning that all variables accessed via
\&\fIset()\fR (which includes access via shortcut such as 
\&\f(CW\*(C`$state\->variable($value)\*(C'\fR which delegates to \fIset()\fR) must previously 
have been defined via \fIdefine()\fR.  When \s-1CREATE\s0 is set to 1, calling 
set($variable, \f(CW$value\fR) on a variable that doesn't exist will cause it 
to be created automatically.
.Sp
When \s-1CREATE\s0 is set to any other non-zero value, it is assumed to be a
regular expression pattern.  If the variable name matches the regex, the
variable is created.  This can be used to specify configuration file 
blocks in which variables should be created, for example:
.Sp
.Vb 3
\&    $state = AppConfig::State\->new( {
\&        CREATE => \*(Aq^define_\*(Aq,
\&    } );
.Ve
.Sp
In a config file:
.Sp
.Vb 2
\&    [define]
\&    name = fred           # define_name gets created automatically
\&
\&    [other]
\&    name = john           # other_name doesn\*(Aqt \- warning raised
.Ve
.Sp
Note that a regex pattern specified in \s-1CREATE\s0 is applied to the real 
variable name rather than any alias by which the variables may be 
accessed.
.IP "\s-1PEDANTIC\s0" 4
.IX Item "PEDANTIC"
The \s-1PEDANTIC\s0 option determines what action the configuration file 
(AppConfig::File) or argument parser (AppConfig::Args) should take 
on encountering a warning condition (typically caused when trying to set an
undeclared variable).  If \s-1PEDANTIC\s0 is set to any true value, the parsing
methods will immediately return a value of 0 on encountering such a
condition.  If \s-1PEDANTIC\s0 is not set, the method will continue to parse the
remainder of the current file(s) or arguments, returning 0 when complete.
.Sp
If no warnings or errors are encountered, the method returns 1.
.Sp
In the case of a system error (e.g. unable to open a file), the method
returns undef immediately, regardless of the \s-1PEDANTIC\s0 option.
.IP "\s-1ERROR\s0" 4
.IX Item "ERROR"
Specifies a user-defined error handling routine.  When the handler is 
called, a format string is passed as the first parameter, followed by 
any additional values, as per printf(3C).
.IP "\s-1DEBUG\s0" 4
.IX Item "DEBUG"
Turns debugging on or off when set to 1 or 0 accordingly.  Debugging may 
also be activated by calling \fI_debug()\fR as an object method 
(\f(CW\*(C`$state\->_debug(1)\*(C'\fR) or as a package function 
(\f(CWAppConfig::State::_debug(1)\fR), passing in a true/false value to 
set the debugging state accordingly.  The package variable 
\&\f(CW$AppConfig::State::DEBUG\fR can also be set directly.
.Sp
The \fI_debug()\fR method returns the current debug value.  If a new value 
is passed in, the internal value is updated, but the previous value is 
returned.
.Sp
Note that any AppConfig::File or App::Config::Args objects that are 
instantiated with a reference to an App::State will inherit the 
\&\s-1DEBUG \s0(and also \s-1PEDANTIC\s0) values of the state at that time.  Subsequent
changes to the AppConfig::State debug value will not affect them.
.IP "\s-1GLOBAL \s0" 4
.IX Item "GLOBAL "
The \s-1GLOBAL\s0 option allows default values to be set for the \s-1DEFAULT, ARGCOUNT, 
EXPAND, VALIDATE\s0 and \s-1ACTION\s0 options for any subsequently defined variables.
.Sp
.Vb 7
\&    $state = AppConfig::State\->new({
\&        GLOBAL => {
\&            DEFAULT  => \*(Aq<undef>\*(Aq,     # default value for new vars
\&            ARGCOUNT => 1,             # vars expect an argument
\&            ACTION   => \e&my_set_var,  # callback when vars get set
\&        }
\&    });
.Ve
.Sp
Any attributes specified explicitly when a variable is defined will
override any \s-1GLOBAL\s0 values.
.Sp
See \*(L"\s-1DEFINING VARIABLES\*(R"\s0 below which describes these options in detail.
.SS "\s-1DEFINING VARIABLES\s0"
.IX Subsection "DEFINING VARIABLES"
The \f(CW\*(C`define()\*(C'\fR function is used to pre-declare a variable and specify 
its configuration.
.PP
.Vb 1
\&    $state\->define("foo");
.Ve
.PP
In the simple example above, a new variable called \*(L"foo\*(R" is defined.  A 
reference to a hash array may also be passed to specify configuration 
information for the variable:
.PP
.Vb 4
\&    $state\->define("foo", {
\&            DEFAULT   => 99,
\&            ALIAS     => \*(Aqmetavar1\*(Aq,
\&        });
.Ve
.PP
Any variable-wide \s-1GLOBAL\s0 values passed to the \fInew()\fR constructor in the 
configuration hash will also be applied.  Values explicitly specified 
in a variable's \fIdefine()\fR configuration will override the respective \s-1GLOBAL \s0
values.
.PP
The following configuration options may be specified
.IP "\s-1DEFAULT\s0" 4
.IX Item "DEFAULT"
The \s-1DEFAULT\s0 value is used to initialise the variable.
.Sp
.Vb 3
\&    $state\->define("drink", {
\&            DEFAULT => \*(Aqcoffee\*(Aq,
\&        });
\&
\&    print $state\->drink();        # prints "coffee"
.Ve
.IP "\s-1ALIAS\s0" 4
.IX Item "ALIAS"
The \s-1ALIAS\s0 option allows a number of alternative names to be specified for 
this variable.  A single alias should be specified as a string.  Multiple 
aliases can be specified as a reference to an array of alternatives or as 
a string of names separated by vertical bars, '|'.  e.g.:
.Sp
.Vb 4
\&    # either
\&    $state\->define("name", {
\&            ALIAS  => \*(Aqperson\*(Aq,
\&        });
\&
\&    # or
\&    $state\->define("name", {
\&            ALIAS => [ \*(Aqperson\*(Aq, \*(Aquser\*(Aq, \*(Aquid\*(Aq ],
\&        });
\&
\&    # or
\&    $state\->define("name", {
\&            ALIAS => \*(Aqperson|user|uid\*(Aq,
\&        });
\&
\&    $state\->user(\*(Aqabw\*(Aq);     # equivalent to $state\->name(\*(Aqabw\*(Aq);
.Ve
.IP "\s-1ARGCOUNT\s0" 4
.IX Item "ARGCOUNT"
The \s-1ARGCOUNT\s0 option specifies the number of arguments that should be 
supplied for this variable.  By default, no additional arguments are 
expected for variables (\s-1ARGCOUNT_NONE\s0).
.Sp
The ARGCOUNT_* constants can be imported from the AppConfig module:
.Sp
.Vb 1
\&    use AppConfig \*(Aq:argcount\*(Aq;
\&
\&    $state\->define(\*(Aqfoo\*(Aq, { ARGCOUNT => ARGCOUNT_ONE });
.Ve
.Sp
or can be accessed directly from the AppConfig package:
.Sp
.Vb 1
\&    use AppConfig;
\&
\&    $state\->define(\*(Aqfoo\*(Aq, { ARGCOUNT => AppConfig::ARGCOUNT_ONE });
.Ve
.Sp
The following values for \s-1ARGCOUNT\s0 may be specified.
.RS 4
.IP "\s-1ARGCOUNT_NONE \\fIs0\fR\|(0)" 4
.IX Item "ARGCOUNT_NONE f(ISs0"
Indicates that no additional arguments are expected.  If the variable is
identified in a confirguration file or in the command line arguments, it
is set to a value of 1 regardless of whatever arguments follow it.
.IP "\s-1ARGCOUNT_ONE \\fIs0\fR\|(1)" 4
.IX Item "ARGCOUNT_ONE f(ISs0"
Indicates that the variable expects a single argument to be provided.
The variable value will be overwritten with a new value each time it 
is encountered.
.IP "\s-1ARGCOUNT_LIST \\fIs0\fR\|(2)" 4
.IX Item "ARGCOUNT_LIST f(ISs0"
Indicates that the variable expects multiple arguments.  The variable 
value will be appended to the list of previous values each time it is
encountered.
.IP "\s-1ARGCOUNT_HASH \\fIs0\fR\|(3)" 4
.IX Item "ARGCOUNT_HASH f(ISs0"
Indicates that the variable expects multiple arguments and that each
argument is of the form \*(L"key=value\*(R".  The argument will be split into 
a key/value pair and inserted into the hash of values each time it 
is encountered.
.RE
.RS 4
.RE
.IP "\s-1ARGS\s0" 4
.IX Item "ARGS"
The \s-1ARGS\s0 option can also be used to specify advanced command line options 
for use with AppConfig::Getopt, which itself delegates to Getopt::Long.  
See those two modules for more information on the format and meaning of
these options.
.Sp
.Vb 3
\&    $state\->define("name", {
\&            ARGS => "=i@",
\&        });
.Ve
.IP "\s-1EXPAND \s0" 4
.IX Item "EXPAND "
The \s-1EXPAND\s0 option specifies how the AppConfig::File processor should 
expand embedded variables in the configuration file values it reads.
By default, \s-1EXPAND\s0 is turned off (\s-1EXPAND_NONE\s0) and no expansion is made.
.Sp
The EXPAND_* constants can be imported from the AppConfig module:
.Sp
.Vb 1
\&    use AppConfig \*(Aq:expand\*(Aq;
\&
\&    $state\->define(\*(Aqfoo\*(Aq, { EXPAND => EXPAND_VAR });
.Ve
.Sp
or can be accessed directly from the AppConfig package:
.Sp
.Vb 1
\&    use AppConfig;
\&
\&    $state\->define(\*(Aqfoo\*(Aq, { EXPAND => AppConfig::EXPAND_VAR });
.Ve
.Sp
The following values for \s-1EXPAND\s0 may be specified.  Multiple values should
be combined with vertical bars , '|', e.g. \f(CW\*(C`EXPAND_UID | EXPAND_VAR\*(C'\fR).
.RS 4
.IP "\s-1EXPAND_NONE\s0" 4
.IX Item "EXPAND_NONE"
Indicates that no variable expansion should be attempted.
.IP "\s-1EXPAND_VAR\s0" 4
.IX Item "EXPAND_VAR"
Indicates that variables embedded as \f(CW$var\fR or $(var) should be expanded
to the values of the relevant AppConfig::State variables.
.IP "\s-1EXPAND_UID \s0" 4
.IX Item "EXPAND_UID "
Indicates that '~' or '~uid' patterns in the string should be 
expanded to the current users ($<), or specified user's home directory.
In the first case, \f(CW\*(C`~\*(C'\fR is expanded to the value of the \f(CW\*(C`HOME\*(C'\fR
environment variable.  In the second case, the \f(CW\*(C`getpwnam()\*(C'\fR method
is used if it is available on your system (which it isn't on Win32).
.IP "\s-1EXPAND_ENV\s0" 4
.IX Item "EXPAND_ENV"
Inidicates that variables embedded as ${var} should be expanded to the 
value of the relevant environment variable.
.IP "\s-1EXPAND_ALL\s0" 4
.IX Item "EXPAND_ALL"
Equivalent to \f(CW\*(C`EXPAND_VARS | EXPAND_UIDS | EXPAND_ENVS\*(C'\fR).
.IP "\s-1EXPAND_WARN\s0" 4
.IX Item "EXPAND_WARN"
Indicates that embedded variables that are not defined should raise a
warning.  If \s-1PEDANTIC\s0 is set, this will cause the \fIread()\fR method to return 0
immediately.
.RE
.RS 4
.RE
.IP "\s-1VALIDATE\s0" 4
.IX Item "VALIDATE"
Each variable may have a sub-routine or regular expression defined which 
is used to validate the intended value for a variable before it is set.
.Sp
If \s-1VALIDATE\s0 is defined as a regular expression, it is applied to the
value and deemed valid if the pattern matches.  In this case, the
variable is then set to the new value.  A warning message is generated
if the pattern match fails.
.Sp
\&\s-1VALIDATE\s0 may also be defined as a reference to a sub-routine which takes
as its arguments the name of the variable and its intended value.  The 
sub-routine should return 1 or 0 to indicate that the value is valid
or invalid, respectively.  An invalid value will cause a warning error
message to be generated.
.Sp
If the \s-1GLOBAL VALIDATE\s0 variable is set (see \s-1GLOBAL\s0 in \s-1DESCRIPTION\s0 
above) then this value will be used as the default \s-1VALIDATE\s0 for each 
variable unless otherwise specified.
.Sp
.Vb 3
\&    $state\->define("age", {
\&            VALIDATE => \*(Aq\ed+\*(Aq,
\&        });
\&
\&    $state\->define("pin", {
\&            VALIDATE => \e&check_pin,
\&        });
.Ve
.IP "\s-1ACTION\s0" 4
.IX Item "ACTION"
The \s-1ACTION\s0 option allows a sub-routine to be bound to a variable as a
callback that is executed whenever the variable is set.  The \s-1ACTION\s0 is
passed a reference to the AppConfig::State object, the name of the
variable and the value of the variable.
.Sp
The \s-1ACTION\s0 routine may be used, for example, to post-process variable
data, update the value of some other dependant variable, generate a
warning message, etc.
.Sp
Example:
.Sp
.Vb 1
\&    $state\->define("foo", { ACTION => \e&my_notify });
\&
\&    sub my_notify {
\&        my $state = shift;
\&        my $var   = shift;
\&        my $val   = shift;
\&
\&        print "$variable set to $value";
\&    }
\&
\&    $state\->foo(42);        # prints "foo set to 42"
.Ve
.Sp
Be aware that calling \f(CW\*(C`$state\->set()\*(C'\fR to update the same variable
from within the \s-1ACTION\s0 function will cause a recursive loop as the
\&\s-1ACTION\s0 function is repeatedly called.
.SS "\s-1DEFINING VARIABLES USING THE COMPACT FORMAT\s0"
.IX Subsection "DEFINING VARIABLES USING THE COMPACT FORMAT"
Variables may be defined in a compact format which allows any \s-1ALIAS\s0 and
\&\s-1ARGS\s0 values to be specified as part of the variable name.  This is designed
to mimic the behaviour of Johan Vromans' Getopt::Long module.
.PP
Aliases for a variable should be specified after the variable name, 
separated by vertical bars, '|'.  Any \s-1ARGS\s0 parameter should be appended 
after the variable name(s) and/or aliases.
.PP
The following examples are equivalent:
.PP
.Vb 4
\&    $state\->define("foo", { 
\&            ALIAS => [ \*(Aqbar\*(Aq, \*(Aqbaz\*(Aq ],
\&            ARGS  => \*(Aq=i\*(Aq,
\&        });
\&
\&    $state\->define("foo|bar|baz=i");
.Ve
.SS "\s-1READING AND MODIFYING VARIABLE VALUES\s0"
.IX Subsection "READING AND MODIFYING VARIABLE VALUES"
AppConfig::State defines two methods to manipulate variable values:
.PP
.Vb 2
\&    set($variable, $value);
\&    get($variable);
.Ve
.PP
Both functions take the variable name as the first parameter and
\&\f(CW\*(C`set()\*(C'\fR takes an additional parameter which is the new value for the
variable.  \f(CW\*(C`set()\*(C'\fR returns 1 or 0 to indicate successful or
unsuccessful update of the variable value.  If there is an \s-1ACTION\s0
routine associated with the named variable, the value returned will be
passed back from \f(CW\*(C`set()\*(C'\fR.  The \f(CW\*(C`get()\*(C'\fR function returns the current
value of the variable.
.PP
Once defined, variables may be accessed directly as object methods where
the method name is the same as the variable name.  i.e.
.PP
.Vb 1
\&    $state\->set("verbose", 1);
.Ve
.PP
is equivalent to
.PP
.Vb 1
\&    $state\->verbose(1);
.Ve
.PP
Without parameters, the current value of the variable is returned.  If
a parameter is specified, the variable is set to that value and the 
result of the \fIset()\fR operation is returned.
.PP
.Vb 1
\&    $state\->age(29);        # sets \*(Aqage\*(Aq to 29, returns 1 (ok)
.Ve
.SS "\s-1VARLIST\s0"
.IX Subsection "VARLIST"
The \fIvarlist()\fR method can be used to extract a number of variables into
a hash array.  The first parameter should be a regular expression
used for matching against the variable names.
.PP
.Vb 1
\&    my %vars = $state\->varlist("^file");   # all "file*" variables
.Ve
.PP
A second parameter may be specified (any true value) to indicate that
the part of the variable name matching the regex should be removed
when copied to the target hash.
.PP
.Vb 2
\&    $state\->file_name("/tmp/file");
\&    $state\->file_path("/foo:/bar:/baz");
\&
\&    my %vars = $state\->varlist("^file_", 1);
\&
\&    # %vars:
\&    #    name => /tmp/file
\&    #    path => "/foo:/bar:/baz"
.Ve
.SS "\s-1INTERNAL METHODS\s0"
.IX Subsection "INTERNAL METHODS"
The interal (private) methods of the AppConfig::State class are listed 
below.
.PP
They aren't intended for regular use and potential users should consider
the fact that nothing about the internal implementation is guaranteed to
remain the same.  Having said that, the AppConfig::State class is
intended to co-exist and work with a number of other modules and these
are considered \*(L"friend\*(R" classes.  These methods are provided, in part,
as services to them.  With this acknowledged co-operation in mind, it is
safe to assume some stability in this core interface.
.PP
The \fI_varname()\fR method can be used to determine the real name of a variable 
from an alias:
.PP
.Vb 1
\&    $varname\->_varname($alias);
.Ve
.PP
Note that all methods that take a variable name, including those listed
below, can accept an alias and automatically resolve it to the correct 
variable name.  There is no need to call \fI_varname()\fR explicitly to do 
alias expansion.  The \fI_varname()\fR method will fold all variables names
to lower case unless \s-1CASE\s0 sensititvity is set.
.PP
The \fI_exists()\fR method can be used to check if a variable has been
defined:
.PP
.Vb 1
\&    $state\->_exists($varname);
.Ve
.PP
The \fI_default()\fR method can be used to reset a variable to its default value:
.PP
.Vb 1
\&    $state\->_default($varname);
.Ve
.PP
The \fI_expand()\fR method can be used to determine the \s-1EXPAND\s0 value for a 
variable:
.PP
.Vb 1
\&    print "$varname EXPAND: ", $state\->_expand($varname), "\en";
.Ve
.PP
The \fI_argcount()\fR method returns the value of the \s-1ARGCOUNT\s0 attribute for a 
variable:
.PP
.Vb 1
\&    print "$varname ARGCOUNT: ", $state\->_argcount($varname), "\en";
.Ve
.PP
The \fI_validate()\fR method can be used to determine if a new value for a variable
meets any validation criteria specified for it.  The variable name and 
intended value should be passed in.  The methods returns a true/false value
depending on whether or not the validation succeeded:
.PP
.Vb 1
\&    print "OK\en" if $state\->_validate($varname, $value);
.Ve
.PP
The \fI_pedantic()\fR method can be called to determine the current value of the
\&\s-1PEDANTIC\s0 option.
.PP
.Vb 1
\&    print "pedantic mode is ", $state\->_pedantic() ? "on" ; "off", "\en";
.Ve
.PP
The \fI_debug()\fR method can be used to turn debugging on or off (pass 1 or 0
as a parameter).  It can also be used to check the debug state,
returning the current internal value of \f(CW$AppConfig::State::DEBUG\fR.  If a
new debug value is provided, the debug state is updated and the previous
state is returned.
.PP
.Vb 1
\&    $state\->_debug(1);               # debug on, returns previous value
.Ve
.PP
The _dump_var($varname) and \fI_dump()\fR methods may also be called for
debugging purposes.
.PP
.Vb 2
\&    $state\->_dump_var($varname);    # show variable state
\&    $state\->_dump();                # show internal state and all vars
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Andy Wardley, <abw@wardley.org>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 1997\-2007 Andy Wardley.  All Rights Reserved.
.PP
Copyright (C) 1997,1998 Canon Research Centre Europe Ltd.
.PP
This module is free software; you can redistribute it and/or modify it 
under the same terms as Perl itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
AppConfig, AppConfig::File, AppConfig::Args, AppConfig::Getopt

cmd: