xref: /dflybsd-src/contrib/cvs-1.12/README (revision 86d7f5d305c6adaa56ff4582ece9859d73106103)
186d7f5d3SJohn Marino				CVS Kit
286d7f5d3SJohn Marino
386d7f5d3SJohn Marino	   Copyright (C) 1986-2005 Free Software Foundation, Inc.
486d7f5d3SJohn Marino
586d7f5d3SJohn Marino	   Portions Copyright (C) 1998-2005 Derek Price,
686d7f5d3SJohn Marino	                                    & Ximbiot <http://ximbiot.com>.
786d7f5d3SJohn Marino	   Portions Copyright (C) 1993-1994 Brian Berliner.
886d7f5d3SJohn Marino	   Portions Copyright (C) 1992 Brian Berliner and Jeff Polk.
986d7f5d3SJohn Marino	   Portions Copyright (C) 1989-1992 Brian Berliner.
1086d7f5d3SJohn Marino	   All Rights Reserved
1186d7f5d3SJohn Marino
1286d7f5d3SJohn Marino    This program is free software; you can redistribute it and/or modify
1386d7f5d3SJohn Marino    it under the terms of the GNU General Public License as published by
1486d7f5d3SJohn Marino    the Free Software Foundation; either version 1, or (at your option)
1586d7f5d3SJohn Marino    any later version.
1686d7f5d3SJohn Marino
1786d7f5d3SJohn Marino    This program is distributed in the hope that it will be useful,
1886d7f5d3SJohn Marino    but WITHOUT ANY WARRANTY; without even the implied warranty of
1986d7f5d3SJohn Marino    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
2086d7f5d3SJohn Marino    GNU General Public License for more details.
2186d7f5d3SJohn Marino
2286d7f5d3SJohn Marino-------------------------------------------------------------------------------
2386d7f5d3SJohn Marino
2486d7f5d3SJohn MarinoWelcome to CVS!
2586d7f5d3SJohn Marino
2686d7f5d3SJohn MarinoIf you have problems or think you have found a bug in CVS, see the
2786d7f5d3SJohn Marinosection BUGS in the CVS manual (also known as Version Management with
2886d7f5d3SJohn MarinoCVS by Per Cederqvist et al, or cvs.texinfo--see below for details).
2986d7f5d3SJohn Marino
3086d7f5d3SJohn MarinoIf you are thinking of submitting changes to CVS, see the
3186d7f5d3SJohn Marinofile HACKING.
3286d7f5d3SJohn Marino
3386d7f5d3SJohn MarinoPlease consult the INSTALL-CVS file for information on tested
3486d7f5d3SJohn Marinoconfigurations.  If you have a comment about an already tested
3586d7f5d3SJohn Marinoconfiguration, or have tried CVS on a new configuration, please let us
3686d7f5d3SJohn Marinoknow as described in INSTALL-CVS.  Free software only works if we all help
3786d7f5d3SJohn Marinoout.
3886d7f5d3SJohn Marino
3986d7f5d3SJohn MarinoFinally, we cannot guarantee that this release will not completely wipe out
4086d7f5d3SJohn Marinoall of your work from your system.  We do some simple testing before each
4186d7f5d3SJohn Marinorelease, but you are completely on your own.  We recommend testing this
4286d7f5d3SJohn Marinorelease on a source repository that is not critical to your work.  THIS
4386d7f5d3SJohn MarinoSOFTWARE IS SUPPLIED COMPLETELY "AS IS".  NO WARRANTY....
4486d7f5d3SJohn Marino
4586d7f5d3SJohn MarinoThanks for your support!
4686d7f5d3SJohn Marino
4786d7f5d3SJohn Marino	-The CVS Team
4886d7f5d3SJohn Marino
4986d7f5d3SJohn Marino-------------------------------------------------------------------------------
5086d7f5d3SJohn Marino
5186d7f5d3SJohn MarinoWhat Is CVS?
5286d7f5d3SJohn Marino
5386d7f5d3SJohn MarinoCVS is a version control system, which allows you to keep old versions
5486d7f5d3SJohn Marinoof files (usually source code), keep a log of who, when, and why
5586d7f5d3SJohn Marinochanges occurred, etc., like RCS or SCCS.  It handles multiple
5686d7f5d3SJohn Marinodevelopers, multiple directories, triggers to enable/log/control
5786d7f5d3SJohn Marinovarious operations, and can work over a wide area network.  The
5886d7f5d3SJohn Marinofollowing tasks are not included; they can be done in conjunction with
5986d7f5d3SJohn MarinoCVS but will tend to require some script-writing and software other
6086d7f5d3SJohn Marinothan CVS: bug-tracking, build management (that is, make and make-like
6186d7f5d3SJohn Marinotools), and automated testing.
6286d7f5d3SJohn Marino
6386d7f5d3SJohn MarinoAnd a whole lot more.  See the manual for more information.
6486d7f5d3SJohn Marino
6586d7f5d3SJohn Marino-------------------------------------------------------------------------------
6686d7f5d3SJohn Marino
6786d7f5d3SJohn MarinoNotes to people upgrading from a previous release of CVS:
6886d7f5d3SJohn Marino
6986d7f5d3SJohn MarinoSee the NEWS file for a description of features new in this version.
7086d7f5d3SJohn Marino
7186d7f5d3SJohn MarinoSee the Compatibility section of the manual for information on
7286d7f5d3SJohn Marinocompatibility between CVS versions.  The quick summary is that as long
7386d7f5d3SJohn Marinoas you not using the optional watch features, there are no
7486d7f5d3SJohn Marinocompatibility problems with CVS 1.5 or later.
7586d7f5d3SJohn Marino
7686d7f5d3SJohn Marino-------------------------------------------------------------------------------
7786d7f5d3SJohn Marino
7886d7f5d3SJohn MarinoInstallation:
7986d7f5d3SJohn Marino
8086d7f5d3SJohn MarinoPlease read the INSTALL-CVS file for installation instructions.  The brief
8186d7f5d3SJohn Marinosummary is:
8286d7f5d3SJohn Marino
8386d7f5d3SJohn Marino	$ ./configure
8486d7f5d3SJohn Marino	$ make
8586d7f5d3SJohn Marino	(run the regression tests, if desired, via `make check')
8686d7f5d3SJohn Marino	$ make install
8786d7f5d3SJohn Marino	(create a repository if you don't already have one)
8886d7f5d3SJohn Marino
8986d7f5d3SJohn MarinoThe documentation is in the doc subdirectory.  cvs.texinfo is the main
9086d7f5d3SJohn Marinomanual; cvs.info* and cvs.ps are the info and postscript versions,
9186d7f5d3SJohn Marinorespectively, generated from cvs.texinfo.  The postscript version is
9286d7f5d3SJohn Marinofor US letter size paper; we do this not because we consider this size
9386d7f5d3SJohn Marino"better" than A4, but because we believe that the US letter version
9486d7f5d3SJohn Marinowill print better on A4 paper than the other way around. If you want a
9586d7f5d3SJohn Marinoversion formatted for A4, add the line @afourpaper near the start of
9686d7f5d3SJohn Marinocvs.texinfo and re-generate cvs.ps using TeX.
9786d7f5d3SJohn Marino
9886d7f5d3SJohn Marino-------------------------------------------------------------------------------
9986d7f5d3SJohn Marino
10086d7f5d3SJohn Marino* How do I get up-to-date information and information about other
10186d7f5d3SJohn Marinoversions of CVS?
10286d7f5d3SJohn Marino
10386d7f5d3SJohn MarinoSee also
10486d7f5d3SJohn Marino	http://cvs.nongnu.org
10586d7f5d3SJohn Marino	http://www.cvsnt.org
10686d7f5d3SJohn Marino
10786d7f5d3SJohn MarinoAnyone can add themselves to the following mailing lists:
10886d7f5d3SJohn Marino
10986d7f5d3SJohn Marino    bug-cvs:  This is the list which users are requested to send bug reports
11086d7f5d3SJohn Marino      to.  General CVS development and design discussions also tend to take
11186d7f5d3SJohn Marino      place on this list.
11286d7f5d3SJohn Marino    info-cvs:  This list is intended for user questions, including general
11386d7f5d3SJohn Marino      help requests.
11486d7f5d3SJohn Marino    cvs-announce:  CVS release announcements and other major
11586d7f5d3SJohn Marino      announcements about the project are sent to this list.
11686d7f5d3SJohn Marino    cvs-announce-binaries:  Announcements are made to this list
11786d7f5d3SJohn Marino      when binaries for various platforms are built and initially
11886d7f5d3SJohn Marino      posted for download.
11986d7f5d3SJohn Marino
12086d7f5d3SJohn MarinoTo subscribe to any of these lists, send mail to <list>-request@nongnu.org
12186d7f5d3SJohn Marinoor visit http://savannah.nongnu.org/mail/?group=cvs and follow the instructions
12286d7f5d3SJohn Marinofor the list you wish to subscribe to.
12386d7f5d3SJohn Marino
12486d7f5d3SJohn MarinoThe newsgroup for CVS (and other configuration management systems) is
12586d7f5d3SJohn Marinocomp.software.config-mgmt.  The gnu.cvs.help newsgroup is a 2-way mirror
12686d7f5d3SJohn Marinoof the info-cvs@nongnu.org mailing list and gnu.cvs.bug is similarly a 2-way
12786d7f5d3SJohn Marinomirror of bug-cvs@nongnu.org.
12886d7f5d3SJohn Marino
12986d7f5d3SJohn Marino-------------------------------------------------------------------------------
13086d7f5d3SJohn Marino
13186d7f5d3SJohn MarinoCredits:  See the AUTHORS file.
132