.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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 "Cvs 3pm"
.TH Cvs 3pm "2021-01-07" "perl v5.32.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"
Cvs \- Object oriented interface to the CVS command
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Cvs;
\&
\&    my $cvs = new Cvs
\&      (
\&        \*(Aq/path/to/repository/for/module\*(Aq,
\&        cvsroot => \*(Aq:pserver:user@host:/path/to/cvs\*(Aq,
\&        password => \*(Aqsecret\*(Aq
\&      ) or die $Cvs::ERROR;
\&
\&    $cvs\->checkout(\*(Aqmodule\*(Aq);
\&
\&    ...
\&
\&    my $status = $cvs\->status(\*(Aqfile\*(Aq);
\&    if($status\->is_modified)
\&    {
\&        $cvs\->commit(\*(Aqfile\*(Aq);
\&    }
\&
\&    $cvs\->release({delete_after => 1});
\&    $cvs\->logout();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
bla bla
.SH "LEGACY CVS METHODS"
.IX Header "LEGACY CVS METHODS"
.SS "new"
.IX Subsection "new"
.Vb 1
\&    Cvs = new Cvs ["workdir"] [key => "value" [, ...]];
\&
\&    my $obj = new Cvs "workdir";
\&
\&    my $obj = new Cvs "workdir", cvsroot => "/path/to/cvsroot";
\&
\&    my $obj = new Cvs cvsroot => ":pserver:user\e@host:/path/to/cvs";
.Ve
.PP
Create a new Cvs object for the repository given in argument. Note
that the working directory doesn't need to already exist.
.PP
Allowed parameters are:
.IP "workdir" 4
.IX Item "workdir"
Path to the working directory. You don't need it if you plan to use
only remote commands like rdiff or rtag.
.IP "cvsroot" 4
.IX Item "cvsroot"
Address of the cvsroot. See the Cvs::Cvsroot module documentation for
more information on supported \s-1CVSROOT.\s0 Note that if you don't supply a
cvs root but a working directory, Cvs will try to guess the \s-1CVSROOT\s0
value. You still need to supply password and others authentication
values. If Cvs can't determine the \s-1CVSROOT\s0 value, an error will be
thrown and the object will not be created.
.IP "password, passphrase, ..." 4
.IX Item "password, passphrase, ..."
All options supported by Cvs::Cvsroot are supported here. Please see
Cvs::Cvsroot documentation for more details.
.SS "checkout"
.IX Subsection "checkout"
.Vb 1
\&    Cvs::Result::Checkout = $obj\->checkout("module", {key => "value"});
.Ve
.PP
Checkout the module \*(L"module\*(R" in the repository (the one that served to
create the Cvs object) from the cvsroot given in parameter.
.PP
Allowed parameters are:
.IP "reset" 4
.IX Item "reset"
Boolean value used to reset any sticky tags, dates or options (See the
\&\-A cvs checkout option).
.IP "revision" 4
.IX Item "revision"
Specify the revision to checkout the module (See the \-r cvs checkout
option).
.IP "date" 4
.IX Item "date"
Specify the date from when to checkout the module (See the \-D cvs
checkout option).
.PP
Cvs::Result::Checkout.
.SS "update"
.IX Subsection "update"
.Vb 1
\&    Cvs::Result::Update = $cvs\->update();
.Ve
.PP
Cvs::Result::Update.
.SS "status"
.IX Subsection "status"
.Vb 1
\&    Cvs::Result::StatusItem = $cvs\->status("file");
\&
\&    Cvs::Result::StatusList =
\&        $cvs\->status("file1", "file2", {multiple => 1});
.Ve
.PP
Get the status of one of more files.
.PP
Allowed parameters are:
.IP "multiple" 4
.IX Item "multiple"
Boolean value that specify the type of object returned. If true, a
Cvs::Result::StatusList object is returned, and status on more than
one files can be handled. If false, a Cvs::Result::StatusItem object
is return and only one file status can be handled (the first one if
several).
.IP "recursive" 4
.IX Item "recursive"
If a directory is supplied, process it recursively (Default true).
.PP
Cvs::Result::StatusItem, Cvs::Result::StatusList
.SS "diff"
.IX Subsection "diff"
.Vb 1
\&    Cvs::Result::DiffItem = $cvs\->diff();
\&
\&    Cvs::Result::DiffList = $cvs\->diff({multiple => 1});
.Ve
.PP
Cvs::Result::DiffItem, Cvs::Result::DiffList.
.SS "rdiff"
.IX Subsection "rdiff"
.Vb 2
\&    Cvs::Result::RdiffList =
\&      $cvs\->rdiff("module", {from_revision => $rev});
.Ve
.PP
Cvs::Result::RdiffList.
.SS "log"
.IX Subsection "log"
.Vb 1
\&    Cvs::Result::Log = $cvs\->log();
.Ve
.PP
Cvs::Result::Log.
.SS "tag"
.IX Subsection "tag"
.Vb 1
\&    Cvs::Result::Tag = $cvs\->tag("tag");
.Ve
.PP
Cvs::Result::Tag.
.SS "rtag"
.IX Subsection "rtag"
.Vb 1
\&    Cvs::Result::Tag = $cvs\->rtag("module", "tag");
.Ve
.PP
Cvs::Result::Rtag.
.SS "release"
.IX Subsection "release"
.Vb 1
\&    Cvs::Result::Release = $cvs\->release();
\&
\&    Cvs::Result::Release = $cvs\->release(\*(Aqmodule\*(Aq, ..., {force => 1});
.Ve
.PP
Call the release command.
.PP
If call with no directories to release, self repository will be
released.
.IP "force" 4
.IX Item "force"
Boolean value that activate a forced directory release even if some
files was not committed.  Defaults to false.
.IP "delete_after" 4
.IX Item "delete_after"
Boolean value that activate directory removal after a release. Default
to false.
.PP
Cvs::Result::Release
.SS "export"
.IX Subsection "export"
.Vb 1
\&    Cvs::Result::Export = $obj\->export("module", {key => "value"});
.Ve
.PP
Checkout the module \*(L"module\*(R" in the repository (the one that served to
create the Cvs object) from the cvsroot given in parameter, but without
the \s-1CVS\s0 administrative directories.
.PP
Allowed parameters are the same as for checkout.  However, one of the 
options 'revision' or 'date' must be specified.
.SH "OTHERS METHODS"
.IX Header "OTHERS METHODS"
.SS "module_list"
.IX Subsection "module_list"
.Vb 1
\&  my @modules = $cvs\->module_list();
.Ve
.PP
Returns the list of all modules which can be riched on the
\&\s-1CVSROOT.\s0 This method do something that cvs doesn't implement by itself,
we use a little trick to get this list, and this perhaps not work with
all cvs versions.
.PP
Do not mix up this method with the \*(L"\-c\*(R" argument of the cvs' checkout
sub-command.
.SH "ACCESSORS"
.IX Header "ACCESSORS"
.SS "cvsroot"
.IX Subsection "cvsroot"
Returns the Cvs::Cvsroot object.
.SS "working_directory"
.IX Subsection "working_directory"
Returns the full path of the working directory
.SH "LICENCE"
.IX Header "LICENCE"
This library is free software; you can redistribute it and/or modify
it under the terms of the \s-1GNU\s0 Lesser General Public License as
published by the Free Software Foundation; either version 2.1 of the
License, or (at your option) any later version.
.PP
This library is distributed in the hope that it will be useful, but
\&\s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of
\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0  See the \s-1GNU\s0
Lesser General Public License for more details.
.PP
You should have received a copy of the \s-1GNU\s0 Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, \s-1MA 02111\-1307
USA\s0
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2003 \- Olivier Poitrey