git-clone.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
   2     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
   6 <meta name="generator" content="AsciiDoc 8.5.2" />
   7 <title>git-clone(1)</title>
   8 <style type="text/css">
   9 /* Debug borders */
  10 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
  11 /*
  12   border: 1px solid red;
  13 */
  14 }
  15
  16 body {
  17   margin: 1em 5% 1em 5%;
  18 }
  19
  20 a {
  21   color: blue;
  22   text-decoration: underline;
  23 }
  24 a:visited {
  25   color: fuchsia;
  26 }
  27
  28 em {
  29   font-style: italic;
  30   color: navy;
  31 }
  32
  33 strong {
  34   font-weight: bold;
  35   color: #083194;
  36 }
  37
  38 tt {
  39   color: navy;
  40 }
  41
  42 h1, h2, h3, h4, h5, h6 {
  43   color: #527bbd;
  44   font-family: sans-serif;
  45   margin-top: 1.2em;
  46   margin-bottom: 0.5em;
  47   line-height: 1.3;
  48 }
  49
  50 h1, h2, h3 {
  51   border-bottom: 2px solid silver;
  52 }
  53 h2 {
  54   padding-top: 0.5em;
  55 }
  56 h3 {
  57   float: left;
  58 }
  59 h3 + * {
  60   clear: left;
  61 }
  62
  63 div.sectionbody {
  64   font-family: serif;
  65   margin-left: 0;
  66 }
  67
  68 hr {
  69   border: 1px solid silver;
  70 }
  71
  72 p {
  73   margin-top: 0.5em;
  74   margin-bottom: 0.5em;
  75 }
  76
  77 ul, ol, li > p {
  78   margin-top: 0;
  79 }
  80
  81 pre {
  82   padding: 0;
  83   margin: 0;
  84 }
  85
  86 span#author {
  87   color: #527bbd;
  88   font-family: sans-serif;
  89   font-weight: bold;
  90   font-size: 1.1em;
  91 }
  92 span#email {
  93 }
  94 span#revnumber, span#revdate, span#revremark {
  95   font-family: sans-serif;
  96 }
  97
  98 div#footer {
  99   font-family: sans-serif;
 100   font-size: small;
 101   border-top: 2px solid silver;
 102   padding-top: 0.5em;
 103   margin-top: 4.0em;
 104 }
 105 div#footer-text {
 106   float: left;
 107   padding-bottom: 0.5em;
 108 }
 109 div#footer-badges {
 110   float: right;
 111   padding-bottom: 0.5em;
 112 }
 113
 114 div#preamble {
 115   margin-top: 1.5em;
 116   margin-bottom: 1.5em;
 117 }
 118 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
 119 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 120 div.admonitionblock {
 121   margin-top: 1.0em;
 122   margin-bottom: 1.5em;
 123 }
 124 div.admonitionblock {
 125   margin-top: 2.0em;
 126   margin-bottom: 2.0em;
 127   margin-right: 10%;
 128   color: #606060;
 129 }
 130
 131 div.content { /* Block element content. */
 132   padding: 0;
 133 }
 134
 135 /* Block element titles. */
 136 div.title, caption.title {
 137   color: #527bbd;
 138   font-family: sans-serif;
 139   font-weight: bold;
 140   text-align: left;
 141   margin-top: 1.0em;
 142   margin-bottom: 0.5em;
 143 }
 144 div.title + * {
 145   margin-top: 0;
 146 }
 147
 148 td div.title:first-child {
 149   margin-top: 0.0em;
 150 }
 151 div.content div.title:first-child {
 152   margin-top: 0.0em;
 153 }
 154 div.content + div.title {
 155   margin-top: 0.0em;
 156 }
 157
 158 div.sidebarblock > div.content {
 159   background: #ffffee;
 160   border: 1px solid silver;
 161   padding: 0.5em;
 162 }
 163
 164 div.listingblock > div.content {
 165   border: 1px solid silver;
 166   background: #f4f4f4;
 167   padding: 0.5em;
 168 }
 169
 170 div.quoteblock, div.verseblock {
 171   padding-left: 1.0em;
 172   margin-left: 1.0em;
 173   margin-right: 10%;
 174   border-left: 5px solid #dddddd;
 175   color: #777777;
 176 }
 177
 178 div.quoteblock > div.attribution {
 179   padding-top: 0.5em;
 180   text-align: right;
 181 }
 182
 183 div.verseblock > div.content {
 184   white-space: pre;
 185 }
 186 div.verseblock > div.attribution {
 187   padding-top: 0.75em;
 188   text-align: left;
 189 }
 190 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
 191 div.verseblock + div.attribution {
 192   text-align: left;
 193 }
 194
 195 div.admonitionblock .icon {
 196   vertical-align: top;
 197   font-size: 1.1em;
 198   font-weight: bold;
 199   text-decoration: underline;
 200   color: #527bbd;
 201   padding-right: 0.5em;
 202 }
 203 div.admonitionblock td.content {
 204   padding-left: 0.5em;
 205   border-left: 3px solid #dddddd;
 206 }
 207
 208 div.exampleblock > div.content {
 209   border-left: 3px solid #dddddd;
 210   padding-left: 0.5em;
 211 }
 212
 213 div.imageblock div.content { padding-left: 0; }
 214 span.image img { border-style: none; }
 215 a.image:visited { color: white; }
 216
 217 dl {
 218   margin-top: 0.8em;
 219   margin-bottom: 0.8em;
 220 }
 221 dt {
 222   margin-top: 0.5em;
 223   margin-bottom: 0;
 224   font-style: normal;
 225   color: navy;
 226 }
 227 dd > *:first-child {
 228   margin-top: 0.1em;
 229 }
 230
 231 ul, ol {
 232     list-style-position: outside;
 233 }
 234 ol.arabic {
 235   list-style-type: decimal;
 236 }
 237 ol.loweralpha {
 238   list-style-type: lower-alpha;
 239 }
 240 ol.upperalpha {
 241   list-style-type: upper-alpha;
 242 }
 243 ol.lowerroman {
 244   list-style-type: lower-roman;
 245 }
 246 ol.upperroman {
 247   list-style-type: upper-roman;
 248 }
 249
 250 div.compact ul, div.compact ol,
 251 div.compact p, div.compact p,
 252 div.compact div, div.compact div {
 253   margin-top: 0.1em;
 254   margin-bottom: 0.1em;
 255 }
 256
 257 div.tableblock > table {
 258   border: 3px solid #527bbd;
 259 }
 260 thead, p.table.header {
 261   font-family: sans-serif;
 262   font-weight: bold;
 263 }
 264 tfoot {
 265   font-weight: bold;
 266 }
 267 td > div.verse {
 268   white-space: pre;
 269 }
 270 p.table {
 271   margin-top: 0;
 272 }
 273 /* Because the table frame attribute is overriden by CSS in most browsers. */
 274 div.tableblock > table[frame="void"] {
 275   border-style: none;
 276 }
 277 div.tableblock > table[frame="hsides"] {
 278   border-left-style: none;
 279   border-right-style: none;
 280 }
 281 div.tableblock > table[frame="vsides"] {
 282   border-top-style: none;
 283   border-bottom-style: none;
 284 }
 285
 286
 287 div.hdlist {
 288   margin-top: 0.8em;
 289   margin-bottom: 0.8em;
 290 }
 291 div.hdlist tr {
 292   padding-bottom: 15px;
 293 }
 294 dt.hdlist1.strong, td.hdlist1.strong {
 295   font-weight: bold;
 296 }
 297 td.hdlist1 {
 298   vertical-align: top;
 299   font-style: normal;
 300   padding-right: 0.8em;
 301   color: navy;
 302 }
 303 td.hdlist2 {
 304   vertical-align: top;
 305 }
 306 div.hdlist.compact tr {
 307   margin: 0;
 308   padding-bottom: 0;
 309 }
 310
 311 .comment {
 312   background: yellow;
 313 }
 314
 315 .footnote, .footnoteref {
 316   font-size: 0.8em;
 317 }
 318
 319 span.footnote, span.footnoteref {
 320   vertical-align: super;
 321 }
 322
 323 #footnotes {
 324   margin: 20px 0 20px 0;
 325   padding: 7px 0 0 0;
 326 }
 327
 328 #footnotes div.footnote {
 329   margin: 0 0 5px 0;
 330 }
 331
 332 #footnotes hr {
 333   border: none;
 334   border-top: 1px solid silver;
 335   height: 1px;
 336   text-align: left;
 337   margin-left: 0;
 338   width: 20%;
 339   min-width: 100px;
 340 }
 341
 342
 343 @media print {
 344   div#footer-badges { display: none; }
 345 }
 346
 347 div#toc {
 348   margin-bottom: 2.5em;
 349 }
 350
 351 div#toctitle {
 352   color: #527bbd;
 353   font-family: sans-serif;
 354   font-size: 1.1em;
 355   font-weight: bold;
 356   margin-top: 1.0em;
 357   margin-bottom: 0.1em;
 358 }
 359
 360 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 361   margin-top: 0;
 362   margin-bottom: 0;
 363 }
 364 div.toclevel2 {
 365   margin-left: 2em;
 366   font-size: 0.9em;
 367 }
 368 div.toclevel3 {
 369   margin-left: 4em;
 370   font-size: 0.9em;
 371 }
 372 div.toclevel4 {
 373   margin-left: 6em;
 374   font-size: 0.9em;
 375 }
 376 /* Overrides for manpage documents */
 377 h1 {
 378   padding-top: 0.5em;
 379   padding-bottom: 0.5em;
 380   border-top: 2px solid silver;
 381   border-bottom: 2px solid silver;
 382 }
 383 h2 {
 384   border-style: none;
 385 }
 386 div.sectionbody {
 387   margin-left: 5%;
 388 }
 389
 390 @media print {
 391   div#toc { display: none; }
 392 }
 393
 394 /* Workarounds for IE6's broken and incomplete CSS2. */
 395
 396 div.sidebar-content {
 397   background: #ffffee;
 398   border: 1px solid silver;
 399   padding: 0.5em;
 400 }
 401 div.sidebar-title, div.image-title {
 402   color: #527bbd;
 403   font-family: sans-serif;
 404   font-weight: bold;
 405   margin-top: 0.0em;
 406   margin-bottom: 0.5em;
 407 }
 408
 409 div.listingblock div.content {
 410   border: 1px solid silver;
 411   background: #f4f4f4;
 412   padding: 0.5em;
 413 }
 414
 415 div.quoteblock-attribution {
 416   padding-top: 0.5em;
 417   text-align: right;
 418 }
 419
 420 div.verseblock-content {
 421   white-space: pre;
 422 }
 423 div.verseblock-attribution {
 424   padding-top: 0.75em;
 425   text-align: left;
 426 }
 427
 428 div.exampleblock-content {
 429   border-left: 3px solid #dddddd;
 430   padding-left: 0.5em;
 431 }
 432
 433 /* IE6 sets dynamically generated links as visited. */
 434 div#toc a:visited { color: blue; }
 435 </style>
 436 <script type="text/javascript">
 437 /*<![CDATA[*/
 438 window.onload = function(){asciidoc.footnotes();}
 439 var asciidoc = {  // Namespace.
 440
 441 /////////////////////////////////////////////////////////////////////
 442 // Table Of Contents generator
 443 /////////////////////////////////////////////////////////////////////
 444
 445 /* Author: Mihai Bazon, September 2002
 446  * http://students.infoiasi.ro/~mishoo
 447  *
 448  * Table Of Content generator
 449  * Version: 0.4
 450  *
 451  * Feel free to use this script under the terms of the GNU General Public
 452  * License, as long as you do not remove or alter this notice.
 453  */
 454
 455  /* modified by Troy D. Hanson, September 2006. License: GPL */
 456  /* modified by Stuart Rackham, 2006, 2009. License: GPL */
 457
 458 // toclevels = 1..4.
 459 toc: function (toclevels) {
 460
 461   function getText(el) {
 462     var text = "";
 463     for (var i = el.firstChild; i != null; i = i.nextSibling) {
 464       if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
 465         text += i.data;
 466       else if (i.firstChild != null)
 467         text += getText(i);
 468     }
 469     return text;
 470   }
 471
 472   function TocEntry(el, text, toclevel) {
 473     this.element = el;
 474     this.text = text;
 475     this.toclevel = toclevel;
 476   }
 477
 478   function tocEntries(el, toclevels) {
 479     var result = new Array;
 480     var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
 481     // Function that scans the DOM tree for header elements (the DOM2
 482     // nodeIterator API would be a better technique but not supported by all
 483     // browsers).
 484     var iterate = function (el) {
 485       for (var i = el.firstChild; i != null; i = i.nextSibling) {
 486         if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
 487           var mo = re.exec(i.tagName);
 488           if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
 489             result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
 490           }
 491           iterate(i);
 492         }
 493       }
 494     }
 495     iterate(el);
 496     return result;
 497   }
 498
 499   var toc = document.getElementById("toc");
 500   var entries = tocEntries(document.getElementById("content"), toclevels);
 501   for (var i = 0; i < entries.length; ++i) {
 502     var entry = entries[i];
 503     if (entry.element.id == "")
 504       entry.element.id = "_toc_" + i;
 505     var a = document.createElement("a");
 506     a.href = "#" + entry.element.id;
 507     a.appendChild(document.createTextNode(entry.text));
 508     var div = document.createElement("div");
 509     div.appendChild(a);
 510     div.className = "toclevel" + entry.toclevel;
 511     toc.appendChild(div);
 512   }
 513   if (entries.length == 0)
 514     toc.parentNode.removeChild(toc);
 515 },
 516
 517
 518 /////////////////////////////////////////////////////////////////////
 519 // Footnotes generator
 520 /////////////////////////////////////////////////////////////////////
 521
 522 /* Based on footnote generation code from:
 523  * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
 524  */
 525
 526 footnotes: function () {
 527   var cont = document.getElementById("content");
 528   var noteholder = document.getElementById("footnotes");
 529   var spans = cont.getElementsByTagName("span");
 530   var refs = {};
 531   var n = 0;
 532   for (i=0; i<spans.length; i++) {
 533     if (spans[i].className == "footnote") {
 534       n++;
 535       // Use [\s\S] in place of . so multi-line matches work.
 536       // Because JavaScript has no s (dotall) regex flag.
 537       note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
 538       noteholder.innerHTML +=
 539         "<div class='footnote' id='_footnote_" + n + "'>" +
 540         "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
 541         n + "</a>. " + note + "</div>";
 542       spans[i].innerHTML =
 543         "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
 544         "' title='View footnote' class='footnote'>" + n + "</a>]";
 545       var id =spans[i].getAttribute("id");
 546       if (id != null) refs["#"+id] = n;
 547     }
 548   }
 549   if (n == 0)
 550     noteholder.parentNode.removeChild(noteholder);
 551   else {
 552     // Process footnoterefs.
 553     for (i=0; i<spans.length; i++) {
 554       if (spans[i].className == "footnoteref") {
 555         var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
 556         href = href.match(/#.*/)[0];  // Because IE return full URL.
 557         n = refs[href];
 558         spans[i].innerHTML =
 559           "[<a href='#_footnote_" + n +
 560           "' title='View footnote' class='footnote'>" + n + "</a>]";
 561       }
 562     }
 563   }
 564 }
 565
 566 }
 567 /*]]>*/
 568 </script>
 569 </head>
 570 <body>
 571 <div id="header">
 572 <h1>
 573 git-clone(1) Manual Page
 574 </h1>
 575 <h2>NAME</h2>
 576 <div class="sectionbody">
 577 <p>git-clone -
 578    Clone a repository into a new directory
 579 </p>
 580 </div>
 581 </div>
 582 <div id="content">
 583 <h2 id="_synopsis">SYNOPSIS</h2>
 584 <div class="sectionbody">
 585 <div class="verseblock">
 586 <div class="verseblock-content"><em>git clone</em> [--template=&lt;template_directory&gt;]
 587           [-l] [-s] [--no-hardlinks] [-q] [-n] [--bare] [--mirror]
 588           [-o &lt;name&gt;] [-b &lt;name&gt;] [-u &lt;upload-pack&gt;] [--reference &lt;repository&gt;]
 589           [--separate-git-dir &lt;git dir&gt;]
 590           [--depth &lt;depth&gt;] [--recursive|--recurse-submodules] [--] &lt;repository&gt;
 591           [&lt;directory&gt;]</div>
 592 <div class="verseblock-attribution">
 593 </div></div>
 594 </div>
 595 <h2 id="_description">DESCRIPTION</h2>
 596 <div class="sectionbody">
 597 <div class="paragraph"><p>Clones a repository into a newly created directory, creates
 598 remote-tracking branches for each branch in the cloned repository
 599 (visible using <tt>git branch -r</tt>), and creates and checks out an
 600 initial branch that is forked from the cloned repository&#8217;s
 601 currently active branch.</p></div>
 602 <div class="paragraph"><p>After the clone, a plain <tt>git fetch</tt> without arguments will update
 603 all the remote-tracking branches, and a <tt>git pull</tt> without
 604 arguments will in addition merge the remote master branch into the
 605 current master branch, if any.</p></div>
 606 <div class="paragraph"><p>This default configuration is achieved by creating references to
 607 the remote branch heads under <tt>refs/remotes/origin</tt> and
 608 by initializing <tt>remote.origin.url</tt> and <tt>remote.origin.fetch</tt>
 609 configuration variables.</p></div>
 610 </div>
 611 <h2 id="_options">OPTIONS</h2>
 612 <div class="sectionbody">
 613 <div class="dlist"><dl>
 614 <dt class="hdlist1">
 615 --local
 616 </dt>
 617 <dt class="hdlist1">
 618 -l
 619 </dt>
 620 <dd>
 621 <p>
 622         When the repository to clone from is on a local machine,
 623         this flag bypasses the normal "git aware" transport
 624         mechanism and clones the repository by making a copy of
 625         HEAD and everything under objects and refs directories.
 626         The files under <tt>.git/objects/</tt> directory are hardlinked
 627         to save space when possible.  This is now the default when
 628         the source repository is specified with <tt>/path/to/repo</tt>
 629         syntax, so it essentially is a no-op option.  To force
 630         copying instead of hardlinking (which may be desirable
 631         if you are trying to make a back-up of your repository),
 632         but still avoid the usual "git aware" transport
 633         mechanism, <tt>--no-hardlinks</tt> can be used.
 634 </p>
 635 </dd>
 636 <dt class="hdlist1">
 637 --no-hardlinks
 638 </dt>
 639 <dd>
 640 <p>
 641         Optimize the cloning process from a repository on a
 642         local filesystem by copying files under <tt>.git/objects</tt>
 643         directory.
 644 </p>
 645 </dd>
 646 <dt class="hdlist1">
 647 --shared
 648 </dt>
 649 <dt class="hdlist1">
 650 -s
 651 </dt>
 652 <dd>
 653 <p>
 654         When the repository to clone is on the local machine,
 655         instead of using hard links, automatically setup
 656         <tt>.git/objects/info/alternates</tt> to share the objects
 657         with the source repository.  The resulting repository
 658         starts out without any object of its own.
 659 </p>
 660 <div class="paragraph"><p><strong>NOTE</strong>: this is a possibly dangerous operation; do <strong>not</strong> use
 661 it unless you understand what it does. If you clone your
 662 repository using this option and then delete branches (or use any
 663 other git command that makes any existing commit unreferenced) in the
 664 source repository, some objects may become unreferenced (or dangling).
 665 These objects may be removed by normal git operations (such as <tt>git commit</tt>)
 666 which automatically call <tt>git gc --auto</tt>. (See <a href="git-gc.html">git-gc(1)</a>.)
 667 If these objects are removed and were referenced by the cloned repository,
 668 then the cloned repository will become corrupt.</p></div>
 669 <div class="paragraph"><p>Note that running <tt>git repack</tt> without the <tt>-l</tt> option in a repository
 670 cloned with <tt>-s</tt> will copy objects from the source repository into a pack
 671 in the cloned repository, removing the disk space savings of <tt>clone -s</tt>.
 672 It is safe, however, to run <tt>git gc</tt>, which uses the <tt>-l</tt> option by
 673 default.</p></div>
 674 <div class="paragraph"><p>If you want to break the dependency of a repository cloned with <tt>-s</tt> on
 675 its source repository, you can simply run <tt>git repack -a</tt> to copy all
 676 objects from the source repository into a pack in the cloned repository.</p></div>
 677 </dd>
 678 <dt class="hdlist1">
 679 --reference &lt;repository&gt;
 680 </dt>
 681 <dd>
 682 <p>
 683         If the reference repository is on the local machine,
 684         automatically setup <tt>.git/objects/info/alternates</tt> to
 685         obtain objects from the reference repository.  Using
 686         an already existing repository as an alternate will
 687         require fewer objects to be copied from the repository
 688         being cloned, reducing network and local storage costs.
 689 </p>
 690 <div class="paragraph"><p><strong>NOTE</strong>: see the NOTE for the <tt>--shared</tt> option.</p></div>
 691 </dd>
 692 <dt class="hdlist1">
 693 --quiet
 694 </dt>
 695 <dt class="hdlist1">
 696 -q
 697 </dt>
 698 <dd>
 699 <p>
 700         Operate quietly.  Progress is not reported to the standard
 701         error stream. This flag is also passed to the &#8216;rsync&#8217;
 702         command when given.
 703 </p>
 704 </dd>
 705 <dt class="hdlist1">
 706 --verbose
 707 </dt>
 708 <dt class="hdlist1">
 709 -v
 710 </dt>
 711 <dd>
 712 <p>
 713         Run verbosely. Does not affect the reporting of progress status
 714         to the standard error stream.
 715 </p>
 716 </dd>
 717 <dt class="hdlist1">
 718 --progress
 719 </dt>
 720 <dd>
 721 <p>
 722         Progress status is reported on the standard error stream
 723         by default when it is attached to a terminal, unless -q
 724         is specified. This flag forces progress status even if the
 725         standard error stream is not directed to a terminal.
 726 </p>
 727 </dd>
 728 <dt class="hdlist1">
 729 --no-checkout
 730 </dt>
 731 <dt class="hdlist1">
 732 -n
 733 </dt>
 734 <dd>
 735 <p>
 736         No checkout of HEAD is performed after the clone is complete.
 737 </p>
 738 </dd>
 739 <dt class="hdlist1">
 740 --bare
 741 </dt>
 742 <dd>
 743 <p>
 744         Make a <em>bare</em> GIT repository.  That is, instead of
 745         creating <tt>&lt;directory&gt;</tt> and placing the administrative
 746         files in <tt>&lt;directory&gt;/.git</tt>, make the <tt>&lt;directory&gt;</tt>
 747         itself the <tt>$GIT_DIR</tt>. This obviously implies the <tt>-n</tt>
 748         because there is nowhere to check out the working tree.
 749         Also the branch heads at the remote are copied directly
 750         to corresponding local branch heads, without mapping
 751         them to <tt>refs/remotes/origin/</tt>.  When this option is
 752         used, neither remote-tracking branches nor the related
 753         configuration variables are created.
 754 </p>
 755 </dd>
 756 <dt class="hdlist1">
 757 --mirror
 758 </dt>
 759 <dd>
 760 <p>
 761         Set up a mirror of the source repository.  This implies <tt>--bare</tt>.
 762         Compared to <tt>--bare</tt>, <tt>--mirror</tt> not only maps local branches of the
 763         source to local branches of the target, it maps all refs (including
 764         remote-tracking branches, notes etc.) and sets up a refspec configuration such
 765         that all these refs are overwritten by a <tt>git remote update</tt> in the
 766         target repository.
 767 </p>
 768 </dd>
 769 <dt class="hdlist1">
 770 --origin &lt;name&gt;
 771 </dt>
 772 <dt class="hdlist1">
 773 -o &lt;name&gt;
 774 </dt>
 775 <dd>
 776 <p>
 777         Instead of using the remote name <tt>origin</tt> to keep track
 778         of the upstream repository, use <tt>&lt;name&gt;</tt>.
 779 </p>
 780 </dd>
 781 <dt class="hdlist1">
 782 --branch &lt;name&gt;
 783 </dt>
 784 <dt class="hdlist1">
 785 -b &lt;name&gt;
 786 </dt>
 787 <dd>
 788 <p>
 789         Instead of pointing the newly created HEAD to the branch pointed
 790         to by the cloned repository&#8217;s HEAD, point to <tt>&lt;name&gt;</tt> branch
 791         instead. In a non-bare repository, this is the branch that will
 792         be checked out.
 793 </p>
 794 </dd>
 795 <dt class="hdlist1">
 796 --upload-pack &lt;upload-pack&gt;
 797 </dt>
 798 <dt class="hdlist1">
 799 -u &lt;upload-pack&gt;
 800 </dt>
 801 <dd>
 802 <p>
 803         When given, and the repository to clone from is accessed
 804         via ssh, this specifies a non-default path for the command
 805         run on the other end.
 806 </p>
 807 </dd>
 808 <dt class="hdlist1">
 809 --template=&lt;template_directory&gt;
 810 </dt>
 811 <dd>
 812 <p>
 813         Specify the directory from which templates will be used;
 814         (See the "TEMPLATE DIRECTORY" section of <a href="git-init.html">git-init(1)</a>.)
 815 </p>
 816 </dd>
 817 <dt class="hdlist1">
 818 --config &lt;key&gt;=&lt;value&gt;
 819 </dt>
 820 <dt class="hdlist1">
 821 -c &lt;key&gt;=&lt;value&gt;
 822 </dt>
 823 <dd>
 824 <p>
 825         Set a configuration variable in the newly-created repository;
 826         this takes effect immediately after the repository is
 827         initialized, but before the remote history is fetched or any
 828         files checked out.  The key is in the same format as expected by
 829         <a href="git-config.html">git-config(1)</a> (e.g., <tt>core.eol=true</tt>). If multiple
 830         values are given for the same key, each value will be written to
 831         the config file. This makes it safe, for example, to add
 832         additional fetch refspecs to the origin remote.
 833 </p>
 834 </dd>
 835 <dt class="hdlist1">
 836 --depth &lt;depth&gt;
 837 </dt>
 838 <dd>
 839 <p>
 840         Create a <em>shallow</em> clone with a history truncated to the
 841         specified number of revisions.  A shallow repository has a
 842         number of limitations (you cannot clone or fetch from
 843         it, nor push from nor into it), but is adequate if you
 844         are only interested in the recent history of a large project
 845         with a long history, and would want to send in fixes
 846         as patches.
 847 </p>
 848 </dd>
 849 <dt class="hdlist1">
 850 --recursive
 851 </dt>
 852 <dt class="hdlist1">
 853 --recurse-submodules
 854 </dt>
 855 <dd>
 856 <p>
 857         After the clone is created, initialize all submodules within,
 858         using their default settings. This is equivalent to running
 859         <tt>git submodule update --init --recursive</tt> immediately after
 860         the clone is finished. This option is ignored if the cloned
 861         repository does not have a worktree/checkout (i.e. if any of
 862         <tt>--no-checkout</tt>/<tt>-n</tt>, <tt>--bare</tt>, or <tt>--mirror</tt> is given)
 863 </p>
 864 </dd>
 865 <dt class="hdlist1">
 866 --separate-git-dir=&lt;git dir&gt;
 867 </dt>
 868 <dd>
 869 <p>
 870         Instead of placing the cloned repository where it is supposed
 871         to be, place the cloned repository at the specified directory,
 872         then make a filesytem-agnostic git symbolic link to there.
 873         The result is git repository can be separated from working
 874         tree.
 875 </p>
 876 </dd>
 877 <dt class="hdlist1">
 878 &lt;repository&gt;
 879 </dt>
 880 <dd>
 881 <p>
 882         The (possibly remote) repository to clone from.  See the
 883         <a href="#URLS">URLS</a> section below for more information on specifying
 884         repositories.
 885 </p>
 886 </dd>
 887 <dt class="hdlist1">
 888 &lt;directory&gt;
 889 </dt>
 890 <dd>
 891 <p>
 892         The name of a new directory to clone into.  The "humanish"
 893         part of the source repository is used if no directory is
 894         explicitly given (<tt>repo</tt> for <tt>/path/to/repo.git</tt> and <tt>foo</tt>
 895         for <tt>host.xz:foo/.git</tt>).  Cloning into an existing directory
 896         is only allowed if the directory is empty.
 897 </p>
 898 </dd>
 899 </dl></div>
 900 </div>
 901 <h2 id="_git_urls_a_id_urls_a">GIT URLS<a id="URLS"></a></h2>
 902 <div class="sectionbody">
 903 <div class="paragraph"><p>In general, URLs contain information about the transport protocol, the
 904 address of the remote server, and the path to the repository.
 905 Depending on the transport protocol, some of this information may be
 906 absent.</p></div>
 907 <div class="paragraph"><p>Git natively supports ssh, git, http, https, ftp, ftps, and rsync
 908 protocols. The following syntaxes may be used with them:</p></div>
 909 <div class="ulist"><ul>
 910 <li>
 911 <p>
 912 ssh://&#91;user@&#93;host.xz&#91;:port&#93;/path/to/repo.git/
 913 </p>
 914 </li>
 915 <li>
 916 <p>
 917 git://host.xz&#91;:port&#93;/path/to/repo.git/
 918 </p>
 919 </li>
 920 <li>
 921 <p>
 922 http&#91;s&#93;://host.xz&#91;:port&#93;/path/to/repo.git/
 923 </p>
 924 </li>
 925 <li>
 926 <p>
 927 ftp&#91;s&#93;://host.xz&#91;:port&#93;/path/to/repo.git/
 928 </p>
 929 </li>
 930 <li>
 931 <p>
 932 rsync://host.xz/path/to/repo.git/
 933 </p>
 934 </li>
 935 </ul></div>
 936 <div class="paragraph"><p>An alternative scp-like syntax may also be used with the ssh protocol:</p></div>
 937 <div class="ulist"><ul>
 938 <li>
 939 <p>
 940 &#91;user@&#93;host.xz:path/to/repo.git/
 941 </p>
 942 </li>
 943 </ul></div>
 944 <div class="paragraph"><p>The ssh and git protocols additionally support ~username expansion:</p></div>
 945 <div class="ulist"><ul>
 946 <li>
 947 <p>
 948 ssh://&#91;user@&#93;host.xz&#91;:port&#93;/~&#91;user&#93;/path/to/repo.git/
 949 </p>
 950 </li>
 951 <li>
 952 <p>
 953 git://host.xz&#91;:port&#93;/~&#91;user&#93;/path/to/repo.git/
 954 </p>
 955 </li>
 956 <li>
 957 <p>
 958 &#91;user@&#93;host.xz:/~&#91;user&#93;/path/to/repo.git/
 959 </p>
 960 </li>
 961 </ul></div>
 962 <div class="paragraph"><p>For local repositories, also supported by git natively, the following
 963 syntaxes may be used:</p></div>
 964 <div class="ulist"><ul>
 965 <li>
 966 <p>
 967 /path/to/repo.git/
 968 </p>
 969 </li>
 970 <li>
 971 <p>
 972 <a href="file:///path/to/repo.git/">file:///path/to/repo.git/</a>
 973 </p>
 974 </li>
 975 </ul></div>
 976 <div class="paragraph"><p>These two syntaxes are mostly equivalent, except the former implies
 977 --local option.</p></div>
 978 <div class="paragraph"><p>When git doesn&#8217;t know how to handle a certain transport protocol, it
 979 attempts to use the <em>remote-&lt;transport&gt;</em> remote helper, if one
 980 exists. To explicitly request a remote helper, the following syntax
 981 may be used:</p></div>
 982 <div class="ulist"><ul>
 983 <li>
 984 <p>
 985 &lt;transport&gt;::&lt;address&gt;
 986 </p>
 987 </li>
 988 </ul></div>
 989 <div class="paragraph"><p>where &lt;address&gt; may be a path, a server and path, or an arbitrary
 990 URL-like string recognized by the specific remote helper being
 991 invoked. See <a href="git-remote-helpers.html">git-remote-helpers(1)</a> for details.</p></div>
 992 <div class="paragraph"><p>If there are a large number of similarly-named remote repositories and
 993 you want to use a different format for them (such that the URLs you
 994 use will be rewritten into URLs that work), you can create a
 995 configuration section of the form:</p></div>
 996 <div class="listingblock">
 997 <div class="content">
 998 <pre><tt>        [url "&lt;actual url base&gt;"]
 999                 insteadOf = &lt;other url base&gt;</tt></pre>
