.\" 
.\" Copyright (c) 2004 Steven G. Johnson
.\" 
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 2 of the License, or
.\" (at your option) any later version.
.\" 
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\" 
.\" You should have received a copy of the GNU General Public License
.\" along with this program; if not, write to the Free Software
.\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
.\"
.TH CVS2DARCS 1 "November, 2004" "darcs" "darcs"
.SH NAME
cvs2darcs \- import a CVS project into Darcs
.SH SYNOPSIS
\fBcvs2darcs\fR [\fIOPTIONS\fR] \fIMODULE\fR
.SH DESCRIPTION
.PP
." Add any additional description here
.I cvs2darcs
is a program to import a CVS module/project into a Darcs repository,
preserving all (or as much as possible) of the revision history,
including support for importing branches.

Darcs is a free advanced revision-control program, available from
\fIwww.darcs.net\fR, that has many features lacking in CVS (such as the
ability to have independent branch repositories, arbitrary merging of
repositories, etc.).

.I cvs2darcs
checks out \fIMODULE\fR from the CVS repository into a new directory
(by default, into the directory \fIMODULE\fR) and converts this
directory into a Darcs repository.  (This will take some time for
large repositories. You may want to copy your CVS repository to a
local disk to speed things up.) 

Instead of \fIMODULE\fR, you can also specify an existing CVS project
directory.  This will import the directory into a Darcs repository
(preserving the CVS information as with \fB-p\fR below).  If the
directory was already imported into Darcs, then cvs2darcs will import
any new CVS patches into Darcs (but not vice-versa).

The most important option flags are \fB-d\fR \fICVSROOT\fR, which
specifies the location of the CVS repository root (exactly as the \fIcvs\fR
\fB-d\fR flag); \fB-o\fR \fIDIR\fR, which specifies an alternate
output directory name; and \fB-b\fR \fIBRANCH\fR, which specifies a
CVS branch to import (default is HEAD).  Other options are described below.

The CVS repository is not modified.  However, the output directory
created by \fIcvs2darcs\fR is not linked to the CVS repository
(technically, it has no CVS/ directories).  If you want to preserve
the CVS information in the output directory, you can pass the \fB-p\fR
flag; this is the default if the output directory already exists as a
CVS-controlled directory.

.SH OPTIONS
.TP
\fB\-h\fR, \fB\--help\fR
Display help on the command-line options and usage.
.TP
\fB\-V\fR, \fB\--version\fR
Print the version number and copyright information.
.TP
\fB\-o\fR \fIDIR\fR, \fB\--output-dir\fR=\fIDIR\fR
Use/create directory \fIDIR\fR as the output Darcs repository, rather than
\fIMODULE\fR (the default).
.TP
\fB\-b\fR \fIBRANCH\fR, \fB\--branch\fR=\fIBRANCH\fR
Import the CVS branch named \fIBRANCH\fR, instead of the current CVS
HEAD (the default).
.TP
\fB\-p\fI, \fB\--preserve-cvs\fI
Preserve the CVS-repository information in the output directory (default
is to remove it).  If the output-directory has pre-existing CVS information,
it is preserved by default.
.TP
\fB\-d\fR \fICVSROOT\fR
Use \fICVSROOT\fR as the root directory pathname of the CVS
repository, exactly as for the \fIcvs\fR \fB-d\fR flag.
.TP
\fB\-z\fR \fIGZIP-LEVEL\fR
Use \fIGZIP-LEVEL\fR as the gzip compression level in CVS,
exactly as for the \fIcvs\fR \fB-z\fR flag.
.TP
.B -R
As for the \fIcvs\fR \fB-R\fR flag: use read-only CVS repository mode, which
may improve CVS performance.
.TP
.B -x
As for the \fIcvs\fR \fB-x\fR flag (used for GSSAPI and Kerberos encryption).
.SH BUGS
Send bug reports to cvs2darcs@darcs.net.
.SH AUTHORS
The cvs2darcs script was written by Steven G. Johnson as a wrapper around
Perl scripts written by David Roundy and Ganesh Sittampalam.

Copyright (c) 2004 David Roundy
.br
Copyright (c) 2004 Ganesh Sittampalam
.br
Copyright (c) 2004 Steven G. Johnson
.SH "SEE ALSO"
darcs(1), cvs(1)