doc/source/en/TortoiseGit/git_doc/git-cvsserver.xml

   1 <?xml version="1.0" encoding="UTF-8"?>\r
   2 <!DOCTYPE sect2 SYSTEM "../../../dtd/dblite.dtd">\r
   3 \r
   4 <sect2 lang="en" id="git-cvsserver(1)">\r
   5     <title>git-cvsserver(1)</title>\r
   6 <indexterm>\r
   7 <primary>git-cvsserver(1)</primary>\r
   8 </indexterm>\r
   9 <simplesect id="git-cvsserver(1)__name">\r
  10 <title>NAME</title>\r
  11 <simpara>git-cvsserver - A CVS server emulator for Git</simpara>\r
  12 </simplesect>\r
  13 <simplesect id="git-cvsserver(1)__synopsis">\r
  14 <title>SYNOPSIS</title>\r
  15 <simpara>SSH:</simpara>\r
  16 <blockquote>\r
  17 <literallayout>export CVS_SERVER="git cvsserver"\r
  18 <emphasis>cvs</emphasis> -d :ext:user@server/path/repo.git co &lt;HEAD_name&gt;</literallayout>\r
  19 </blockquote>\r
  20 <simpara>pserver (/etc/inetd.conf):</simpara>\r
  21 <blockquote>\r
  22 <literallayout>cvspserver stream tcp nowait nobody /usr/bin/git-cvsserver git-cvsserver pserver</literallayout>\r
  23 </blockquote>\r
  24 <simpara>Usage:</simpara>\r
  25 <blockquote>\r
  26 <literallayout><emphasis>git-cvsserver</emphasis> [&lt;options&gt;] [pserver|server] [&lt;directory&gt; &#8230;]</literallayout>\r
  27 </blockquote>\r
  28 </simplesect>\r
  29 <simplesect id="git-cvsserver(1)__options">\r
  30 <title>OPTIONS</title>\r
  31 <simpara>All these options obviously only make sense if enforced by the server side.\r
  32 They have been implemented to resemble the <xref linkend="git-daemon(1)" /> options as\r
  33 closely as possible.</simpara>\r
  34 <variablelist>\r
  35 <varlistentry>\r
  36 <term>\r
  37 --base-path &lt;path&gt;\r
  38 </term>\r
  39 <listitem>\r
  40 <simpara>\r
  41 Prepend <emphasis>path</emphasis> to requested CVSROOT\r
  42 </simpara>\r
  43 </listitem>\r
  44 </varlistentry>\r
  45 <varlistentry>\r
  46 <term>\r
  47 --strict-paths\r
  48 </term>\r
  49 <listitem>\r
  50 <simpara>\r
  51 Don't allow recursing into subdirectories\r
  52 </simpara>\r
  53 </listitem>\r
  54 </varlistentry>\r
  55 <varlistentry>\r
  56 <term>\r
  57 --export-all\r
  58 </term>\r
  59 <listitem>\r
  60 <simpara>\r
  61 Don't check for <emphasis>gitcvs.enabled</emphasis> in config. You also have to specify a list\r
  62 of allowed directories (see below) if you want to use this option.\r
  63 </simpara>\r
  64 </listitem>\r
  65 </varlistentry>\r
  66 <varlistentry>\r
  67 <term>\r
  68 -V\r
  69 </term>\r
  70 <term>\r
  71 --version\r
  72 </term>\r
  73 <listitem>\r
  74 <simpara>\r
  75 Print version information and exit\r
  76 </simpara>\r
  77 </listitem>\r
  78 </varlistentry>\r
  79 <varlistentry>\r
  80 <term>\r
  81 -h\r
  82 </term>\r
  83 <term>\r
  84 -H\r
  85 </term>\r
  86 <term>\r
  87 --help\r
  88 </term>\r
  89 <listitem>\r
  90 <simpara>\r
  91 Print usage information and exit\r
  92 </simpara>\r
  93 </listitem>\r
  94 </varlistentry>\r
  95 <varlistentry>\r
  96 <term>\r
  97 &lt;directory&gt;\r
  98 </term>\r
  99 <listitem>\r
 100 <simpara>\r
 101 You can specify a list of allowed directories. If no directories\r
 102 are given, all are allowed. This is an additional restriction, gitcvs\r
 103 access still needs to be enabled by the <emphasis>gitcvs.enabled</emphasis> config option\r
 104 unless <emphasis>--export-all</emphasis> was given, too.\r
 105 </simpara>\r
 106 </listitem>\r
 107 </varlistentry>\r
 108 </variablelist>\r
 109 </simplesect>\r
 110 <simplesect id="git-cvsserver(1)__description">\r
 111 <title>DESCRIPTION</title>\r
 112 <simpara>This application is a CVS emulation layer for Git.</simpara>\r
 113 <simpara>It is highly functional. However, not all methods are implemented,\r
 114 and for those methods that are implemented,\r
 115 not all switches are implemented.</simpara>\r
 116 <simpara>Testing has been done using both the CLI CVS client, and the Eclipse CVS\r
 117 plugin. Most functionality works fine with both of these clients.</simpara>\r
 118 </simplesect>\r
 119 <simplesect id="git-cvsserver(1)__limitations">\r
 120 <title>LIMITATIONS</title>\r
 121 <simpara>CVS clients cannot tag, branch or perform Git merges.</simpara>\r
 122 <simpara><emphasis>git-cvsserver</emphasis> maps Git branches to CVS modules. This is very different\r
 123 from what most CVS users would expect since in CVS modules usually represent\r
 124 one or more directories.</simpara>\r
 125 </simplesect>\r
 126 <simplesect id="git-cvsserver(1)__installation">\r
 127 <title>INSTALLATION</title>\r
 128 <orderedlist numeration="arabic">\r
 129 <listitem>\r
 130 <simpara>\r
 131 If you are going to offer CVS access via pserver, add a line in\r
 132    /etc/inetd.conf like\r
 133 </simpara>\r
 134 <screen>   cvspserver stream tcp nowait nobody git-cvsserver pserver</screen>\r
 135 <simpara>Note: Some inetd servers let you specify the name of the executable\r
 136 independently of the value of argv[0] (i.e. the name the program assumes\r
 137 it was executed with). In this case the correct line in /etc/inetd.conf\r
 138 looks like</simpara>\r
 139 <screen>   cvspserver stream tcp nowait nobody /usr/bin/git-cvsserver git-cvsserver pserver</screen>\r
 140 <simpara>Only anonymous access is provided by pserve by default. To commit you\r
 141 will have to create pserver accounts, simply add a gitcvs.authdb\r
 142 setting in the config file of the repositories you want the cvsserver\r
 143 to allow writes to, for example:</simpara>\r
 144 <screen>   [gitcvs]\r
 145         authdb = /etc/cvsserver/passwd</screen>\r
 146 <simpara>The format of these files is username followed by the encrypted password,\r
 147 for example:</simpara>\r
 148 <screen>   myuser:$1Oyx5r9mdGZ2\r
 149    myuser:$1$BA)@$vbnMJMDym7tA32AamXrm./</screen>\r
 150 <simpara>You can use the <emphasis>htpasswd</emphasis> facility that comes with Apache to make these\r
 151 files, but Apache's MD5 crypt method differs from the one used by most C\r
 152 library's crypt() function, so don't use the -m option.</simpara>\r
 153 <simpara>Alternatively you can produce the password with perl's crypt() operator:</simpara>\r
 154 <screen>   perl -e 'my ($user, $pass) = @ARGV; printf "%s:%s\n", $user, crypt($user, $pass)' $USER password</screen>\r
 155 <simpara>Then provide your password via the pserver method, for example:</simpara>\r
 156 <screen>   cvs -d:pserver:someuser:somepassword &lt;at&gt; server/path/repo.git co &lt;HEAD_name&gt;</screen>\r
 157 <simpara>No special setup is needed for SSH access, other than having Git tools\r
 158 in the PATH. If you have clients that do not accept the CVS_SERVER\r
 159 environment variable, you can rename <emphasis>git-cvsserver</emphasis> to <emphasis>cvs</emphasis>.</simpara>\r
 160 <simpara>Note: Newer CVS versions (&gt;= 1.12.11) also support specifying\r
 161 CVS_SERVER directly in CVSROOT like</simpara>\r
 162 <screen>cvs -d ":ext;CVS_SERVER=git cvsserver:user@server/path/repo.git" co &lt;HEAD_name&gt;</screen>\r
 163 <simpara>This has the advantage that it will be saved in your <emphasis>CVS/Root</emphasis> files and\r
 164 you don't need to worry about always setting the correct environment\r
 165 variable.  SSH users restricted to <emphasis>git-shell</emphasis> don't need to override the default\r
 166 with CVS_SERVER (and shouldn't) as <emphasis>git-shell</emphasis> understands <emphasis>cvs</emphasis> to mean\r
 167 <emphasis>git-cvsserver</emphasis> and pretends that the other end runs the real <emphasis>cvs</emphasis> better.</simpara>\r
 168 </listitem>\r
 169 <listitem>\r
 170 <simpara>\r
 171 For each repo that you want accessible from CVS you need to edit config in\r
 172    the repo and add the following section.\r
 173 </simpara>\r
 174 <screen>   [gitcvs]\r
 175         enabled=1\r
 176         # optional for debugging\r
 177         logFile=/path/to/logfile</screen>\r
 178 <simpara>Note: you need to ensure each user that is going to invoke <emphasis>git-cvsserver</emphasis> has\r
 179 write access to the log file and to the database (see\r
 180 <link linkend="git-cvsserver(1)_dbbackend">Database Backend</link>. If you want to offer write access over\r
 181 SSH, the users of course also need write access to the Git repository itself.</simpara>\r
 182 <simpara>You also need to ensure that each repository is "bare" (without a Git index\r
 183 file) for <emphasis>cvs commit</emphasis> to work. See <xref linkend="gitcvs-migration(7)" />.</simpara>\r
 184 <simpara id="git-cvsserver(1)_configaccessmethod">All configuration variables can also be overridden for a specific method of\r
 185 access. Valid method names are "ext" (for SSH access) and "pserver". The\r
 186 following example configuration would disable pserver access while still\r
 187 allowing access over SSH.</simpara>\r
 188 <screen>   [gitcvs]\r
 189         enabled=0\r
 190 \r
 191    [gitcvs "ext"]\r
 192         enabled=1</screen>\r
 193 </listitem>\r
 194 <listitem>\r
 195 <simpara>\r
 196 If you didn't specify the CVSROOT/CVS_SERVER directly in the checkout command,\r
 197    automatically saving it in your <emphasis>CVS/Root</emphasis> files, then you need to set them\r
 198    explicitly in your environment.  CVSROOT should be set as per normal, but the\r
 199    directory should point at the appropriate Git repo.  As above, for SSH clients\r
 200    <emphasis>not</emphasis> restricted to <emphasis>git-shell</emphasis>, CVS_SERVER should be set to <emphasis>git-cvsserver</emphasis>.\r
 201 </simpara>\r
 202 <screen>     export CVSROOT=:ext:user@server:/var/git/project.git\r
 203      export CVS_SERVER="git cvsserver"</screen>\r
 204 </listitem>\r
 205 <listitem>\r
 206 <simpara>\r
 207 For SSH clients that will make commits, make sure their server-side\r
 208    .ssh/environment files (or .bashrc, etc., according to their specific shell)\r
 209    export appropriate values for GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL,\r
 210    GIT_COMMITTER_NAME, and GIT_COMMITTER_EMAIL.  For SSH clients whose login\r
 211    shell is bash, .bashrc may be a reasonable alternative.\r
 212 </simpara>\r
 213 </listitem>\r
 214 <listitem>\r
 215 <simpara>\r
 216 Clients should now be able to check out the project. Use the CVS <emphasis>module</emphasis>\r
 217    name to indicate what Git <emphasis>head</emphasis> you want to check out.  This also sets the\r
 218    name of your newly checked-out directory, unless you tell it otherwise with\r
 219    <emphasis>-d &lt;dir_name&gt;</emphasis>.  For example, this checks out <emphasis>master</emphasis> branch to the\r
 220    <emphasis>project-master</emphasis> directory:\r
 221 </simpara>\r
 222 <screen>     cvs co -d project-master master</screen>\r
 223 </listitem>\r
 224 </orderedlist>\r
 225 </simplesect>\r
 226 <simplesect id="git-cvsserver(1)_dbbackend">\r
 227 <title>DATABASE BACKEND</title>\r
 228 <simpara><emphasis>git-cvsserver</emphasis> uses one database per Git head (i.e. CVS module) to\r
 229 store information about the repository to maintain consistent\r
 230 CVS revision numbers. The database needs to be\r
 231 updated (i.e. written to) after every commit.</simpara>\r
 232 <simpara>If the commit is done directly by using <emphasis>git</emphasis> (as opposed to\r
 233 using <emphasis>git-cvsserver</emphasis>) the update will need to happen on the\r
 234 next repository access by <emphasis>git-cvsserver</emphasis>, independent of\r
 235 access method and requested operation.</simpara>\r
 236 <simpara>That means that even if you offer only read access (e.g. by using\r
 237 the pserver method), <emphasis>git-cvsserver</emphasis> should have write access to\r
 238 the database to work reliably (otherwise you need to make sure\r
 239 that the database is up to date any time <emphasis>git-cvsserver</emphasis> is executed).</simpara>\r
 240 <simpara>By default it uses SQLite databases in the Git directory, named\r
 241 <emphasis>gitcvs.&lt;module_name&gt;.sqlite</emphasis>. Note that the SQLite backend creates\r
 242 temporary files in the same directory as the database file on\r
 243 write so it might not be enough to grant the users using\r
 244 <emphasis>git-cvsserver</emphasis> write access to the database file without granting\r
 245 them write access to the directory, too.</simpara>\r
 246 <simpara>The database cannot be reliably regenerated in a\r
 247 consistent form after the branch it is tracking has changed.\r
 248 Example: For merged branches, <emphasis>git-cvsserver</emphasis> only tracks\r
 249 one branch of development, and after a <emphasis>git merge</emphasis> an\r
 250 incrementally updated database may track a different branch\r
 251 than a database regenerated from scratch, causing inconsistent\r
 252 CVS revision numbers. <emphasis>git-cvsserver</emphasis> has no way of knowing which\r
 253 branch it would have picked if it had been run incrementally\r
 254 pre-merge. So if you have to fully or partially (from old\r
 255 backup) regenerate the database, you should be suspicious\r
 256 of pre-existing CVS sandboxes.</simpara>\r
 257 <simpara>You can configure the database backend with the following\r
 258 configuration variables:</simpara>\r
 259 <section id="git-cvsserver(1)__configuring_database_backend">\r
 260 <title>Configuring database backend</title>\r
 261 <simpara><emphasis>git-cvsserver</emphasis> uses the Perl DBI module. Please also read\r
 262 its documentation if changing these variables, especially\r
 263 about <emphasis>DBI-&gt;connect()</emphasis>.</simpara>\r
 264 <variablelist>\r
 265 <varlistentry>\r
 266 <term>\r
 267 gitcvs.dbName\r
 268 </term>\r
 269 <listitem>\r
 270 <simpara>\r
 271         Database name. The exact meaning depends on the\r
 272         selected database driver, for SQLite this is a filename.\r
 273         Supports variable substitution (see below). May\r
 274         not contain semicolons (<emphasis>;</emphasis>).\r
 275         Default: <emphasis>%Ggitcvs.%m.sqlite</emphasis>\r
 276 </simpara>\r
 277 </listitem>\r
 278 </varlistentry>\r
 279 <varlistentry>\r
 280 <term>\r
 281 gitcvs.dbDriver\r
 282 </term>\r
 283 <listitem>\r
 284 <simpara>\r
 285         Used DBI driver. You can specify any available driver\r
 286         for this here, but it might not work. cvsserver is tested\r
 287         with <emphasis>DBD::SQLite</emphasis>, reported to work with\r
 288         <emphasis>DBD::Pg</emphasis>, and reported <emphasis role="strong">not</emphasis> to work with <emphasis>DBD::mysql</emphasis>.\r
 289         Please regard this as an experimental feature. May not\r
 290         contain colons (<emphasis>:</emphasis>).\r
 291         Default: <emphasis>SQLite</emphasis>\r
 292 </simpara>\r
 293 </listitem>\r
 294 </varlistentry>\r
 295 <varlistentry>\r
 296 <term>\r
 297 gitcvs.dbuser\r
 298 </term>\r
 299 <listitem>\r
 300 <simpara>\r
 301         Database user. Only useful if setting <emphasis>dbDriver</emphasis>, since\r
 302         SQLite has no concept of database users. Supports variable\r
 303         substitution (see below).\r
 304 </simpara>\r
 305 </listitem>\r
 306 </varlistentry>\r
 307 <varlistentry>\r
 308 <term>\r
 309 gitcvs.dbPass\r
 310 </term>\r
 311 <listitem>\r
 312 <simpara>\r
 313         Database password.  Only useful if setting <emphasis>dbDriver</emphasis>, since\r
 314         SQLite has no concept of database passwords.\r
 315 </simpara>\r
 316 </listitem>\r
 317 </varlistentry>\r
 318 <varlistentry>\r
 319 <term>\r
 320 gitcvs.dbTableNamePrefix\r
 321 </term>\r
 322 <listitem>\r
 323 <simpara>\r
 324         Database table name prefix.  Supports variable substitution\r
 325         (see below).  Any non-alphabetic characters will be replaced\r
 326         with underscores.\r
 327 </simpara>\r
 328 </listitem>\r
 329 </varlistentry>\r
 330 </variablelist>\r
 331 <simpara>All variables can also be set per access method, see <link linkend="git-cvsserver(1)_configaccessmethod">above</link>.</simpara>\r
 332 <section id="git-cvsserver(1)__variable_substitution">\r
 333 <title>Variable substitution</title>\r
 334 <simpara>In <emphasis>dbDriver</emphasis> and <emphasis>dbUser</emphasis> you can use the following variables:</simpara>\r
 335 <variablelist>\r
 336 <varlistentry>\r
 337 <term>\r
 338 %G\r
 339 </term>\r
 340 <listitem>\r
 341 <simpara>\r
 342         Git directory name\r
 343 </simpara>\r
 344 </listitem>\r
 345 </varlistentry>\r
 346 <varlistentry>\r
 347 <term>\r
 348 %g\r
 349 </term>\r
 350 <listitem>\r
 351 <simpara>\r
 352         Git directory name, where all characters except for\r
 353         alphanumeric ones, <emphasis>.</emphasis>, and <emphasis>-</emphasis> are replaced with\r
 354         <emphasis>_</emphasis> (this should make it easier to use the directory\r
 355         name in a filename if wanted)\r
 356 </simpara>\r
 357 </listitem>\r
 358 </varlistentry>\r
 359 <varlistentry>\r
 360 <term>\r
 361 %m\r
 362 </term>\r
 363 <listitem>\r
 364 <simpara>\r
 365         CVS module/Git head name\r
 366 </simpara>\r
 367 </listitem>\r
 368 </varlistentry>\r
 369 <varlistentry>\r
 370 <term>\r
 371 %a\r
 372 </term>\r
 373 <listitem>\r
 374 <simpara>\r
 375         access method (one of "ext" or "pserver")\r
 376 </simpara>\r
 377 </listitem>\r
 378 </varlistentry>\r
 379 <varlistentry>\r
 380 <term>\r
 381 %u\r
 382 </term>\r
 383 <listitem>\r
 384 <simpara>\r
 385         Name of the user running <emphasis>git-cvsserver</emphasis>.\r
 386         If no name can be determined, the\r
 387         numeric uid is used.\r
 388 </simpara>\r
 389 </listitem>\r
 390 </varlistentry>\r
 391 </variablelist>\r
 392 </section>\r
 393 </section>\r
 394 </simplesect>\r
 395 <simplesect id="git-cvsserver(1)__environment">\r
 396 <title>ENVIRONMENT</title>\r
 397 <simpara>These variables obviate the need for command-line options in some\r
 398 circumstances, allowing easier restricted usage through git-shell.</simpara>\r
 399 <simpara>GIT_CVSSERVER_BASE_PATH takes the place of the argument to --base-path.</simpara>\r
 400 <simpara>GIT_CVSSERVER_ROOT specifies a single-directory whitelist. The\r
 401 repository must still be configured to allow access through\r
 402 git-cvsserver, as described above.</simpara>\r
 403 <simpara>When these environment variables are set, the corresponding\r
 404 command-line arguments may not be used.</simpara>\r
 405 </simplesect>\r
 406 <simplesect id="git-cvsserver(1)__eclipse_cvs_client_notes">\r
 407 <title>ECLIPSE CVS CLIENT NOTES</title>\r
 408 <simpara>To get a checkout with the Eclipse CVS client:</simpara>\r
 409 <orderedlist numeration="arabic">\r
 410 <listitem>\r
 411 <simpara>\r
 412 Select "Create a new project &#8594; From CVS checkout"\r
 413 </simpara>\r
 414 </listitem>\r
 415 <listitem>\r
 416 <simpara>\r
 417 Create a new location. See the notes below for details on how to choose the\r
 418    right protocol.\r
 419 </simpara>\r
 420 </listitem>\r
 421 <listitem>\r
 422 <simpara>\r
 423 Browse the <emphasis>modules</emphasis> available. It will give you a list of the heads in\r
 424    the repository. You will not be able to browse the tree from there. Only\r
 425    the heads.\r
 426 </simpara>\r
 427 </listitem>\r
 428 <listitem>\r
 429 <simpara>\r
 430 Pick <emphasis>HEAD</emphasis> when it asks what branch/tag to check out. Untick the\r
 431    "launch commit wizard" to avoid committing the .project file.\r
 432 </simpara>\r
 433 </listitem>\r
 434 </orderedlist>\r
 435 <simpara>Protocol notes: If you are using anonymous access via pserver, just select that.\r
 436 Those using SSH access should choose the <emphasis>ext</emphasis> protocol, and configure <emphasis>ext</emphasis>\r
 437 access on the Preferences&#8594;Team&#8594;CVS&#8594;ExtConnection pane. Set CVS_SERVER to\r
 438 "<emphasis>git cvsserver</emphasis>". Note that password support is not good when using <emphasis>ext</emphasis>,\r
 439 you will definitely want to have SSH keys setup.</simpara>\r
 440 <simpara>Alternatively, you can just use the non-standard extssh protocol that Eclipse\r
 441 offer. In that case CVS_SERVER is ignored, and you will have to replace\r
 442 the cvs utility on the server with <emphasis>git-cvsserver</emphasis> or manipulate your <emphasis>.bashrc</emphasis>\r
 443 so that calling <emphasis>cvs</emphasis> effectively calls <emphasis>git-cvsserver</emphasis>.</simpara>\r
 444 </simplesect>\r
 445 <simplesect id="git-cvsserver(1)__clients_known_to_work">\r
 446 <title>CLIENTS KNOWN TO WORK</title>\r
 447 <itemizedlist>\r
 448 <listitem>\r
 449 <simpara>\r
 450 CVS 1.12.9 on Debian\r
 451 </simpara>\r
 452 </listitem>\r
 453 <listitem>\r
 454 <simpara>\r
 455 CVS 1.11.17 on MacOSX (from Fink package)\r
 456 </simpara>\r
 457 </listitem>\r
 458 <listitem>\r
 459 <simpara>\r
 460 Eclipse 3.0, 3.1.2 on MacOSX (see Eclipse CVS Client Notes)\r
 461 </simpara>\r
 462 </listitem>\r
 463 <listitem>\r
 464 <simpara>\r
 465 TortoiseCVS\r
 466 </simpara>\r
 467 </listitem>\r
 468 </itemizedlist>\r
 469 </simplesect>\r
 470 <simplesect id="git-cvsserver(1)__operations_supported">\r
 471 <title>OPERATIONS SUPPORTED</title>\r
 472 <simpara>All the operations required for normal use are supported, including\r
 473 checkout, diff, status, update, log, add, remove, commit.</simpara>\r
 474 <simpara>Most CVS command arguments that read CVS tags or revision numbers\r
 475 (typically -r) work, and also support any git refspec\r
 476 (tag, branch, commit ID, etc).\r
 477 However, CVS revision numbers for non-default branches are not well\r
 478 emulated, and cvs log does not show tags or branches at\r
 479 all.  (Non-main-branch CVS revision numbers superficially resemble CVS\r
 480 revision numbers, but they actually encode a git commit ID directly,\r
 481 rather than represent the number of revisions since the branch point.)</simpara>\r
 482 <simpara>Note that there are two ways to checkout a particular branch.\r
 483 As described elsewhere on this page, the "module" parameter\r
 484 of cvs checkout is interpreted as a branch name, and it becomes\r
 485 the main branch.  It remains the main branch for a given sandbox\r
 486 even if you temporarily make another branch sticky with\r
 487 cvs update -r.  Alternatively, the -r argument can indicate\r
 488 some other branch to actually checkout, even though the module\r
 489 is still the "main" branch.  Tradeoffs (as currently\r
 490 implemented): Each new "module" creates a new database on disk with\r
 491 a history for the given module, and after the database is created,\r
 492 operations against that main branch are fast.  Or alternatively,\r
 493 -r doesn't take any extra disk space, but may be significantly slower for\r
 494 many operations, like cvs update.</simpara>\r
 495 <simpara>If you want to refer to a git refspec that has characters that are\r
 496 not allowed by CVS, you have two options.  First, it may just work\r
 497 to supply the git refspec directly to the appropriate CVS -r argument;\r
 498 some CVS clients don't seem to do much sanity checking of the argument.\r
 499 Second, if that fails, you can use a special character escape mechanism\r
 500 that only uses characters that are valid in CVS tags.  A sequence\r
 501 of 4 or 5 characters of the form (underscore (<emphasis>"_"</emphasis>), dash (<emphasis>"-"</emphasis>),\r
 502 one or two characters, and dash (<emphasis>"-"</emphasis>)) can encode various characters based\r
 503 on the one or two letters: <emphasis>"s"</emphasis> for slash (<emphasis>"/"</emphasis>), <emphasis>"p"</emphasis> for\r
 504 period (<emphasis>"."</emphasis>), <emphasis>"u"</emphasis> for underscore (<emphasis>"_"</emphasis>), or two hexadecimal digits\r
 505 for any byte value at all (typically an ASCII number, or perhaps a part\r
 506 of a UTF-8 encoded character).</simpara>\r
 507 <simpara>Legacy monitoring operations are not supported (edit, watch and related).\r
 508 Exports and tagging (tags and branches) are not supported at this stage.</simpara>\r
 509 <section id="git-cvsserver(1)__crlf_line_ending_conversions">\r
 510 <title>CRLF Line Ending Conversions</title>\r
 511 <simpara>By default the server leaves the <emphasis>-k</emphasis> mode blank for all files,\r
 512 which causes the CVS client to treat them as a text files, subject\r
 513 to end-of-line conversion on some platforms.</simpara>\r
 514 <simpara>You can make the server use the end-of-line conversion attributes to\r
 515 set the <emphasis>-k</emphasis> modes for files by setting the <emphasis>gitcvs.usecrlfattr</emphasis>\r
 516 config variable.  See <xref linkend="gitattributes(5)" /> for more information\r
 517 about end-of-line conversion.</simpara>\r
 518 <simpara>Alternatively, if <emphasis>gitcvs.usecrlfattr</emphasis> config is not enabled\r
 519 or the attributes do not allow automatic detection for a filename, then\r
 520 the server uses the <emphasis>gitcvs.allBinary</emphasis> config for the default setting.\r
 521 If <emphasis>gitcvs.allBinary</emphasis> is set, then file not otherwise\r
 522 specified will default to <emphasis>-kb</emphasis> mode. Otherwise the <emphasis>-k</emphasis> mode\r
 523 is left blank. But if <emphasis>gitcvs.allBinary</emphasis> is set to "guess", then\r
 524 the correct <emphasis>-k</emphasis> mode will be guessed based on the contents of\r
 525 the file.</simpara>\r
 526 <simpara>For best consistency with <emphasis>cvs</emphasis>, it is probably best to override the\r
 527 defaults by setting <emphasis>gitcvs.usecrlfattr</emphasis> to true,\r
 528 and <emphasis>gitcvs.allBinary</emphasis> to "guess".</simpara>\r
 529 </section>\r
 530 </simplesect>\r
 531 <simplesect id="git-cvsserver(1)__dependencies">\r
 532 <title>DEPENDENCIES</title>\r
 533 <simpara><emphasis>git-cvsserver</emphasis> depends on DBD::SQLite.</simpara>\r
 534 </simplesect>\r
 535 <simplesect id="git-cvsserver(1)__git">\r
 536 <title>GIT</title>\r
 537 <simpara>Part of the <xref linkend="git(1)" /> suite</simpara>\r
 538 </simplesect>\r
 539 </sect2>\r