| blob | 7b23128e5f7084a2695655546ae1f905a6a62734 |
4 <head>
9 /* Debug borders */
11 /*
12 border: 1px solid red;
13 */
14 }
16 body {
18 }
20 a {
23 }
26 }
28 em {
31 }
33 strong {
36 }
38 tt {
40 }
48 }
52 }
53 h2 {
55 }
56 h3 {
58 }
59 h3 + * {
61 }
66 }
68 hr {
70 }
72 p {
75 }
79 }
81 pre {
84 }
86 span#author {
91 }
92 span#email {
93 }
96 }
98 div#footer {
104 }
105 div#footer-text {
108 }
109 div#footer-badges {
112 }
114 div#preamble {
117 }
123 }
127 }
131 }
133 /* Block element titles. */
141 }
144 }
148 }
151 }
154 }
160 }
166 }
171 }
175 }
180 }
183 }
187 }
188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
191 }
200 }
204 }
209 }
215 dl {
218 }
219 dt {
224 }
227 }
231 }
234 }
237 }
240 }
243 }
246 }
253 }
257 }
258 thead {
261 }
262 tfoot {
264 }
267 }
270 }
271 /* Because the table frame attribute is overriden by CSS in most browsers. */
274 }
278 }
282 }
288 }
291 }
294 }
300 }
303 }
307 }
311 }
315 }
317 div#toctitle {
324 }
329 }
333 }
337 }
341 }
342 /* Overrides for manpage documents */
343 h1 {
348 }
349 h2 {
351 }
354 }
358 }
360 /* Workarounds for IE6's broken and incomplete CSS2. */
366 }
373 }
379 }
384 }
388 }
392 }
397 }
399 /* IE6 sets dynamically generated links as visited. */
401 </style>
402 </head>
403 <body>
405 <h1>
406 git-cvsserver(1) Manual Page
407 </h1>
410 <p>git-cvsserver -
411 A CVS server emulator for git
412 </p>
413 </div>
414 </div>
422 </div></div>
425 <div class="verseblock-content">cvspserver stream tcp nowait nobody /usr/bin/git-cvsserver git-cvsserver pserver</div>
427 </div></div>
430 <div class="verseblock-content"><em>git-cvsserver</em> [options] [pserver|server] [<directory> …]</div>
432 </div></div>
433 </div>
436 <div class="paragraph"><p>All these options obviously only make sense if enforced by the server side.
437 They have been implemented to resemble the <a href="git-daemon.html">git-daemon(1)</a> options as
438 closely as possible.</p></div>
442 </dt>
443 <dd>
444 <p>
446 </p>
447 </dd>
449 --strict-paths
450 </dt>
451 <dd>
452 <p>
453 Don’t allow recursing into subdirectories
454 </p>
455 </dd>
457 --export-all
458 </dt>
459 <dd>
460 <p>
462 of allowed directories (see below) if you want to use this option.
463 </p>
464 </dd>
466 -V
467 </dt>
469 --version
470 </dt>
471 <dd>
472 <p>
473 Print version information and exit
474 </p>
475 </dd>
477 -h
478 </dt>
480 -H
481 </dt>
483 --help
484 </dt>
485 <dd>
486 <p>
487 Print usage information and exit
488 </p>
489 </dd>
492 </dt>
493 <dd>
494 <p>
495 You can specify a list of allowed directories. If no directories
496 are given, all are allowed. This is an additional restriction, gitcvs
499 </p>
500 </dd>
501 </dl></div>
502 </div>
507 and for those methods that are implemented,
508 not all switches are implemented.</p></div>
509 <div class="paragraph"><p>Testing has been done using both the CLI CVS client, and the Eclipse CVS
510 plugin. Most functionality works fine with both of these clients.</p></div>
511 </div>
515 <div class="paragraph"><p><em>git-cvsserver</em> maps GIT branches to CVS modules. This is very different
516 from what most CVS users would expect since in CVS modules usually represent
517 one or more directories.</p></div>
518 </div>
522 <li>
523 <p>
524 If you are going to offer CVS access via pserver, add a line in
525 /etc/inetd.conf like
526 </p>
530 </div></div>
532 independently of the value of argv[0] (i.e. the name the program assumes
533 it was executed with). In this case the correct line in /etc/inetd.conf
534 looks like</p></div>
537 <pre><tt> cvspserver stream tcp nowait nobody /usr/bin/git-cvsserver git-cvsserver pserver</tt></pre>
538 </div></div>
540 will have to create pserver accounts, simply add a gitcvs.authdb
541 setting in the config file of the repositories you want the cvsserver
542 to allow writes to, for example:</p></div>
545 <pre><tt> [gitcvs]
546 authdb = /etc/cvsserver/passwd</tt></pre>
547 </div></div>
548 <div class="paragraph"><p>The format of these files is username followed by the crypted password,
549 for example:</p></div>
554 </div></div>
555 <div class="paragraph"><p>You can use the <em>htpasswd</em> facility that comes with Apache to make these
556 files, but Apache’s MD5 crypt method differs from the one used by most C
558 <div class="paragraph"><p>Alternatively you can produce the password with perl’s crypt() operator:</p></div>
561 <pre><tt> perl -e 'my ($user, $pass) = @ARGV; printf "%s:%s\n", $user, crypt($user, $pass)' $USER password</tt></pre>
562 </div></div>
563 <div class="paragraph"><p>Then provide your password via the pserver method, for example:</p></div>
566 <pre><tt> cvs -d:pserver:someuser:somepassword <at> server/path/repo.git co <HEAD_name></tt></pre>
567 </div></div>
568 <div class="paragraph"><p>No special setup is needed for SSH access, other than having GIT tools
569 in the PATH. If you have clients that do not accept the CVS_SERVER
572 CVS_SERVER directly in CVSROOT like</p></div>
575 <pre><tt>cvs -d ":ext;CVS_SERVER=git cvsserver:user@server/path/repo.git" co <HEAD_name></tt></pre>
576 </div></div>
577 <div class="paragraph"><p>This has the advantage that it will be saved in your <em>CVS/Root</em> files and
578 you don’t need to worry about always setting the correct environment
581 <em>git-cvsserver</em> and pretends that the other end runs the real <em>cvs</em> better.</p></div>
582 </li>
583 <li>
584 <p>
585 For each repo that you want accessible from CVS you need to edit config in
586 the repo and add the following section.
587 </p>
590 <pre><tt> [gitcvs]
591 enabled=1
592 # optional for debugging
593 logfile=/path/to/logfile</tt></pre>
594 </div></div>
595 <div class="paragraph"><p>Note: you need to ensure each user that is going to invoke <em>git-cvsserver</em> has
596 write access to the log file and to the database (see
598 SSH, the users of course also need write access to the git repository itself.</p></div>
599 <div class="paragraph"><p>You also need to ensure that each repository is "bare" (without a git index
600 file) for <tt>cvs commit</tt> to work. See <a href="gitcvs-migration.html">gitcvs-migration(7)</a>.</p></div>
601 <div class="paragraph" id="configaccessmethod"><p>All configuration variables can also be overridden for a specific method of
603 following example configuration would disable pserver access while still
604 allowing access over SSH.</p></div>
607 <pre><tt> [gitcvs]
608 enabled=0
610 [gitcvs "ext"]
612 </div></div>
613 </li>
614 <li>
615 <p>
616 If you didn’t specify the CVSROOT/CVS_SERVER directly in the checkout command,
618 explicitly in your environment. CVSROOT should be set as per normal, but the
619 directory should point at the appropriate git repo. As above, for SSH clients
620 <em>not</em> restricted to <em>git-shell</em>, CVS_SERVER should be set to <em>git-cvsserver</em>.
621 </p>
624 <pre><tt> export CVSROOT=:ext:user@server:/var/git/project.git
626 </div></div>
627 </li>
628 <li>
629 <p>
630 For SSH clients that will make commits, make sure their server-side
631 .ssh/environment files (or .bashrc, etc., according to their specific shell)
632 export appropriate values for GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL,
633 GIT_COMMITTER_NAME, and GIT_COMMITTER_EMAIL. For SSH clients whose login
634 shell is bash, .bashrc may be a reasonable alternative.
635 </p>
636 </li>
637 <li>
638 <p>
641 name of your newly checked-out directory, unless you tell it otherwise with
644 </p>
648 </div></div>
649 </li>
650 </ol></div>
651 </div>
654 <div class="paragraph"><p><em>git-cvsserver</em> uses one database per git head (i.e. CVS module) to
655 store information about the repository to maintain consistent
656 CVS revision numbers. The database needs to be
657 updated (i.e. written to) after every commit.</p></div>
661 access method and requested operation.</p></div>
664 the database to work reliably (otherwise you need to make sure
668 temporary files in the same directory as the database file on
669 write so it might not be enough to grant the users using
671 them write access to the directory, too.</p></div>
673 consistent form after the branch it is tracking has changed.
676 incrementally updated database may track a different branch
677 than a database regenerated from scratch, causing inconsistent
679 branch it would have picked if it had been run incrementally
680 pre-merge. So if you have to fully or partially (from old
681 backup) regenerate the database, you should be suspicious
682 of pre-existing CVS sandboxes.</p></div>
684 configuration variables:</p></div>
685 <h3 id="_configuring_database_backend">Configuring database backend</h3><div style="clear:left"></div>
687 its documentation if changing these variables, especially
691 gitcvs.dbname
692 </dt>
693 <dd>
694 <p>
695 Database name. The exact meaning depends on the
696 selected database driver, for SQLite this is a filename.
697 Supports variable substitution (see below). May
700 </p>
701 </dd>
703 gitcvs.dbdriver
704 </dt>
705 <dd>
706 <p>
707 Used DBI driver. You can specify any available driver
708 for this here, but it might not work. cvsserver is tested
711 Please regard this as an experimental feature. May not
714 </p>
715 </dd>
717 gitcvs.dbuser
718 </dt>
719 <dd>
720 <p>
722 SQLite has no concept of database users. Supports variable
723 substitution (see below).
724 </p>
725 </dd>
727 gitcvs.dbpass
728 </dt>
729 <dd>
730 <p>
732 SQLite has no concept of database passwords.
733 </p>
734 </dd>
736 gitcvs.dbTableNamePrefix
737 </dt>
738 <dd>
739 <p>
740 Database table name prefix. Supports variable substitution
741 (see below). Any non-alphabetic characters will be replaced
742 with underscores.
743 </p>
744 </dd>
745 </dl></div>
746 <div class="paragraph"><p>All variables can also be set per access method, see <a href="#configaccessmethod">above</a>.</p></div>
748 <div class="paragraph"><p>In <tt>dbdriver</tt> and <tt>dbuser</tt> you can use the following variables:</p></div>
751 %G
752 </dt>
753 <dd>
754 <p>
755 git directory name
756 </p>
757 </dd>
759 %g
760 </dt>
761 <dd>
762 <p>
763 git directory name, where all characters except for
766 name in a filename if wanted)
767 </p>
768 </dd>
770 %m
771 </dt>
772 <dd>
773 <p>
774 CVS module/git head name
775 </p>
776 </dd>
778 %a
779 </dt>
780 <dd>
781 <p>
783 </p>
784 </dd>
786 %u
787 </dt>
788 <dd>
789 <p>
791 If no name can be determined, the
792 numeric uid is used.
793 </p>
794 </dd>
795 </dl></div>
796 </div>
800 circumstances, allowing easier restricted usage through git-shell.</p></div>
801 <div class="paragraph"><p>GIT_CVSSERVER_BASE_PATH takes the place of the argument to --base-path.</p></div>
803 repository must still be configured to allow access through
804 git-cvsserver, as described above.</p></div>
806 command-line arguments may not be used.</p></div>
807 </div>
812 <li>
813 <p>
814 Select "Create a new project → From CVS checkout"
815 </p>
816 </li>
817 <li>
818 <p>
819 Create a new location. See the notes below for details on how to choose the
820 right protocol.
821 </p>
822 </li>
823 <li>
824 <p>
826 the repository. You will not be able to browse the tree from there. Only
827 the heads.
828 </p>
829 </li>
830 <li>
831 <p>
833 "launch commit wizard" to avoid committing the .project file.
834 </p>
835 </li>
836 </ol></div>
837 <div class="paragraph"><p>Protocol notes: If you are using anonymous access via pserver, just select that.
841 you will definitely want to have SSH keys setup.</p></div>
842 <div class="paragraph"><p>Alternatively, you can just use the non-standard extssh protocol that Eclipse
843 offer. In that case CVS_SERVER is ignored, and you will have to replace
846 </div>
850 <li>
851 <p>
852 CVS 1.12.9 on Debian
853 </p>
854 </li>
855 <li>
856 <p>
857 CVS 1.11.17 on MacOSX (from Fink package)
858 </p>
859 </li>
860 <li>
861 <p>
863 </p>
864 </li>
865 <li>
866 <p>
867 TortoiseCVS
868 </p>
869 </li>
870 </ul></div>
871 </div>
875 checkout, diff, status, update, log, add, remove, commit.
876 Legacy monitoring operations are not supported (edit, watch and related).
877 Exports and tagging (tags and branches) are not supported at this stage.</p></div>
878 <h3 id="_crlf_line_ending_conversions">CRLF Line Ending Conversions</h3><div style="clear:left"></div>
879 <div class="paragraph"><p>By default the server leaves the <em>-k</em> mode blank for all files,
880 which causes the CVS client to treat them as a text files, subject
881 to end-of-line conversion on some platforms.</p></div>
885 about end-of-line conversion.</p></div>
887 or the attributes do not allow automatic detection for a filename, then
893 the file.</p></div>
894 <div class="paragraph"><p>For best consistency with <em>cvs</em>, it is probably best to override the
897 </div>
901 </div>
907 <li>
908 <p>
910 </p>
911 </li>
912 <li>
913 <p>
915 </p>
916 </li>
917 </ul></div>
918 <div class="paragraph"><p>with ideas and patches from participants of the git-list <<a href="mailto:git@vger.kernel.org">git@vger.kernel.org</a>>.</p></div>
919 </div>
922 <div class="paragraph"><p>Documentation by Martyn Smith <<a href="mailto:martyn@catalyst.net.nz">martyn@catalyst.net.nz</a>>, Martin Langhoff <<a href="mailto:martin@laptop.org">martin@laptop.org</a>>, and Matthias Urlichs <<a href="mailto:smurf@smurf.noris.de">smurf@smurf.noris.de</a>>.</p></div>
923 </div>
927 </div>
931 </div>
932 </div>
933 </body>
934 </html>