1000 </div></div>
1001 <div class="paragraph"><p>For example, with this:</p></div>
1002 <div class="listingblock">
1003 <div class="content">
1004 <pre><tt>        [url "git://git.host.xz/"]
1005                 insteadOf = host.xz:/path/to/
1006                 insteadOf = work:</tt></pre>
1007 </div></div>
1008 <div class="paragraph"><p>a URL like "work:repo.git" or like "host.xz:/path/to/repo.git" will be
1009 rewritten in any context that takes a URL to be "git://git.host.xz/repo.git".</p></div>
1010 <div class="paragraph"><p>If you want to rewrite URLs for push only, you can create a
1011 configuration section of the form:</p></div>
1012 <div class="listingblock">
1013 <div class="content">
1014 <pre><tt>        [url "&lt;actual url base&gt;"]
1015                 pushInsteadOf = &lt;other url base&gt;</tt></pre>
1016 </div></div>
1017 <div class="paragraph"><p>For example, with this:</p></div>
1018 <div class="listingblock">
1019 <div class="content">
1020 <pre><tt>        [url "ssh://example.org/"]
1021                 pushInsteadOf = git://example.org/</tt></pre>
1022 </div></div>
1023 <div class="paragraph"><p>a URL like "git://example.org/path/to/repo.git" will be rewritten to
1024 "ssh://example.org/path/to/repo.git" for pushes, but pulls will still
1025 use the original URL.</p></div>
1026 </div>
1027 <h2 id="_examples">Examples</h2>
1028 <div class="sectionbody">
1029 <div class="ulist"><ul>
1030 <li>
1031 <p>
1032 Clone from upstream:
1033 </p>
1034 <div class="listingblock">
1035 <div class="content">
1036 <pre><tt>$ git clone git://git.kernel.org/pub/scm/.../linux-2.6 my2.6
1037 $ cd my2.6
1038 $ make</tt></pre>
1039 </div></div>
1040 </li>
1041 <li>
1042 <p>
1043 Make a local clone that borrows from the current directory, without checking things out:
1044 </p>
1045 <div class="listingblock">
1046 <div class="content">
1047 <pre><tt>$ git clone -l -s -n . ../copy
1048 $ cd ../copy
1049 $ git show-branch</tt></pre>
1050 </div></div>
1051 </li>
1052 <li>
1053 <p>
1054 Clone from upstream while borrowing from an existing local directory:
1055 </p>
1056 <div class="listingblock">
1057 <div class="content">
1058 <pre><tt>$ git clone --reference my2.6 \
1059         git://git.kernel.org/pub/scm/.../linux-2.7 \
1060         my2.7
1061 $ cd my2.7</tt></pre>
1062 </div></div>
1063 </li>
1064 <li>
1065 <p>
1066 Create a bare repository to publish your changes to the public:
1067 </p>
1068 <div class="listingblock">
1069 <div class="content">
1070 <pre><tt>$ git clone --bare -l /home/proj/.git /pub/scm/proj.git</tt></pre>
1071 </div></div>
1072 </li>
1073 <li>
1074 <p>
1075 Create a repository on the kernel.org machine that borrows from Linus:
1076 </p>
1077 <div class="listingblock">
1078 <div class="content">
1079 <pre><tt>$ git clone --bare -l -s /pub/scm/.../torvalds/linux-2.6.git \
1080     /pub/scm/.../me/subsys-2.6.git</tt></pre>
1081 </div></div>
1082 </li>
1083 </ul></div>
1084 </div>
1085 <h2 id="_git">GIT</h2>
1086 <div class="sectionbody">
1087 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
1088 </div>
1089 </div>
1090 <div id="footnotes"><hr /></div>
1091 <div id="footer">
1092 <div id="footer-text">
1093 Last updated 2011-09-21 23:01:14 PDT
1094 </div>
1095 </div>
1096 </body>
1097 </html>