blob: 0d7247a1753b7a1531384572402af0f64472d235 [file] [log] [blame]
Junio C Hamanoccb82522018-05-08 07:52:091<?xml version="1.0" encoding="UTF-8"?>
Junio C Hamanob5e079f2013-02-08 00:02:522<!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" />
Junio C Hamanoccb82522018-05-08 07:52:097<meta name="generator" content="AsciiDoc 8.6.10" />
Junio C Hamanob5513772019-04-22 03:38:398<title>gitremote-helpers(7)</title>
Junio C Hamanob5e079f2013-02-08 00:02:529<style type="text/css">
10/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
11
12/* Default font. */
13body {
14 font-family: Georgia,serif;
15}
16
17/* Title font. */
18h1, h2, h3, h4, h5, h6,
19div.title, caption.title,
20thead, p.table.header,
21#toctitle,
22#author, #revnumber, #revdate, #revremark,
23#footer {
24 font-family: Arial,Helvetica,sans-serif;
25}
26
27body {
28 margin: 1em 5% 1em 5%;
29}
30
31a {
32 color: blue;
33 text-decoration: underline;
34}
35a:visited {
36 color: fuchsia;
37}
38
39em {
40 font-style: italic;
41 color: navy;
42}
43
44strong {
45 font-weight: bold;
46 color: #083194;
47}
48
49h1, 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
56h1, h2, h3 {
57 border-bottom: 2px solid silver;
58}
59h2 {
60 padding-top: 0.5em;
61}
62h3 {
63 float: left;
64}
65h3 + * {
66 clear: left;
67}
68h5 {
69 font-size: 1.0em;
70}
71
72div.sectionbody {
73 margin-left: 0;
74}
75
76hr {
77 border: 1px solid silver;
78}
79
80p {
81 margin-top: 0.5em;
82 margin-bottom: 0.5em;
83}
84
85ul, ol, li > p {
86 margin-top: 0;
87}
88ul > li { color: #aaa; }
89ul > li > * { color: black; }
90
Junio C Hamanoc14e6ad2014-10-31 20:25:5391.monospaced, code, pre {
92 font-family: "Courier New", Courier, monospace;
93 font-size: inherit;
94 color: navy;
Junio C Hamanob5e079f2013-02-08 00:02:5295 padding: 0;
96 margin: 0;
97}
Junio C Hamanoc14e6ad2014-10-31 20:25:5398pre {
99 white-space: pre-wrap;
100}
Junio C Hamanob5e079f2013-02-08 00:02:52101
Junio C Hamanob5e079f2013-02-08 00:02:52102#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}
131div.imageblock, div.exampleblock, div.verseblock,
132div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
133div.admonitionblock {
134 margin-top: 1.0em;
135 margin-bottom: 1.5em;
136}
137div.admonitionblock {
138 margin-top: 2.0em;
139 margin-bottom: 2.0em;
140 margin-right: 10%;
141 color: #606060;
142}
143
144div.content { /* Block element content. */
145 padding: 0;
146}
147
148/* Block element titles. */
149div.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}
156div.title + * {
157 margin-top: 0;
158}
159
160td div.title:first-child {
161 margin-top: 0.0em;
162}
163div.content div.title:first-child {
164 margin-top: 0.0em;
165}
166div.content + div.title {
167 margin-top: 0.0em;
168}
169
170div.sidebarblock > div.content {
171 background: #ffffee;
172 border: 1px solid #dddddd;
173 border-left: 4px solid #f0f0f0;
174 padding: 0.5em;
175}
176
177div.listingblock > div.content {
178 border: 1px solid #dddddd;
179 border-left: 5px solid #f0f0f0;
180 background: #f8f8f8;
181 padding: 0.5em;
182}
183
184div.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
192div.quoteblock > div.attribution {
193 padding-top: 0.5em;
194 text-align: right;
195}
196
197div.verseblock > pre.content {
198 font-family: inherit;
199 font-size: inherit;
200}
201div.verseblock > div.attribution {
202 padding-top: 0.75em;
203 text-align: left;
204}
205/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
206div.verseblock + div.attribution {
207 text-align: left;
208}
209
210div.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}
218div.admonitionblock td.content {
219 padding-left: 0.5em;
220 border-left: 3px solid #dddddd;
221}
222
223div.exampleblock > div.content {
224 border-left: 3px solid #dddddd;
225 padding-left: 0.5em;
226}
227
228div.imageblock div.content { padding-left: 0; }
Junio C Hamanoc14e6ad2014-10-31 20:25:53229span.image img { border-style: none; vertical-align: text-bottom; }
Junio C Hamanob5e079f2013-02-08 00:02:52230a.image:visited { color: white; }
231
232dl {
233 margin-top: 0.8em;
234 margin-bottom: 0.8em;
235}
236dt {
237 margin-top: 0.5em;
238 margin-bottom: 0;
239 font-style: normal;
240 color: navy;
241}
242dd > *:first-child {
243 margin-top: 0.1em;
244}
245
246ul, ol {
247 list-style-position: outside;
248}
249ol.arabic {
250 list-style-type: decimal;
251}
252ol.loweralpha {
253 list-style-type: lower-alpha;
254}
255ol.upperalpha {
256 list-style-type: upper-alpha;
257}
258ol.lowerroman {
259 list-style-type: lower-roman;
260}
261ol.upperroman {
262 list-style-type: upper-roman;
263}
264
265div.compact ul, div.compact ol,
266div.compact p, div.compact p,
267div.compact div, div.compact div {
268 margin-top: 0.1em;
269 margin-bottom: 0.1em;
270}
271
272tfoot {
273 font-weight: bold;
274}
275td > div.verse {
276 white-space: pre;
277}
278
279div.hdlist {
280 margin-top: 0.8em;
281 margin-bottom: 0.8em;
282}
283div.hdlist tr {
284 padding-bottom: 15px;
285}
286dt.hdlist1.strong, td.hdlist1.strong {
287 font-weight: bold;
288}
289td.hdlist1 {
290 vertical-align: top;
291 font-style: normal;
292 padding-right: 0.8em;
293 color: navy;
294}
295td.hdlist2 {
296 vertical-align: top;
297}
298div.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
311span.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
334div.colist td {
335 padding-right: 0.5em;
336 padding-bottom: 0.3em;
337 vertical-align: top;
338}
339div.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
Junio C Hamanoc14e6ad2014-10-31 20:25:53359div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
Junio C Hamanob5e079f2013-02-08 00:02:52360 margin-top: 0;
361 margin-bottom: 0;
362}
363div.toclevel2 {
364 margin-left: 2em;
365 font-size: 0.9em;
366}
367div.toclevel3 {
368 margin-left: 4em;
369 font-size: 0.9em;
370}
371div.toclevel4 {
372 margin-left: 6em;
373 font-size: 0.9em;
374}
375
376span.aqua { color: aqua; }
377span.black { color: black; }
378span.blue { color: blue; }
379span.fuchsia { color: fuchsia; }
380span.gray { color: gray; }
381span.green { color: green; }
382span.lime { color: lime; }
383span.maroon { color: maroon; }
384span.navy { color: navy; }
385span.olive { color: olive; }
386span.purple { color: purple; }
387span.red { color: red; }
388span.silver { color: silver; }
389span.teal { color: teal; }
390span.white { color: white; }
391span.yellow { color: yellow; }
392
393span.aqua-background { background: aqua; }
394span.black-background { background: black; }
395span.blue-background { background: blue; }
396span.fuchsia-background { background: fuchsia; }
397span.gray-background { background: gray; }
398span.green-background { background: green; }
399span.lime-background { background: lime; }
400span.maroon-background { background: maroon; }
401span.navy-background { background: navy; }
402span.olive-background { background: olive; }
403span.purple-background { background: purple; }
404span.red-background { background: red; }
405span.silver-background { background: silver; }
406span.teal-background { background: teal; }
407span.white-background { background: white; }
408span.yellow-background { background: yellow; }
409
410span.big { font-size: 2em; }
411span.small { font-size: 0.6em; }
412
413span.underline { text-decoration: underline; }
414span.overline { text-decoration: overline; }
415span.line-through { text-decoration: line-through; }
416
Junio C Hamanoc14e6ad2014-10-31 20:25:53417div.unbreakable { page-break-inside: avoid; }
418
Junio C Hamanob5e079f2013-02-08 00:02:52419
420/*
421 * xhtml11 specific
422 *
423 * */
424
425div.tableblock {
426 margin-top: 1.0em;
427 margin-bottom: 1.5em;
428}
429div.tableblock > table {
430 border: 3px solid #527bbd;
431}
432thead, p.table.header {
433 font-weight: bold;
434 color: #527bbd;
435}
436p.table {
437 margin-top: 0;
438}
Junio C Hamano725b0da2020-01-22 22:02:40439/* Because the table frame attribute is overridden by CSS in most browsers. */
Junio C Hamanob5e079f2013-02-08 00:02:52440div.tableblock > table[frame="void"] {
441 border-style: none;
442}
443div.tableblock > table[frame="hsides"] {
444 border-left-style: none;
445 border-right-style: none;
446}
447div.tableblock > table[frame="vsides"] {
448 border-top-style: none;
449 border-bottom-style: none;
450}
451
452
453/*
454 * html5 specific
455 *
456 * */
457
458table.tableblock {
459 margin-top: 1.0em;
460 margin-bottom: 1.5em;
461}
462thead, p.tableblock.header {
463 font-weight: bold;
464 color: #527bbd;
465}
466p.tableblock {
467 margin-top: 0;
468}
469table.tableblock {
470 border-width: 3px;
471 border-spacing: 0px;
472 border-style: solid;
473 border-color: #527bbd;
474 border-collapse: collapse;
475}
476th.tableblock, td.tableblock {
477 border-width: 1px;
478 padding: 4px;
479 border-style: solid;
480 border-color: #527bbd;
481}
482
483table.tableblock.frame-topbot {
484 border-left-style: hidden;
485 border-right-style: hidden;
486}
487table.tableblock.frame-sides {
488 border-top-style: hidden;
489 border-bottom-style: hidden;
490}
491table.tableblock.frame-none {
492 border-style: hidden;
493}
494
495th.tableblock.halign-left, td.tableblock.halign-left {
496 text-align: left;
497}
498th.tableblock.halign-center, td.tableblock.halign-center {
499 text-align: center;
500}
501th.tableblock.halign-right, td.tableblock.halign-right {
502 text-align: right;
503}
504
505th.tableblock.valign-top, td.tableblock.valign-top {
506 vertical-align: top;
507}
508th.tableblock.valign-middle, td.tableblock.valign-middle {
509 vertical-align: middle;
510}
511th.tableblock.valign-bottom, td.tableblock.valign-bottom {
512 vertical-align: bottom;
513}
514
515
516/*
517 * manpage specific
518 *
519 * */
520
521body.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}
527body.manpage h2 {
528 border-style: none;
529}
530body.manpage div.sectionbody {
531 margin-left: 3em;
532}
533
534@media print {
535 body.manpage div#toc { display: none; }
536}
Junio C Hamanoc14e6ad2014-10-31 20:25:53537
538
Junio C Hamanob5e079f2013-02-08 00:02:52539</style>
540<script type="text/javascript">
541/*<![CDATA[*/
542var 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.
562toc: 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;
Junio C Hamanoc14e6ad2014-10-31 20:25:53583 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
Junio C Hamanob5e079f2013-02-08 00:02:52584 // 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];
Junio C Hamanoc14e6ad2014-10-31 20:25:53612 if (entry.nodeName.toLowerCase() == 'div'
Junio C Hamanob5e079f2013-02-08 00:02:52613 && 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
648footnotes: 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];
Junio C Hamanoc14e6ad2014-10-31 20:25:53658 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
Junio C Hamanob5e079f2013-02-08 00:02:52659 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
708install: 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}
731asciidoc.install();
732/*]]>*/
733</script>
734</head>
735<body class="manpage">
736<div id="header">
737<h1>
Junio C Hamanob5513772019-04-22 03:38:39738gitremote-helpers(7) Manual Page
Junio C Hamanob5e079f2013-02-08 00:02:52739</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,
761but they are invoked by Git when it needs to interact with remote
762repositories Git does not support natively. A given helper will
763implement a subset of the capabilities documented here. When Git
764needs to interact with a repository using a remote helper, it spawns
765the helper as an independent process, sends commands to the helper&#8217;s
766standard input, and expects results from the helper&#8217;s standard
767output. Because a remote helper runs as an independent process from
768Git, there is no need to re-link Git to add a new helper, nor any
769need 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
771uses to determine what other commands the helper will accept. Those
772other commands can be used to discover and update remote refs,
773transport objects between the object database and the remote repository,
774and update the local object store.</p></div>
775<div class="paragraph"><p>Git comes with a "curl" family of remote helpers, that handle various
776transport 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
785arguments. The first argument specifies a remote repository as in Git;
786it is either the name of a configured remote or a URL. The second
787argument specifies a URL; it is usually of the form
788<em>&lt;transport&gt;://&lt;address&gt;</em>, but any arbitrary string is possible.
Junio C Hamano042f2142016-06-27 18:05:05789The <code>GIT_DIR</code> environment variable is set up for the remote helper
Junio C Hamanob5e079f2013-02-08 00:02:52790and can be used to determine where to store additional data or from
791which 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
794automatically invokes <em>git remote-&lt;transport&gt;</em> with the full URL as
795the second argument. If such a URL is encountered directly on the
796command line, the first argument is the same as the second, and if it
797is encountered in a configured remote, the first argument is the name
798of 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
800invoke <em>git remote-&lt;transport&gt;</em> with <em>&lt;address&gt;</em> as the second
801argument. If such a URL is encountered directly on the command line,
802the first argument is <em>&lt;address&gt;</em>, and if it is encountered in a
803configured remote, the first argument is the name of that remote.</p></div>
Junio C Hamano042f2142016-06-27 18:05:05804<div class="paragraph"><p>Additionally, when a configured remote has <code>remote.&lt;name&gt;.vcs</code> set to
Junio C Hamanob5e079f2013-02-08 00:02:52805<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
Junio C Hamano042f2142016-06-27 18:05:05807<code>remote.&lt;name&gt;.url</code>; otherwise, the second argument is omitted.</p></div>
Junio C Hamanob5e079f2013-02-08 00:02:52808</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
814per line. The first command is always the <em>capabilities</em> command, in
815response to which the remote helper must print a list of the
816capabilities it supports (see below) followed by a blank line. The
817response to the capabilities command determines what commands Git uses
818in 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
821line is followed by a payload in some other protocol (e.g., the pack
822protocol), 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.
826The operations a helper supports are declared to Git in the response
Junio C Hamanoc14e6ad2014-10-31 20:25:53827to the <code>capabilities</code> command (see COMMANDS, below).</p></div>
Junio C Hamanob5e079f2013-02-08 00:02:52828<div class="paragraph"><p>In the following, we list all defined capabilities and for
829each we list which commands a helper with that capability
830must 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">
Junio C Hamanoccb82522018-05-08 07:52:09847<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">
Junio C Hamanob5e079f2013-02-08 00:02:52859<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
880fall back to another capability if the helper requests so when
881connecting (see the <em>connect</em> command under COMMANDS).
882When choosing between <em>push</em> and <em>export</em>, Git prefers <em>push</em>.
883Other frontends may have some other order of preference.</p></div>
Junio C Hamano0e0e0d22013-09-12 23:25:03884<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>
Junio C Hamanob5e079f2013-02-08 00:02:52896</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">
Junio C Hamanoccb82522018-05-08 07:52:09913<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">
Junio C Hamanob5e079f2013-02-08 00:02:52925<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>
Junio C Hamano8eac2682013-09-09 22:35:20944<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>
Junio C Hamanob5e079f2013-02-08 00:02:52953</dl></div>
954<div class="paragraph"><p>If a helper advertises <em>connect</em>, Git will use it if possible and
955fall back to another capability if the helper requests so when
956connecting (see the <em>connect</em> command under COMMANDS).
957When choosing between <em>fetch</em> and <em>import</em>, Git prefers <em>fetch</em>.
958Other frontends may have some other order of preference.</p></div>
959</div>
960<div class="sect3">
961<h4 id="_miscellaneous_capabilities">Miscellaneous capabilities</h4>
962<div class="dlist"><dl>
963<dt class="hdlist1">
964<em>option</em>
965</dt>
966<dd>
967<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53968 For specifying settings like <code>verbosity</code> (how much output to
969 write to stderr) and <code>depth</code> (how much history is wanted in the
Junio C Hamanob5e079f2013-02-08 00:02:52970 case of a shallow clone) that affect how other commands are
971 carried out.
972</p>
973</dd>
974<dt class="hdlist1">
975<em>refspec</em> &lt;refspec&gt;
976</dt>
977<dd>
978<p>
Junio C Hamanoc7102962013-05-29 23:57:17979 For remote helpers that implement <em>import</em> or <em>export</em>, this capability
980 allows the refs to be constrained to a private namespace, instead of
981 writing to refs/heads or refs/remotes directly.
Junio C Hamanob5e079f2013-02-08 00:02:52982 It is recommended that all importers providing the <em>import</em>
Junio C Hamanoc7102962013-05-29 23:57:17983 capability use this. It&#8217;s mandatory for <em>export</em>.
Junio C Hamanob5e079f2013-02-08 00:02:52984</p>
985<div class="paragraph"><p>A helper advertising the capability
Junio C Hamanoc14e6ad2014-10-31 20:25:53986<code>refspec refs/heads/*:refs/svn/origin/branches/*</code>
987is saying that, when it is asked to <code>import refs/heads/topic</code>, the
988stream it outputs will update the <code>refs/svn/origin/branches/topic</code>
Junio C Hamanob5e079f2013-02-08 00:02:52989ref.</p></div>
990<div class="paragraph"><p>This capability can be advertised multiple times. The first
991applicable refspec takes precedence. The left-hand of refspecs
992advertised with this capability must cover all refs reported by
Junio C Hamanoc7102962013-05-29 23:57:17993the list command. If no <em>refspec</em> capability is advertised,
Junio C Hamanoc14e6ad2014-10-31 20:25:53994there is an implied <code>refspec *:*</code>.</p></div>
Junio C Hamano0e0e0d22013-09-12 23:25:03995<div class="paragraph"><p>When writing remote-helpers for decentralized version control
996systems, it is advised to keep a local copy of the repository to
997interact with, and to let the private namespace refs point to this
998local repository, while the refs/remotes namespace is used to track
999the remote repository.</p></div>
Junio C Hamanob5e079f2013-02-08 00:02:521000</dd>
1001<dt class="hdlist1">
1002<em>bidi-import</em>
1003</dt>
1004<dd>
1005<p>
1006 This modifies the <em>import</em> capability.
1007 The fast-import commands <em>cat-blob</em> and <em>ls</em> can be used by remote-helpers
1008 to retrieve information about blobs and trees that already exist in
1009 fast-import&#8217;s memory. This requires a channel from fast-import to the
1010 remote-helper.
1011 If it is advertised in addition to "import", Git establishes a pipe from
1012 fast-import to the remote-helper&#8217;s stdin.
1013 It follows that Git and fast-import are both connected to the
1014 remote-helper&#8217;s stdin. Because Git can send multiple commands to
1015 the remote-helper it is required that helpers that use <em>bidi-import</em>
1016 buffer all <em>import</em> commands of a batch before sending data to fast-import.
1017 This is to prevent mixing commands and fast-import responses on the
1018 helper&#8217;s stdin.
1019</p>
1020</dd>
1021<dt class="hdlist1">
1022<em>export-marks</em> &lt;file&gt;
1023</dt>
1024<dd>
1025<p>
1026 This modifies the <em>export</em> capability, instructing Git to dump the
1027 internal marks table to &lt;file&gt; when complete. For details,
Junio C Hamano92d80372016-07-13 22:00:051028 read up on <code>--export-marks=&lt;file&gt;</code> in <a href="git-fast-export.html">git-fast-export(1)</a>.
Junio C Hamanob5e079f2013-02-08 00:02:521029</p>
1030</dd>
1031<dt class="hdlist1">
1032<em>import-marks</em> &lt;file&gt;
1033</dt>
1034<dd>
1035<p>
1036 This modifies the <em>export</em> capability, instructing Git to load the
1037 marks specified in &lt;file&gt; before processing any input. For details,
Junio C Hamano92d80372016-07-13 22:00:051038 read up on <code>--import-marks=&lt;file&gt;</code> in <a href="git-fast-export.html">git-fast-export(1)</a>.
Junio C Hamanob5e079f2013-02-08 00:02:521039</p>
1040</dd>
Junio C Hamanoac002b62013-04-25 01:02:581041<dt class="hdlist1">
1042<em>signed-tags</em>
1043</dt>
1044<dd>
1045<p>
1046 This modifies the <em>export</em> capability, instructing Git to pass
Junio C Hamano92d80372016-07-13 22:00:051047 <code>--signed-tags=verbatim</code> to <a href="git-fast-export.html">git-fast-export(1)</a>. In the
1048 absence of this capability, Git will use <code>--signed-tags=warn-strip</code>.
Junio C Hamanoac002b62013-04-25 01:02:581049</p>
1050</dd>
Junio C Hamanob5e079f2013-02-08 00:02:521051</dl></div>
1052</div>
1053</div>
1054</div>
1055</div>
1056<div class="sect1">
1057<h2 id="_commands">COMMANDS</h2>
1058<div class="sectionbody">
1059<div class="paragraph"><p>Commands are given by the caller on the helper&#8217;s standard input, one per line.</p></div>
1060<div class="dlist"><dl>
1061<dt class="hdlist1">
1062<em>capabilities</em>
1063</dt>
1064<dd>
1065<p>
1066 Lists the capabilities of the helper, one per line, ending
1067 with a blank line. Each capability may be preceded with <em>*</em>,
1068 which marks them mandatory for Git versions using the remote
1069 helper to understand. Any unknown mandatory capability is a
1070 fatal error.
1071</p>
1072<div class="paragraph"><p>Support for this command is mandatory.</p></div>
1073</dd>
1074<dt class="hdlist1">
1075<em>list</em>
1076</dt>
1077<dd>
1078<p>
1079 Lists the refs, one per line, in the format "&lt;value&gt; &lt;name&gt;
1080 [&lt;attr&gt; &#8230;]". The value may be a hex sha1 hash, "@&lt;dest&gt;" for
1081 a symref, or "?" to indicate that the helper could not get the
1082 value of the ref. A space-separated list of attributes follows
1083 the name; unrecognized attributes are ignored. The list ends
1084 with a blank line.
1085</p>
1086<div class="paragraph"><p>See REF LIST ATTRIBUTES for a list of currently defined attributes.</p></div>
1087<div class="paragraph"><p>Supported if the helper has the "fetch" or "import" capability.</p></div>
1088</dd>
1089<dt class="hdlist1">
1090<em>list for-push</em>
1091</dt>
1092<dd>
1093<p>
1094 Similar to <em>list</em>, except that it is used if and only if
1095 the caller wants to the resulting ref list to prepare
1096 push commands.
1097 A helper supporting both push and fetch can use this
1098 to distinguish for which operation the output of <em>list</em>
1099 is going to be used, possibly reducing the amount
1100 of work that needs to be performed.
1101</p>
1102<div class="paragraph"><p>Supported if the helper has the "push" or "export" capability.</p></div>
1103</dd>
1104<dt class="hdlist1">
1105<em>option</em> &lt;name&gt; &lt;value&gt;
1106</dt>
1107<dd>
1108<p>
1109 Sets the transport helper option &lt;name&gt; to &lt;value&gt;. Outputs a
1110 single line containing one of <em>ok</em> (option successfully set),
1111 <em>unsupported</em> (option not recognized) or <em>error &lt;msg&gt;</em>
1112 (option &lt;name&gt; is supported but &lt;value&gt; is not valid
1113 for it). Options should be set before other commands,
1114 and may influence the behavior of those commands.
1115</p>
1116<div class="paragraph"><p>See OPTIONS for a list of currently defined options.</p></div>
1117<div class="paragraph"><p>Supported if the helper has the "option" capability.</p></div>
1118</dd>
1119<dt class="hdlist1">
1120<em>fetch</em> &lt;sha1&gt; &lt;name&gt;
1121</dt>
1122<dd>
1123<p>
1124 Fetches the given object, writing the necessary objects
1125 to the database. Fetch commands are sent in a batch, one
1126 per line, terminated with a blank line.
1127 Outputs a single blank line when all fetch commands in the
1128 same batch are complete. Only objects which were reported
1129 in the output of <em>list</em> with a sha1 may be fetched this way.
1130</p>
Junio C Hamanoa8858312019-09-30 05:07:451131<div class="paragraph"><p>Optionally may output a <em>lock &lt;file&gt;</em> line indicating the full path of
1132a file under <code>$GIT_DIR/objects/pack</code> which is keeping a pack until
1133refs can be suitably updated. The path must end with <code>.keep</code>. This is
1134a mechanism to name a &lt;pack,idx,keep&gt; tuple by giving only the keep
1135component. The kept pack will not be deleted by a concurrent repack,
1136even though its objects may not be referenced until the fetch completes.
1137The <code>.keep</code> file will be deleted at the conclusion of the fetch.</p></div>
Junio C Hamano8eac2682013-09-09 22:35:201138<div class="paragraph"><p>If option <em>check-connectivity</em> is requested, the helper must output
1139<em>connectivity-ok</em> if the clone is self-contained and connected.</p></div>
Junio C Hamanob5e079f2013-02-08 00:02:521140<div class="paragraph"><p>Supported if the helper has the "fetch" capability.</p></div>
1141</dd>
1142<dt class="hdlist1">
1143<em>push</em> +&lt;src&gt;:&lt;dst&gt;
1144</dt>
1145<dd>
1146<p>
1147 Pushes the given local &lt;src&gt; commit or branch to the
1148 remote branch described by &lt;dst&gt;. A batch sequence of
1149 one or more <em>push</em> commands is terminated with a blank line
1150 (if there is only one reference to push, a single <em>push</em> command
1151 is followed by a blank line). For example, the following would
1152 be two batches of <em>push</em>, the first asking the remote-helper
1153 to push the local ref <em>master</em> to the remote ref <em>master</em> and
Junio C Hamano92d80372016-07-13 22:00:051154 the local <code>HEAD</code> to the remote <em>branch</em>, and the second
Junio C Hamanob5e079f2013-02-08 00:02:521155 asking to push ref <em>foo</em> to ref <em>bar</em> (forced update requested
1156 by the <em>+</em>).
1157</p>
1158<div class="listingblock">
1159<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:531160<pre><code>push refs/heads/master:refs/heads/master
Junio C Hamanob5e079f2013-02-08 00:02:521161push HEAD:refs/heads/branch
1162\n
1163push +refs/heads/foo:refs/heads/bar
Junio C Hamanoc14e6ad2014-10-31 20:25:531164\n</code></pre>
Junio C Hamanob5e079f2013-02-08 00:02:521165</div></div>
1166<div class="paragraph"><p>Zero or more protocol options may be entered after the last <em>push</em>
1167command, before the batch&#8217;s terminating blank line.</p></div>
1168<div class="paragraph"><p>When the push is complete, outputs one or more <em>ok &lt;dst&gt;</em> or
1169<em>error &lt;dst&gt; &lt;why&gt;?</em> lines to indicate success or failure of
1170each pushed ref. The status report output is terminated by
1171a blank line. The option field &lt;why&gt; may be quoted in a C
1172style string if it contains an LF.</p></div>
1173<div class="paragraph"><p>Supported if the helper has the "push" capability.</p></div>
1174</dd>
1175<dt class="hdlist1">
1176<em>import</em> &lt;name&gt;
1177</dt>
1178<dd>
1179<p>
1180 Produces a fast-import stream which imports the current value
1181 of the named ref. It may additionally import other refs as
1182 needed to construct the history efficiently. The script writes
1183 to a helper-specific private namespace. The value of the named
1184 ref should be written to a location in this namespace derived
1185 by applying the refspecs from the "refspec" capability to the
1186 name of the ref.
1187</p>
1188<div class="paragraph"><p>Especially useful for interoperability with a foreign versioning
1189system.</p></div>
1190<div class="paragraph"><p>Just like <em>push</em>, a batch sequence of one or more <em>import</em> is
1191terminated with a blank line. For each batch of <em>import</em>, the remote
1192helper should produce a fast-import stream terminated by a <em>done</em>
1193command.</p></div>
1194<div class="paragraph"><p>Note that if the <em>bidi-import</em> capability is used the complete batch
1195sequence has to be buffered before starting to send data to fast-import
1196to prevent mixing of commands and fast-import responses on the helper&#8217;s
1197stdin.</p></div>
1198<div class="paragraph"><p>Supported if the helper has the "import" capability.</p></div>
1199</dd>
1200<dt class="hdlist1">
1201<em>export</em>
1202</dt>
1203<dd>
1204<p>
1205 Instructs the remote helper that any subsequent input is
1206 part of a fast-import stream (generated by <em>git fast-export</em>)
1207 containing objects which should be pushed to the remote.
1208</p>
1209<div class="paragraph"><p>Especially useful for interoperability with a foreign versioning
1210system.</p></div>
1211<div class="paragraph"><p>The <em>export-marks</em> and <em>import-marks</em> capabilities, if specified,
1212affect this command in so far as they are passed on to <em>git
1213fast-export</em>, which then will load/store a table of marks for
1214local objects. This can be used to implement for incremental
1215operations.</p></div>
1216<div class="paragraph"><p>Supported if the helper has the "export" capability.</p></div>
1217</dd>
1218<dt class="hdlist1">
1219<em>connect</em> &lt;service&gt;
1220</dt>
1221<dd>
1222<p>
1223 Connects to given service. Standard input and standard output
1224 of helper are connected to specified service (git prefix is
1225 included in service name so e.g. fetching uses <em>git-upload-pack</em>
1226 as service) on remote side. Valid replies to this command are
1227 empty line (connection established), <em>fallback</em> (no smart
1228 transport support, fall back to dumb transports) and just
1229 exiting with error message printed (can&#8217;t connect, don&#8217;t
1230 bother trying to fall back). After line feed terminating the
1231 positive (empty) response, the output of service starts. After
1232 the connection ends, the remote helper exits.
1233</p>
1234<div class="paragraph"><p>Supported if the helper has the "connect" capability.</p></div>
1235</dd>
Junio C Hamanoccb82522018-05-08 07:52:091236<dt class="hdlist1">
1237<em>stateless-connect</em> &lt;service&gt;
1238</dt>
1239<dd>
1240<p>
1241 Experimental; for internal use only.
1242 Connects to the given remote service for communication using
1243 git&#8217;s wire-protocol version 2. Valid replies to this command
1244 are empty line (connection established), <em>fallback</em> (no smart
1245 transport support, fall back to dumb transports) and just
1246 exiting with error message printed (can&#8217;t connect, don&#8217;t bother
1247 trying to fall back). After line feed terminating the positive
1248 (empty) response, the output of the service starts. Messages
1249 (both request and response) must consist of zero or more
1250 PKT-LINEs, terminating in a flush packet. The client must not
1251 expect the server to store any state in between request-response
1252 pairs. After the connection ends, the remote helper exits.
1253</p>
1254<div class="paragraph"><p>Supported if the helper has the "stateless-connect" capability.</p></div>
1255</dd>
Junio C Hamanob5e079f2013-02-08 00:02:521256</dl></div>
1257<div class="paragraph"><p>If a fatal error occurs, the program writes the error message to
1258stderr and exits. The caller should expect that a suitable error
1259message has been printed if the child closes the connection without
1260completing a valid response for the current command.</p></div>
1261<div class="paragraph"><p>Additional commands may be supported, as may be determined from
1262capabilities reported by the helper.</p></div>
1263</div>
1264</div>
1265<div class="sect1">
1266<h2 id="_ref_list_attributes">REF LIST ATTRIBUTES</h2>
1267<div class="sectionbody">
1268<div class="paragraph"><p>The <em>list</em> command produces a list of refs in which each ref
1269may be followed by a list of attributes. The following ref list
1270attributes are defined.</p></div>
1271<div class="dlist"><dl>
1272<dt class="hdlist1">
1273<em>unchanged</em>
1274</dt>
1275<dd>
1276<p>
1277 This ref is unchanged since the last import or fetch, although
1278 the helper cannot necessarily determine what value that produced.
1279</p>
1280</dd>
1281</dl></div>
1282</div>
1283</div>
1284<div class="sect1">
1285<h2 id="_options">OPTIONS</h2>
1286<div class="sectionbody">
1287<div class="paragraph"><p>The following options are defined and (under suitable circumstances)
1288set by Git if the remote helper has the <em>option</em> capability.</p></div>
1289<div class="dlist"><dl>
1290<dt class="hdlist1">
1291<em>option verbosity</em> &lt;n&gt;
1292</dt>
1293<dd>
1294<p>
1295 Changes the verbosity of messages displayed by the helper.
1296 A value of 0 for &lt;n&gt; means that processes operate
1297 quietly, and the helper produces only error output.
1298 1 is the default level of verbosity, and higher values
1299 of &lt;n&gt; correspond to the number of -v flags passed on the
1300 command line.
1301</p>
1302</dd>
1303<dt class="hdlist1">
1304<em>option progress</em> {<em>true</em>|<em>false</em>}
1305</dt>
1306<dd>
1307<p>
1308 Enables (or disables) progress messages displayed by the
1309 transport helper during a command.
1310</p>
1311</dd>
1312<dt class="hdlist1">
1313<em>option depth</em> &lt;depth&gt;
1314</dt>
1315<dd>
1316<p>
1317 Deepens the history of a shallow repository.
1318</p>
1319</dd>
1320<dt class="hdlist1">
Junio C Hamano20829a42016-10-10 23:24:441321'option deepen-since &lt;timestamp&gt;
1322</dt>
1323<dd>
1324<p>
1325 Deepens the history of a shallow repository based on time.
1326</p>
1327</dd>
1328<dt class="hdlist1">
1329'option deepen-not &lt;ref&gt;
1330</dt>
1331<dd>
1332<p>
1333 Deepens the history of a shallow repository excluding ref.
1334 Multiple options add up.
1335</p>
1336</dd>
1337<dt class="hdlist1">
1338<em>option deepen-relative {'true</em>|<em>false</em>}
1339</dt>
1340<dd>
1341<p>
1342 Deepens the history of a shallow repository relative to
1343 current boundary. Only valid when used with "option depth".
1344</p>
1345</dd>
1346<dt class="hdlist1">
Junio C Hamanob5e079f2013-02-08 00:02:521347<em>option followtags</em> {<em>true</em>|<em>false</em>}
1348</dt>
1349<dd>
1350<p>
1351 If enabled the helper should automatically fetch annotated
1352 tag objects if the object the tag points at was transferred
1353 during the fetch command. If the tag is not fetched by
1354 the helper a second fetch command will usually be sent to
1355 ask for the tag specifically. Some helpers may be able to
1356 use this option to avoid a second network connection.
1357</p>
1358</dd>
1359</dl></div>
1360<div class="paragraph"><p><em>option dry-run</em> {<em>true</em>|<em>false</em>}:
1361 If true, pretend the operation completed successfully,
1362 but don&#8217;t actually change any repository data. For most
1363 helpers this only applies to the <em>push</em>, if supported.</p></div>
1364<div class="dlist"><dl>
1365<dt class="hdlist1">
1366<em>option servpath &lt;c-style-quoted-path&gt;</em>
1367</dt>
1368<dd>
1369<p>
1370 Sets service path (--upload-pack, --receive-pack etc.) for
1371 next connect. Remote helper may support this option, but
1372 must not rely on this option being set before
1373 connect request occurs.
1374</p>
1375</dd>
Junio C Hamano8eac2682013-09-09 22:35:201376<dt class="hdlist1">
1377<em>option check-connectivity</em> {<em>true</em>|<em>false</em>}
1378</dt>
1379<dd>
1380<p>
1381 Request the helper to check connectivity of a clone.
1382</p>
1383</dd>
Junio C Hamano61525f92014-01-17 22:46:491384<dt class="hdlist1">
Junio C Hamano3b0cdc22014-03-18 22:06:161385<em>option force</em> {<em>true</em>|<em>false</em>}
1386</dt>
1387<dd>
1388<p>
1389 Request the helper to perform a force update. Defaults to
1390 <em>false</em>.
1391</p>
1392</dd>
1393<dt class="hdlist1">
Junio C Hamanoe89102f2017-02-15 23:18:151394<em>option cloning</em> {<em>true</em>|<em>false</em>}
Junio C Hamano61525f92014-01-17 22:46:491395</dt>
1396<dd>
1397<p>
1398 Notify the helper this is a clone request (i.e. the current
1399 repository is guaranteed empty).
1400</p>
1401</dd>
1402<dt class="hdlist1">
Junio C Hamanoe89102f2017-02-15 23:18:151403<em>option update-shallow</em> {<em>true</em>|<em>false</em>}
Junio C Hamano61525f92014-01-17 22:46:491404</dt>
1405<dd>
1406<p>
1407 Allow to extend .git/shallow if the new refs require it.
1408</p>
1409</dd>
Junio C Hamano3891e252015-08-31 23:06:131410<dt class="hdlist1">
Junio C Hamanoe89102f2017-02-15 23:18:151411<em>option pushcert</em> {<em>true</em>|<em>false</em>}
Junio C Hamano3891e252015-08-31 23:06:131412</dt>
1413<dd>
1414<p>
1415 GPG sign pushes.
1416</p>
1417</dd>
Junio C Hamanoe89102f2017-02-15 23:18:151418<dt class="hdlist1">
1419'option push-option &lt;string&gt;
1420</dt>
1421<dd>
1422<p>
Junio C Hamano4c60d9a2017-05-04 14:36:221423 Transmit &lt;string&gt; as a push option. As the push option
Junio C Hamanoe89102f2017-02-15 23:18:151424 must not contain LF or NUL characters, the string is not encoded.
1425</p>
1426</dd>
Junio C Hamano640779d2018-02-14 01:29:141427<dt class="hdlist1">
1428<em>option from-promisor</em> {<em>true</em>|<em>false</em>}
1429</dt>
1430<dd>
1431<p>
1432 Indicate that these objects are being fetched from a promisor.
1433</p>
1434</dd>
1435<dt class="hdlist1">
1436<em>option no-dependents</em> {<em>true</em>|<em>false</em>}
1437</dt>
1438<dd>
1439<p>
1440 Indicate that only the objects wanted need to be fetched, not
1441 their dependents.
1442</p>
1443</dd>
Junio C Hamanoebc12702019-10-23 06:04:591444<dt class="hdlist1">
1445<em>option atomic</em> {<em>true</em>|<em>false</em>}
1446</dt>
1447<dd>
1448<p>
1449 When pushing, request the remote server to update refs in a single atomic
1450 transaction. If successful, all refs will be updated, or none will. If the
1451 remote side does not support this capability, the push will fail.
1452</p>
1453</dd>
Junio C Hamanob5e079f2013-02-08 00:02:521454</dl></div>
1455</div>
1456</div>
1457<div class="sect1">
1458<h2 id="_see_also">SEE ALSO</h2>
1459<div class="sectionbody">
1460<div class="paragraph"><p><a href="git-remote.html">git-remote(1)</a></p></div>
Junio C Hamano13220242014-11-19 23:06:271461<div class="paragraph"><p><a href="git-remote-ext.html">git-remote-ext(1)</a></p></div>
1462<div class="paragraph"><p><a href="git-remote-fd.html">git-remote-fd(1)</a></p></div>
Junio C Hamano13220242014-11-19 23:06:271463<div class="paragraph"><p><a href="git-fast-import.html">git-fast-import(1)</a></p></div>
Junio C Hamanob5e079f2013-02-08 00:02:521464</div>
1465</div>
1466<div class="sect1">
1467<h2 id="_git">GIT</h2>
1468<div class="sectionbody">
1469<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
1470</div>
1471</div>
1472</div>
1473<div id="footnotes"><hr /></div>
1474<div id="footer">
1475<div id="footer-text">
Junio C Hamano2ef0ba32018-01-26 23:13:531476Last updated
Junio C Hamano7a46cd62020-03-15 21:57:101477 2020-03-10 08:03:13 PDT
Junio C Hamanob5e079f2013-02-08 00:02:521478</div>
1479</div>
1480</body>
1481</html>