blob: a1fdcac821d6051203b942b5e9d28f7ae784ed78 [file] [log] [blame]
Junio C Hamano34b18112006-02-23 11:21:401<!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>
Junio C Hamano9d971152012-12-19 00:43:115<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
Junio C Hamanoc14e6ad2014-10-31 20:25:536<meta name="generator" content="AsciiDoc 8.6.9" />
Junio C Hamano68cf15a2010-11-06 01:01:597<title>git-cvsserver(1)</title>
Junio C Hamano34b18112006-02-23 11:21:408<style type="text/css">
Junio C Hamano9d971152012-12-19 00:43:119/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
10
11/* Default font. */
12body {
13 font-family: Georgia,serif;
14}
15
16/* Title font. */
17h1, h2, h3, h4, h5, h6,
18div.title, caption.title,
19thead, p.table.header,
20#toctitle,
21#author, #revnumber, #revdate, #revremark,
22#footer {
23 font-family: Arial,Helvetica,sans-serif;
Junio C Hamano34b18112006-02-23 11:21:4024}
25
26body {
27 margin: 1em 5% 1em 5%;
28}
29
Junio C Hamanoba4b9282008-07-06 05:20:3130a {
31 color: blue;
32 text-decoration: underline;
33}
34a:visited {
35 color: fuchsia;
36}
Junio C Hamano34b18112006-02-23 11:21:4037
38em {
39 font-style: italic;
Junio C Hamano68cf15a2010-11-06 01:01:5940 color: navy;
Junio C Hamano34b18112006-02-23 11:21:4041}
42
43strong {
44 font-weight: bold;
Junio C Hamano68cf15a2010-11-06 01:01:5945 color: #083194;
Junio C Hamano34b18112006-02-23 11:21:4046}
47
Junio C Hamano34b18112006-02-23 11:21:4048h1, h2, h3, h4, h5, h6 {
49 color: #527bbd;
Junio C Hamano34b18112006-02-23 11:21:4050 margin-top: 1.2em;
51 margin-bottom: 0.5em;
52 line-height: 1.3;
53}
54
Junio C Hamanoba4b9282008-07-06 05:20:3155h1, h2, h3 {
Junio C Hamano34b18112006-02-23 11:21:4056 border-bottom: 2px solid silver;
57}
58h2 {
Junio C Hamano34b18112006-02-23 11:21:4059 padding-top: 0.5em;
60}
Junio C Hamanoba4b9282008-07-06 05:20:3161h3 {
62 float: left;
63}
64h3 + * {
65 clear: left;
66}
Junio C Hamano9d971152012-12-19 00:43:1167h5 {
68 font-size: 1.0em;
69}
Junio C Hamano34b18112006-02-23 11:21:4070
71div.sectionbody {
Junio C Hamano34b18112006-02-23 11:21:4072 margin-left: 0;
73}
74
75hr {
76 border: 1px solid silver;
77}
78
79p {
80 margin-top: 0.5em;
81 margin-bottom: 0.5em;
82}
83
Junio C Hamano68cf15a2010-11-06 01:01:5984ul, ol, li > p {
85 margin-top: 0;
86}
Junio C Hamano9d971152012-12-19 00:43:1187ul > li { color: #aaa; }
88ul > li > * { color: black; }
Junio C Hamano68cf15a2010-11-06 01:01:5989
Junio C Hamanoc14e6ad2014-10-31 20:25:5390.monospaced, code, pre {
91 font-family: "Courier New", Courier, monospace;
92 font-size: inherit;
93 color: navy;
Junio C Hamano34b18112006-02-23 11:21:4094 padding: 0;
95 margin: 0;
96}
Junio C Hamanoc14e6ad2014-10-31 20:25:5397pre {
98 white-space: pre-wrap;
99}
Junio C Hamano34b18112006-02-23 11:21:40100
Junio C Hamano9d971152012-12-19 00:43:11101#author {
Junio C Hamano34b18112006-02-23 11:21:40102 color: #527bbd;
Junio C Hamano34b18112006-02-23 11:21:40103 font-weight: bold;
Junio C Hamanoba4b9282008-07-06 05:20:31104 font-size: 1.1em;
Junio C Hamano34b18112006-02-23 11:21:40105}
Junio C Hamano9d971152012-12-19 00:43:11106#email {
Junio C Hamano34b18112006-02-23 11:21:40107}
Junio C Hamano9d971152012-12-19 00:43:11108#revnumber, #revdate, #revremark {
Junio C Hamano34b18112006-02-23 11:21:40109}
110
Junio C Hamano9d971152012-12-19 00:43:11111#footer {
Junio C Hamano34b18112006-02-23 11:21:40112 font-size: small;
113 border-top: 2px solid silver;
114 padding-top: 0.5em;
115 margin-top: 4.0em;
116}
Junio C Hamano9d971152012-12-19 00:43:11117#footer-text {
Junio C Hamano34b18112006-02-23 11:21:40118 float: left;
119 padding-bottom: 0.5em;
120}
Junio C Hamano9d971152012-12-19 00:43:11121#footer-badges {
Junio C Hamano34b18112006-02-23 11:21:40122 float: right;
123 padding-bottom: 0.5em;
124}
125
Junio C Hamano9d971152012-12-19 00:43:11126#preamble {
Junio C Hamano68cf15a2010-11-06 01:01:59127 margin-top: 1.5em;
128 margin-bottom: 1.5em;
129}
Junio C Hamano9d971152012-12-19 00:43:11130div.imageblock, div.exampleblock, div.verseblock,
Junio C Hamano34b18112006-02-23 11:21:40131div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
132div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22133 margin-top: 1.0em;
Junio C Hamano34b18112006-02-23 11:21:40134 margin-bottom: 1.5em;
135}
136div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22137 margin-top: 2.0em;
138 margin-bottom: 2.0em;
139 margin-right: 10%;
140 color: #606060;
Junio C Hamano34b18112006-02-23 11:21:40141}
142
143div.content { /* Block element content. */
144 padding: 0;
145}
146
147/* Block element titles. */
148div.title, caption.title {
Junio C Hamano68cf15a2010-11-06 01:01:59149 color: #527bbd;
Junio C Hamano34b18112006-02-23 11:21:40150 font-weight: bold;
151 text-align: left;
152 margin-top: 1.0em;
153 margin-bottom: 0.5em;
154}
155div.title + * {
156 margin-top: 0;
157}
158
159td div.title:first-child {
160 margin-top: 0.0em;
161}
162div.content div.title:first-child {
163 margin-top: 0.0em;
164}
165div.content + div.title {
166 margin-top: 0.0em;
167}
168
169div.sidebarblock > div.content {
170 background: #ffffee;
Junio C Hamano9d971152012-12-19 00:43:11171 border: 1px solid #dddddd;
172 border-left: 4px solid #f0f0f0;
Junio C Hamano34b18112006-02-23 11:21:40173 padding: 0.5em;
174}
175
176div.listingblock > div.content {
Junio C Hamano9d971152012-12-19 00:43:11177 border: 1px solid #dddddd;
178 border-left: 5px solid #f0f0f0;
179 background: #f8f8f8;
Junio C Hamano34b18112006-02-23 11:21:40180 padding: 0.5em;
181}
182
Junio C Hamano7bd050f2011-09-22 06:32:22183div.quoteblock, div.verseblock {
184 padding-left: 1.0em;
185 margin-left: 1.0em;
Junio C Hamano68cf15a2010-11-06 01:01:59186 margin-right: 10%;
Junio C Hamano9d971152012-12-19 00:43:11187 border-left: 5px solid #f0f0f0;
188 color: #888;
Junio C Hamano34b18112006-02-23 11:21:40189}
Junio C Hamano7bd050f2011-09-22 06:32:22190
Junio C Hamano68cf15a2010-11-06 01:01:59191div.quoteblock > div.attribution {
192 padding-top: 0.5em;
Junio C Hamano34b18112006-02-23 11:21:40193 text-align: right;
194}
Junio C Hamano68cf15a2010-11-06 01:01:59195
Junio C Hamano9d971152012-12-19 00:43:11196div.verseblock > pre.content {
197 font-family: inherit;
198 font-size: inherit;
Junio C Hamano68cf15a2010-11-06 01:01:59199}
200div.verseblock > div.attribution {
201 padding-top: 0.75em;
202 text-align: left;
203}
204/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
Junio C Hamanoba4b9282008-07-06 05:20:31205div.verseblock + div.attribution {
206 text-align: left;
207}
Junio C Hamano34b18112006-02-23 11:21:40208
209div.admonitionblock .icon {
210 vertical-align: top;
211 font-size: 1.1em;
212 font-weight: bold;
213 text-decoration: underline;
214 color: #527bbd;
215 padding-right: 0.5em;
216}
217div.admonitionblock td.content {
218 padding-left: 0.5em;
Junio C Hamano7bd050f2011-09-22 06:32:22219 border-left: 3px solid #dddddd;
Junio C Hamano34b18112006-02-23 11:21:40220}
221
222div.exampleblock > div.content {
Junio C Hamano7bd050f2011-09-22 06:32:22223 border-left: 3px solid #dddddd;
224 padding-left: 0.5em;
Junio C Hamano34b18112006-02-23 11:21:40225}
226
Junio C Hamano34b18112006-02-23 11:21:40227div.imageblock div.content { padding-left: 0; }
Junio C Hamanoc14e6ad2014-10-31 20:25:53228span.image img { border-style: none; vertical-align: text-bottom; }
Junio C Hamano68cf15a2010-11-06 01:01:59229a.image:visited { color: white; }
Junio C Hamano34b18112006-02-23 11:21:40230
231dl {
232 margin-top: 0.8em;
233 margin-bottom: 0.8em;
234}
235dt {
236 margin-top: 0.5em;
237 margin-bottom: 0;
Junio C Hamano68cf15a2010-11-06 01:01:59238 font-style: normal;
239 color: navy;
Junio C Hamano34b18112006-02-23 11:21:40240}
241dd > *:first-child {
Junio C Hamano68cf15a2010-11-06 01:01:59242 margin-top: 0.1em;
Junio C Hamano34b18112006-02-23 11:21:40243}
244
245ul, ol {
246 list-style-position: outside;
247}
Junio C Hamano68cf15a2010-11-06 01:01:59248ol.arabic {
249 list-style-type: decimal;
250}
251ol.loweralpha {
Junio C Hamano34b18112006-02-23 11:21:40252 list-style-type: lower-alpha;
253}
Junio C Hamano68cf15a2010-11-06 01:01:59254ol.upperalpha {
255 list-style-type: upper-alpha;
256}
257ol.lowerroman {
258 list-style-type: lower-roman;
259}
260ol.upperroman {
261 list-style-type: upper-roman;
262}
263
264div.compact ul, div.compact ol,
265div.compact p, div.compact p,
266div.compact div, div.compact div {
267 margin-top: 0.1em;
268 margin-bottom: 0.1em;
269}
Junio C Hamano34b18112006-02-23 11:21:40270
Junio C Hamano34b18112006-02-23 11:21:40271tfoot {
272 font-weight: bold;
273}
Junio C Hamano68cf15a2010-11-06 01:01:59274td > div.verse {
275 white-space: pre;
276}
Junio C Hamano68cf15a2010-11-06 01:01:59277
278div.hdlist {
Junio C Hamano34b18112006-02-23 11:21:40279 margin-top: 0.8em;
280 margin-bottom: 0.8em;
281}
Junio C Hamano68cf15a2010-11-06 01:01:59282div.hdlist tr {
283 padding-bottom: 15px;
Junio C Hamanoba4b9282008-07-06 05:20:31284}
Junio C Hamano68cf15a2010-11-06 01:01:59285dt.hdlist1.strong, td.hdlist1.strong {
286 font-weight: bold;
287}
288td.hdlist1 {
Junio C Hamano34b18112006-02-23 11:21:40289 vertical-align: top;
Junio C Hamano68cf15a2010-11-06 01:01:59290 font-style: normal;
Junio C Hamano34b18112006-02-23 11:21:40291 padding-right: 0.8em;
Junio C Hamano68cf15a2010-11-06 01:01:59292 color: navy;
Junio C Hamano34b18112006-02-23 11:21:40293}
Junio C Hamano68cf15a2010-11-06 01:01:59294td.hdlist2 {
Junio C Hamano34b18112006-02-23 11:21:40295 vertical-align: top;
296}
Junio C Hamano68cf15a2010-11-06 01:01:59297div.hdlist.compact tr {
298 margin: 0;
299 padding-bottom: 0;
300}
301
302.comment {
303 background: yellow;
304}
Junio C Hamano34b18112006-02-23 11:21:40305
Junio C Hamano7bd050f2011-09-22 06:32:22306.footnote, .footnoteref {
307 font-size: 0.8em;
308}
309
310span.footnote, span.footnoteref {
311 vertical-align: super;
312}
313
314#footnotes {
315 margin: 20px 0 20px 0;
316 padding: 7px 0 0 0;
317}
318
319#footnotes div.footnote {
320 margin: 0 0 5px 0;
321}
322
323#footnotes hr {
324 border: none;
325 border-top: 1px solid silver;
326 height: 1px;
327 text-align: left;
328 margin-left: 0;
329 width: 20%;
330 min-width: 100px;
331}
332
Junio C Hamano9d971152012-12-19 00:43:11333div.colist td {
334 padding-right: 0.5em;
335 padding-bottom: 0.3em;
336 vertical-align: top;
337}
338div.colist td img {
339 margin-top: 0.3em;
Junio C Hamano34b18112006-02-23 11:21:40340}
Junio C Hamanoba4b9282008-07-06 05:20:31341
Junio C Hamano9d971152012-12-19 00:43:11342@media print {
343 #footer-badges { display: none; }
344}
345
346#toc {
Junio C Hamano7bd050f2011-09-22 06:32:22347 margin-bottom: 2.5em;
348}
349
Junio C Hamano9d971152012-12-19 00:43:11350#toctitle {
Junio C Hamanoba4b9282008-07-06 05:20:31351 color: #527bbd;
Junio C Hamanoba4b9282008-07-06 05:20:31352 font-size: 1.1em;
353 font-weight: bold;
354 margin-top: 1.0em;
355 margin-bottom: 0.1em;
356}
357
Junio C Hamanoc14e6ad2014-10-31 20:25:53358div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
Junio C Hamanoba4b9282008-07-06 05:20:31359 margin-top: 0;
360 margin-bottom: 0;
361}
362div.toclevel2 {
363 margin-left: 2em;
364 font-size: 0.9em;
365}
366div.toclevel3 {
367 margin-left: 4em;
368 font-size: 0.9em;
369}
370div.toclevel4 {
371 margin-left: 6em;
372 font-size: 0.9em;
373}
Junio C Hamano9d971152012-12-19 00:43:11374
375span.aqua { color: aqua; }
376span.black { color: black; }
377span.blue { color: blue; }
378span.fuchsia { color: fuchsia; }
379span.gray { color: gray; }
380span.green { color: green; }
381span.lime { color: lime; }
382span.maroon { color: maroon; }
383span.navy { color: navy; }
384span.olive { color: olive; }
385span.purple { color: purple; }
386span.red { color: red; }
387span.silver { color: silver; }
388span.teal { color: teal; }
389span.white { color: white; }
390span.yellow { color: yellow; }
391
392span.aqua-background { background: aqua; }
393span.black-background { background: black; }
394span.blue-background { background: blue; }
395span.fuchsia-background { background: fuchsia; }
396span.gray-background { background: gray; }
397span.green-background { background: green; }
398span.lime-background { background: lime; }
399span.maroon-background { background: maroon; }
400span.navy-background { background: navy; }
401span.olive-background { background: olive; }
402span.purple-background { background: purple; }
403span.red-background { background: red; }
404span.silver-background { background: silver; }
405span.teal-background { background: teal; }
406span.white-background { background: white; }
407span.yellow-background { background: yellow; }
408
409span.big { font-size: 2em; }
410span.small { font-size: 0.6em; }
411
412span.underline { text-decoration: underline; }
413span.overline { text-decoration: overline; }
414span.line-through { text-decoration: line-through; }
415
Junio C Hamanoc14e6ad2014-10-31 20:25:53416div.unbreakable { page-break-inside: avoid; }
417
Junio C Hamano9d971152012-12-19 00:43:11418
419/*
420 * xhtml11 specific
421 *
422 * */
423
424div.tableblock {
425 margin-top: 1.0em;
426 margin-bottom: 1.5em;
427}
428div.tableblock > table {
429 border: 3px solid #527bbd;
430}
431thead, p.table.header {
432 font-weight: bold;
433 color: #527bbd;
434}
435p.table {
436 margin-top: 0;
437}
438/* Because the table frame attribute is overriden by CSS in most browsers. */
439div.tableblock > table[frame="void"] {
440 border-style: none;
441}
442div.tableblock > table[frame="hsides"] {
443 border-left-style: none;
444 border-right-style: none;
445}
446div.tableblock > table[frame="vsides"] {
447 border-top-style: none;
448 border-bottom-style: none;
449}
450
451
452/*
453 * html5 specific
454 *
455 * */
456
457table.tableblock {
458 margin-top: 1.0em;
459 margin-bottom: 1.5em;
460}
461thead, p.tableblock.header {
462 font-weight: bold;
463 color: #527bbd;
464}
465p.tableblock {
466 margin-top: 0;
467}
468table.tableblock {
469 border-width: 3px;
470 border-spacing: 0px;
471 border-style: solid;
472 border-color: #527bbd;
473 border-collapse: collapse;
474}
475th.tableblock, td.tableblock {
476 border-width: 1px;
477 padding: 4px;
478 border-style: solid;
479 border-color: #527bbd;
480}
481
482table.tableblock.frame-topbot {
483 border-left-style: hidden;
484 border-right-style: hidden;
485}
486table.tableblock.frame-sides {
487 border-top-style: hidden;
488 border-bottom-style: hidden;
489}
490table.tableblock.frame-none {
491 border-style: hidden;
492}
493
494th.tableblock.halign-left, td.tableblock.halign-left {
495 text-align: left;
496}
497th.tableblock.halign-center, td.tableblock.halign-center {
498 text-align: center;
499}
500th.tableblock.halign-right, td.tableblock.halign-right {
501 text-align: right;
502}
503
504th.tableblock.valign-top, td.tableblock.valign-top {
505 vertical-align: top;
506}
507th.tableblock.valign-middle, td.tableblock.valign-middle {
508 vertical-align: middle;
509}
510th.tableblock.valign-bottom, td.tableblock.valign-bottom {
511 vertical-align: bottom;
512}
513
514
515/*
516 * manpage specific
517 *
518 * */
519
520body.manpage h1 {
Junio C Hamano68cf15a2010-11-06 01:01:59521 padding-top: 0.5em;
522 padding-bottom: 0.5em;
523 border-top: 2px solid silver;
524 border-bottom: 2px solid silver;
525}
Junio C Hamano9d971152012-12-19 00:43:11526body.manpage h2 {
Junio C Hamano68cf15a2010-11-06 01:01:59527 border-style: none;
528}
Junio C Hamano9d971152012-12-19 00:43:11529body.manpage div.sectionbody {
530 margin-left: 3em;
Junio C Hamano68cf15a2010-11-06 01:01:59531}
532
533@media print {
Junio C Hamano9d971152012-12-19 00:43:11534 body.manpage div#toc { display: none; }
Junio C Hamano68cf15a2010-11-06 01:01:59535}
Junio C Hamanoc14e6ad2014-10-31 20:25:53536
537
Junio C Hamano34b18112006-02-23 11:21:40538</style>
Junio C Hamano7bd050f2011-09-22 06:32:22539<script type="text/javascript">
540/*<![CDATA[*/
Junio C Hamano7bd050f2011-09-22 06:32:22541var asciidoc = { // Namespace.
542
543/////////////////////////////////////////////////////////////////////
544// Table Of Contents generator
545/////////////////////////////////////////////////////////////////////
546
547/* Author: Mihai Bazon, September 2002
548 * http://students.infoiasi.ro/~mishoo
549 *
550 * Table Of Content generator
551 * Version: 0.4
552 *
553 * Feel free to use this script under the terms of the GNU General Public
554 * License, as long as you do not remove or alter this notice.
555 */
556
557 /* modified by Troy D. Hanson, September 2006. License: GPL */
558 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
559
560// toclevels = 1..4.
561toc: function (toclevels) {
562
563 function getText(el) {
564 var text = "";
565 for (var i = el.firstChild; i != null; i = i.nextSibling) {
566 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
567 text += i.data;
568 else if (i.firstChild != null)
569 text += getText(i);
570 }
571 return text;
572 }
573
574 function TocEntry(el, text, toclevel) {
575 this.element = el;
576 this.text = text;
577 this.toclevel = toclevel;
578 }
579
580 function tocEntries(el, toclevels) {
581 var result = new Array;
Junio C Hamanoc14e6ad2014-10-31 20:25:53582 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
Junio C Hamano7bd050f2011-09-22 06:32:22583 // Function that scans the DOM tree for header elements (the DOM2
584 // nodeIterator API would be a better technique but not supported by all
585 // browsers).
586 var iterate = function (el) {
587 for (var i = el.firstChild; i != null; i = i.nextSibling) {
588 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
589 var mo = re.exec(i.tagName);
590 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
591 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
592 }
593 iterate(i);
594 }
595 }
596 }
597 iterate(el);
598 return result;
599 }
600
601 var toc = document.getElementById("toc");
Junio C Hamano9d971152012-12-19 00:43:11602 if (!toc) {
603 return;
604 }
605
606 // Delete existing TOC entries in case we're reloading the TOC.
607 var tocEntriesToRemove = [];
608 var i;
609 for (i = 0; i < toc.childNodes.length; i++) {
610 var entry = toc.childNodes[i];
Junio C Hamanoc14e6ad2014-10-31 20:25:53611 if (entry.nodeName.toLowerCase() == 'div'
Junio C Hamano9d971152012-12-19 00:43:11612 && entry.getAttribute("class")
613 && entry.getAttribute("class").match(/^toclevel/))
614 tocEntriesToRemove.push(entry);
615 }
616 for (i = 0; i < tocEntriesToRemove.length; i++) {
617 toc.removeChild(tocEntriesToRemove[i]);
618 }
619
620 // Rebuild TOC entries.
Junio C Hamano7bd050f2011-09-22 06:32:22621 var entries = tocEntries(document.getElementById("content"), toclevels);
622 for (var i = 0; i < entries.length; ++i) {
623 var entry = entries[i];
624 if (entry.element.id == "")
625 entry.element.id = "_toc_" + i;
626 var a = document.createElement("a");
627 a.href = "#" + entry.element.id;
628 a.appendChild(document.createTextNode(entry.text));
629 var div = document.createElement("div");
630 div.appendChild(a);
631 div.className = "toclevel" + entry.toclevel;
632 toc.appendChild(div);
633 }
634 if (entries.length == 0)
635 toc.parentNode.removeChild(toc);
636},
637
638
639/////////////////////////////////////////////////////////////////////
640// Footnotes generator
641/////////////////////////////////////////////////////////////////////
642
643/* Based on footnote generation code from:
644 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
645 */
646
647footnotes: function () {
Junio C Hamano9d971152012-12-19 00:43:11648 // Delete existing footnote entries in case we're reloading the footnodes.
649 var i;
Junio C Hamano7bd050f2011-09-22 06:32:22650 var noteholder = document.getElementById("footnotes");
Junio C Hamano9d971152012-12-19 00:43:11651 if (!noteholder) {
652 return;
653 }
654 var entriesToRemove = [];
655 for (i = 0; i < noteholder.childNodes.length; i++) {
656 var entry = noteholder.childNodes[i];
Junio C Hamanoc14e6ad2014-10-31 20:25:53657 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
Junio C Hamano9d971152012-12-19 00:43:11658 entriesToRemove.push(entry);
659 }
660 for (i = 0; i < entriesToRemove.length; i++) {
661 noteholder.removeChild(entriesToRemove[i]);
662 }
663
664 // Rebuild footnote entries.
665 var cont = document.getElementById("content");
Junio C Hamano7bd050f2011-09-22 06:32:22666 var spans = cont.getElementsByTagName("span");
667 var refs = {};
668 var n = 0;
669 for (i=0; i<spans.length; i++) {
670 if (spans[i].className == "footnote") {
671 n++;
Junio C Hamano9d971152012-12-19 00:43:11672 var note = spans[i].getAttribute("data-note");
673 if (!note) {
674 // Use [\s\S] in place of . so multi-line matches work.
675 // Because JavaScript has no s (dotall) regex flag.
676 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
677 spans[i].innerHTML =
678 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
679 "' title='View footnote' class='footnote'>" + n + "</a>]";
680 spans[i].setAttribute("data-note", note);
681 }
Junio C Hamano7bd050f2011-09-22 06:32:22682 noteholder.innerHTML +=
683 "<div class='footnote' id='_footnote_" + n + "'>" +
684 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
685 n + "</a>. " + note + "</div>";
Junio C Hamano7bd050f2011-09-22 06:32:22686 var id =spans[i].getAttribute("id");
687 if (id != null) refs["#"+id] = n;
688 }
689 }
690 if (n == 0)
691 noteholder.parentNode.removeChild(noteholder);
692 else {
693 // Process footnoterefs.
694 for (i=0; i<spans.length; i++) {
695 if (spans[i].className == "footnoteref") {
696 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
697 href = href.match(/#.*/)[0]; // Because IE return full URL.
698 n = refs[href];
699 spans[i].innerHTML =
700 "[<a href='#_footnote_" + n +
701 "' title='View footnote' class='footnote'>" + n + "</a>]";
702 }
703 }
704 }
Junio C Hamano9d971152012-12-19 00:43:11705},
706
707install: function(toclevels) {
708 var timerId;
709
710 function reinstall() {
711 asciidoc.footnotes();
712 if (toclevels) {
713 asciidoc.toc(toclevels);
714 }
715 }
716
717 function reinstallAndRemoveTimer() {
718 clearInterval(timerId);
719 reinstall();
720 }
721
722 timerId = setInterval(reinstall, 500);
723 if (document.addEventListener)
724 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
725 else
726 window.onload = reinstallAndRemoveTimer;
Junio C Hamano7bd050f2011-09-22 06:32:22727}
728
729}
Junio C Hamano9d971152012-12-19 00:43:11730asciidoc.install();
Junio C Hamano7bd050f2011-09-22 06:32:22731/*]]>*/
732</script>
Junio C Hamano34b18112006-02-23 11:21:40733</head>
Junio C Hamano9d971152012-12-19 00:43:11734<body class="manpage">
Junio C Hamano34b18112006-02-23 11:21:40735<div id="header">
736<h1>
737git-cvsserver(1) Manual Page
738</h1>
739<h2>NAME</h2>
740<div class="sectionbody">
741<p>git-cvsserver -
Junio C Hamano076ffcc2013-02-06 05:13:21742 A CVS server emulator for Git
Junio C Hamano34b18112006-02-23 11:21:40743</p>
744</div>
745</div>
Junio C Hamano7bd050f2011-09-22 06:32:22746<div id="content">
Junio C Hamano9d971152012-12-19 00:43:11747<div class="sect1">
Junio C Hamano68cf15a2010-11-06 01:01:59748<h2 id="_synopsis">SYNOPSIS</h2>
Junio C Hamano34b18112006-02-23 11:21:40749<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59750<div class="paragraph"><p>SSH:</p></div>
Junio C Hamano34b18112006-02-23 11:21:40751<div class="verseblock">
Junio C Hamano9d971152012-12-19 00:43:11752<pre class="content">export CVS_SERVER="git cvsserver"
753<em>cvs</em> -d :ext:user@server/path/repo.git co &lt;HEAD_name&gt;</pre>
754<div class="attribution">
Junio C Hamano68cf15a2010-11-06 01:01:59755</div></div>
756<div class="paragraph"><p>pserver (/etc/inetd.conf):</p></div>
Junio C Hamano6926bef2007-06-16 09:54:05757<div class="verseblock">
Junio C Hamano9d971152012-12-19 00:43:11758<pre class="content">cvspserver stream tcp nowait nobody /usr/bin/git-cvsserver git-cvsserver pserver</pre>
759<div class="attribution">
Junio C Hamano68cf15a2010-11-06 01:01:59760</div></div>
761<div class="paragraph"><p>Usage:</p></div>
Junio C Hamano6926bef2007-06-16 09:54:05762<div class="verseblock">
Junio C Hamano9d971152012-12-19 00:43:11763<pre class="content"><em>git-cvsserver</em> [options] [pserver|server] [&lt;directory&gt; &#8230;]</pre>
764<div class="attribution">
Junio C Hamano68cf15a2010-11-06 01:01:59765</div></div>
Junio C Hamano6926bef2007-06-16 09:54:05766</div>
Junio C Hamano9d971152012-12-19 00:43:11767</div>
768<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31769<h2 id="_options">OPTIONS</h2>
Junio C Hamano6926bef2007-06-16 09:54:05770<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59771<div class="paragraph"><p>All these options obviously only make sense if enforced by the server side.
Junio C Hamanoa28a9202012-06-21 07:08:23772They have been implemented to resemble the <a href="git-daemon.html">git-daemon(1)</a> options as
Junio C Hamanoba4b9282008-07-06 05:20:31773closely as possible.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59774<div class="dlist"><dl>
775<dt class="hdlist1">
Junio C Hamano6926bef2007-06-16 09:54:05776--base-path &lt;path&gt;
777</dt>
778<dd>
779<p>
780Prepend <em>path</em> to requested CVSROOT
781</p>
782</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59783<dt class="hdlist1">
Junio C Hamano6926bef2007-06-16 09:54:05784--strict-paths
785</dt>
786<dd>
787<p>
Junio C Hamano68cf15a2010-11-06 01:01:59788Don&#8217;t allow recursing into subdirectories
Junio C Hamano6926bef2007-06-16 09:54:05789</p>
790</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59791<dt class="hdlist1">
Junio C Hamano6926bef2007-06-16 09:54:05792--export-all
793</dt>
794<dd>
795<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53796Don&#8217;t check for <code>gitcvs.enabled</code> in config. You also have to specify a list
Junio C Hamano6926bef2007-06-16 09:54:05797of allowed directories (see below) if you want to use this option.
798</p>
799</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59800<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47801-V
802</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59803<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47804--version
Junio C Hamano6926bef2007-06-16 09:54:05805</dt>
806<dd>
807<p>
808Print version information and exit
809</p>
810</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59811<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47812-h
813</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59814<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47815-H
816</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59817<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47818--help
Junio C Hamano6926bef2007-06-16 09:54:05819</dt>
820<dd>
821<p>
822Print usage information and exit
823</p>
824</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59825<dt class="hdlist1">
Junio C Hamano6926bef2007-06-16 09:54:05826&lt;directory&gt;
827</dt>
828<dd>
829<p>
830You can specify a list of allowed directories. If no directories
831are given, all are allowed. This is an additional restriction, gitcvs
Junio C Hamanoc14e6ad2014-10-31 20:25:53832access still needs to be enabled by the <code>gitcvs.enabled</code> config option
Junio C Hamano6926bef2007-06-16 09:54:05833unless <em>--export-all</em> was given, too.
834</p>
835</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31836</dl></div>
Junio C Hamano34b18112006-02-23 11:21:40837</div>
Junio C Hamano9d971152012-12-19 00:43:11838</div>
839<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31840<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano34b18112006-02-23 11:21:40841<div class="sectionbody">
Junio C Hamano076ffcc2013-02-06 05:13:21842<div class="paragraph"><p>This application is a CVS emulation layer for Git.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59843<div class="paragraph"><p>It is highly functional. However, not all methods are implemented,
Junio C Hamano34b18112006-02-23 11:21:40844and for those methods that are implemented,
Junio C Hamanoba4b9282008-07-06 05:20:31845not all switches are implemented.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59846<div class="paragraph"><p>Testing has been done using both the CLI CVS client, and the Eclipse CVS
Junio C Hamanoba4b9282008-07-06 05:20:31847plugin. Most functionality works fine with both of these clients.</p></div>
Junio C Hamano34b18112006-02-23 11:21:40848</div>
Junio C Hamano9d971152012-12-19 00:43:11849</div>
850<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31851<h2 id="_limitations">LIMITATIONS</h2>
Junio C Hamano34b18112006-02-23 11:21:40852<div class="sectionbody">
Junio C Hamano076ffcc2013-02-06 05:13:21853<div class="paragraph"><p>CVS clients cannot tag, branch or perform Git merges.</p></div>
854<div class="paragraph"><p><em>git-cvsserver</em> maps Git branches to CVS modules. This is very different
Junio C Hamanoa2ad99e2007-04-18 09:57:04855from what most CVS users would expect since in CVS modules usually represent
Junio C Hamanoba4b9282008-07-06 05:20:31856one or more directories.</p></div>
Junio C Hamano34b18112006-02-23 11:21:40857</div>
Junio C Hamano9d971152012-12-19 00:43:11858</div>
859<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31860<h2 id="_installation">INSTALLATION</h2>
Junio C Hamano34b18112006-02-23 11:21:40861<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59862<div class="olist arabic"><ol class="arabic">
Junio C Hamano34b18112006-02-23 11:21:40863<li>
864<p>
Junio C Hamanoa574a092010-06-13 19:57:10865If you are going to offer CVS access via pserver, add a line in
Junio C Hamanodecf50e2006-03-05 10:51:14866 /etc/inetd.conf like
Junio C Hamano34b18112006-02-23 11:21:40867</p>
Junio C Hamano9d971152012-12-19 00:43:11868<div class="openblock">
869<div class="content">
Junio C Hamanof1d14802006-06-08 00:48:17870<div class="listingblock">
Junio C Hamanodecf50e2006-03-05 10:51:14871<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53872<pre><code> cvspserver stream tcp nowait nobody git-cvsserver pserver</code></pre>
Junio C Hamanodecf50e2006-03-05 10:51:14873</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59874<div class="paragraph"><p>Note: Some inetd servers let you specify the name of the executable
Junio C Hamano591dc6a2007-05-29 09:18:19875independently of the value of argv[0] (i.e. the name the program assumes
876it was executed with). In this case the correct line in /etc/inetd.conf
Junio C Hamanoba4b9282008-07-06 05:20:31877looks like</p></div>
Junio C Hamanof1d14802006-06-08 00:48:17878<div class="listingblock">
Junio C Hamanodecf50e2006-03-05 10:51:14879<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53880<pre><code> cvspserver stream tcp nowait nobody /usr/bin/git-cvsserver git-cvsserver pserver</code></pre>
Junio C Hamanodecf50e2006-03-05 10:51:14881</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59882<div class="paragraph"><p>Only anonymous access is provided by pserve by default. To commit you
Junio C Hamanoa574a092010-06-13 19:57:10883will have to create pserver accounts, simply add a gitcvs.authdb
884setting in the config file of the repositories you want the cvsserver
885to allow writes to, for example:</p></div>
886<div class="listingblock">
887<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53888<pre><code> [gitcvs]
889 authdb = /etc/cvsserver/passwd</code></pre>
Junio C Hamanoa574a092010-06-13 19:57:10890</div></div>
Junio C Hamanofb5ffde2014-11-04 22:38:56891<div class="paragraph"><p>The format of these files is username followed by the encrypted password,
Junio C Hamanoa574a092010-06-13 19:57:10892for example:</p></div>
893<div class="listingblock">
894<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53895<pre><code> myuser:$1Oyx5r9mdGZ2
896 myuser:$1$BA)@$vbnMJMDym7tA32AamXrm./</code></pre>
Junio C Hamanoa574a092010-06-13 19:57:10897</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59898<div class="paragraph"><p>You can use the <em>htpasswd</em> facility that comes with Apache to make these
899files, but Apache&#8217;s MD5 crypt method differs from the one used by most C
900library&#8217;s crypt() function, so don&#8217;t use the -m option.</p></div>
901<div class="paragraph"><p>Alternatively you can produce the password with perl&#8217;s crypt() operator:</p></div>
Junio C Hamanoa574a092010-06-13 19:57:10902<div class="listingblock">
903<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53904<pre><code> perl -e 'my ($user, $pass) = @ARGV; printf "%s:%s\n", $user, crypt($user, $pass)' $USER password</code></pre>
Junio C Hamanoa574a092010-06-13 19:57:10905</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59906<div class="paragraph"><p>Then provide your password via the pserver method, for example:</p></div>
Junio C Hamanoa574a092010-06-13 19:57:10907<div class="listingblock">
908<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53909<pre><code> cvs -d:pserver:someuser:somepassword &lt;at&gt; server/path/repo.git co &lt;HEAD_name&gt;</code></pre>
Junio C Hamanoa574a092010-06-13 19:57:10910</div></div>
Junio C Hamano076ffcc2013-02-06 05:13:21911<div class="paragraph"><p>No special setup is needed for SSH access, other than having Git tools
Junio C Hamanodecf50e2006-03-05 10:51:14912in the PATH. If you have clients that do not accept the CVS_SERVER
Junio C Hamanoc14e6ad2014-10-31 20:25:53913environment variable, you can rename <em>git-cvsserver</em> to <code>cvs</code>.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59914<div class="paragraph"><p>Note: Newer CVS versions (&gt;= 1.12.11) also support specifying
Junio C Hamanoba4b9282008-07-06 05:20:31915CVS_SERVER directly in CVSROOT like</p></div>
Junio C Hamano591dc6a2007-05-29 09:18:19916<div class="listingblock">
917<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53918<pre><code>cvs -d ":ext;CVS_SERVER=git cvsserver:user@server/path/repo.git" co &lt;HEAD_name&gt;</code></pre>
Junio C Hamano591dc6a2007-05-29 09:18:19919</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59920<div class="paragraph"><p>This has the advantage that it will be saved in your <em>CVS/Root</em> files and
921you don&#8217;t need to worry about always setting the correct environment
922variable. SSH users restricted to <em>git-shell</em> don&#8217;t need to override the default
Junio C Hamanoc14e6ad2014-10-31 20:25:53923with CVS_SERVER (and shouldn&#8217;t) as <em>git-shell</em> understands <code>cvs</code> to mean
Junio C Hamanoba4b9282008-07-06 05:20:31924<em>git-cvsserver</em> and pretends that the other end runs the real <em>cvs</em> better.</p></div>
Junio C Hamano9d971152012-12-19 00:43:11925</div></div>
Junio C Hamano34b18112006-02-23 11:21:40926</li>
927<li>
928<p>
929For each repo that you want accessible from CVS you need to edit config in
930 the repo and add the following section.
931</p>
Junio C Hamano9d971152012-12-19 00:43:11932<div class="openblock">
933<div class="content">
Junio C Hamanof1d14802006-06-08 00:48:17934<div class="listingblock">
Junio C Hamano34b18112006-02-23 11:21:40935<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53936<pre><code> [gitcvs]
Junio C Hamanof1d14802006-06-08 00:48:17937 enabled=1
938 # optional for debugging
Junio C Hamano322c6242015-03-23 21:32:46939 logFile=/path/to/logfile</code></pre>
Junio C Hamano34b18112006-02-23 11:21:40940</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59941<div class="paragraph"><p>Note: you need to ensure each user that is going to invoke <em>git-cvsserver</em> has
Junio C Hamanoa2ad99e2007-04-18 09:57:04942write access to the log file and to the database (see
943<a href="#dbbackend">Database Backend</a>. If you want to offer write access over
Junio C Hamano076ffcc2013-02-06 05:13:21944SSH, the users of course also need write access to the Git repository itself.</p></div>
945<div class="paragraph"><p>You also need to ensure that each repository is "bare" (without a Git index
Junio C Hamanoc14e6ad2014-10-31 20:25:53946file) for <code>cvs commit</code> to work. See <a href="gitcvs-migration.html">gitcvs-migration(7)</a>.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59947<div class="paragraph" id="configaccessmethod"><p>All configuration variables can also be overridden for a specific method of
Junio C Hamanoa2ad99e2007-04-18 09:57:04948access. Valid method names are "ext" (for SSH access) and "pserver". The
949following example configuration would disable pserver access while still
Junio C Hamanoba4b9282008-07-06 05:20:31950allowing access over SSH.</p></div>
Junio C Hamanoa2ad99e2007-04-18 09:57:04951<div class="listingblock">
952<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53953<pre><code> [gitcvs]
Junio C Hamanoa2ad99e2007-04-18 09:57:04954 enabled=0
955
956 [gitcvs "ext"]
Junio C Hamanoc14e6ad2014-10-31 20:25:53957 enabled=1</code></pre>
Junio C Hamano9d971152012-12-19 00:43:11958</div></div>
Junio C Hamanoa2ad99e2007-04-18 09:57:04959</div></div>
Junio C Hamano34b18112006-02-23 11:21:40960</li>
961<li>
962<p>
Junio C Hamano68cf15a2010-11-06 01:01:59963If you didn&#8217;t specify the CVSROOT/CVS_SERVER directly in the checkout command,
Junio C Hamano33f98432008-04-16 09:10:05964 automatically saving it in your <em>CVS/Root</em> files, then you need to set them
965 explicitly in your environment. CVSROOT should be set as per normal, but the
Junio C Hamano076ffcc2013-02-06 05:13:21966 directory should point at the appropriate Git repo. As above, for SSH clients
Junio C Hamano68cf15a2010-11-06 01:01:59967 <em>not</em> restricted to <em>git-shell</em>, CVS_SERVER should be set to <em>git-cvsserver</em>.
Junio C Hamanodecf50e2006-03-05 10:51:14968</p>
Junio C Hamano9d971152012-12-19 00:43:11969<div class="openblock">
970<div class="content">
Junio C Hamanof1d14802006-06-08 00:48:17971<div class="listingblock">
Junio C Hamanodecf50e2006-03-05 10:51:14972<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53973<pre><code> export CVSROOT=:ext:user@server:/var/git/project.git
974 export CVS_SERVER="git cvsserver"</code></pre>
Junio C Hamano9d971152012-12-19 00:43:11975</div></div>
Junio C Hamanodecf50e2006-03-05 10:51:14976</div></div>
977</li>
978<li>
979<p>
Junio C Hamano33f98432008-04-16 09:10:05980For SSH clients that will make commits, make sure their server-side
981 .ssh/environment files (or .bashrc, etc., according to their specific shell)
982 export appropriate values for GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL,
983 GIT_COMMITTER_NAME, and GIT_COMMITTER_EMAIL. For SSH clients whose login
984 shell is bash, .bashrc may be a reasonable alternative.
Junio C Hamano34b18112006-02-23 11:21:40985</p>
986</li>
987<li>
988<p>
Junio C Hamanodecf50e2006-03-05 10:51:14989Clients should now be able to check out the project. Use the CVS <em>module</em>
Junio C Hamano076ffcc2013-02-06 05:13:21990 name to indicate what Git <em>head</em> you want to check out. This also sets the
Junio C Hamano33f98432008-04-16 09:10:05991 name of your newly checked-out directory, unless you tell it otherwise with
Junio C Hamanoc14e6ad2014-10-31 20:25:53992 <code>-d &lt;dir_name&gt;</code>. For example, this checks out <em>master</em> branch to the
993 <code>project-master</code> directory:
Junio C Hamano34b18112006-02-23 11:21:40994</p>
Junio C Hamanof1d14802006-06-08 00:48:17995<div class="listingblock">
Junio C Hamanodecf50e2006-03-05 10:51:14996<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53997<pre><code> cvs co -d project-master master</code></pre>
Junio C Hamanodecf50e2006-03-05 10:51:14998</div></div>
Junio C Hamano34b18112006-02-23 11:21:40999</li>
Junio C Hamanoba4b9282008-07-06 05:20:311000</ol></div>
Junio C Hamano34b18112006-02-23 11:21:401001</div>
Junio C Hamano9d971152012-12-19 00:43:111002</div>
1003<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:311004<h2 id="dbbackend">Database Backend</h2>
Junio C Hamanoa2ad99e2007-04-18 09:57:041005<div class="sectionbody">
Junio C Hamano076ffcc2013-02-06 05:13:211006<div class="paragraph"><p><em>git-cvsserver</em> uses one database per Git head (i.e. CVS module) to
Junio C Hamano9df0c662009-11-23 11:09:271007store information about the repository to maintain consistent
1008CVS revision numbers. The database needs to be
1009updated (i.e. written to) after every commit.</p></div>
Junio C Hamanoc14e6ad2014-10-31 20:25:531010<div class="paragraph"><p>If the commit is done directly by using <code>git</code> (as opposed to
Junio C Hamanoba4b9282008-07-06 05:20:311011using <em>git-cvsserver</em>) the update will need to happen on the
1012next repository access by <em>git-cvsserver</em>, independent of
1013access method and requested operation.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:591014<div class="paragraph"><p>That means that even if you offer only read access (e.g. by using
Junio C Hamanoba4b9282008-07-06 05:20:311015the pserver method), <em>git-cvsserver</em> should have write access to
Junio C Hamanoa2ad99e2007-04-18 09:57:041016the database to work reliably (otherwise you need to make sure
Junio C Hamanoba4b9282008-07-06 05:20:311017that the database is up-to-date any time <em>git-cvsserver</em> is executed).</p></div>
Junio C Hamano076ffcc2013-02-06 05:13:211018<div class="paragraph"><p>By default it uses SQLite databases in the Git directory, named
Junio C Hamanoc14e6ad2014-10-31 20:25:531019<code>gitcvs.&lt;module_name&gt;.sqlite</code>. Note that the SQLite backend creates
Junio C Hamanoa2ad99e2007-04-18 09:57:041020temporary files in the same directory as the database file on
1021write so it might not be enough to grant the users using
Junio C Hamanoba4b9282008-07-06 05:20:311022<em>git-cvsserver</em> write access to the database file without granting
1023them write access to the directory, too.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:591024<div class="paragraph"><p>The database can not be reliably regenerated in a
Junio C Hamano9df0c662009-11-23 11:09:271025consistent form after the branch it is tracking has changed.
1026Example: For merged branches, <em>git-cvsserver</em> only tracks
Junio C Hamano1aa40d22010-01-21 17:46:431027one branch of development, and after a <em>git merge</em> an
Junio C Hamano9df0c662009-11-23 11:09:271028incrementally updated database may track a different branch
1029than a database regenerated from scratch, causing inconsistent
Junio C Hamanoc14e6ad2014-10-31 20:25:531030CVS revision numbers. <code>git-cvsserver</code> has no way of knowing which
Junio C Hamano9df0c662009-11-23 11:09:271031branch it would have picked if it had been run incrementally
1032pre-merge. So if you have to fully or partially (from old
1033backup) regenerate the database, you should be suspicious
1034of pre-existing CVS sandboxes.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:591035<div class="paragraph"><p>You can configure the database backend with the following
Junio C Hamanoba4b9282008-07-06 05:20:311036configuration variables:</p></div>
Junio C Hamano9d971152012-12-19 00:43:111037<div class="sect2">
1038<h3 id="_configuring_database_backend">Configuring database backend</h3>
Junio C Hamano68cf15a2010-11-06 01:01:591039<div class="paragraph"><p><em>git-cvsserver</em> uses the Perl DBI module. Please also read
Junio C Hamanoa2ad99e2007-04-18 09:57:041040its documentation if changing these variables, especially
Junio C Hamanoc14e6ad2014-10-31 20:25:531041about <code>DBI-&gt;connect()</code>.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:591042<div class="dlist"><dl>
1043<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:461044gitcvs.dbName
Junio C Hamanoa2ad99e2007-04-18 09:57:041045</dt>
1046<dd>
1047<p>
1048 Database name. The exact meaning depends on the
Junio C Hamano1f511962008-01-30 08:28:521049 selected database driver, for SQLite this is a filename.
Junio C Hamanoa2ad99e2007-04-18 09:57:041050 Supports variable substitution (see below). May
Junio C Hamanoc14e6ad2014-10-31 20:25:531051 not contain semicolons (<code>;</code>).
Junio C Hamanoa2ad99e2007-04-18 09:57:041052 Default: <em>%Ggitcvs.%m.sqlite</em>
1053</p>
1054</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591055<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:461056gitcvs.dbDriver
Junio C Hamanoa2ad99e2007-04-18 09:57:041057</dt>
1058<dd>
1059<p>
1060 Used DBI driver. You can specify any available driver
1061 for this here, but it might not work. cvsserver is tested
1062 with <em>DBD::SQLite</em>, reported to work with
1063 <em>DBD::Pg</em>, and reported <strong>not</strong> to work with <em>DBD::mysql</em>.
1064 Please regard this as an experimental feature. May not
Junio C Hamanoc14e6ad2014-10-31 20:25:531065 contain colons (<code>:</code>).
Junio C Hamanoa2ad99e2007-04-18 09:57:041066 Default: <em>SQLite</em>
1067</p>
1068</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591069<dt class="hdlist1">
Junio C Hamanoa2ad99e2007-04-18 09:57:041070gitcvs.dbuser
1071</dt>
1072<dd>
1073<p>
Junio C Hamano322c6242015-03-23 21:32:461074 Database user. Only useful if setting <code>dbDriver</code>, since
Junio C Hamanoa2ad99e2007-04-18 09:57:041075 SQLite has no concept of database users. Supports variable
1076 substitution (see below).
1077</p>
1078</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591079<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:461080gitcvs.dbPass
Junio C Hamanoa2ad99e2007-04-18 09:57:041081</dt>
1082<dd>
1083<p>
Junio C Hamano322c6242015-03-23 21:32:461084 Database password. Only useful if setting <code>dbDriver</code>, since
Junio C Hamanoa2ad99e2007-04-18 09:57:041085 SQLite has no concept of database passwords.
1086</p>
1087</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591088<dt class="hdlist1">
Junio C Hamanoa74efce2008-04-02 08:39:081089gitcvs.dbTableNamePrefix
1090</dt>
1091<dd>
1092<p>
1093 Database table name prefix. Supports variable substitution
1094 (see below). Any non-alphabetic characters will be replaced
1095 with underscores.
1096</p>
1097</dd>
Junio C Hamanoba4b9282008-07-06 05:20:311098</dl></div>
Junio C Hamano68cf15a2010-11-06 01:01:591099<div class="paragraph"><p>All variables can also be set per access method, see <a href="#configaccessmethod">above</a>.</p></div>
Junio C Hamano9d971152012-12-19 00:43:111100<div class="sect3">
Junio C Hamanoba4b9282008-07-06 05:20:311101<h4 id="_variable_substitution">Variable substitution</h4>
Junio C Hamano322c6242015-03-23 21:32:461102<div class="paragraph"><p>In <code>dbDriver</code> and <code>dbUser</code> you can use the following variables:</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:591103<div class="dlist"><dl>
1104<dt class="hdlist1">
Junio C Hamanoa2ad99e2007-04-18 09:57:041105%G
1106</dt>
1107<dd>
1108<p>
Junio C Hamano076ffcc2013-02-06 05:13:211109 Git directory name
Junio C Hamanoa2ad99e2007-04-18 09:57:041110</p>
1111</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591112<dt class="hdlist1">
Junio C Hamanoa2ad99e2007-04-18 09:57:041113%g
1114</dt>
1115<dd>
1116<p>
Junio C Hamano076ffcc2013-02-06 05:13:211117 Git directory name, where all characters except for
Junio C Hamanoc14e6ad2014-10-31 20:25:531118 alpha-numeric ones, <code>.</code>, and <code>-</code> are replaced with
1119 <code>_</code> (this should make it easier to use the directory
Junio C Hamanoa2ad99e2007-04-18 09:57:041120 name in a filename if wanted)
1121</p>
1122</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591123<dt class="hdlist1">
Junio C Hamanoa2ad99e2007-04-18 09:57:041124%m
1125</dt>
1126<dd>
1127<p>
Junio C Hamano076ffcc2013-02-06 05:13:211128 CVS module/Git head name
Junio C Hamanoa2ad99e2007-04-18 09:57:041129</p>
1130</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591131<dt class="hdlist1">
Junio C Hamanoa2ad99e2007-04-18 09:57:041132%a
1133</dt>
1134<dd>
1135<p>
1136 access method (one of "ext" or "pserver")
1137</p>
1138</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591139<dt class="hdlist1">
Junio C Hamanoa2ad99e2007-04-18 09:57:041140%u
1141</dt>
1142<dd>
1143<p>
Junio C Hamanoba4b9282008-07-06 05:20:311144 Name of the user running <em>git-cvsserver</em>.
Junio C Hamanoa2ad99e2007-04-18 09:57:041145 If no name can be determined, the
1146 numeric uid is used.
1147</p>
1148</dd>
Junio C Hamanoba4b9282008-07-06 05:20:311149</dl></div>
Junio C Hamanoa2ad99e2007-04-18 09:57:041150</div>
Junio C Hamano9d971152012-12-19 00:43:111151</div>
1152</div>
1153</div>
1154<div class="sect1">
Junio C Hamanob141a922010-01-10 19:55:141155<h2 id="_environment">ENVIRONMENT</h2>
1156<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:591157<div class="paragraph"><p>These variables obviate the need for command-line options in some
Junio C Hamanob141a922010-01-10 19:55:141158circumstances, allowing easier restricted usage through git-shell.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:591159<div class="paragraph"><p>GIT_CVSSERVER_BASE_PATH takes the place of the argument to --base-path.</p></div>
1160<div class="paragraph"><p>GIT_CVSSERVER_ROOT specifies a single-directory whitelist. The
Junio C Hamanob141a922010-01-10 19:55:141161repository must still be configured to allow access through
1162git-cvsserver, as described above.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:591163<div class="paragraph"><p>When these environment variables are set, the corresponding
Junio C Hamanob141a922010-01-10 19:55:141164command-line arguments may not be used.</p></div>
1165</div>
Junio C Hamano9d971152012-12-19 00:43:111166</div>
1167<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:311168<h2 id="_eclipse_cvs_client_notes">Eclipse CVS Client Notes</h2>
Junio C Hamano9512fcf2006-03-01 12:05:141169<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:591170<div class="paragraph"><p>To get a checkout with the Eclipse CVS client:</p></div>
1171<div class="olist arabic"><ol class="arabic">
Junio C Hamano9512fcf2006-03-01 12:05:141172<li>
1173<p>
Junio C Hamano68cf15a2010-11-06 01:01:591174Select "Create a new project &#8594; From CVS checkout"
Junio C Hamano9512fcf2006-03-01 12:05:141175</p>
1176</li>
1177<li>
1178<p>
Junio C Hamanodecf50e2006-03-05 10:51:141179Create a new location. See the notes below for details on how to choose the
1180 right protocol.
Junio C Hamano9512fcf2006-03-01 12:05:141181</p>
1182</li>
1183<li>
1184<p>
Junio C Hamanodecf50e2006-03-05 10:51:141185Browse the <em>modules</em> available. It will give you a list of the heads in
1186 the repository. You will not be able to browse the tree from there. Only
1187 the heads.
Junio C Hamano9512fcf2006-03-01 12:05:141188</p>
1189</li>
1190<li>
1191<p>
Junio C Hamanodecf50e2006-03-05 10:51:141192Pick <em>HEAD</em> when it asks what branch/tag to check out. Untick the
1193 "launch commit wizard" to avoid committing the .project file.
Junio C Hamano9512fcf2006-03-01 12:05:141194</p>
1195</li>
Junio C Hamanoba4b9282008-07-06 05:20:311196</ol></div>
Junio C Hamano68cf15a2010-11-06 01:01:591197<div class="paragraph"><p>Protocol notes: If you are using anonymous access via pserver, just select that.
Junio C Hamanodecf50e2006-03-05 10:51:141198Those using SSH access should choose the <em>ext</em> protocol, and configure <em>ext</em>
Junio C Hamano68cf15a2010-11-06 01:01:591199access on the Preferences&#8594;Team&#8594;CVS&#8594;ExtConnection pane. Set CVS_SERVER to
Junio C Hamanoc14e6ad2014-10-31 20:25:531200"<code>git cvsserver</code>". Note that password support is not good when using <em>ext</em>,
Junio C Hamanoba4b9282008-07-06 05:20:311201you will definitely want to have SSH keys setup.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:591202<div class="paragraph"><p>Alternatively, you can just use the non-standard extssh protocol that Eclipse
Junio C Hamanodecf50e2006-03-05 10:51:141203offer. In that case CVS_SERVER is ignored, and you will have to replace
Junio C Hamanoc14e6ad2014-10-31 20:25:531204the cvs utility on the server with <em>git-cvsserver</em> or manipulate your <code>.bashrc</code>
Junio C Hamanoba4b9282008-07-06 05:20:311205so that calling <em>cvs</em> effectively calls <em>git-cvsserver</em>.</p></div>
Junio C Hamano9512fcf2006-03-01 12:05:141206</div>
Junio C Hamano9d971152012-12-19 00:43:111207</div>
1208<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:311209<h2 id="_clients_known_to_work">Clients known to work</h2>
Junio C Hamano9512fcf2006-03-01 12:05:141210<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:591211<div class="ulist"><ul>
Junio C Hamano103ad7f2007-03-14 11:19:261212<li>
1213<p>
1214CVS 1.12.9 on Debian
1215</p>
1216</li>
1217<li>
1218<p>
Junio C Hamano9512fcf2006-03-01 12:05:141219CVS 1.11.17 on MacOSX (from Fink package)
Junio C Hamano103ad7f2007-03-14 11:19:261220</p>
1221</li>
1222<li>
1223<p>
Junio C Hamano9512fcf2006-03-01 12:05:141224Eclipse 3.0, 3.1.2 on MacOSX (see Eclipse CVS Client Notes)
Junio C Hamano103ad7f2007-03-14 11:19:261225</p>
1226</li>
1227<li>
1228<p>
1229TortoiseCVS
1230</p>
1231</li>
Junio C Hamanoba4b9282008-07-06 05:20:311232</ul></div>
Junio C Hamano9512fcf2006-03-01 12:05:141233</div>
Junio C Hamano9d971152012-12-19 00:43:111234</div>
1235<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:311236<h2 id="_operations_supported">Operations supported</h2>
Junio C Hamano34b18112006-02-23 11:21:401237<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:591238<div class="paragraph"><p>All the operations required for normal use are supported, including
Junio C Hamano36d52292013-01-25 21:32:361239checkout, diff, status, update, log, add, remove, commit.</p></div>
1240<div class="paragraph"><p>Most CVS command arguments that read CVS tags or revision numbers
1241(typically -r) work, and also support any git refspec
1242(tag, branch, commit ID, etc).
1243However, CVS revision numbers for non-default branches are not well
1244emulated, and cvs log does not show tags or branches at
1245all. (Non-main-branch CVS revision numbers superficially resemble CVS
1246revision numbers, but they actually encode a git commit ID directly,
1247rather than represent the number of revisions since the branch point.)</p></div>
1248<div class="paragraph"><p>Note that there are two ways to checkout a particular branch.
1249As described elsewhere on this page, the "module" parameter
1250of cvs checkout is interpreted as a branch name, and it becomes
1251the main branch. It remains the main branch for a given sandbox
1252even if you temporarily make another branch sticky with
1253cvs update -r. Alternatively, the -r argument can indicate
1254some other branch to actually checkout, even though the module
1255is still the "main" branch. Tradeoffs (as currently
1256implemented): Each new "module" creates a new database on disk with
1257a history for the given module, and after the database is created,
1258operations against that main branch are fast. Or alternatively,
1259-r doesn&#8217;t take any extra disk space, but may be significantly slower for
1260many operations, like cvs update.</p></div>
1261<div class="paragraph"><p>If you want to refer to a git refspec that has characters that are
1262not allowed by CVS, you have two options. First, it may just work
1263to supply the git refspec directly to the appropriate CVS -r argument;
1264some CVS clients don&#8217;t seem to do much sanity checking of the argument.
1265Second, if that fails, you can use a special character escape mechanism
1266that only uses characters that are valid in CVS tags. A sequence
Junio C Hamanoc14e6ad2014-10-31 20:25:531267of 4 or 5 characters of the form (underscore (<code>"_"</code>), dash (<code>"-"</code>),
1268one or two characters, and dash (<code>"-"</code>)) can encode various characters based
1269on the one or two letters: <code>"s"</code> for slash (<code>"/"</code>), <code>"p"</code> for
1270period (<code>"."</code>), <code>"u"</code> for underscore (<code>"_"</code>), or two hexadecimal digits
Junio C Hamano36d52292013-01-25 21:32:361271for any byte value at all (typically an ASCII number, or perhaps a part
1272of a UTF-8 encoded character).</p></div>
1273<div class="paragraph"><p>Legacy monitoring operations are not supported (edit, watch and related).
Junio C Hamanoba4b9282008-07-06 05:20:311274Exports and tagging (tags and branches) are not supported at this stage.</p></div>
Junio C Hamano9d971152012-12-19 00:43:111275<div class="sect2">
1276<h3 id="_crlf_line_ending_conversions">CRLF Line Ending Conversions</h3>
Junio C Hamano68cf15a2010-11-06 01:01:591277<div class="paragraph"><p>By default the server leaves the <em>-k</em> mode blank for all files,
Junio C Hamano619596a2010-08-18 22:15:351278which causes the CVS client to treat them as a text files, subject
1279to end-of-line conversion on some platforms.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:591280<div class="paragraph"><p>You can make the server use the end-of-line conversion attributes to
Junio C Hamanoc14e6ad2014-10-31 20:25:531281set the <em>-k</em> modes for files by setting the <code>gitcvs.usecrlfattr</code>
Junio C Hamanoa28a9202012-06-21 07:08:231282config variable. See <a href="gitattributes.html">gitattributes(5)</a> for more information
Junio C Hamanobb88cf42010-06-21 15:23:551283about end-of-line conversion.</p></div>
Junio C Hamanoc14e6ad2014-10-31 20:25:531284<div class="paragraph"><p>Alternatively, if <code>gitcvs.usecrlfattr</code> config is not enabled
Junio C Hamanobb88cf42010-06-21 15:23:551285or the attributes do not allow automatic detection for a filename, then
Junio C Hamano322c6242015-03-23 21:32:461286the server uses the <code>gitcvs.allBinary</code> config for the default setting.
1287If <code>gitcvs.allBinary</code> is set, then file not otherwise
Junio C Hamanodfccbb02008-05-26 01:16:141288specified will default to <em>-kb</em> mode. Otherwise the <em>-k</em> mode
Junio C Hamano322c6242015-03-23 21:32:461289is left blank. But if <code>gitcvs.allBinary</code> is set to "guess", then
Junio C Hamanodfccbb02008-05-26 01:16:141290the correct <em>-k</em> mode will be guessed based on the contents of
Junio C Hamanoba4b9282008-07-06 05:20:311291the file.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:591292<div class="paragraph"><p>For best consistency with <em>cvs</em>, it is probably best to override the
Junio C Hamanoc14e6ad2014-10-31 20:25:531293defaults by setting <code>gitcvs.usecrlfattr</code> to true,
Junio C Hamano322c6242015-03-23 21:32:461294and <code>gitcvs.allBinary</code> to "guess".</p></div>
Junio C Hamano34b18112006-02-23 11:21:401295</div>
Junio C Hamano9d971152012-12-19 00:43:111296</div>
1297</div>
1298<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:311299<h2 id="_dependencies">Dependencies</h2>
Junio C Hamano34b18112006-02-23 11:21:401300<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:591301<div class="paragraph"><p><em>git-cvsserver</em> depends on DBD::SQLite.</p></div>
Junio C Hamano34b18112006-02-23 11:21:401302</div>
Junio C Hamano9d971152012-12-19 00:43:111303</div>
1304<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:311305<h2 id="_git">GIT</h2>
Junio C Hamano34b18112006-02-23 11:21:401306<div class="sectionbody">
Junio C Hamanoa28a9202012-06-21 07:08:231307<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano34b18112006-02-23 11:21:401308</div>
Junio C Hamano7bd050f2011-09-22 06:32:221309</div>
Junio C Hamano9d971152012-12-19 00:43:111310</div>
Junio C Hamano7bd050f2011-09-22 06:32:221311<div id="footnotes"><hr /></div>
Junio C Hamano34b18112006-02-23 11:21:401312<div id="footer">
1313<div id="footer-text">
Junio C Hamano322c6242015-03-23 21:32:461314Last updated 2015-03-23 14:31:16 PDT
Junio C Hamano34b18112006-02-23 11:21:401315</div>
1316</div>
1317</body>
1318</html>