INSTALL revision 54427
1First, read the README file. If you're still happy... 2 3First you need to obtain and install the CVS executables. If you got 4a distribution which contains executables, consult the installation 5instructions for that distribution. If you got source code, do not 6panic. On many platforms building CVS from source code is a 7straightforward process requiring no programming knowledge. See the 8section BUILDING FROM SOURCE CODE at the end of this file, which 9includes a list of platforms which have been tested. 10 11------------------------------------------------------------------------------- 12 131) Take a look at the CVS documentation, if desired. For most 14 purposes you want doc/cvs.texinfo, also known as _Version Management 15 with CVS_ by Per Cederqvist et al. Looking at it might be as simple 16 as "info cvs" but this will depend on your installation; see README 17 for more details. 18 19 See what CVS can do for you, and if it fits your environment (or can 20 possibly be made to fit your environment). If things look good, 21 continue on. Alternately, just give CVS a try first then figure out 22 what it is good for. 23 242) Set the CVSROOT environment variable to where you want to put your 25 source repository. See the "Setting up the repository" section of 26 the Cederqvist manual for details, but the quick summary is just to 27 pick some directory. We'll use /src/master as an example. For 28 users of a POSIX shell (sh/bash/ksh) on unix, the following 29 commands can be placed in user's ~/.profile, ~/.bash_profile file; 30 or in the site-wide /etc/profile: 31 32 CVSROOT=/src/master; export CVSROOT 33 34 For C shell users on unix place the following commands in the 35 user's ~/.cshrc, ~/.login, or /etc/chsrc file: 36 37 setenv CVSROOT /src/master 38 39 For Windows users, supposing the repository will be in 40 d:\src\master, place the following line in c:\autoexec.bat. On 41 Windows 95, autoexec.bat might not already exist. In that case, 42 just create a new file containing the following line. 43 44 set CVSROOT=:local:d:\src\master 45 46 If these environment variables are not already set in your current 47 shell, set them now by typing the above line at the command prompt 48 (or source the login script you just edited). 49 The instructions for the remaining steps assume that you have set 50 the CVSROOT environment variable. 51 523) Create the master source repository. Again, the details are in 53 the "Setting up the repository" section of cvs.texinfo; the 54 one-line summary is: 55 56 $ cvs init 57 58 In this and subsequent examples we use "$" to indicate the command 59 prompt; do not type the "$". 60 614) It might be a good idea to jump right in and put some sources or 62 documents directly under CVS control. From within the top-level 63 directory of your source tree, run the following commands: 64 65 $ cvs import -m "test distribution" ccvs CVS_DIST CVS-TEST 66 67 (Those last three items are, respectively, a repository location, a 68 "vendor tag", and a "release tag". You don't need to understand 69 them yet, but read the section "Starting new projects" in the 70 Cederqvist manual for details). 71 725) Having done step 4, one should be able to checkout a fresh copy of the 73 sources you just imported and hack away at the sources with the 74 following command: 75 76 $ cd 77 $ cvs checkout ccvs 78 79 This will make the directory "ccvs" in your current directory and 80 populate it with the appropriate files and directories. 81 826) You may wish to customize the various administrative files, in particular 83 modules. See the Cederqvist manual for details. 84 857) Read the NEWS file to see what's new. 86 878) Hack away. 88 89------------------------------------------------------------------------------- 90 91BUILDING FROM SOURCE CODE 92 93Tested platforms 94 95CVS has been tested on the following platforms. The most recent 96version of CVS reported to have been tested is indicated, but more 97recent versions of CVS probably will work too. Please send updates to 98this list to bug-cvs@gnu.org (doing so in the form of a diff 99to this file, or at least exact suggested text, is encouraged). 100"tested" means, at a minimum, that CVS compiles and appears to work on 101simple (manual) testing. In many cases it also means "make check" 102and/or "make remotecheck" passes, but we don't try to list the 103platforms for which that is true. 104 105Alpha: 106 DEC Alpha running OSF/1 version 1.3 using cc (about 1.4A2) 107 DEC Alpha running OSF/1 version 2.0 (1.8) 108 DEC Alpha running OSF/1 version 2.1 (about 1.4A2) 109 DEC Alpha running OSF/1 version 3.0 (1.5.95) (footnote 7) 110 DEC Alpha running OSF/1 version 3.2 (1.9) 111 Alpha running alpha-dec-osf4.0 (1.10) 112 DEC Alpha running Digital UNIX v4.0C using gcc 2.7.2.2 (1.9.14) 113 DEC Alpha running VMS 6.2 (1.8.85 client-only) 114 Alpha running NetBSD 1.2E (1.10) 115Cray: 116 J90 (CVS 970215 snapshot) 117 T3E (CVS 970215 snapshot) 118HPPA: 119 HP 9000/710 running HP-UX 8.07A using gcc (about 1.4A2) 120 HPPA running HP-UX 9 (1.8) 121 HPPA 1.1 running HP-UX A.09.03 (1.5.95) (footnote 8) 122 HPPA 1.1 running HP-UX A.09.04 (1.7.1) 123 HPPA running HP-UX 9.05 (1.9) 124 HPPA running HP-UX 10.01 (1.7) 125 HPPA running HP-UX 10.20 (1.9, 1.9.14) 126 NextSTEP 3.3 (1.7) 127i386 family: 128 Solaris 2.4 using gcc (about 1.4A2) 129 Solaris 2.6 (1.9) 130 UnixWare v1.1.1 using gcc (about 1.4A2) 131 Unixware 2.1 (1.8.86) 132 Unixware 7 (1.9.29) 133 ISC 4.0.1 (1.8.87) 134 Linux (kernel 1.2.x) (1.8.86) 135 Linux (kernel 2.0.x, RedHat 4.2) (1.10) 136 Linux (kernel 2.0.x, RedHat 5.x) (1.10) 137 BSDI 2.0 (1.4.93) (footnote 5) 138 FreeBSD 2.1.5-stable (1.8.87) 139 NextSTEP 3.3 (1.7) 140 SCO Unix 3.2.4.2, gcc 2.7.2 (1.8.87) (footnote 4) 141 SCO OpenServer 5.0.5 (1.10.2) 142 Sequent DYNIX/ptx4.0 (1.10 or so) (remove -linet) 143 Sequent Dynix/PTX 4.1.4 (1.9.20 or so + patches) 144 Lynx 2.3.0 080695 (1.6.86) (footnote 9) 145 Windows NT 3.51 (1.8.86 client; 1.8.3 local) 146 Windows NT 3.51 service pack 4 (1.9) 147 Windows NT 3.51 service pack 5 (1.9) -- DOES NOT WORK (footnote 11) 148 Windows NT 4.0 (1.9 client and local) 149 Windows 95 (1.9 client and local) 150 QNX (1.9.1 + patches for strippath() and va_list) 151 OS/2 Version 3 using IBM C/C++ Tools 2.01 (1.8.86 + patches, client) 152 OS/2 Version 3 using EMX 0.9c (1.9.22, client) 153 OS/2 Version 3 using Watcom version ? (? - has this been tested?) 154m68k: 155 Sun 3 running SunOS 4.1.1_U1 w/ bundled K&R /usr/5bin/cc (1.8.86+) 156 NextSTEP 3.3p1 (1.8.87) 157 Lynx 2.3.0 062695 (1.6.86) (footnote 9) 158 NetBSD/mac68k (1.9.28) 159m88k: 160 Data General AViiON running dgux 5.4R2.10 (1.5) 161 Data General AViiON running dgux 5.4R3.10 (1.7.1) 162 Harris Nighthawk 5800 running CX/UX 7.1 (1.5) (footnote 6) 163MIPS: 164 DECstation running Ultrix 4.2a (1.4.90) 165 DECstation running Ultrix 4.3 (1.10) 166 SGI running Irix 4.0.5H using gcc and cc (about 1.4A2) (footnote 2) 167 SGI running Irix 5.3 (1.10) 168 SGI running Irix 6.2 using SGI MIPSpro 6.2 and beta 7.2 compilers (1.9) 169 SGI running Irix-6.2 (1.9.8) 170 SGI running IRIX 6.4 (1.10) 171 Siemens-Nixdorf RM600 running SINIX-Y (1.6) 172PowerPC or RS/6000: 173 IBM RS/6000 running AIX 3.1 using gcc and cc (1.6.86) 174 IBM RS/6000 running AIX 3.2.5 (1.8) 175 IBM RS/6000 running AIX 4.1 (1.9) 176 Lynx 2.3.1 120495 (1.6.86) (footnote 9) 177 Lynx 2.5 (1.9) (footnote 10) 178 MkLinux DR3 GENERIC #6 (1.10.5.1) (presumably LinuxPPC too) 179SPARC: 180 Sun SPARC running SunOS 4.1.x (1.10) 181 Sun SPARCstation 10 running Solaris 2.3 using gcc and cc (about 1.4A2) 182 Sun SPARCstation running Solaris 2.4 using gcc and cc (about 1.5.91) 183 Sun SPARC running Solaris 2.5 (1.8.87) 184 Sun SPARC running Solaris 2.5.1 using gcc 2.7.2.2 (1.9.14) 185 Sun UltraSPARC running Solaris 2.6 using gcc 2.8.1 (1.10) 186 NextSTEP 3.3 (1.7) 187 Sun SPARC running Linux 2.0.17, gcc 2.7.2 (1.8.87) 188VAX: 189 VAX running VMS 6.2 (1.9+patches, client-only) 190 (see README.VMS for information on necessary hacks). 191 192(footnote 2) 193 Some Irix 4.0 systems may core dump in malloc while running 194 CVS. We believe this is a bug in the Irix malloc. You can 195 workaround this bug by linking with "-lmalloc" if necessary. 196 (about 1.4A2). 197 198(footnote 4) Comment out the include of sys/time.h in src/server.c. (1.4.93) 199 You also may have to make sure TIME_WITH_SYS_TIME is undef'ed. 200 201(footnote 5) Change /usr/tmp to /var/tmp in src/server.c (2 places) (1.4.93). 202 (This should no longer be needed; CVS doesn't have /usr/tmp in 203 src/server.c any more. Has anyone tried a more recent version 204 on BSDI? If so, please report it so we can update this file). 205 206(footnote 6) Build in ucb universe with COFF compiler tools. Put 207 /usr/local/bin first in PATH while doing a configure, make 208 and install of GNU diffutils-2.7, rcs-5.7, then cvs-1.5. 209 210(footnote 7) Manoj Srivastava <srivasta@pilgrim.umass.edu> reports 211 success with this configure command: 212 CC=cc CFLAGS='-O2 -Olimit 2000 -std1' ./configure --verbose alpha-dec-osf 213 214(footnote 8) Manoj Srivastava <srivasta@pilgrim.umass.edu> reports 215 success with this configure command: 216 CC=cc CFLAGS='+O2 -Aa -D_HPUX_SOURCE' ./configure --verbose hppa1.1-hp-hpux 217 218(footnote 9) 219 Had to configure with ./configure --host=<arch>-lynx. 220 221 In src/cvs.h, protected the waitpid prototype with ifdef _POSIX_SOURCE. 222 (I might try building with gcc -mposix -D_POSIX_SOURCE.) 223 224 LynxOS has <dirent.h>, but you don't want to use it. 225 You want to use <sys/dir.h> instead. 226 So after running configure I had to undef HAVE_DIRENT_H and 227 define HAVE_SYS_DIR_H. 228 229(footnote 10) 230 Had to compile with "make LIBS=-lbsd" (to get gethostbyname 231 and getservbyname). 232 233(footnote 11) 234 when I do a `cvs init' I get this message: 235 ci: 'RCS/loginfo,v' is not a regular file 236 ci: RCS/loginfo,v: Invalid argument 237 cvs [init aborted]: failed to checkin n:/safe/CVSROOT/loginfo 238 239------------------------------------------------------------------------------- 240 241Building from source code under Unix: 242 2431) Run "configure": 244 245 $ ./configure 246 247 You can specify an alternate destination to override the default with 248 the --prefix option: 249 250 $ ./configure --prefix=/usr/local/gnu 251 252 or some path that is more appropriate for your site. The default prefix 253 value is "/usr/local", with binaries in sub-directory "bin", manual 254 pages in sub-directory "man", and libraries in sub-directory "lib". 255 256 A normal build of CVS will create an executable which supports 257 local, server, or client CVS (if you don't know the difference, 258 it is described in the Repository chapter of doc/cvs.texinfo). If 259 you do not intend to use client or server CVS, you may want to 260 prevent these features from being included in the executable you 261 build. You can do this with the --disable-client and 262 --disable-server options: 263 264 $ ./configure --disable-client --disable-server 265 266 Typically this can reduce the size of the executable by around 30%. 267 268 Unlike previous versions of CVS, you do not need to install RCS 269 or GNU diff. 270 271 NOTE: The configure program will cache the results of the previous 272 configure execution. If you need to re-run configure from scratch, you 273 may need to run "make distclean" first to remove the cached 274 configuration information. 275 276 If you are using gcc and are planning to modify CVS, you may want to 277 configure with -Wall; see the file HACKING for details. 278 279 If you have Kerberos 4 installed, you can specify the location of 280 the header files and libraries using the --with-krb4=DIR option. 281 DIR should be a directory with subdirectories include and lib 282 holding the Kerberos 4 header files and libraries, respectively. 283 The default value is /usr/kerberos. 284 285 If you want to enable support for encryption over Kerberos, use 286 the --enable-encryption option. This option is disabled by 287 default. 288 289 Try './configure --help' for further information on its usage. 290 291 NOTE ON CVS's USE OF NDBM: 292 293 By default, CVS uses some built-in ndbm emulation code to allow 294 CVS to work in a heterogeneous environment. However, if you have 295 a very large modules database, this may not work well. You will 296 need to edit src/options.h to turn off the MY_NDBM #define and 297 re-run configure. If you do this, the following comments apply. 298 If not, you may safely skip these comments. 299 300 If you configure CVS to use the real ndbm(3) libraries and 301 you do not have them installed in a "normal" place, you will 302 probably want to get the GNU version of ndbm (gdbm) and install 303 that before running the CVS configure script. Be aware that the 304 GDBM 1.5 release does NOT install the <ndbm.h> header file included 305 with the release automatically. You may have to install it by hand. 306 307 If you configure CVS to use the ndbm(3) libraries, you cannot 308 compile CVS with GNU cc (gcc) on Sun-4 SPARC systems. However, gcc 309 2.0 may have fixed this limitation if -fpcc-struct-return is 310 defined. When using gcc on other systems to compile CVS, you *may* 311 need to specify the -fpcc-struct-return option to gcc (you will 312 *know* you have to if "cvs checkout" core dumps in some ndbm 313 function). You can do this as follows: 314 315 $ CC='gcc -fpcc-struct-return' ./configure 316 317 for sh, bash, and ksh users and: 318 319 % setenv CC 'gcc -fpcc-struct-return' 320 % ./configure 321 322 for csh and tcsh users. 323 324 END OF NOTE FOR NDBM GUNK. 325 3262) Edit src/options.h. The defaults should be reasonable, and in fact 327 if you are lazy you can safely skip this step. 328 3293) Try to build it: 330 331 $ make 332 333 This will (hopefully) make the needed CVS binaries within the 334 "src" directory. If something fails for your system, and you want 335 to submit a bug report, you may wish to include your 336 "config.status" file, your host type, operating system and 337 compiler information, make output, and anything else you think 338 will be helpful. 339 3403a) Run the regression tests (optional). 341 342 You may also wish to validate the correctness of the new binary by 343 running the regression tests. If they succeed, that is nice to 344 know. However, if they fail, it doesn't tell you much. Often it 345 will just be a problem with running the tests on your machine, 346 rather than a problem with CVS. Unless you will have the time to 347 determine which of the two it is in case of failure, you might 348 want to save yourself the time and just not run the tests. 349 350 If you want to run the tests, see the file TESTS for more information. 351 3524) Install the binaries/documentation: 353 354 $ make install 355 356 Depending on your installation's configuration, you may need to be 357 root to do this. 358 359------------------------------------------------------------------------------- 360 361Detailed information about your interaction with "configure": 362 363The "configure" script and its interaction with its options and the 364environment is described here. For more detailed documentation about 365"configure", please refer to the GNU Autoconf documentation. 366 367Supported options are: 368 369 --srcdir=DIR Useful for compiling on many different 370 machines sharing one source tree. 371 --prefix=DIR The root of where to install the 372 various pieces of CVS (/usr/local). 373 --exec_prefix=DIR If you want executables in a 374 host-dependent place and shared 375 things in a host-independent place. 376 377The following environment variables override configure's default 378behaviour: 379 380 CC If not set, tries to use gcc first, 381 then cc. Also tries to use "-g -O" 382 as options, backing down to -g 383 alone if that doesn't work. 384 INSTALL If not set, tries to use "install", then 385 "./install-sh" as a final choice. 386 RANLIB If not set, tries to determine if "ranlib" 387 is available, choosing "echo" if it doesn't 388 appear to be. 389 YACC If not set, tries to determine if "bison" 390 is available, choosing "yacc" if it doesn't 391 appear to be. 392 393------------------------------------------------------------------------------- 394 395Building from source code under Windows NT/95: 396 397You may find interesting information in windows-NT/README. 398 3991) Using Microsoft Visual C++ 5.x, open the project `cvsnt.dsp', 400 in the top directory of the CVS distribution. If you have an older 401 version of Visual C++, take a look at windows-NT/README. 4022) Choose "Build cvs.exe" from the "Project" menu. 4033) MSVC will place the executable file cvs.exe in WinRel, or whatever 404 your target directory is. 405 406------------------------------------------------------------------------------- 407 408Building from source code under other platforms: 409 410For OS/2, see os2/README and emx/README. 411 412For VMS, see README.VMS 413 414For Macintosh, see macintosh/README.MacCVS 415 416For a Java client, see jCVS (which is a separate package from CVS 417itself, but which might be preferable to the Macintosh port mentioned 418above, for example). 419 420------------------------------------------------------------------------------- 421