.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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 >0, 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 "Arch::Session 3pm"
.TH Arch::Session 3pm "2022-06-08" "perl v5.34.0" "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::Session \- access arch archives
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Arch::Session;
\&
\&    my $session = Arch::Session\->new;
\&
\&    my $rev  = \*(Aqmigo@homemail.com\-\-Perl\-GPL/arch\-perl\-\-devel\-\-0\-\-patch\-1\*(Aq;
\&    my $log  = $session\->get_revision_log($rev);
\&    my $cset = $session\->get_revision_changeset($rev);
\&    my $tree = $session\->get_tree($rev);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Arch::Session provides an interface to access changesets and logs
stored in arch archives.
.SH "METHODS"
.IX Header "METHODS"
The following common methods (inherited and pure virtual that
this class implements) are documented in Arch::Storage:
.PP
\&\fBnew\fR,
\&\fBinit\fR,
\&\fBworking_name\fR,
\&\fBworking_names\fR,
\&\fBfixup_name_alias\fR,
\&\fBis_archive_managed\fR,
\&\fBexpanded_revisions\fR.
.PP
\&\fBarchives\fR,
\&\fBcategories\fR,
\&\fBbranches\fR,
\&\fBversions\fR,
\&\fBrevisions\fR,
\&\fBget_revision_descs\fR,
\&\fBexpanded_archive_info\fR,
\&\fBget_revision_changeset\fR,
\&\fBget_changeset\fR,
\&\fBget_revision_log\fR,
\&\fBget_log\fR.
.PP
Additionally, the following methods are available:
.PP
\&\fBget_specified_changeset\fR,
\&\fBclear_cache\fR,
\&\fBget_tree\fR,
\&\fBinit_tree\fR,
\&\fBmy_id\fR.
.IP "\fBget_specified_changeset\fR \fIarg\fR" 4
.IX Item "get_specified_changeset arg"
Get changeset object (Arch::Changeset) by a user specified input. \fIarg\fR
may be revision name, or changeset directory, or tree directory (then
changeset for tree changes is constructed), and in the future local tarball
filepath or remote tarball url.
.IP "\fBclear_cache\fR [\fIkey\fR ..]" 4
.IX Item "clear_cache [key ..]"
For performance reasons, most method results are cached (memoized in fact).
Use this method to explicitly request this cache to be cleared.
.Sp
By default all cached keys are cleared; \fIkey\fR may be one of the strings
\&'archives', 'categories', 'branches', 'versions', 'revisions' or
\&'revision_descs'.
.IP "\fBget_tree\fR [{ \fIoptions\fR }] [\fIrevision\fR [\fIdir\fR]]" 4
.IX Item "get_tree [{ options }] [revision [dir]]"
Construct a working tree for \fIrevision\fR or \fBworking_name\fR in
\&\fIdir\fR. If \fIdir\fR is not specified, a new temporary directory is
automatically created.
.Sp
Keys of \fIoptions\fR may be \fIpristine\fR, \fIlink\fR, \fIlibrary\fR, \fIsparse\fR,
\&\fInon_sparse\fR, \fIno_greedy_add\fR; all are false by default.
See \f(CW\*(C`tla get\*(C'\fR.
.IP "\fBinit_tree\fR \fIdir\fR" 4
.IX Item "init_tree dir"
Run \f(CW\*(C`tla init\-tree\*(C'\fR in \fIdir\fR.
.IP "\fBmy_id\fR [\fInewid\fR]" 4
.IX Item "my_id [newid]"
Get or set \f(CW\*(C`tla my\-id\*(C'\fR.
.SH "BUGS"
.IX Header "BUGS"
No known bugs.
.SH "AUTHORS"
.IX Header "AUTHORS"
Mikhael Goikhman (migo@homemail.com\*(--Perl\-GPL/arch\-perl\*(--devel).
.PP
Enno Cramer (uebergeek@web.de\-\-2003/arch\-perl\*(--devel).
.SH "SEE ALSO"
.IX Header "SEE ALSO"
For more information, see tla, Arch::Storage, Arch::Library,
Arch::Name, Arch::Log, Arch::Changeset.