gitremote-helpers.html

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
   3     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
   5 <head>
   6 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
   7 <meta name="generator" content="AsciiDoc 10.2.0" />
   8 <title>gitremote-helpers(7)</title>
   9 <style type="text/css">
  10 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
  11
  12 /* Default font. */
  13 body {
  14   font-family: Georgia,serif;
  15 }
  16
  17 /* Title font. */
  18 h1, h2, h3, h4, h5, h6,
  19 div.title, caption.title,
  20 thead, p.table.header,
  21 #toctitle,
  22 #author, #revnumber, #revdate, #revremark,
  23 #footer {
  24   font-family: Arial,Helvetica,sans-serif;
  25 }
  26
  27 body {
  28   margin: 1em 5% 1em 5%;
  29 }
  30
  31 a {
  32   color: blue;
  33   text-decoration: underline;
  34 }
  35 a:visited {
  36   color: fuchsia;
  37 }
  38
  39 em {
  40   font-style: italic;
  41   color: navy;
  42 }
  43
  44 strong {
  45   font-weight: bold;
  46   color: #083194;
  47 }
  48
  49 h1, h2, h3, h4, h5, h6 {
  50   color: #527bbd;
  51   margin-top: 1.2em;
  52   margin-bottom: 0.5em;
  53   line-height: 1.3;
  54 }
  55
  56 h1, h2, h3 {
  57   border-bottom: 2px solid silver;
  58 }
  59 h2 {
  60   padding-top: 0.5em;
  61 }
  62 h3 {
  63   float: left;
  64 }
  65 h3 + * {
  66   clear: left;
  67 }
  68 h5 {
  69   font-size: 1.0em;
  70 }
  71
  72 div.sectionbody {
  73   margin-left: 0;
  74 }
  75
  76 hr {
  77   border: 1px solid silver;
  78 }
  79
  80 p {
  81   margin-top: 0.5em;
  82   margin-bottom: 0.5em;
  83 }
  84
  85 ul, ol, li > p {
  86   margin-top: 0;
  87 }
  88 ul > li     { color: #aaa; }
  89 ul > li > * { color: black; }
  90
  91 .monospaced, code, pre {
  92   font-family: "Courier New", Courier, monospace;
  93   font-size: inherit;
  94   color: navy;
  95   padding: 0;
  96   margin: 0;
  97 }
  98 pre {
  99   white-space: pre-wrap;
 100 }
 101
 102 #author {
 103   color: #527bbd;
 104   font-weight: bold;
 105   font-size: 1.1em;
 106 }
 107 #email {
 108 }
 109 #revnumber, #revdate, #revremark {
 110 }
 111
 112 #footer {
 113   font-size: small;
 114   border-top: 2px solid silver;
 115   padding-top: 0.5em;
 116   margin-top: 4.0em;
 117 }
 118 #footer-text {
 119   float: left;
 120   padding-bottom: 0.5em;
 121 }
 122 #footer-badges {
 123   float: right;
 124   padding-bottom: 0.5em;
 125 }
 126
 127 #preamble {
 128   margin-top: 1.5em;
 129   margin-bottom: 1.5em;
 130 }
 131 div.imageblock, div.exampleblock, div.verseblock,
 132 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 133 div.admonitionblock {
 134   margin-top: 1.0em;
 135   margin-bottom: 1.5em;
 136 }
 137 div.admonitionblock {
 138   margin-top: 2.0em;
 139   margin-bottom: 2.0em;
 140   margin-right: 10%;
 141   color: #606060;
 142 }
 143
 144 div.content { /* Block element content. */
 145   padding: 0;
 146 }
 147
 148 /* Block element titles. */
 149 div.title, caption.title {
 150   color: #527bbd;
 151   font-weight: bold;
 152   text-align: left;
 153   margin-top: 1.0em;
 154   margin-bottom: 0.5em;
 155 }
 156 div.title + * {
 157   margin-top: 0;
 158 }
 159
 160 td div.title:first-child {
 161   margin-top: 0.0em;
 162 }
 163 div.content div.title:first-child {
 164   margin-top: 0.0em;
 165 }
 166 div.content + div.title {
 167   margin-top: 0.0em;
 168 }
 169
 170 div.sidebarblock > div.content {
 171   background: #ffffee;
 172   border: 1px solid #dddddd;
 173   border-left: 4px solid #f0f0f0;
 174   padding: 0.5em;
 175 }
 176
 177 div.listingblock > div.content {
 178   border: 1px solid #dddddd;
 179   border-left: 5px solid #f0f0f0;
 180   background: #f8f8f8;
 181   padding: 0.5em;
 182 }
 183
 184 div.quoteblock, div.verseblock {
 185   padding-left: 1.0em;
 186   margin-left: 1.0em;
 187   margin-right: 10%;
 188   border-left: 5px solid #f0f0f0;
 189   color: #888;
 190 }
 191
 192 div.quoteblock > div.attribution {
 193   padding-top: 0.5em;
 194   text-align: right;
 195 }
 196
 197 div.verseblock > pre.content {
 198   font-family: inherit;
 199   font-size: inherit;
 200 }
 201 div.verseblock > div.attribution {
 202   padding-top: 0.75em;
 203   text-align: left;
 204 }
 205 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
 206 div.verseblock + div.attribution {
 207   text-align: left;
 208 }
 209
 210 div.admonitionblock .icon {
 211   vertical-align: top;
 212   font-size: 1.1em;
 213   font-weight: bold;
 214   text-decoration: underline;
 215   color: #527bbd;
 216   padding-right: 0.5em;
 217 }
 218 div.admonitionblock td.content {
 219   padding-left: 0.5em;
 220   border-left: 3px solid #dddddd;
 221 }
 222
 223 div.exampleblock > div.content {
 224   border-left: 3px solid #dddddd;
 225   padding-left: 0.5em;
 226 }
 227
 228 div.imageblock div.content { padding-left: 0; }
 229 span.image img { border-style: none; vertical-align: text-bottom; }
 230 a.image:visited { color: white; }
 231
 232 dl {
 233   margin-top: 0.8em;
 234   margin-bottom: 0.8em;
 235 }
 236 dt {
 237   margin-top: 0.5em;
 238   margin-bottom: 0;
 239   font-style: normal;
 240   color: navy;
 241 }
 242 dd > *:first-child {
 243   margin-top: 0.1em;
 244 }
 245
 246 ul, ol {
 247     list-style-position: outside;
 248 }
 249 ol.arabic {
 250   list-style-type: decimal;
 251 }
 252 ol.loweralpha {
 253   list-style-type: lower-alpha;
 254 }
 255 ol.upperalpha {
 256   list-style-type: upper-alpha;
 257 }
 258 ol.lowerroman {
 259   list-style-type: lower-roman;
 260 }
 261 ol.upperroman {
 262   list-style-type: upper-roman;
 263 }
 264
 265 div.compact ul, div.compact ol,
 266 div.compact p, div.compact p,
 267 div.compact div, div.compact div {
 268   margin-top: 0.1em;
 269   margin-bottom: 0.1em;
 270 }
 271
 272 tfoot {
 273   font-weight: bold;
 274 }
 275 td > div.verse {
 276   white-space: pre;
 277 }
 278
 279 div.hdlist {
 280   margin-top: 0.8em;
 281   margin-bottom: 0.8em;
 282 }
 283 div.hdlist tr {
 284   padding-bottom: 15px;
 285 }
 286 dt.hdlist1.strong, td.hdlist1.strong {
 287   font-weight: bold;
 288 }
 289 td.hdlist1 {
 290   vertical-align: top;
 291   font-style: normal;
 292   padding-right: 0.8em;
 293   color: navy;
 294 }
 295 td.hdlist2 {
 296   vertical-align: top;
 297 }
 298 div.hdlist.compact tr {
 299   margin: 0;
 300   padding-bottom: 0;
 301 }
 302
 303 .comment {
 304   background: yellow;
 305 }
 306
 307 .footnote, .footnoteref {
 308   font-size: 0.8em;
 309 }
 310
 311 span.footnote, span.footnoteref {
 312   vertical-align: super;
 313 }
 314
 315 #footnotes {
 316   margin: 20px 0 20px 0;
 317   padding: 7px 0 0 0;
 318 }
 319
 320 #footnotes div.footnote {
 321   margin: 0 0 5px 0;
 322 }
 323
 324 #footnotes hr {
 325   border: none;
 326   border-top: 1px solid silver;
 327   height: 1px;
 328   text-align: left;
 329   margin-left: 0;
 330   width: 20%;
 331   min-width: 100px;
 332 }
 333
 334 div.colist td {
 335   padding-right: 0.5em;
 336   padding-bottom: 0.3em;
 337   vertical-align: top;
 338 }
 339 div.colist td img {
 340   margin-top: 0.3em;
 341 }
 342
 343 @media print {
 344   #footer-badges { display: none; }
 345 }
 346
 347 #toc {
 348   margin-bottom: 2.5em;
 349 }
 350
 351 #toctitle {
 352   color: #527bbd;
 353   font-size: 1.1em;
 354   font-weight: bold;
 355   margin-top: 1.0em;
 356   margin-bottom: 0.1em;
 357 }
 358
 359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 360   margin-top: 0;
 361   margin-bottom: 0;
 362 }
 363 div.toclevel2 {
 364   margin-left: 2em;
 365   font-size: 0.9em;
 366 }
 367 div.toclevel3 {
 368   margin-left: 4em;
 369   font-size: 0.9em;
 370 }
 371 div.toclevel4 {
 372   margin-left: 6em;
 373   font-size: 0.9em;
 374 }
 375
 376 span.aqua { color: aqua; }
 377 span.black { color: black; }
 378 span.blue { color: blue; }
 379 span.fuchsia { color: fuchsia; }
 380 span.gray { color: gray; }
 381 span.green { color: green; }
 382 span.lime { color: lime; }
 383 span.maroon { color: maroon; }
 384 span.navy { color: navy; }
 385 span.olive { color: olive; }
 386 span.purple { color: purple; }
 387 span.red { color: red; }
 388 span.silver { color: silver; }
 389 span.teal { color: teal; }
 390 span.white { color: white; }
 391 span.yellow { color: yellow; }
 392
 393 span.aqua-background { background: aqua; }
 394 span.black-background { background: black; }
 395 span.blue-background { background: blue; }
 396 span.fuchsia-background { background: fuchsia; }
 397 span.gray-background { background: gray; }
 398 span.green-background { background: green; }
 399 span.lime-background { background: lime; }
 400 span.maroon-background { background: maroon; }
 401 span.navy-background { background: navy; }
 402 span.olive-background { background: olive; }
 403 span.purple-background { background: purple; }
 404 span.red-background { background: red; }
 405 span.silver-background { background: silver; }
 406 span.teal-background { background: teal; }
 407 span.white-background { background: white; }
 408 span.yellow-background { background: yellow; }
 409
 410 span.big { font-size: 2em; }
 411 span.small { font-size: 0.6em; }
 412
 413 span.underline { text-decoration: underline; }
 414 span.overline { text-decoration: overline; }
 415 span.line-through { text-decoration: line-through; }
 416
 417 div.unbreakable { page-break-inside: avoid; }
 418
 419
 420 /*
 421  * xhtml11 specific
 422  *
 423  * */
 424
 425 div.tableblock {
 426   margin-top: 1.0em;
 427   margin-bottom: 1.5em;
 428 }
 429 div.tableblock > table {
 430   border: 3px solid #527bbd;
 431 }
 432 thead, p.table.header {
 433   font-weight: bold;
 434   color: #527bbd;
 435 }
 436 p.table {
 437   margin-top: 0;
 438 }
 439 /* Because the table frame attribute is overridden by CSS in most browsers. */
 440 div.tableblock > table[frame="void"] {
 441   border-style: none;
 442 }
 443 div.tableblock > table[frame="hsides"] {
 444   border-left-style: none;
 445   border-right-style: none;
 446 }
 447 div.tableblock > table[frame="vsides"] {
 448   border-top-style: none;
 449   border-bottom-style: none;
 450 }
 451
 452
 453 /*
 454  * html5 specific
 455  *
 456  * */
 457
 458 table.tableblock {
 459   margin-top: 1.0em;
 460   margin-bottom: 1.5em;
 461 }
 462 thead, p.tableblock.header {
 463   font-weight: bold;
 464   color: #527bbd;
 465 }
 466 p.tableblock {
 467   margin-top: 0;
 468 }
 469 table.tableblock {
 470   border-width: 3px;
 471   border-spacing: 0px;
 472   border-style: solid;
 473   border-color: #527bbd;
 474   border-collapse: collapse;
 475 }
 476 th.tableblock, td.tableblock {
 477   border-width: 1px;
 478   padding: 4px;
 479   border-style: solid;
 480   border-color: #527bbd;
 481 }
 482
 483 table.tableblock.frame-topbot {
 484   border-left-style: hidden;
 485   border-right-style: hidden;
 486 }
 487 table.tableblock.frame-sides {
 488   border-top-style: hidden;
 489   border-bottom-style: hidden;
 490 }
 491 table.tableblock.frame-none {
 492   border-style: hidden;
 493 }
 494
 495 th.tableblock.halign-left, td.tableblock.halign-left {
 496   text-align: left;
 497 }
 498 th.tableblock.halign-center, td.tableblock.halign-center {
 499   text-align: center;
 500 }
 501 th.tableblock.halign-right, td.tableblock.halign-right {
 502   text-align: right;
 503 }
 504
 505 th.tableblock.valign-top, td.tableblock.valign-top {
 506   vertical-align: top;
 507 }
 508 th.tableblock.valign-middle, td.tableblock.valign-middle {
 509   vertical-align: middle;
 510 }
 511 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
 512   vertical-align: bottom;
 513 }
 514
 515
 516 /*
 517  * manpage specific
 518  *
 519  * */
 520
 521 body.manpage h1 {
 522   padding-top: 0.5em;
 523   padding-bottom: 0.5em;
 524   border-top: 2px solid silver;
 525   border-bottom: 2px solid silver;
 526 }
 527 body.manpage h2 {
 528   border-style: none;
 529 }
 530 body.manpage div.sectionbody {
 531   margin-left: 3em;
 532 }
 533
 534 @media print {
 535   body.manpage div#toc { display: none; }
 536 }
 537
 538
 539 </style>
 540 <script type="text/javascript">
 541 /*<![CDATA[*/
 542 var asciidoc = {  // Namespace.
 543
 544 /////////////////////////////////////////////////////////////////////
 545 // Table Of Contents generator
 546 /////////////////////////////////////////////////////////////////////
 547
 548 /* Author: Mihai Bazon, September 2002
 549  * http://students.infoiasi.ro/~mishoo
 550  *
 551  * Table Of Content generator
 552  * Version: 0.4
 553  *
 554  * Feel free to use this script under the terms of the GNU General Public
 555  * License, as long as you do not remove or alter this notice.
 556  */
 557
 558  /* modified by Troy D. Hanson, September 2006. License: GPL */
 559  /* modified by Stuart Rackham, 2006, 2009. License: GPL */
 560
 561 // toclevels = 1..4.
 562 toc: function (toclevels) {
 563
 564   function getText(el) {
 565     var text = "";
 566     for (var i = el.firstChild; i != null; i = i.nextSibling) {
 567       if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
 568         text += i.data;
 569       else if (i.firstChild != null)
 570         text += getText(i);
 571     }
 572     return text;
 573   }
 574
 575   function TocEntry(el, text, toclevel) {
 576     this.element = el;
 577     this.text = text;
 578     this.toclevel = toclevel;
 579   }
 580
 581   function tocEntries(el, toclevels) {
 582     var result = new Array;
 583     var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
 584     // Function that scans the DOM tree for header elements (the DOM2
 585     // nodeIterator API would be a better technique but not supported by all
 586     // browsers).
 587     var iterate = function (el) {
 588       for (var i = el.firstChild; i != null; i = i.nextSibling) {
 589         if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
 590           var mo = re.exec(i.tagName);
 591           if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
 592             result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
 593           }
 594           iterate(i);
 595         }
 596       }
 597     }
 598     iterate(el);
 599     return result;
 600   }
 601
 602   var toc = document.getElementById("toc");
 603   if (!toc) {
 604     return;
 605   }
 606
 607   // Delete existing TOC entries in case we're reloading the TOC.
 608   var tocEntriesToRemove = [];
 609   var i;
 610   for (i = 0; i < toc.childNodes.length; i++) {
 611     var entry = toc.childNodes[i];
 612     if (entry.nodeName.toLowerCase() == 'div'
 613      && entry.getAttribute("class")
 614      && entry.getAttribute("class").match(/^toclevel/))
 615       tocEntriesToRemove.push(entry);
 616   }
 617   for (i = 0; i < tocEntriesToRemove.length; i++) {
 618     toc.removeChild(tocEntriesToRemove[i]);
 619   }
 620
 621   // Rebuild TOC entries.
 622   var entries = tocEntries(document.getElementById("content"), toclevels);
 623   for (var i = 0; i < entries.length; ++i) {
 624     var entry = entries[i];
 625     if (entry.element.id == "")
 626       entry.element.id = "_toc_" + i;
 627     var a = document.createElement("a");
 628     a.href = "#" + entry.element.id;
 629     a.appendChild(document.createTextNode(entry.text));
 630     var div = document.createElement("div");
 631     div.appendChild(a);
 632     div.className = "toclevel" + entry.toclevel;
 633     toc.appendChild(div);
 634   }
 635   if (entries.length == 0)
 636     toc.parentNode.removeChild(toc);
 637 },
 638
 639
 640 /////////////////////////////////////////////////////////////////////
 641 // Footnotes generator
 642 /////////////////////////////////////////////////////////////////////
 643
 644 /* Based on footnote generation code from:
 645  * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
 646  */
 647
 648 footnotes: function () {
 649   // Delete existing footnote entries in case we're reloading the footnodes.
 650   var i;
 651   var noteholder = document.getElementById("footnotes");
 652   if (!noteholder) {
 653     return;
 654   }
 655   var entriesToRemove = [];
 656   for (i = 0; i < noteholder.childNodes.length; i++) {
 657     var entry = noteholder.childNodes[i];
 658     if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
 659       entriesToRemove.push(entry);
 660   }
 661   for (i = 0; i < entriesToRemove.length; i++) {
 662     noteholder.removeChild(entriesToRemove[i]);
 663   }
 664
 665   // Rebuild footnote entries.
 666   var cont = document.getElementById("content");
 667   var spans = cont.getElementsByTagName("span");
 668   var refs = {};
 669   var n = 0;
 670   for (i=0; i<spans.length; i++) {
 671     if (spans[i].className == "footnote") {
 672       n++;
 673       var note = spans[i].getAttribute("data-note");
 674       if (!note) {
 675         // Use [\s\S] in place of . so multi-line matches work.
 676         // Because JavaScript has no s (dotall) regex flag.
 677         note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
 678         spans[i].innerHTML =
 679           "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
 680           "' title='View footnote' class='footnote'>" + n + "</a>]";
 681         spans[i].setAttribute("data-note", note);
 682       }
 683       noteholder.innerHTML +=
 684         "<div class='footnote' id='_footnote_" + n + "'>" +
 685         "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
 686         n + "</a>. " + note + "</div>";
 687       var id =spans[i].getAttribute("id");
 688       if (id != null) refs["#"+id] = n;
 689     }
 690   }
 691   if (n == 0)
 692     noteholder.parentNode.removeChild(noteholder);
 693   else {
 694     // Process footnoterefs.
 695     for (i=0; i<spans.length; i++) {
 696       if (spans[i].className == "footnoteref") {
 697         var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
 698         href = href.match(/#.*/)[0];  // Because IE return full URL.
 699         n = refs[href];
 700         spans[i].innerHTML =
 701           "[<a href='#_footnote_" + n +
 702           "' title='View footnote' class='footnote'>" + n + "</a>]";
 703       }
 704     }
 705   }
 706 },
 707
 708 install: function(toclevels) {
 709   var timerId;
 710
 711   function reinstall() {
 712     asciidoc.footnotes();
 713     if (toclevels) {
 714       asciidoc.toc(toclevels);
 715     }
 716   }
 717
 718   function reinstallAndRemoveTimer() {
 719     clearInterval(timerId);
 720     reinstall();
 721   }
 722
 723   timerId = setInterval(reinstall, 500);
 724   if (document.addEventListener)
 725     document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
 726   else
 727     window.onload = reinstallAndRemoveTimer;
 728 }
 729
 730 }
 731 asciidoc.install();
 732 /*]]>*/
 733 </script>
 734 </head>
 735 <body class="manpage">
 736 <div id="header">
 737 <h1>
 738 gitremote-helpers(7) Manual Page
 739 </h1>
 740 <h2>NAME</h2>
 741 <div class="sectionbody">
 742 <p>gitremote-helpers -
 743    Helper programs to interact with remote repositories
 744 </p>
 745 </div>
 746 </div>
 747 <div id="content">
 748 <div class="sect1">
 749 <h2 id="_synopsis">SYNOPSIS</h2>
 750 <div class="sectionbody">
 751 <div class="verseblock">
 752 <pre class="content"><em>git remote-&lt;transport&gt;</em> &lt;repository&gt; [&lt;URL&gt;]</pre>
 753 <div class="attribution">
 754 </div></div>
 755 </div>
 756 </div>
 757 <div class="sect1">
 758 <h2 id="_description">DESCRIPTION</h2>
 759 <div class="sectionbody">
 760 <div class="paragraph"><p>Remote helper programs are normally not used directly by end users,
 761 but they are invoked by Git when it needs to interact with remote
 762 repositories Git does not support natively.  A given helper will
 763 implement a subset of the capabilities documented here. When Git
 764 needs to interact with a repository using a remote helper, it spawns
 765 the helper as an independent process, sends commands to the helper&#8217;s
 766 standard input, and expects results from the helper&#8217;s standard
 767 output. Because a remote helper runs as an independent process from
 768 Git, there is no need to re-link Git to add a new helper, nor any
 769 need to link the helper with the implementation of Git.</p></div>
 770 <div class="paragraph"><p>Every helper must support the "capabilities" command, which Git
 771 uses to determine what other commands the helper will accept.  Those
 772 other commands can be used to discover and update remote refs,
 773 transport objects between the object database and the remote repository,
 774 and update the local object store.</p></div>
 775 <div class="paragraph"><p>Git comes with a "curl" family of remote helpers, that handle various
 776 transport protocols, such as <em>git-remote-http</em>, <em>git-remote-https</em>,
 777 <em>git-remote-ftp</em> and <em>git-remote-ftps</em>. They implement the capabilities
 778 <em>fetch</em>, <em>option</em>, and <em>push</em>.</p></div>
 779 </div>
 780 </div>
 781 <div class="sect1">
 782 <h2 id="_invocation">INVOCATION</h2>
 783 <div class="sectionbody">
 784 <div class="paragraph"><p>Remote helper programs are invoked with one or (optionally) two
 785 arguments. The first argument specifies a remote repository as in Git;
 786 it is either the name of a configured remote or a URL. The second
 787 argument specifies a URL; it is usually of the form
 788 <em>&lt;transport&gt;://&lt;address&gt;</em>, but any arbitrary string is possible.
 789 The <code>GIT_DIR</code> environment variable is set up for the remote helper
 790 and can be used to determine where to store additional data or from
 791 which directory to invoke auxiliary Git commands.</p></div>
 792 <div class="paragraph"><p>When Git encounters a URL of the form <em>&lt;transport&gt;://&lt;address&gt;</em>, where
 793 <em>&lt;transport&gt;</em> is a protocol that it cannot handle natively, it
 794 automatically invokes <em>git remote-&lt;transport&gt;</em> with the full URL as
 795 the second argument. If such a URL is encountered directly on the
 796 command line, the first argument is the same as the second, and if it
 797 is encountered in a configured remote, the first argument is the name
 798 of that remote.</p></div>
 799 <div class="paragraph"><p>A URL of the form <em>&lt;transport&gt;::&lt;address&gt;</em> explicitly instructs Git to
 800 invoke <em>git remote-&lt;transport&gt;</em> with <em>&lt;address&gt;</em> as the second
 801 argument. If such a URL is encountered directly on the command line,
 802 the first argument is <em>&lt;address&gt;</em>, and if it is encountered in a
 803 configured remote, the first argument is the name of that remote.</p></div>
 804 <div class="paragraph"><p>Additionally, when a configured remote has <code>remote.&lt;name&gt;.vcs</code> set to
 805 <em>&lt;transport&gt;</em>, Git explicitly invokes <em>git remote-&lt;transport&gt;</em> with
 806 <em>&lt;name&gt;</em> as the first argument. If set, the second argument is
 807 <code>remote.&lt;name&gt;.url</code>; otherwise, the second argument is omitted.</p></div>
 808 </div>
 809 </div>
 810 <div class="sect1">
 811 <h2 id="_input_format">INPUT FORMAT</h2>
 812 <div class="sectionbody">
 813 <div class="paragraph"><p>Git sends the remote helper a list of commands on standard input, one
 814 per line.  The first command is always the <em>capabilities</em> command, in
 815 response to which the remote helper must print a list of the
 816 capabilities it supports (see below) followed by a blank line.  The
 817 response to the capabilities command determines what commands Git uses
 818 in the remainder of the command stream.</p></div>
 819 <div class="paragraph"><p>The command stream is terminated by a blank line.  In some cases
 820 (indicated in the documentation of the relevant commands), this blank
 821 line is followed by a payload in some other protocol (e.g., the pack
 822 protocol), while in others it indicates the end of input.</p></div>
 823 <div class="sect2">
 824 <h3 id="_capabilities">Capabilities</h3>
 825 <div class="paragraph"><p>Each remote helper is expected to support only a subset of commands.
 826 The operations a helper supports are declared to Git in the response
 827 to the <code>capabilities</code> command (see COMMANDS, below).</p></div>
 828 <div class="paragraph"><p>In the following, we list all defined capabilities and for
 829 each we list which commands a helper with that capability
 830 must provide.</p></div>
 831 <div class="sect3">
 832 <h4 id="_capabilities_for_pushing">Capabilities for Pushing</h4>
 833 <div class="dlist"><dl>
 834 <dt class="hdlist1">
 835 <em>connect</em>
 836 </dt>
 837 <dd>
 838 <p>
 839         Can attempt to connect to <em>git receive-pack</em> (for pushing),
 840         <em>git upload-pack</em>, etc for communication using
 841         git&#8217;s native packfile protocol. This
 842         requires a bidirectional, full-duplex connection.
 843 </p>
 844 <div class="paragraph"><p>Supported commands: <em>connect</em>.</p></div>
 845 </dd>
 846 <dt class="hdlist1">
 847 <em>stateless-connect</em>
 848 </dt>
 849 <dd>
 850 <p>
 851         Experimental; for internal use only.
 852         Can attempt to connect to a remote server for communication
 853         using git&#8217;s wire-protocol version 2.  See the documentation
 854         for the stateless-connect command for more information.
 855 </p>
 856 <div class="paragraph"><p>Supported commands: <em>stateless-connect</em>.</p></div>
 857 </dd>
 858 <dt class="hdlist1">
 859 <em>push</em>
 860 </dt>
 861 <dd>
 862 <p>
 863         Can discover remote refs and push local commits and the
 864         history leading up to them to new or existing remote refs.
 865 </p>
 866 <div class="paragraph"><p>Supported commands: <em>list for-push</em>, <em>push</em>.</p></div>
 867 </dd>
 868 <dt class="hdlist1">
 869 <em>export</em>
 870 </dt>
 871 <dd>
 872 <p>
 873         Can discover remote refs and push specified objects from a
 874         fast-import stream to remote refs.
 875 </p>
 876 <div class="paragraph"><p>Supported commands: <em>list for-push</em>, <em>export</em>.</p></div>
 877 </dd>
 878 </dl></div>
 879 <div class="paragraph"><p>If a helper advertises <em>connect</em>, Git will use it if possible and
 880 fall back to another capability if the helper requests so when
 881 connecting (see the <em>connect</em> command under COMMANDS).
 882 When choosing between <em>push</em> and <em>export</em>, Git prefers <em>push</em>.
 883 Other frontends may have some other order of preference.</p></div>
 884 <div class="dlist"><dl>
 885 <dt class="hdlist1">
 886 <em>no-private-update</em>
 887 </dt>
 888 <dd>
 889 <p>
 890         When using the <em>refspec</em> capability, git normally updates the
 891         private ref on successful push. This update is disabled when
 892         the remote-helper declares the capability <em>no-private-update</em>.
 893 </p>
 894 </dd>
 895 </dl></div>
 896 </div>
 897 <div class="sect3">
 898 <h4 id="_capabilities_for_fetching">Capabilities for Fetching</h4>
 899 <div class="dlist"><dl>
 900 <dt class="hdlist1">
 901 <em>connect</em>
 902 </dt>
 903 <dd>
 904 <p>
 905         Can try to connect to <em>git upload-pack</em> (for fetching),
 906         <em>git receive-pack</em>, etc for communication using the
 907         Git&#8217;s native packfile protocol. This
 908         requires a bidirectional, full-duplex connection.
 909 </p>
 910 <div class="paragraph"><p>Supported commands: <em>connect</em>.</p></div>
 911 </dd>
 912 <dt class="hdlist1">
 913 <em>stateless-connect</em>
 914 </dt>
 915 <dd>
 916 <p>
 917         Experimental; for internal use only.
 918         Can attempt to connect to a remote server for communication
 919         using git&#8217;s wire-protocol version 2.  See the documentation
 920         for the stateless-connect command for more information.
 921 </p>
 922 <div class="paragraph"><p>Supported commands: <em>stateless-connect</em>.</p></div>
 923 </dd>
 924 <dt class="hdlist1">
 925 <em>fetch</em>
 926 </dt>
 927 <dd>
 928 <p>
 929         Can discover remote refs and transfer objects reachable from
 930         them to the local object store.
 931 </p>
 932 <div class="paragraph"><p>Supported commands: <em>list</em>, <em>fetch</em>.</p></div>
 933 </dd>
 934 <dt class="hdlist1">
 935 <em>import</em>
 936 </dt>
 937 <dd>
 938 <p>
 939         Can discover remote refs and output objects reachable from
 940         them as a stream in fast-import format.
 941 </p>
 942 <div class="paragraph"><p>Supported commands: <em>list</em>, <em>import</em>.</p></div>
 943 </dd>
 944 <dt class="hdlist1">
 945 <em>check-connectivity</em>
 946 </dt>
 947 <dd>
 948 <p>
 949         Can guarantee that when a clone is requested, the received
 950         pack is self contained and is connected.
 951 </p>
 952 </dd>
 953 <dt class="hdlist1">
 954 <em>get</em>
 955 </dt>
 956 <dd>
 957 <p>
 958         Can use the <em>get</em> command to download a file from a given URI.
 959 </p>
 960 </dd>
 961 </dl></div>
 962 <div class="paragraph"><p>If a helper advertises <em>connect</em>, Git will use it if possible and
 963 fall back to another capability if the helper requests so when
 964 connecting (see the <em>connect</em> command under COMMANDS).
 965 When choosing between <em>fetch</em> and <em>import</em>, Git prefers <em>fetch</em>.
 966 Other frontends may have some other order of preference.</p></div>
 967 </div>
 968 <div class="sect3">
 969 <h4 id="_miscellaneous_capabilities">Miscellaneous capabilities</h4>
 970 <div class="dlist"><dl>
 971 <dt class="hdlist1">
 972 <em>option</em>
 973 </dt>
 974 <dd>
 975 <p>
 976         For specifying settings like <code>verbosity</code> (how much output to
 977         write to stderr) and <code>depth</code> (how much history is wanted in the
 978         case of a shallow clone) that affect how other commands are
 979         carried out.
 980 </p>
 981 </dd>
 982 <dt class="hdlist1">
 983 <em>refspec</em> &lt;refspec&gt;
 984 </dt>
 985 <dd>
 986 <p>
 987         For remote helpers that implement <em>import</em> or <em>export</em>, this capability
 988         allows the refs to be constrained to a private namespace, instead of
 989         writing to refs/heads or refs/remotes directly.
 990         It is recommended that all importers providing the <em>import</em>
 991         capability use this. It&#8217;s mandatory for <em>export</em>.
 992 </p>
 993 <div class="paragraph"><p>A helper advertising the capability
 994 <code>refspec refs/heads/*:refs/svn/origin/branches/*</code>
 995 is saying that, when it is asked to <code>import refs/heads/topic</code>, the
 996 stream it outputs will update the <code>refs/svn/origin/branches/topic</code>
 997 ref.</p></div>
 998 <div class="paragraph"><p>This capability can be advertised multiple times.  The first
 999 applicable refspec takes precedence.  The left-hand of refspecs
1000 advertised with this capability must cover all refs reported by
1001 the list command.  If no <em>refspec</em> capability is advertised,
1002 there is an implied <code>refspec *:*</code>.</p></div>
1003 <div class="paragraph"><p>When writing remote-helpers for decentralized version control
1004 systems, it is advised to keep a local copy of the repository to
1005 interact with, and to let the private namespace refs point to this
1006 local repository, while the refs/remotes namespace is used to track
1007 the remote repository.</p></div>
1008 </dd>
1009 <dt class="hdlist1">
1010 <em>bidi-import</em>
1011 </dt>
1012 <dd>
1013 <p>
1014         This modifies the <em>import</em> capability.
1015         The fast-import commands <em>cat-blob</em> and <em>ls</em> can be used by remote-helpers
1016         to retrieve information about blobs and trees that already exist in
1017         fast-import&#8217;s memory. This requires a channel from fast-import to the
1018         remote-helper.
1019         If it is advertised in addition to "import", Git establishes a pipe from
1020         fast-import to the remote-helper&#8217;s stdin.
1021         It follows that Git and fast-import are both connected to the
1022         remote-helper&#8217;s stdin. Because Git can send multiple commands to
1023         the remote-helper it is required that helpers that use <em>bidi-import</em>
1024         buffer all <em>import</em> commands of a batch before sending data to fast-import.
1025         This is to prevent mixing commands and fast-import responses on the
1026         helper&#8217;s stdin.
1027 </p>
1028 </dd>
1029 <dt class="hdlist1">
1030 <em>export-marks</em> &lt;file&gt;
1031 </dt>
1032 <dd>
1033 <p>
1034         This modifies the <em>export</em> capability, instructing Git to dump the
1035         internal marks table to &lt;file&gt; when complete. For details,
1036         read up on <code>--export-marks=&lt;file&gt;</code> in <a href="git-fast-export.html">git-fast-export(1)</a>.
1037 </p>
1038 </dd>
1039 <dt class="hdlist1">
1040 <em>import-marks</em> &lt;file&gt;
1041 </dt>
1042 <dd>
1043 <p>
1044         This modifies the <em>export</em> capability, instructing Git to load the
1045         marks specified in &lt;file&gt; before processing any input. For details,
1046         read up on <code>--import-marks=&lt;file&gt;</code> in <a href="git-fast-export.html">git-fast-export(1)</a>.
1047 </p>
1048 </dd>
1049 <dt class="hdlist1">
1050 <em>signed-tags</em>
1051 </dt>
1052 <dd>
1053 <p>
1054         This modifies the <em>export</em> capability, instructing Git to pass
1055         <code>--signed-tags=verbatim</code> to <a href="git-fast-export.html">git-fast-export(1)</a>.  In the
1056         absence of this capability, Git will use <code>--signed-tags=warn-strip</code>.
1057 </p>
1058 </dd>
1059 <dt class="hdlist1">
1060 <em>object-format</em>
1061 </dt>
1062 <dd>
1063 <p>
1064         This indicates that the helper is able to interact with the remote
1065         side using an explicit hash algorithm extension.
1066 </p>
1067 </dd>
1068 </dl></div>
1069 </div>
1070 </div>
1071 </div>
1072 </div>
1073 <div class="sect1">
1074 <h2 id="_commands">COMMANDS</h2>
1075 <div class="sectionbody">
1076 <div class="paragraph"><p>Commands are given by the caller on the helper&#8217;s standard input, one per line.</p></div>
1077 <div class="dlist"><dl>
1078 <dt class="hdlist1">
1079 <em>capabilities</em>
1080 </dt>
1081 <dd>
1082 <p>
1083         Lists the capabilities of the helper, one per line, ending
1084         with a blank line. Each capability may be preceded with <em>*</em>,
1085         which marks them mandatory for Git versions using the remote
1086         helper to understand. Any unknown mandatory capability is a
1087         fatal error.
1088 </p>
1089 <div class="paragraph"><p>Support for this command is mandatory.</p></div>
1090 </dd>
1091 <dt class="hdlist1">
1092 <em>list</em>
1093 </dt>
1094 <dd>
1095 <p>
1096         Lists the refs, one per line, in the format "&lt;value&gt; &lt;name&gt;
1097         [&lt;attr&gt; &#8230;]". The value may be a hex sha1 hash, "@&lt;dest&gt;" for
1098         a symref, ":&lt;keyword&gt; &lt;value&gt;" for a key-value pair, or
1099         "?" to indicate that the helper could not get the value of the
1100         ref. A space-separated list of attributes follows the name;
1101         unrecognized attributes are ignored. The list ends with a
1102         blank line.
1103 </p>
1104 <div class="paragraph"><p>See REF LIST ATTRIBUTES for a list of currently defined attributes.
1105 See REF LIST KEYWORDS for a list of currently defined keywords.</p></div>
1106 <div class="paragraph"><p>Supported if the helper has the "fetch" or "import" capability.</p></div>
1107 </dd>
1108 <dt class="hdlist1">
1109 <em>list for-push</em>
1110 </dt>
1111 <dd>
1112 <p>
1113         Similar to <em>list</em>, except that it is used if and only if
1114         the caller wants to the resulting ref list to prepare
1115         push commands.
1116         A helper supporting both push and fetch can use this
1117         to distinguish for which operation the output of <em>list</em>
1118         is going to be used, possibly reducing the amount
1119         of work that needs to be performed.
1120 </p>
1121 <div class="paragraph"><p>Supported if the helper has the "push" or "export" capability.</p></div>
1122 </dd>
1123 <dt class="hdlist1">
1124 <em>option</em> &lt;name&gt; &lt;value&gt;
1125 </dt>
1126 <dd>
1127 <p>
1128         Sets the transport helper option &lt;name&gt; to &lt;value&gt;.  Outputs a
1129         single line containing one of <em>ok</em> (option successfully set),
1130         <em>unsupported</em> (option not recognized) or <em>error &lt;msg&gt;</em>
1131         (option &lt;name&gt; is supported but &lt;value&gt; is not valid
1132         for it).  Options should be set before other commands,
1133         and may influence the behavior of those commands.
1134 </p>
1135 <div class="paragraph"><p>See OPTIONS for a list of currently defined options.</p></div>
1136 <div class="paragraph"><p>Supported if the helper has the "option" capability.</p></div>
1137 </dd>
1138 <dt class="hdlist1">
1139 <em>fetch</em> &lt;sha1&gt; &lt;name&gt;
1140 </dt>
1141 <dd>
1142 <p>
1143         Fetches the given object, writing the necessary objects
1144         to the database.  Fetch commands are sent in a batch, one
1145         per line, terminated with a blank line.
1146         Outputs a single blank line when all fetch commands in the
1147         same batch are complete. Only objects which were reported
1148         in the output of <em>list</em> with a sha1 may be fetched this way.
1149 </p>
1150 <div class="paragraph"><p>Optionally may output a <em>lock &lt;file&gt;</em> line indicating the full path of
1151 a file under <code>$GIT_DIR/objects/pack</code> which is keeping a pack until
1152 refs can be suitably updated.  The path must end with <code>.keep</code>. This is
1153 a mechanism to name a &lt;pack,idx,keep&gt; tuple by giving only the keep
1154 component.  The kept pack will not be deleted by a concurrent repack,
1155 even though its objects may not be referenced until the fetch completes.
1156 The <code>.keep</code> file will be deleted at the conclusion of the fetch.</p></div>
1157 <div class="paragraph"><p>If option <em>check-connectivity</em> is requested, the helper must output
1158 <em>connectivity-ok</em> if the clone is self-contained and connected.</p></div>
1159 <div class="paragraph"><p>Supported if the helper has the "fetch" capability.</p></div>
1160 </dd>
1161 <dt class="hdlist1">
1162 <em>push</em> +&lt;src&gt;:&lt;dst&gt;
1163 </dt>
1164 <dd>
1165 <p>
1166         Pushes the given local &lt;src&gt; commit or branch to the
1167         remote branch described by &lt;dst&gt;.  A batch sequence of
1168         one or more <em>push</em> commands is terminated with a blank line
1169         (if there is only one reference to push, a single <em>push</em> command
1170         is followed by a blank line). For example, the following would
1171         be two batches of <em>push</em>, the first asking the remote-helper
1172         to push the local ref <em>master</em> to the remote ref <em>master</em> and
1173         the local <code>HEAD</code> to the remote <em>branch</em>, and the second
1174         asking to push ref <em>foo</em> to ref <em>bar</em> (forced update requested
1175         by the <em>+</em>).
1176 </p>
1177 <div class="listingblock">
1178 <div class="content">
1179 <pre><code>push refs/heads/master:refs/heads/master
1180 push HEAD:refs/heads/branch
1181 \n
1182 push +refs/heads/foo:refs/heads/bar
1183 \n</code></pre>
1184 </div></div>
1185 <div class="paragraph"><p>Zero or more protocol options may be entered after the last <em>push</em>
1186 command, before the batch&#8217;s terminating blank line.</p></div>
1187 <div class="paragraph"><p>When the push is complete, outputs one or more <em>ok &lt;dst&gt;</em> or
1188 <em>error &lt;dst&gt; &lt;why&gt;?</em> lines to indicate success or failure of
1189 each pushed ref.  The status report output is terminated by
1190 a blank line.  The option field &lt;why&gt; may be quoted in a C
1191 style string if it contains an LF.</p></div>
1192 <div class="paragraph"><p>Supported if the helper has the "push" capability.</p></div>
1193 </dd>
1194 <dt class="hdlist1">
1195 <em>import</em> &lt;name&gt;
1196 </dt>
1197 <dd>
1198 <p>
1199         Produces a fast-import stream which imports the current value
1200         of the named ref. It may additionally import other refs as
1201         needed to construct the history efficiently. The script writes
1202         to a helper-specific private namespace. The value of the named
1203         ref should be written to a location in this namespace derived
1204         by applying the refspecs from the "refspec" capability to the
1205         name of the ref.
1206 </p>
1207 <div class="paragraph"><p>Especially useful for interoperability with a foreign versioning
1208 system.</p></div>
1209 <div class="paragraph"><p>Just like <em>push</em>, a batch sequence of one or more <em>import</em> is
1210 terminated with a blank line. For each batch of <em>import</em>, the remote
1211 helper should produce a fast-import stream terminated by a <em>done</em>
1212 command.</p></div>
1213 <div class="paragraph"><p>Note that if the <em>bidi-import</em> capability is used the complete batch
1214 sequence has to be buffered before starting to send data to fast-import
1215 to prevent mixing of commands and fast-import responses on the helper&#8217;s
1216 stdin.</p></div>
1217 <div class="paragraph"><p>Supported if the helper has the "import" capability.</p></div>
1218 </dd>
1219 <dt class="hdlist1">
1220 <em>export</em>
1221 </dt>
1222 <dd>
1223 <p>
1224         Instructs the remote helper that any subsequent input is
1225         part of a fast-import stream (generated by <em>git fast-export</em>)
1226         containing objects which should be pushed to the remote.
1227 </p>
1228 <div class="paragraph"><p>Especially useful for interoperability with a foreign versioning
1229 system.</p></div>
1230 <div class="paragraph"><p>The <em>export-marks</em> and <em>import-marks</em> capabilities, if specified,
1231 affect this command in so far as they are passed on to <em>git
1232 fast-export</em>, which then will load/store a table of marks for
1233 local objects. This can be used to implement for incremental
1234 operations.</p></div>
1235 <div class="paragraph"><p>Supported if the helper has the "export" capability.</p></div>
1236 </dd>
1237 <dt class="hdlist1">
1238 <em>connect</em> &lt;service&gt;
1239 </dt>
1240 <dd>
1241 <p>
1242         Connects to given service. Standard input and standard output
1243         of helper are connected to specified service (git prefix is
1244         included in service name so e.g. fetching uses <em>git-upload-pack</em>
1245         as service) on remote side. Valid replies to this command are
1246         empty line (connection established), <em>fallback</em> (no smart
1247         transport support, fall back to dumb transports) and just
1248         exiting with error message printed (can&#8217;t connect, don&#8217;t
1249         bother trying to fall back). After line feed terminating the
1250         positive (empty) response, the output of service starts. After
1251         the connection ends, the remote helper exits.
1252 </p>
1253 <div class="paragraph"><p>Supported if the helper has the "connect" capability.</p></div>
1254 </dd>
1255 <dt class="hdlist1">
1256 <em>stateless-connect</em> &lt;service&gt;
1257 </dt>
1258 <dd>
1259 <p>
1260         Experimental; for internal use only.
1261         Connects to the given remote service for communication using
1262         git&#8217;s wire-protocol version 2.  Valid replies to this command
1263         are empty line (connection established), <em>fallback</em> (no smart
1264         transport support, fall back to dumb transports) and just
1265         exiting with error message printed (can&#8217;t connect, don&#8217;t bother
1266         trying to fall back).  After line feed terminating the positive
1267         (empty) response, the output of the service starts.  Messages
1268         (both request and response) must consist of zero or more
1269         PKT-LINEs, terminating in a flush packet. Response messages will
1270         then have a response end packet after the flush packet to
1271         indicate the end of a response.  The client must not
1272         expect the server to store any state in between request-response
1273         pairs.  After the connection ends, the remote helper exits.
1274 </p>
1275 <div class="paragraph"><p>Supported if the helper has the "stateless-connect" capability.</p></div>
1276 </dd>
1277 <dt class="hdlist1">
1278 <em>get</em> &lt;uri&gt; &lt;path&gt;
1279 </dt>
1280 <dd>
1281 <p>
1282         Downloads the file from the given <code>&lt;uri&gt;</code> to the given <code>&lt;path&gt;</code>. If
1283         <code>&lt;path&gt;.temp</code> exists, then Git assumes that the <code>.temp</code> file is a
1284         partial download from a previous attempt and will resume the
1285         download from that position.
1286 </p>
1287 </dd>
1288 </dl></div>
1289 <div class="paragraph"><p>If a fatal error occurs, the program writes the error message to
1290 stderr and exits. The caller should expect that a suitable error
1291 message has been printed if the child closes the connection without
1292 completing a valid response for the current command.</p></div>
1293 <div class="paragraph"><p>Additional commands may be supported, as may be determined from
1294 capabilities reported by the helper.</p></div>
1295 </div>
1296 </div>
1297 <div class="sect1">
1298 <h2 id="_ref_list_attributes">REF LIST ATTRIBUTES</h2>
1299 <div class="sectionbody">
1300 <div class="paragraph"><p>The <em>list</em> command produces a list of refs in which each ref
1301 may be followed by a list of attributes. The following ref list
1302 attributes are defined.</p></div>
1303 <div class="dlist"><dl>
1304 <dt class="hdlist1">
1305 <em>unchanged</em>
1306 </dt>
1307 <dd>
1308 <p>
1309         This ref is unchanged since the last import or fetch, although
1310         the helper cannot necessarily determine what value that produced.
1311 </p>
1312 </dd>
1313 </dl></div>
1314 </div>
1315 </div>
1316 <div class="sect1">
1317 <h2 id="_ref_list_keywords">REF LIST KEYWORDS</h2>
1318 <div class="sectionbody">
1319 <div class="paragraph"><p>The <em>list</em> command may produce a list of key-value pairs.
1320 The following keys are defined.</p></div>
1321 <div class="dlist"><dl>
1322 <dt class="hdlist1">
1323 <em>object-format</em>
1324 </dt>
1325 <dd>
1326 <p>
1327         The refs are using the given hash algorithm.  This keyword is only
1328         used if the server and client both support the object-format
1329         extension.
1330 </p>
1331 </dd>
1332 </dl></div>
1333 </div>
1334 </div>
1335 <div class="sect1">
1336 <h2 id="_options">OPTIONS</h2>
1337 <div class="sectionbody">
1338 <div class="paragraph"><p>The following options are defined and (under suitable circumstances)
1339 set by Git if the remote helper has the <em>option</em> capability.</p></div>
1340 <div class="dlist"><dl>
1341 <dt class="hdlist1">
1342 <em>option verbosity</em> &lt;n&gt;
1343 </dt>
1344 <dd>
1345 <p>
1346         Changes the verbosity of messages displayed by the helper.
1347         A value of 0 for &lt;n&gt; means that processes operate
1348         quietly, and the helper produces only error output.
1349         1 is the default level of verbosity, and higher values
1350         of &lt;n&gt; correspond to the number of -v flags passed on the
1351         command line.
1352 </p>
1353 </dd>
1354 <dt class="hdlist1">
1355 <em>option progress</em> {<em>true</em>|<em>false</em>}
1356 </dt>
1357 <dd>
1358 <p>
1359         Enables (or disables) progress messages displayed by the
1360         transport helper during a command.
1361 </p>
1362 </dd>
1363 <dt class="hdlist1">
1364 <em>option depth</em> &lt;depth&gt;
1365 </dt>
1366 <dd>
1367 <p>
1368         Deepens the history of a shallow repository.
1369 </p>
1370 </dd>
1371 <dt class="hdlist1">
1372 <em>option deepen-since</em> &lt;timestamp&gt;
1373 </dt>
1374 <dd>
1375 <p>
1376         Deepens the history of a shallow repository based on time.
1377 </p>
1378 </dd>
1379 <dt class="hdlist1">
1380 <em>option deepen-not</em> &lt;ref&gt;
1381 </dt>
1382 <dd>
1383 <p>
1384         Deepens the history of a shallow repository excluding ref.
1385         Multiple options add up.
1386 </p>
1387 </dd>
1388 <dt class="hdlist1">
1389 <em>option deepen-relative</em> {<em>true</em>|<em>false</em>}
1390 </dt>
1391 <dd>
1392 <p>
1393         Deepens the history of a shallow repository relative to
1394         current boundary. Only valid when used with "option depth".
1395 </p>
1396 </dd>
1397 <dt class="hdlist1">
1398 <em>option followtags</em> {<em>true</em>|<em>false</em>}
1399 </dt>
1400 <dd>
1401 <p>
1402         If enabled the helper should automatically fetch annotated
1403         tag objects if the object the tag points at was transferred
1404         during the fetch command.  If the tag is not fetched by
1405         the helper a second fetch command will usually be sent to
1406         ask for the tag specifically.  Some helpers may be able to
1407         use this option to avoid a second network connection.
1408 </p>
1409 </dd>
1410 </dl></div>
1411 <div class="paragraph"><p><em>option dry-run</em> {<em>true</em>|<em>false</em>}:
1412         If true, pretend the operation completed successfully,
1413         but don&#8217;t actually change any repository data.  For most
1414         helpers this only applies to the <em>push</em>, if supported.</p></div>
1415 <div class="dlist"><dl>
1416 <dt class="hdlist1">
1417 <em>option servpath &lt;c-style-quoted-path&gt;</em>
1418 </dt>
1419 <dd>
1420 <p>
1421         Sets service path (--upload-pack, --receive-pack etc.) for
1422         next connect. Remote helper may support this option, but
1423         must not rely on this option being set before
1424         connect request occurs.
1425 </p>
1426 </dd>
1427 <dt class="hdlist1">
1428 <em>option check-connectivity</em> {<em>true</em>|<em>false</em>}
1429 </dt>
1430 <dd>
1431 <p>
1432         Request the helper to check connectivity of a clone.
1433 </p>
1434 </dd>
1435 <dt class="hdlist1">
1436 <em>option force</em> {<em>true</em>|<em>false</em>}
1437 </dt>
1438 <dd>
1439 <p>
1440         Request the helper to perform a force update.  Defaults to
1441         <em>false</em>.
1442 </p>
1443 </dd>
1444 <dt class="hdlist1">
1445 <em>option cloning</em> {<em>true</em>|<em>false</em>}
1446 </dt>
1447 <dd>
1448 <p>
1449         Notify the helper this is a clone request (i.e. the current
1450         repository is guaranteed empty).
1451 </p>
1452 </dd>
1453 <dt class="hdlist1">
1454 <em>option update-shallow</em> {<em>true</em>|<em>false</em>}
1455 </dt>
1456 <dd>
1457 <p>
1458         Allow to extend .git/shallow if the new refs require it.
1459 </p>
1460 </dd>
1461 <dt class="hdlist1">
1462 <em>option pushcert</em> {<em>true</em>|<em>false</em>}
1463 </dt>
1464 <dd>
1465 <p>
1466         GPG sign pushes.
1467 </p>
1468 </dd>
1469 <dt class="hdlist1">
1470 <em>option push-option</em> &lt;string&gt;
1471 </dt>
1472 <dd>
1473 <p>
1474         Transmit &lt;string&gt; as a push option. As the push option
1475         must not contain LF or NUL characters, the string is not encoded.
1476 </p>
1477 </dd>
1478 <dt class="hdlist1">
1479 <em>option from-promisor</em> {<em>true</em>|<em>false</em>}
1480 </dt>
1481 <dd>
1482 <p>
1483         Indicate that these objects are being fetched from a promisor.
1484 </p>
1485 </dd>
1486 <dt class="hdlist1">
1487 <em>option no-dependents</em> {<em>true</em>|<em>false</em>}
1488 </dt>
1489 <dd>
1490 <p>
1491         Indicate that only the objects wanted need to be fetched, not
1492         their dependents.
1493 </p>
1494 </dd>
1495 <dt class="hdlist1">
1496 <em>option atomic</em> {<em>true</em>|<em>false</em>}
1497 </dt>
1498 <dd>
1499 <p>
1500         When pushing, request the remote server to update refs in a single atomic
1501         transaction.  If successful, all refs will be updated, or none will.  If the
1502         remote side does not support this capability, the push will fail.
1503 </p>
1504 </dd>
1505 <dt class="hdlist1">
1506 <em>option object-format true</em>
1507 </dt>
1508 <dd>
1509 <p>
1510         Indicate that the caller wants hash algorithm information
1511         to be passed back from the remote.  This mode is used when fetching
1512         refs.
1513 </p>
1514 </dd>
1515 </dl></div>
1516 </div>
1517 </div>
1518 <div class="sect1">
1519 <h2 id="_see_also">SEE ALSO</h2>
1520 <div class="sectionbody">
1521 <div class="paragraph"><p><a href="git-remote.html">git-remote(1)</a></p></div>
1522 <div class="paragraph"><p><a href="git-remote-ext.html">git-remote-ext(1)</a></p></div>
1523 <div class="paragraph"><p><a href="git-remote-fd.html">git-remote-fd(1)</a></p></div>
1524 <div class="paragraph"><p><a href="git-fast-import.html">git-fast-import(1)</a></p></div>
1525 </div>
1526 </div>
1527 <div class="sect1">
1528 <h2 id="_git">GIT</h2>
1529 <div class="sectionbody">
1530 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
1531 </div>
1532 </div>
1533 </div>
1534 <div id="footnotes"><hr /></div>
1535 <div id="footer">
1536 <div id="footer-text">
1537 Last updated
1538  2024-04-03 15:35:56 PDT
1539 </div>
1540 </div>
1541 </body>
1542 </html>