.\" Automatically generated by Pod::Man 2.28 (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 "Arch::Registry 3pm" .TH Arch::Registry 3pm "2005-05-13" "perl v5.20.2" "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" Arch::Registry \- manage registered archives, search archives on the web .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& use Arch::Registry; \& my $registry = Arch::Registry\->new; \& \& my %archive_locations = $registry\->registered_archives; \& $registry\->register_archive(\*(Aqhttp://john.com/archives/main\*(Aq); \& $registry\->unregister_archive(\*(Aqjohn@mail.com\-\-tux\*(Aq); \& \& %archive_locations = $registry\->supermirror_archives; \& die $registry\->web_error if $registry\->web_error; \& \& my @john_versions = @{ \& $registry\->supermirror_archive_versions\->{\*(Aqjohn@mail.com\-\-tux\*(Aq) \& }; \& \& my $archives = $registry\->search_supermirror(\*(Aq.*\*(Aq, \*(Aq\-\-cset\-gui\-\-\*(Aq); \& die $registry\->web_error unless defined $archives; \& \& my $versions = $registry\->search_supermirror(\*(Aqjohn@\*(Aq, \*(Aq^tla\eb\*(Aq, 1); \& print map { "$_\en" } @$versions; # print john@mail.com\-\-tux/tla... .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This class provides the way to register and unregister \s-1GNU\s0 Arch archives for the caller user and list all registered archives. It also provides the way to search the supermirror (currently mirrors.sourcecontrol.net) by archive name or archive/category/branch/version regexp. .SH "METHODS" .IX Header "METHODS" The following class methods are available: .PP \&\fBnew\fR, \&\fBregister_archive\fR, \&\fBunregister_archive\fR, \&\fBregistered_archives\fR, \&\fBset_web_cache\fR, \&\fBflag_web_cache\fR, \&\fBsupermirror_archives\fR, \&\fBsupermirror_archive_versions\fR, \&\fBsearch_supermirror\fR, \&\fBweb_error\fR. .IP "\fBnew\fR" 4 .IX Item "new" Construct Arch::Registry object. .IP "\fBregister_archive\fR \fIlocation\fR [\fIarchive\fR]" 4 .IX Item "register_archive location [archive]" Register archive at the given \fIlocation\fR and optional \fIarchive\fR (if missing then the location is actually accessed to find the archive name). Returns true on success. .IP "\fBunregister_archive\fR \fIarchive\fR" 4 .IX Item "unregister_archive archive" Unregister \fIarchive\fR. Returns true on success. .IP "\fBregistered_archives\fR" 4 .IX Item "registered_archives" Returns a hash (or hashref in scalar context) of registered archives, that is pairs \fIarchive\fR => \fIlocation\fR. .IP "\fBset_web_cache\fR [ \fInamed-values\fR ]" 4 .IX Item "set_web_cache [ named-values ]" Define the web cache to use with operations on the supermirror. .Sp The keys of \fInamed-values\fR are \fIdir\fR (the web cache directory) and \fIttl\fR (time to live in minutes). If \fInamed-values\fR is empty or misses \fIdir\fR, or \fIdir\fR does not exist, the cache is unset. .Sp This method has a side effect of forgetting memoized real-web-or-cache content fetches. So you may call it with or without parameters to reset the memoized values, although this should rarely be needed. .IP "\fBflag_web_cache\fR [\fIvalue\fR]" 4 .IX Item "flag_web_cache [value]" Turn on or off the web cache depending on the parameter. .Sp \&\fIvalue\fR may be \*(L"enabled\*(R", \*(L"disabled\*(R", \*(L"nowrite\*(R" and \*(L"noread\*(R". Additionally, the false \fIvalue\fR will be taken as \*(L"disabled\*(R", the true \fIvalue\fR as \*(L"enabled\*(R". .IP "\fBsupermirror_archives\fR" 4 .IX Item "supermirror_archives" Returns a hash (or hashref in scalar context) of archives mirrored on the supermirror, that is pairs \fIarchive\fR => \fIlocation\fR. .IP "\fBsupermirror_archive_versions\fR" 4 .IX Item "supermirror_archive_versions" Returns a hashref of archives mirrored on the supermirror and all their versions, that is pairs \fIarchive\fR => [ \fIversion\fR, .. ]. .IP "\fBsearch_supermirror\fR" 4 .IX Item "search_supermirror" .PD 0 .IP "\fBsearch_supermirror\fR \fIarchive_regexp\fR" 4 .IX Item "search_supermirror archive_regexp" .IP "\fBsearch_supermirror\fR \fIarchive_regexp\fR \fIversion_regexp\fR" 4 .IX Item "search_supermirror archive_regexp version_regexp" .IP "\fBsearch_supermirror\fR \fIarchive_regexp\fR \fIversion_regexp\fR \fIreturn_versions\fR" 4 .IX Item "search_supermirror archive_regexp version_regexp return_versions" .PD Search the archives (and possibly their branches/versions) by \fIarchive\fR and \fIversion\fR regular expressions given. .Sp If \fIreturn_versions\fR is unset, returns arrayref that is all matching [ \fIarchive\fR, .. ]. If \fIreturn_versions\fR is set to 'joined', returns arrayref that is all matching [ \fIarchive\fR/\fIversion\fR, .. ]. If \fIreturn_versions\fR is set to 'hashref', returns hashref similar to \fBsupermirror_archive_versions\fR that is all matching { \fIarchive\fR => [ \fIversion\fR, .. ], ... }. .Sp If \fBweb_error\fR occurred, returns undef. .Sp \&\fIarchive_regexp\fR defaults to \*(L"any\*(R", \fIversion_regexp\fR defaults to \*(L"any\*(R", \&\fIreturn_versions\fR defaults to false. .IP "\fBweb_error\fR" 4 .IX Item "web_error" Returns the string containing the error while fetching one or another supermirror url (the last one). Returns undef if no error occured. .SH "BUGS" .IX Header "BUGS" Waiting for your reports. .SH "AUTHORS" .IX Header "AUTHORS" Mikhael Goikhman (migo@homemail.com\*(--Perl\-GPL/arch\-perl\*(--devel). .SH "SEE ALSO" .IX Header "SEE ALSO" For more information, see tla, Arch::Util, Arch::LiteWeb.