git-cvsserver.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
   2     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
   6 <meta name="generator" content="AsciiDoc 8.2.5" />
   7 <style type="text/css">
   8 /* Debug borders */
   9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
  10 /*
  11   border: 1px solid red;
  12 */
  13 }
  14
  15 body {
  16   margin: 1em 5% 1em 5%;
  17 }
  18
  19 a {
  20   color: blue;
  21   text-decoration: underline;
  22 }
  23 a:visited {
  24   color: fuchsia;
  25 }
  26
  27 em {
  28   font-style: italic;
  29 }
  30
  31 strong {
  32   font-weight: bold;
  33 }
  34
  35 tt {
  36   color: navy;
  37 }
  38
  39 h1, h2, h3, h4, h5, h6 {
  40   color: #527bbd;
  41   font-family: sans-serif;
  42   margin-top: 1.2em;
  43   margin-bottom: 0.5em;
  44   line-height: 1.3;
  45 }
  46
  47 h1, h2, h3 {
  48   border-bottom: 2px solid silver;
  49 }
  50 h2 {
  51   padding-top: 0.5em;
  52 }
  53 h3 {
  54   float: left;
  55 }
  56 h3 + * {
  57   clear: left;
  58 }
  59
  60 div.sectionbody {
  61   font-family: serif;
  62   margin-left: 0;
  63 }
  64
  65 hr {
  66   border: 1px solid silver;
  67 }
  68
  69 p {
  70   margin-top: 0.5em;
  71   margin-bottom: 0.5em;
  72 }
  73
  74 pre {
  75   padding: 0;
  76   margin: 0;
  77 }
  78
  79 span#author {
  80   color: #527bbd;
  81   font-family: sans-serif;
  82   font-weight: bold;
  83   font-size: 1.1em;
  84 }
  85 span#email {
  86 }
  87 span#revision {
  88   font-family: sans-serif;
  89 }
  90
  91 div#footer {
  92   font-family: sans-serif;
  93   font-size: small;
  94   border-top: 2px solid silver;
  95   padding-top: 0.5em;
  96   margin-top: 4.0em;
  97 }
  98 div#footer-text {
  99   float: left;
 100   padding-bottom: 0.5em;
 101 }
 102 div#footer-badges {
 103   float: right;
 104   padding-bottom: 0.5em;
 105 }
 106
 107 div#preamble,
 108 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
 109 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 110 div.admonitionblock {
 111   margin-right: 10%;
 112   margin-top: 1.5em;
 113   margin-bottom: 1.5em;
 114 }
 115 div.admonitionblock {
 116   margin-top: 2.5em;
 117   margin-bottom: 2.5em;
 118 }
 119
 120 div.content { /* Block element content. */
 121   padding: 0;
 122 }
 123
 124 /* Block element titles. */
 125 div.title, caption.title {
 126   font-family: sans-serif;
 127   font-weight: bold;
 128   text-align: left;
 129   margin-top: 1.0em;
 130   margin-bottom: 0.5em;
 131 }
 132 div.title + * {
 133   margin-top: 0;
 134 }
 135
 136 td div.title:first-child {
 137   margin-top: 0.0em;
 138 }
 139 div.content div.title:first-child {
 140   margin-top: 0.0em;
 141 }
 142 div.content + div.title {
 143   margin-top: 0.0em;
 144 }
 145
 146 div.sidebarblock > div.content {
 147   background: #ffffee;
 148   border: 1px solid silver;
 149   padding: 0.5em;
 150 }
 151
 152 div.listingblock {
 153   margin-right: 0%;
 154 }
 155 div.listingblock > div.content {
 156   border: 1px solid silver;
 157   background: #f4f4f4;
 158   padding: 0.5em;
 159 }
 160
 161 div.quoteblock > div.content {
 162   padding-left: 2.0em;
 163 }
 164
 165 div.attribution {
 166   text-align: right;
 167 }
 168 div.verseblock + div.attribution {
 169   text-align: left;
 170 }
 171
 172 div.admonitionblock .icon {
 173   vertical-align: top;
 174   font-size: 1.1em;
 175   font-weight: bold;
 176   text-decoration: underline;
 177   color: #527bbd;
 178   padding-right: 0.5em;
 179 }
 180 div.admonitionblock td.content {
 181   padding-left: 0.5em;
 182   border-left: 2px solid silver;
 183 }
 184
 185 div.exampleblock > div.content {
 186   border-left: 2px solid silver;
 187   padding: 0.5em;
 188 }
 189
 190 div.verseblock div.content {
 191   white-space: pre;
 192 }
 193
 194 div.imageblock div.content { padding-left: 0; }
 195 div.imageblock img { border: 1px solid silver; }
 196 span.image img { border-style: none; }
 197
 198 dl {
 199   margin-top: 0.8em;
 200   margin-bottom: 0.8em;
 201 }
 202 dt {
 203   margin-top: 0.5em;
 204   margin-bottom: 0;
 205   font-style: italic;
 206 }
 207 dd > *:first-child {
 208   margin-top: 0;
 209 }
 210
 211 ul, ol {
 212     list-style-position: outside;
 213 }
 214 div.olist2 ol {
 215   list-style-type: lower-alpha;
 216 }
 217
 218 div.tableblock > table {
 219   border: 3px solid #527bbd;
 220 }
 221 thead {
 222   font-family: sans-serif;
 223   font-weight: bold;
 224 }
 225 tfoot {
 226   font-weight: bold;
 227 }
 228
 229 div.hlist {
 230   margin-top: 0.8em;
 231   margin-bottom: 0.8em;
 232 }
 233 div.hlist td {
 234   padding-bottom: 5px;
 235 }
 236 td.hlist1 {
 237   vertical-align: top;
 238   font-style: italic;
 239   padding-right: 0.8em;
 240 }
 241 td.hlist2 {
 242   vertical-align: top;
 243 }
 244
 245 @media print {
 246   div#footer-badges { display: none; }
 247 }
 248
 249 div#toctitle {
 250   color: #527bbd;
 251   font-family: sans-serif;
 252   font-size: 1.1em;
 253   font-weight: bold;
 254   margin-top: 1.0em;
 255   margin-bottom: 0.1em;
 256 }
 257
 258 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 259   margin-top: 0;
 260   margin-bottom: 0;
 261 }
 262 div.toclevel2 {
 263   margin-left: 2em;
 264   font-size: 0.9em;
 265 }
 266 div.toclevel3 {
 267   margin-left: 4em;
 268   font-size: 0.9em;
 269 }
 270 div.toclevel4 {
 271   margin-left: 6em;
 272   font-size: 0.9em;
 273 }
 274 include1::./stylesheets/xhtml11-manpage.css[]
 275 /* Workarounds for IE6's broken and incomplete CSS2. */
 276
 277 div.sidebar-content {
 278   background: #ffffee;
 279   border: 1px solid silver;
 280   padding: 0.5em;
 281 }
 282 div.sidebar-title, div.image-title {
 283   font-family: sans-serif;
 284   font-weight: bold;
 285   margin-top: 0.0em;
 286   margin-bottom: 0.5em;
 287 }
 288
 289 div.listingblock div.content {
 290   border: 1px solid silver;
 291   background: #f4f4f4;
 292   padding: 0.5em;
 293 }
 294
 295 div.quoteblock-content {
 296   padding-left: 2.0em;
 297 }
 298
 299 div.exampleblock-content {
 300   border-left: 2px solid silver;
 301   padding-left: 0.5em;
 302 }
 303
 304 /* IE6 sets dynamically generated links as visited. */
 305 div#toc a:visited { color: blue; }
 306 </style>
 307 <title>git-cvsserver(1)</title>
 308 </head>
 309 <body>
 310 <div id="header">
 311 <h1>
 312 git-cvsserver(1) Manual Page
 313 </h1>
 314 <h2>NAME</h2>
 315 <div class="sectionbody">
 316 <p>git-cvsserver -
 317    A CVS server emulator for git
 318 </p>
 319 </div>
 320 </div>
 321 <h2>SYNOPSIS</h2>
 322 <div class="sectionbody">
 323 <div class="para"><p>SSH:</p></div>
 324 <div class="verseblock">
 325 <div class="content">export CVS_SERVER="git cvsserver"
 326 <em>cvs</em> -d :ext:user@server/path/repo.git co &lt;HEAD_name&gt;</div></div>
 327 <div class="para"><p>pserver (/etc/inetd.conf):</p></div>
 328 <div class="verseblock">
 329 <div class="content">cvspserver stream tcp nowait nobody /usr/bin/git-cvsserver git-cvsserver pserver</div></div>
 330 <div class="para"><p>Usage:</p></div>
 331 <div class="verseblock">
 332 <div class="content"><em>git-cvsserver</em> [options] [pserver|server] [&lt;directory&gt; &#8230;]</div></div>
 333 </div>
 334 <h2 id="_options">OPTIONS</h2>
 335 <div class="sectionbody">
 336 <div class="para"><p>All these options obviously only make sense if enforced by the server side.
 337 They have been implemented to resemble the <a href="git-daemon.html">git-daemon(1)</a> options as
 338 closely as possible.</p></div>
 339 <div class="vlist"><dl>
 340 <dt>
 341 --base-path &lt;path&gt;
 342 </dt>
 343 <dd>
 344 <p>
 345 Prepend <em>path</em> to requested CVSROOT
 346 </p>
 347 </dd>
 348 <dt>
 349 --strict-paths
 350 </dt>
 351 <dd>
 352 <p>
 353 Don't allow recursing into subdirectories
 354 </p>
 355 </dd>
 356 <dt>
 357 --export-all
 358 </dt>
 359 <dd>
 360 <p>
 361 Don't check for <tt>gitcvs.enabled</tt> in config. You also have to specify a list
 362 of allowed directories (see below) if you want to use this option.
 363 </p>
 364 </dd>
 365 <dt>
 366 -V
 367 </dt>
 368 <dt>
 369 --version
 370 </dt>
 371 <dd>
 372 <p>
 373 Print version information and exit
 374 </p>
 375 </dd>
 376 <dt>
 377 -h
 378 </dt>
 379 <dt>
 380 -H
 381 </dt>
 382 <dt>
 383 --help
 384 </dt>
 385 <dd>
 386 <p>
 387 Print usage information and exit
 388 </p>
 389 </dd>
 390 <dt>
 391 &lt;directory&gt;
 392 </dt>
 393 <dd>
 394 <p>
 395 You can specify a list of allowed directories. If no directories
 396 are given, all are allowed. This is an additional restriction, gitcvs
 397 access still needs to be enabled by the <tt>gitcvs.enabled</tt> config option
 398 unless <em>--export-all</em> was given, too.
 399 </p>
 400 </dd>
 401 </dl></div>
 402 </div>
 403 <h2 id="_description">DESCRIPTION</h2>
 404 <div class="sectionbody">
 405 <div class="para"><p>This application is a CVS emulation layer for git.</p></div>
 406 <div class="para"><p>It is highly functional. However, not all methods are implemented,
 407 and for those methods that are implemented,
 408 not all switches are implemented.</p></div>
 409 <div class="para"><p>Testing has been done using both the CLI CVS client, and the Eclipse CVS
 410 plugin. Most functionality works fine with both of these clients.</p></div>
 411 </div>
 412 <h2 id="_limitations">LIMITATIONS</h2>
 413 <div class="sectionbody">
 414 <div class="para"><p>CVS clients cannot tag, branch or perform GIT merges.</p></div>
 415 <div class="para"><p><em>git-cvsserver</em> maps GIT branches to CVS modules. This is very different
 416 from what most CVS users would expect since in CVS modules usually represent
 417 one or more directories.</p></div>
 418 </div>
 419 <h2 id="_installation">INSTALLATION</h2>
 420 <div class="sectionbody">
 421 <div class="olist"><ol>
 422 <li>
 423 <p>
 424 If you are going to offer CVS access via pserver, add a line in
 425    /etc/inetd.conf like
 426 </p>
 427 <div class="listingblock">
 428 <div class="content">
 429 <pre><tt>   cvspserver stream tcp nowait nobody git-cvsserver pserver
 430 </tt></pre>
 431 </div></div>
 432 <div class="para"><p>Note: Some inetd servers let you specify the name of the executable
 433 independently of the value of argv[0] (i.e. the name the program assumes
 434 it was executed with). In this case the correct line in /etc/inetd.conf
 435 looks like</p></div>
 436 <div class="listingblock">
 437 <div class="content">
 438 <pre><tt>   cvspserver stream tcp nowait nobody /usr/bin/git-cvsserver git-cvsserver pserver
 439 </tt></pre>
 440 </div></div>
 441 <div class="para"><p>Only anonymous access is provided by pserve by default. To commit you
 442 will have to create pserver accounts, simply add a gitcvs.authdb
 443 setting in the config file of the repositories you want the cvsserver
 444 to allow writes to, for example:</p></div>
 445 <div class="listingblock">
 446 <div class="content">
 447 <pre><tt>
 448    [gitcvs]
 449         authdb = /etc/cvsserver/passwd
 450 </tt></pre>
 451 </div></div>
 452 <div class="para"><p>The format of these files is username followed by the crypted password,
 453 for example:</p></div>
 454 <div class="listingblock">
 455 <div class="content">
 456 <pre><tt>   myuser:$1Oyx5r9mdGZ2
 457    myuser:$1$BA)@$vbnMJMDym7tA32AamXrm./</tt></pre>
 458 </div></div>
 459 <div class="para"><p>You can use the <em>htpasswd</em> facility that comes with Apache to make these
 460 files, but Apache's MD5 crypt method differs from the one used by most C
 461 library's crypt() function, so don't use the -m option.</p></div>
 462 <div class="para"><p>Alternatively you can produce the password with perl's crypt() operator:</p></div>
 463 <div class="listingblock">
 464 <div class="content">
 465 <pre><tt>   perl -e 'my ($user, $pass) = @ARGV; printf "%s:%s\n", $user, crypt($user, $pass)' $USER password</tt></pre>
 466 </div></div>
 467 <div class="para"><p>Then provide your password via the pserver method, for example:</p></div>
 468 <div class="listingblock">
 469 <div class="content">
 470 <pre><tt>   cvs -d:pserver:someuser:somepassword &lt;at&gt; server/path/repo.git co &lt;HEAD_name&gt;</tt></pre>
 471 </div></div>
 472 <div class="para"><p>No special setup is needed for SSH access, other than having GIT tools
 473 in the PATH. If you have clients that do not accept the CVS_SERVER
 474 environment variable, you can rename <em>git-cvsserver</em> to <tt>cvs</tt>.</p></div>
 475 <div class="para"><p>Note: Newer CVS versions (&gt;= 1.12.11) also support specifying
 476 CVS_SERVER directly in CVSROOT like</p></div>
 477 <div class="listingblock">
 478 <div class="content">
 479 <pre><tt>cvs -d ":ext;CVS_SERVER=git cvsserver:user@server/path/repo.git" co &lt;HEAD_name&gt;</tt></pre>
 480 </div></div>
 481 <div class="para"><p>This has the advantage that it will be saved in your <em>CVS/Root</em> files and
 482 you don't need to worry about always setting the correct environment
 483 variable.  SSH users restricted to <em>git-shell</em> don't need to override the default
 484 with CVS_SERVER (and shouldn't) as <em>git-shell</em> understands <tt>cvs</tt> to mean
 485 <em>git-cvsserver</em> and pretends that the other end runs the real <em>cvs</em> better.</p></div>
 486 </li>
 487 <li>
 488 <p>
 489 For each repo that you want accessible from CVS you need to edit config in
 490    the repo and add the following section.
 491 </p>
 492 <div class="listingblock">
 493 <div class="content">
 494 <pre><tt>   [gitcvs]
 495         enabled=1
 496         # optional for debugging
 497         logfile=/path/to/logfile
 498 </tt></pre>
 499 </div></div>
 500 <div class="para"><p>Note: you need to ensure each user that is going to invoke <em>git-cvsserver</em> has
 501 write access to the log file and to the database (see
 502 <a href="#dbbackend">Database Backend</a>. If you want to offer write access over
 503 SSH, the users of course also need write access to the git repository itself.</p></div>
 504 <div class="para"><p>You also need to ensure that each repository is "bare" (without a git index
 505 file) for <tt>cvs commit</tt> to work. See <a href="gitcvs-migration.html">gitcvs-migration(7)</a>.</p></div>
 506 <div class="para" id="configaccessmethod"><p>All configuration variables can also be overridden for a specific method of
 507 access. Valid method names are "ext" (for SSH access) and "pserver". The
 508 following example configuration would disable pserver access while still
 509 allowing access over SSH.</p></div>
 510 <div class="listingblock">
 511 <div class="content">
 512 <pre><tt>   [gitcvs]
 513         enabled=0
 514
 515    [gitcvs "ext"]
 516         enabled=1</tt></pre>
 517 </div></div>
 518 </li>
 519 <li>
 520 <p>
 521 If you didn't specify the CVSROOT/CVS_SERVER directly in the checkout command,
 522    automatically saving it in your <em>CVS/Root</em> files, then you need to set them
 523    explicitly in your environment.  CVSROOT should be set as per normal, but the
 524    directory should point at the appropriate git repo.  As above, for SSH clients
 525    _not_ restricted to <em>git-shell</em>, CVS_SERVER should be set to <em>git-cvsserver</em>.
 526 </p>
 527 <div class="listingblock">
 528 <div class="content">
 529 <pre><tt>     export CVSROOT=:ext:user@server:/var/git/project.git
 530      export CVS_SERVER="git cvsserver"</tt></pre>
 531 </div></div>
 532 </li>
 533 <li>
 534 <p>
 535 For SSH clients that will make commits, make sure their server-side
 536    .ssh/environment files (or .bashrc, etc., according to their specific shell)
 537    export appropriate values for GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL,
 538    GIT_COMMITTER_NAME, and GIT_COMMITTER_EMAIL.  For SSH clients whose login
 539    shell is bash, .bashrc may be a reasonable alternative.
 540 </p>
 541 </li>
 542 <li>
 543 <p>
 544 Clients should now be able to check out the project. Use the CVS <em>module</em>
 545    name to indicate what GIT <em>head</em> you want to check out.  This also sets the
 546    name of your newly checked-out directory, unless you tell it otherwise with
 547    <tt>-d &lt;dir_name&gt;</tt>.  For example, this checks out <em>master</em> branch to the
 548    <tt>project-master</tt> directory:
 549 </p>
 550 <div class="listingblock">
 551 <div class="content">
 552 <pre><tt>     cvs co -d project-master master</tt></pre>
 553 </div></div>
 554 </li>
 555 </ol></div>
 556 </div>
 557 <h2 id="dbbackend">Database Backend</h2>
 558 <div class="sectionbody">
 559 <div class="para"><p><em>git-cvsserver</em> uses one database per git head (i.e. CVS module) to
 560 store information about the repository to maintain consistent
 561 CVS revision numbers. The database needs to be
 562 updated (i.e. written to) after every commit.</p></div>
 563 <div class="para"><p>If the commit is done directly by using <tt>git</tt> (as opposed to
 564 using <em>git-cvsserver</em>) the update will need to happen on the
 565 next repository access by <em>git-cvsserver</em>, independent of
 566 access method and requested operation.</p></div>
 567 <div class="para"><p>That means that even if you offer only read access (e.g. by using
 568 the pserver method), <em>git-cvsserver</em> should have write access to
 569 the database to work reliably (otherwise you need to make sure
 570 that the database is up-to-date any time <em>git-cvsserver</em> is executed).</p></div>
 571 <div class="para"><p>By default it uses SQLite databases in the git directory, named
 572 <tt>gitcvs.&lt;module_name&gt;.sqlite</tt>. Note that the SQLite backend creates
 573 temporary files in the same directory as the database file on
 574 write so it might not be enough to grant the users using
 575 <em>git-cvsserver</em> write access to the database file without granting
 576 them write access to the directory, too.</p></div>
 577 <div class="para"><p>The database can not be reliably regenerated in a
 578 consistent form after the branch it is tracking has changed.
 579 Example: For merged branches, <em>git-cvsserver</em> only tracks
 580 one branch of development, and after a <em>git merge</em> an
 581 incrementally updated database may track a different branch
 582 than a database regenerated from scratch, causing inconsistent
 583 CVS revision numbers. <tt>git-cvsserver</tt> has no way of knowing which
 584 branch it would have picked if it had been run incrementally
 585 pre-merge. So if you have to fully or partially (from old
 586 backup) regenerate the database, you should be suspicious
 587 of pre-existing CVS sandboxes.</p></div>
 588 <div class="para"><p>You can configure the database backend with the following
 589 configuration variables:</p></div>
 590 <h3 id="_configuring_database_backend">Configuring database backend</h3><div style="clear:left"></div>
 591 <div class="para"><p><em>git-cvsserver</em> uses the Perl DBI module. Please also read
 592 its documentation if changing these variables, especially
 593 about <tt>DBI-&gt;connect()</tt>.</p></div>
 594 <div class="vlist"><dl>
 595 <dt>
 596 gitcvs.dbname
 597 </dt>
 598 <dd>
 599 <p>
 600         Database name. The exact meaning depends on the
 601         selected database driver, for SQLite this is a filename.
 602         Supports variable substitution (see below). May
 603         not contain semicolons (<tt>;</tt>).
 604         Default: <em>%Ggitcvs.%m.sqlite</em>
 605 </p>
 606 </dd>
 607 <dt>
 608 gitcvs.dbdriver
 609 </dt>
 610 <dd>
 611 <p>
 612         Used DBI driver. You can specify any available driver
 613         for this here, but it might not work. cvsserver is tested
 614         with <em>DBD::SQLite</em>, reported to work with
 615         <em>DBD::Pg</em>, and reported <strong>not</strong> to work with <em>DBD::mysql</em>.
 616         Please regard this as an experimental feature. May not
 617         contain colons (<tt>:</tt>).
 618         Default: <em>SQLite</em>
 619 </p>
 620 </dd>
 621 <dt>
 622 gitcvs.dbuser
 623 </dt>
 624 <dd>
 625 <p>
 626         Database user. Only useful if setting <tt>dbdriver</tt>, since
 627         SQLite has no concept of database users. Supports variable
 628         substitution (see below).
 629 </p>
 630 </dd>
 631 <dt>
 632 gitcvs.dbpass
 633 </dt>
 634 <dd>
 635 <p>
 636         Database password.  Only useful if setting <tt>dbdriver</tt>, since
 637         SQLite has no concept of database passwords.
 638 </p>
 639 </dd>
 640 <dt>
 641 gitcvs.dbTableNamePrefix
 642 </dt>
 643 <dd>
 644 <p>
 645         Database table name prefix.  Supports variable substitution
 646         (see below).  Any non-alphabetic characters will be replaced
 647         with underscores.
 648 </p>
 649 </dd>
 650 </dl></div>
 651 <div class="para"><p>All variables can also be set per access method, see <a href="#configaccessmethod">above</a>.</p></div>
 652 <h4 id="_variable_substitution">Variable substitution</h4>
 653 <div class="para"><p>In <tt>dbdriver</tt> and <tt>dbuser</tt> you can use the following variables:</p></div>
 654 <div class="vlist"><dl>
 655 <dt>
 656 %G
 657 </dt>
 658 <dd>
 659 <p>
 660         git directory name
 661 </p>
 662 </dd>
 663 <dt>
 664 %g
 665 </dt>
 666 <dd>
 667 <p>
 668         git directory name, where all characters except for
 669         alpha-numeric ones, <tt>.</tt>, and <tt>-</tt> are replaced with
 670         <tt>_</tt> (this should make it easier to use the directory
 671         name in a filename if wanted)
 672 </p>
 673 </dd>
 674 <dt>
 675 %m
 676 </dt>
 677 <dd>
 678 <p>
 679         CVS module/git head name
 680 </p>
 681 </dd>
 682 <dt>
 683 %a
 684 </dt>
 685 <dd>
 686 <p>
 687         access method (one of "ext" or "pserver")
 688 </p>
 689 </dd>
 690 <dt>
 691 %u
 692 </dt>
 693 <dd>
 694 <p>
 695         Name of the user running <em>git-cvsserver</em>.
 696         If no name can be determined, the
 697         numeric uid is used.
 698 </p>
 699 </dd>
 700 </dl></div>
 701 </div>
 702 <h2 id="_environment">ENVIRONMENT</h2>
 703 <div class="sectionbody">
 704 <div class="para"><p>These variables obviate the need for command-line options in some
 705 circumstances, allowing easier restricted usage through git-shell.</p></div>
 706 <div class="para"><p>GIT_CVSSERVER_BASE_PATH takes the place of the argument to --base-path.</p></div>
 707 <div class="para"><p>GIT_CVSSERVER_ROOT specifies a single-directory whitelist. The
 708 repository must still be configured to allow access through
 709 git-cvsserver, as described above.</p></div>
 710 <div class="para"><p>When these environment variables are set, the corresponding
 711 command-line arguments may not be used.</p></div>
 712 </div>
 713 <h2 id="_eclipse_cvs_client_notes">Eclipse CVS Client Notes</h2>
 714 <div class="sectionbody">
 715 <div class="para"><p>To get a checkout with the Eclipse CVS client:</p></div>
 716 <div class="olist"><ol>
 717 <li>
 718 <p>
 719 Select "Create a new project -&gt; From CVS checkout"
 720 </p>
 721 </li>
 722 <li>
 723 <p>
 724 Create a new location. See the notes below for details on how to choose the
 725    right protocol.
 726 </p>
 727 </li>
 728 <li>
 729 <p>
 730 Browse the <em>modules</em> available. It will give you a list of the heads in
 731    the repository. You will not be able to browse the tree from there. Only
 732    the heads.
 733 </p>
 734 </li>
 735 <li>
 736 <p>
 737 Pick <em>HEAD</em> when it asks what branch/tag to check out. Untick the
 738    "launch commit wizard" to avoid committing the .project file.
 739 </p>
 740 </li>
 741 </ol></div>
 742 <div class="para"><p>Protocol notes: If you are using anonymous access via pserver, just select that.
 743 Those using SSH access should choose the <em>ext</em> protocol, and configure <em>ext</em>
 744 access on the Preferences-&gt;Team-&gt;CVS-&gt;ExtConnection pane. Set CVS_SERVER to
 745 "<tt>git cvsserver</tt>". Note that password support is not good when using <em>ext</em>,
 746 you will definitely want to have SSH keys setup.</p></div>
 747 <div class="para"><p>Alternatively, you can just use the non-standard extssh protocol that Eclipse
 748 offer. In that case CVS_SERVER is ignored, and you will have to replace
 749 the cvs utility on the server with <em>git-cvsserver</em> or manipulate your <tt>.bashrc</tt>
 750 so that calling <em>cvs</em> effectively calls <em>git-cvsserver</em>.</p></div>
 751 </div>
 752 <h2 id="_clients_known_to_work">Clients known to work</h2>
 753 <div class="sectionbody">
 754 <div class="ilist"><ul>
 755 <li>
 756 <p>
 757 CVS 1.12.9 on Debian
 758 </p>
 759 </li>
 760 <li>
 761 <p>
 762 CVS 1.11.17 on MacOSX (from Fink package)
 763 </p>
 764 </li>
 765 <li>
 766 <p>
 767 Eclipse 3.0, 3.1.2 on MacOSX (see Eclipse CVS Client Notes)
 768 </p>
 769 </li>
 770 <li>
 771 <p>
 772 TortoiseCVS
 773 </p>
 774 </li>
 775 </ul></div>
 776 </div>
 777 <h2 id="_operations_supported">Operations supported</h2>
 778 <div class="sectionbody">
 779 <div class="para"><p>All the operations required for normal use are supported, including
 780 checkout, diff, status, update, log, add, remove, commit.
 781 Legacy monitoring operations are not supported (edit, watch and related).
 782 Exports and tagging (tags and branches) are not supported at this stage.</p></div>
 783 <h3 id="_crlf_line_ending_conversions">CRLF Line Ending Conversions</h3><div style="clear:left"></div>
 784 <div class="para"><p>By default the server leaves the <em>-k</em> mode blank for all files,
 785 which causes the CVS client to treat them as a text files, subject
 786 to end-of-line conversion on some platforms.</p></div>
 787 <div class="para"><p>You can make the server use the end-of-line conversion attributes to
 788 set the <em>-k</em> modes for files by setting the <tt>gitcvs.usecrlfattr</tt>
 789 config variable.  See <a href="gitattributes.html">gitattributes(5)</a> for more information
 790 about end-of-line conversion.</p></div>
 791 <div class="para"><p>Alternatively, if <tt>gitcvs.usecrlfattr</tt> config is not enabled
 792 or the attributes do not allow automatic detection for a filename, then
 793 the server uses the <tt>gitcvs.allbinary</tt> config for the default setting.
 794 If <tt>gitcvs.allbinary</tt> is set, then file not otherwise
 795 specified will default to <em>-kb</em> mode. Otherwise the <em>-k</em> mode
 796 is left blank. But if <tt>gitcvs.allbinary</tt> is set to "guess", then
 797 the correct <em>-k</em> mode will be guessed based on the contents of
 798 the file.</p></div>
 799 <div class="para"><p>For best consistency with <em>cvs</em>, it is probably best to override the
 800 defaults by setting <tt>gitcvs.usecrlfattr</tt> to true,
 801 and <tt>gitcvs.allbinary</tt> to "guess".</p></div>
 802 </div>
 803 <h2 id="_dependencies">Dependencies</h2>
 804 <div class="sectionbody">
 805 <div class="para"><p><em>git-cvsserver</em> depends on DBD::SQLite.</p></div>
 806 </div>
 807 <h2 id="_copyright_and_authors">Copyright and Authors</h2>
 808 <div class="sectionbody">
 809 <div class="para"><p>This program is copyright The Open University UK - 2006.</p></div>
 810 <div class="para"><p>Authors:</p></div>
 811 <div class="ilist"><ul>
 812 <li>
 813 <p>
 814 Martyn Smith    &lt;martyn@catalyst.net.nz&gt;
 815 </p>
 816 </li>
 817 <li>
 818 <p>
 819 Martin Langhoff &lt;martin@catalyst.net.nz&gt;
 820 </p>
 821 </li>
 822 </ul></div>
 823 <div class="para"><p>with ideas and patches from participants of the git-list &lt;git@vger.kernel.org&gt;.</p></div>
 824 </div>
 825 <h2 id="_documentation">Documentation</h2>
 826 <div class="sectionbody">
 827 <div class="para"><p>Documentation by Martyn Smith &lt;martyn@catalyst.net.nz&gt;, Martin Langhoff &lt;martin@catalyst.net.nz&gt;, and Matthias Urlichs &lt;smurf@smurf.noris.de&gt;.</p></div>
 828 </div>
 829 <h2 id="_git">GIT</h2>
 830 <div class="sectionbody">
 831 <div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
 832 </div>
 833 <div id="footer">
 834 <div id="footer-text">
 835 Last updated 2010-09-03 21:30:13 UTC
 836 </div>
 837 </div>
 838 </body>
 839 </html>