Autogenerated HTML docs for v2.45.1-204-gd8ab1
[git-htmldocs.git] / git-remote.html
blobf3626665cbf67ec408a947317ec198941b60b7b5
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>git-remote(1)</title>
9 <style type="text/css">
10 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
12 /* Default font. */
13 body {
14 font-family: Georgia,serif;
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;
27 body {
28 margin: 1em 5% 1em 5%;
31 a {
32 color: blue;
33 text-decoration: underline;
35 a:visited {
36 color: fuchsia;
39 em {
40 font-style: italic;
41 color: navy;
44 strong {
45 font-weight: bold;
46 color: #083194;
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;
56 h1, h2, h3 {
57 border-bottom: 2px solid silver;
59 h2 {
60 padding-top: 0.5em;
62 h3 {
63 float: left;
65 h3 + * {
66 clear: left;
68 h5 {
69 font-size: 1.0em;
72 div.sectionbody {
73 margin-left: 0;
76 hr {
77 border: 1px solid silver;
80 p {
81 margin-top: 0.5em;
82 margin-bottom: 0.5em;
85 ul, ol, li > p {
86 margin-top: 0;
88 ul > li { color: #aaa; }
89 ul > li > * { color: black; }
91 .monospaced, code, pre {
92 font-family: "Courier New", Courier, monospace;
93 font-size: inherit;
94 color: navy;
95 padding: 0;
96 margin: 0;
98 pre {
99 white-space: pre-wrap;
102 #author {
103 color: #527bbd;
104 font-weight: bold;
105 font-size: 1.1em;
107 #email {
109 #revnumber, #revdate, #revremark {
112 #footer {
113 font-size: small;
114 border-top: 2px solid silver;
115 padding-top: 0.5em;
116 margin-top: 4.0em;
118 #footer-text {
119 float: left;
120 padding-bottom: 0.5em;
122 #footer-badges {
123 float: right;
124 padding-bottom: 0.5em;
127 #preamble {
128 margin-top: 1.5em;
129 margin-bottom: 1.5em;
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;
137 div.admonitionblock {
138 margin-top: 2.0em;
139 margin-bottom: 2.0em;
140 margin-right: 10%;
141 color: #606060;
144 div.content { /* Block element content. */
145 padding: 0;
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;
156 div.title + * {
157 margin-top: 0;
160 td div.title:first-child {
161 margin-top: 0.0em;
163 div.content div.title:first-child {
164 margin-top: 0.0em;
166 div.content + div.title {
167 margin-top: 0.0em;
170 div.sidebarblock > div.content {
171 background: #ffffee;
172 border: 1px solid #dddddd;
173 border-left: 4px solid #f0f0f0;
174 padding: 0.5em;
177 div.listingblock > div.content {
178 border: 1px solid #dddddd;
179 border-left: 5px solid #f0f0f0;
180 background: #f8f8f8;
181 padding: 0.5em;
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;
192 div.quoteblock > div.attribution {
193 padding-top: 0.5em;
194 text-align: right;
197 div.verseblock > pre.content {
198 font-family: inherit;
199 font-size: inherit;
201 div.verseblock > div.attribution {
202 padding-top: 0.75em;
203 text-align: left;
205 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
206 div.verseblock + div.attribution {
207 text-align: left;
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;
218 div.admonitionblock td.content {
219 padding-left: 0.5em;
220 border-left: 3px solid #dddddd;
223 div.exampleblock > div.content {
224 border-left: 3px solid #dddddd;
225 padding-left: 0.5em;
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; }
232 dl {
233 margin-top: 0.8em;
234 margin-bottom: 0.8em;
236 dt {
237 margin-top: 0.5em;
238 margin-bottom: 0;
239 font-style: normal;
240 color: navy;
242 dd > *:first-child {
243 margin-top: 0.1em;
246 ul, ol {
247 list-style-position: outside;
249 ol.arabic {
250 list-style-type: decimal;
252 ol.loweralpha {
253 list-style-type: lower-alpha;
255 ol.upperalpha {
256 list-style-type: upper-alpha;
258 ol.lowerroman {
259 list-style-type: lower-roman;
261 ol.upperroman {
262 list-style-type: upper-roman;
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;
272 tfoot {
273 font-weight: bold;
275 td > div.verse {
276 white-space: pre;
279 div.hdlist {
280 margin-top: 0.8em;
281 margin-bottom: 0.8em;
283 div.hdlist tr {
284 padding-bottom: 15px;
286 dt.hdlist1.strong, td.hdlist1.strong {
287 font-weight: bold;
289 td.hdlist1 {
290 vertical-align: top;
291 font-style: normal;
292 padding-right: 0.8em;
293 color: navy;
295 td.hdlist2 {
296 vertical-align: top;
298 div.hdlist.compact tr {
299 margin: 0;
300 padding-bottom: 0;
303 .comment {
304 background: yellow;
307 .footnote, .footnoteref {
308 font-size: 0.8em;
311 span.footnote, span.footnoteref {
312 vertical-align: super;
315 #footnotes {
316 margin: 20px 0 20px 0;
317 padding: 7px 0 0 0;
320 #footnotes div.footnote {
321 margin: 0 0 5px 0;
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;
334 div.colist td {
335 padding-right: 0.5em;
336 padding-bottom: 0.3em;
337 vertical-align: top;
339 div.colist td img {
340 margin-top: 0.3em;
343 @media print {
344 #footer-badges { display: none; }
347 #toc {
348 margin-bottom: 2.5em;
351 #toctitle {
352 color: #527bbd;
353 font-size: 1.1em;
354 font-weight: bold;
355 margin-top: 1.0em;
356 margin-bottom: 0.1em;
359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
360 margin-top: 0;
361 margin-bottom: 0;
363 div.toclevel2 {
364 margin-left: 2em;
365 font-size: 0.9em;
367 div.toclevel3 {
368 margin-left: 4em;
369 font-size: 0.9em;
371 div.toclevel4 {
372 margin-left: 6em;
373 font-size: 0.9em;
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; }
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; }
410 span.big { font-size: 2em; }
411 span.small { font-size: 0.6em; }
413 span.underline { text-decoration: underline; }
414 span.overline { text-decoration: overline; }
415 span.line-through { text-decoration: line-through; }
417 div.unbreakable { page-break-inside: avoid; }
421 * xhtml11 specific
423 * */
425 div.tableblock {
426 margin-top: 1.0em;
427 margin-bottom: 1.5em;
429 div.tableblock > table {
430 border: 3px solid #527bbd;
432 thead, p.table.header {
433 font-weight: bold;
434 color: #527bbd;
436 p.table {
437 margin-top: 0;
439 /* Because the table frame attribute is overridden by CSS in most browsers. */
440 div.tableblock > table[frame="void"] {
441 border-style: none;
443 div.tableblock > table[frame="hsides"] {
444 border-left-style: none;
445 border-right-style: none;
447 div.tableblock > table[frame="vsides"] {
448 border-top-style: none;
449 border-bottom-style: none;
454 * html5 specific
456 * */
458 table.tableblock {
459 margin-top: 1.0em;
460 margin-bottom: 1.5em;
462 thead, p.tableblock.header {
463 font-weight: bold;
464 color: #527bbd;
466 p.tableblock {
467 margin-top: 0;
469 table.tableblock {
470 border-width: 3px;
471 border-spacing: 0px;
472 border-style: solid;
473 border-color: #527bbd;
474 border-collapse: collapse;
476 th.tableblock, td.tableblock {
477 border-width: 1px;
478 padding: 4px;
479 border-style: solid;
480 border-color: #527bbd;
483 table.tableblock.frame-topbot {
484 border-left-style: hidden;
485 border-right-style: hidden;
487 table.tableblock.frame-sides {
488 border-top-style: hidden;
489 border-bottom-style: hidden;
491 table.tableblock.frame-none {
492 border-style: hidden;
495 th.tableblock.halign-left, td.tableblock.halign-left {
496 text-align: left;
498 th.tableblock.halign-center, td.tableblock.halign-center {
499 text-align: center;
501 th.tableblock.halign-right, td.tableblock.halign-right {
502 text-align: right;
505 th.tableblock.valign-top, td.tableblock.valign-top {
506 vertical-align: top;
508 th.tableblock.valign-middle, td.tableblock.valign-middle {
509 vertical-align: middle;
511 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
512 vertical-align: bottom;
517 * manpage specific
519 * */
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;
527 body.manpage h2 {
528 border-style: none;
530 body.manpage div.sectionbody {
531 margin-left: 3em;
534 @media print {
535 body.manpage div#toc { display: none; }
539 </style>
540 <script type="text/javascript">
541 /*<![CDATA[*/
542 var asciidoc = { // Namespace.
544 /////////////////////////////////////////////////////////////////////
545 // Table Of Contents generator
546 /////////////////////////////////////////////////////////////////////
548 /* Author: Mihai Bazon, September 2002
549 * http://students.infoiasi.ro/~mishoo
551 * Table Of Content generator
552 * Version: 0.4
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.
558 /* modified by Troy D. Hanson, September 2006. License: GPL */
559 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
561 // toclevels = 1..4.
562 toc: function (toclevels) {
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);
572 return text;
575 function TocEntry(el, text, toclevel) {
576 this.element = el;
577 this.text = text;
578 this.toclevel = toclevel;
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);
594 iterate(i);
598 iterate(el);
599 return result;
602 var toc = document.getElementById("toc");
603 if (!toc) {
604 return;
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);
617 for (i = 0; i < tocEntriesToRemove.length; i++) {
618 toc.removeChild(tocEntriesToRemove[i]);
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);
635 if (entries.length == 0)
636 toc.parentNode.removeChild(toc);
640 /////////////////////////////////////////////////////////////////////
641 // Footnotes generator
642 /////////////////////////////////////////////////////////////////////
644 /* Based on footnote generation code from:
645 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
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;
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);
661 for (i = 0; i < entriesToRemove.length; i++) {
662 noteholder.removeChild(entriesToRemove[i]);
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);
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;
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>]";
708 install: function(toclevels) {
709 var timerId;
711 function reinstall() {
712 asciidoc.footnotes();
713 if (toclevels) {
714 asciidoc.toc(toclevels);
718 function reinstallAndRemoveTimer() {
719 clearInterval(timerId);
720 reinstall();
723 timerId = setInterval(reinstall, 500);
724 if (document.addEventListener)
725 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
726 else
727 window.onload = reinstallAndRemoveTimer;
731 asciidoc.install();
732 /*]]>*/
733 </script>
734 </head>
735 <body class="manpage">
736 <div id="header">
737 <h1>
738 git-remote(1) Manual Page
739 </h1>
740 <h2>NAME</h2>
741 <div class="sectionbody">
742 <p>git-remote -
743 Manage set of tracked 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</em> [-v | --verbose]
753 <em>git remote add</em> [-t &lt;branch&gt;] [-m &lt;master&gt;] [-f] [--[no-]tags] [--mirror=(fetch|push)] &lt;name&gt; &lt;URL&gt;
754 <em>git remote rename</em> [--[no-]progress] &lt;old&gt; &lt;new&gt;
755 <em>git remote remove</em> &lt;name&gt;
756 <em>git remote set-head</em> &lt;name&gt; (-a | --auto | -d | --delete | &lt;branch&gt;)
757 <em>git remote set-branches</em> [--add] &lt;name&gt; &lt;branch&gt;&#8230;
758 <em>git remote get-url</em> [--push] [--all] &lt;name&gt;
759 <em>git remote set-url</em> [--push] &lt;name&gt; &lt;newurl&gt; [&lt;oldurl&gt;]
760 <em>git remote set-url --add</em> [--push] &lt;name&gt; &lt;newurl&gt;
761 <em>git remote set-url --delete</em> [--push] &lt;name&gt; &lt;URL&gt;
762 <em>git remote</em> [-v | --verbose] <em>show</em> [-n] &lt;name&gt;&#8230;
763 <em>git remote prune</em> [-n | --dry-run] &lt;name&gt;&#8230;
764 <em>git remote</em> [-v | --verbose] <em>update</em> [-p | --prune] [(&lt;group&gt; | &lt;remote&gt;)&#8230;]</pre>
765 <div class="attribution">
766 </div></div>
767 </div>
768 </div>
769 <div class="sect1">
770 <h2 id="_description">DESCRIPTION</h2>
771 <div class="sectionbody">
772 <div class="paragraph"><p>Manage the set of repositories ("remotes") whose branches you track.</p></div>
773 </div>
774 </div>
775 <div class="sect1">
776 <h2 id="_options">OPTIONS</h2>
777 <div class="sectionbody">
778 <div class="dlist"><dl>
779 <dt class="hdlist1">
781 </dt>
782 <dt class="hdlist1">
783 --verbose
784 </dt>
785 <dd>
787 Be a little more verbose and show remote url after name.
788 For promisor remotes, also show which filters (<code>blob:none</code> etc.)
789 are configured.
790 NOTE: This must be placed between <code>remote</code> and subcommand.
791 </p>
792 </dd>
793 </dl></div>
794 </div>
795 </div>
796 <div class="sect1">
797 <h2 id="_commands">COMMANDS</h2>
798 <div class="sectionbody">
799 <div class="paragraph"><p>With no arguments, shows a list of existing remotes. Several
800 subcommands are available to perform operations on the remotes.</p></div>
801 <div class="dlist"><dl>
802 <dt class="hdlist1">
803 <em>add</em>
804 </dt>
805 <dd>
807 Add a remote named &lt;name&gt; for the repository at
808 &lt;URL&gt;. The command <code>git fetch &lt;name&gt;</code> can then be used to create and
809 update remote-tracking branches &lt;name&gt;/&lt;branch&gt;.
810 </p>
811 <div class="paragraph"><p>With <code>-f</code> option, <code>git fetch &lt;name&gt;</code> is run immediately after
812 the remote information is set up.</p></div>
813 <div class="paragraph"><p>With <code>--tags</code> option, <code>git fetch &lt;name&gt;</code> imports every tag from the
814 remote repository.</p></div>
815 <div class="paragraph"><p>With <code>--no-tags</code> option, <code>git fetch &lt;name&gt;</code> does not import tags from
816 the remote repository.</p></div>
817 <div class="paragraph"><p>By default, only tags on fetched branches are imported
818 (see <a href="git-fetch.html">git-fetch(1)</a>).</p></div>
819 <div class="paragraph"><p>With <code>-t &lt;branch&gt;</code> option, instead of the default glob
820 refspec for the remote to track all branches under
821 the <code>refs/remotes/&lt;name&gt;/</code> namespace, a refspec to track only <code>&lt;branch&gt;</code>
822 is created. You can give more than one <code>-t &lt;branch&gt;</code> to track
823 multiple branches without grabbing all branches.</p></div>
824 <div class="paragraph"><p>With <code>-m &lt;master&gt;</code> option, a symbolic-ref <code>refs/remotes/&lt;name&gt;/HEAD</code> is set
825 up to point at remote&#8217;s <code>&lt;master&gt;</code> branch. See also the set-head command.</p></div>
826 <div class="paragraph"><p>When a fetch mirror is created with <code>--mirror=fetch</code>, the refs will not
827 be stored in the <em>refs/remotes/</em> namespace, but rather everything in
828 <em>refs/</em> on the remote will be directly mirrored into <em>refs/</em> in the
829 local repository. This option only makes sense in bare repositories,
830 because a fetch would overwrite any local commits.</p></div>
831 <div class="paragraph"><p>When a push mirror is created with <code>--mirror=push</code>, then <code>git push</code>
832 will always behave as if <code>--mirror</code> was passed.</p></div>
833 </dd>
834 <dt class="hdlist1">
835 <em>rename</em>
836 </dt>
837 <dd>
839 Rename the remote named &lt;old&gt; to &lt;new&gt;. All remote-tracking branches and
840 configuration settings for the remote are updated.
841 </p>
842 <div class="paragraph"><p>In case &lt;old&gt; and &lt;new&gt; are the same, and &lt;old&gt; is a file under
843 <code>$GIT_DIR/remotes</code> or <code>$GIT_DIR/branches</code>, the remote is converted to
844 the configuration file format.</p></div>
845 </dd>
846 <dt class="hdlist1">
847 <em>remove</em>
848 </dt>
849 <dt class="hdlist1">
850 <em>rm</em>
851 </dt>
852 <dd>
854 Remove the remote named &lt;name&gt;. All remote-tracking branches and
855 configuration settings for the remote are removed.
856 </p>
857 </dd>
858 <dt class="hdlist1">
859 <em>set-head</em>
860 </dt>
861 <dd>
863 Sets or deletes the default branch (i.e. the target of the
864 symbolic-ref <code>refs/remotes/&lt;name&gt;/HEAD</code>) for
865 the named remote. Having a default branch for a remote is not required,
866 but allows the name of the remote to be specified in lieu of a specific
867 branch. For example, if the default branch for <code>origin</code> is set to
868 <code>master</code>, then <code>origin</code> may be specified wherever you would normally
869 specify <code>origin/master</code>.
870 </p>
871 <div class="paragraph"><p>With <code>-d</code> or <code>--delete</code>, the symbolic ref <code>refs/remotes/&lt;name&gt;/HEAD</code> is deleted.</p></div>
872 <div class="paragraph"><p>With <code>-a</code> or <code>--auto</code>, the remote is queried to determine its <code>HEAD</code>, then the
873 symbolic-ref <code>refs/remotes/&lt;name&gt;/HEAD</code> is set to the same branch. e.g., if the remote
874 <code>HEAD</code> is pointed at <code>next</code>, <code>git remote set-head origin -a</code> will set
875 the symbolic-ref <code>refs/remotes/origin/HEAD</code> to <code>refs/remotes/origin/next</code>. This will
876 only work if <code>refs/remotes/origin/next</code> already exists; if not it must be
877 fetched first.</p></div>
878 <div class="paragraph"><p>Use <code>&lt;branch&gt;</code> to set the symbolic-ref <code>refs/remotes/&lt;name&gt;/HEAD</code> explicitly. e.g., <code>git
879 remote set-head origin master</code> will set the symbolic-ref <code>refs/remotes/origin/HEAD</code> to
880 <code>refs/remotes/origin/master</code>. This will only work if
881 <code>refs/remotes/origin/master</code> already exists; if not it must be fetched first.</p></div>
882 </dd>
883 <dt class="hdlist1">
884 <em>set-branches</em>
885 </dt>
886 <dd>
888 Changes the list of branches tracked by the named remote.
889 This can be used to track a subset of the available remote branches
890 after the initial setup for a remote.
891 </p>
892 <div class="paragraph"><p>The named branches will be interpreted as if specified with the
893 <code>-t</code> option on the <code>git remote add</code> command line.</p></div>
894 <div class="paragraph"><p>With <code>--add</code>, instead of replacing the list of currently tracked
895 branches, adds to that list.</p></div>
896 </dd>
897 <dt class="hdlist1">
898 <em>get-url</em>
899 </dt>
900 <dd>
902 Retrieves the URLs for a remote. Configurations for <code>insteadOf</code> and
903 <code>pushInsteadOf</code> are expanded here. By default, only the first URL is listed.
904 </p>
905 <div class="paragraph"><p>With <code>--push</code>, push URLs are queried rather than fetch URLs.</p></div>
906 <div class="paragraph"><p>With <code>--all</code>, all URLs for the remote will be listed.</p></div>
907 </dd>
908 <dt class="hdlist1">
909 <em>set-url</em>
910 </dt>
911 <dd>
913 Changes URLs for the remote. Sets first URL for remote &lt;name&gt; that matches
914 regex &lt;oldurl&gt; (first URL if no &lt;oldurl&gt; is given) to &lt;newurl&gt;. If
915 &lt;oldurl&gt; doesn&#8217;t match any URL, an error occurs and nothing is changed.
916 </p>
917 <div class="paragraph"><p>With <code>--push</code>, push URLs are manipulated instead of fetch URLs.</p></div>
918 <div class="paragraph"><p>With <code>--add</code>, instead of changing existing URLs, new URL is added.</p></div>
919 <div class="paragraph"><p>With <code>--delete</code>, instead of changing existing URLs, all URLs matching
920 regex &lt;URL&gt; are deleted for remote &lt;name&gt;. Trying to delete all
921 non-push URLs is an error.</p></div>
922 <div class="paragraph"><p>Note that the push URL and the fetch URL, even though they can
923 be set differently, must still refer to the same place. What you
924 pushed to the push URL should be what you would see if you
925 immediately fetched from the fetch URL. If you are trying to
926 fetch from one place (e.g. your upstream) and push to another (e.g.
927 your publishing repository), use two separate remotes.</p></div>
928 </dd>
929 <dt class="hdlist1">
930 <em>show</em>
931 </dt>
932 <dd>
934 Gives some information about the remote &lt;name&gt;.
935 </p>
936 <div class="paragraph"><p>With <code>-n</code> option, the remote heads are not queried first with
937 <code>git ls-remote &lt;name&gt;</code>; cached information is used instead.</p></div>
938 </dd>
939 <dt class="hdlist1">
940 <em>prune</em>
941 </dt>
942 <dd>
944 Deletes stale references associated with &lt;name&gt;. By default, stale
945 remote-tracking branches under &lt;name&gt; are deleted, but depending on
946 global configuration and the configuration of the remote we might even
947 prune local tags that haven&#8217;t been pushed there. Equivalent to <code>git
948 fetch --prune &lt;name&gt;</code>, except that no new references will be fetched.
949 </p>
950 <div class="paragraph"><p>See the PRUNING section of <a href="git-fetch.html">git-fetch(1)</a> for what it&#8217;ll prune
951 depending on various configuration.</p></div>
952 <div class="paragraph"><p>With <code>--dry-run</code> option, report what branches would be pruned, but do not
953 actually prune them.</p></div>
954 </dd>
955 <dt class="hdlist1">
956 <em>update</em>
957 </dt>
958 <dd>
960 Fetch updates for remotes or remote groups in the repository as defined by
961 <code>remotes.&lt;group&gt;</code>. If neither group nor remote is specified on the command line,
962 the configuration parameter remotes.default will be used; if
963 remotes.default is not defined, all remotes which do not have the
964 configuration parameter <code>remote.&lt;name&gt;.skipDefaultUpdate</code> set to true will
965 be updated. (See <a href="git-config.html">git-config(1)</a>).
966 </p>
967 <div class="paragraph"><p>With <code>--prune</code> option, run pruning against all the remotes that are updated.</p></div>
968 </dd>
969 </dl></div>
970 </div>
971 </div>
972 <div class="sect1">
973 <h2 id="_discussion">DISCUSSION</h2>
974 <div class="sectionbody">
975 <div class="paragraph"><p>The remote configuration is achieved using the <code>remote.origin.url</code> and
976 <code>remote.origin.fetch</code> configuration variables. (See
977 <a href="git-config.html">git-config(1)</a>).</p></div>
978 </div>
979 </div>
980 <div class="sect1">
981 <h2 id="_exit_status">EXIT STATUS</h2>
982 <div class="sectionbody">
983 <div class="paragraph"><p>On success, the exit status is <code>0</code>.</p></div>
984 <div class="paragraph"><p>When subcommands such as <em>add</em>, <em>rename</em>, and <em>remove</em> can&#8217;t find the
985 remote in question, the exit status is <code>2</code>. When the remote already
986 exists, the exit status is <code>3</code>.</p></div>
987 <div class="paragraph"><p>On any other error, the exit status may be any other non-zero value.</p></div>
988 </div>
989 </div>
990 <div class="sect1">
991 <h2 id="_examples">EXAMPLES</h2>
992 <div class="sectionbody">
993 <div class="ulist"><ul>
994 <li>
996 Add a new remote, fetch, and check out a branch from it
997 </p>
998 <div class="listingblock">
999 <div class="content">
1000 <pre><code>$ git remote
1001 origin
1002 $ git branch -r
1003 origin/HEAD -&gt; origin/master
1004 origin/master
1005 $ git remote add staging git://git.kernel.org/.../gregkh/staging.git
1006 $ git remote
1007 origin
1008 staging
1009 $ git fetch staging
1011 From git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/staging
1012 * [new branch] master -&gt; staging/master
1013 * [new branch] staging-linus -&gt; staging/staging-linus
1014 * [new branch] staging-next -&gt; staging/staging-next
1015 $ git branch -r
1016 origin/HEAD -&gt; origin/master
1017 origin/master
1018 staging/master
1019 staging/staging-linus
1020 staging/staging-next
1021 $ git switch -c staging staging/master
1022 ...</code></pre>
1023 </div></div>
1024 </li>
1025 <li>
1027 Imitate <em>git clone</em> but track only selected branches
1028 </p>
1029 <div class="listingblock">
1030 <div class="content">
1031 <pre><code>$ mkdir project.git
1032 $ cd project.git
1033 $ git init
1034 $ git remote add -f -t master -m master origin git://example.com/git.git/
1035 $ git merge origin</code></pre>
1036 </div></div>
1037 </li>
1038 </ul></div>
1039 </div>
1040 </div>
1041 <div class="sect1">
1042 <h2 id="_see_also">SEE ALSO</h2>
1043 <div class="sectionbody">
1044 <div class="paragraph"><p><a href="git-fetch.html">git-fetch(1)</a>
1045 <a href="git-branch.html">git-branch(1)</a>
1046 <a href="git-config.html">git-config(1)</a></p></div>
1047 </div>
1048 </div>
1049 <div class="sect1">
1050 <h2 id="_git">GIT</h2>
1051 <div class="sectionbody">
1052 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
1053 </div>
1054 </div>
1055 </div>
1056 <div id="footnotes"><hr /></div>
1057 <div id="footer">
1058 <div id="footer-text">
1059 Last updated
1060 2024-03-01 17:30:58 PST
1061 </div>
1062 </div>
1063 </body>
1064 </html>