git-clone.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
   2     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
   4 <head>\r
   5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />\r
   6 <meta name="generator" content="AsciiDoc 7.0.2" />\r
   7 <style type="text/css">\r
   8 /* Debug borders */\r
   9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {\r
  10 /*\r
  11   border: 1px solid red;\r
  12 */\r
  13 }\r
  14 \r
  15 body {\r
  16   margin: 1em 5% 1em 5%;\r
  17 }\r
  18 \r
  19 a { color: blue; }\r
  20 a:visited { color: fuchsia; }\r
  21 \r
  22 em {\r
  23   font-style: italic;\r
  24 }\r
  25 \r
  26 strong {\r
  27   font-weight: bold;\r
  28 }\r
  29 \r
  30 tt {\r
  31   color: navy;\r
  32 }\r
  33 \r
  34 h1, h2, h3, h4, h5, h6 {\r
  35   color: #527bbd;\r
  36   font-family: sans-serif;\r
  37   margin-top: 1.2em;\r
  38   margin-bottom: 0.5em;\r
  39   line-height: 1.3;\r
  40 }\r
  41 \r
  42 h1 {\r
  43   border-bottom: 2px solid silver;\r
  44 }\r
  45 h2 {\r
  46   border-bottom: 2px solid silver;\r
  47   padding-top: 0.5em;\r
  48 }\r
  49 \r
  50 div.sectionbody {\r
  51   font-family: serif;\r
  52   margin-left: 0;\r
  53 }\r
  54 \r
  55 hr {\r
  56   border: 1px solid silver;\r
  57 }\r
  58 \r
  59 p {\r
  60   margin-top: 0.5em;\r
  61   margin-bottom: 0.5em;\r
  62 }\r
  63 \r
  64 pre {\r
  65   padding: 0;\r
  66   margin: 0;\r
  67 }\r
  68 \r
  69 span#author {\r
  70   color: #527bbd;\r
  71   font-family: sans-serif;\r
  72   font-weight: bold;\r
  73   font-size: 1.2em;\r
  74 }\r
  75 span#email {\r
  76 }\r
  77 span#revision {\r
  78   font-family: sans-serif;\r
  79 }\r
  80 \r
  81 div#footer {\r
  82   font-family: sans-serif;\r
  83   font-size: small;\r
  84   border-top: 2px solid silver;\r
  85   padding-top: 0.5em;\r
  86   margin-top: 4.0em;\r
  87 }\r
  88 div#footer-text {\r
  89   float: left;\r
  90   padding-bottom: 0.5em;\r
  91 }\r
  92 div#footer-badges {\r
  93   float: right;\r
  94   padding-bottom: 0.5em;\r
  95 }\r
  96 \r
  97 div#preamble,\r
  98 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,\r
  99 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,\r
 100 div.admonitionblock {\r
 101   margin-right: 10%;\r
 102   margin-top: 1.5em;\r
 103   margin-bottom: 1.5em;\r
 104 }\r
 105 div.admonitionblock {\r
 106   margin-top: 2.5em;\r
 107   margin-bottom: 2.5em;\r
 108 }\r
 109 \r
 110 div.content { /* Block element content. */\r
 111   padding: 0;\r
 112 }\r
 113 \r
 114 /* Block element titles. */\r
 115 div.title, caption.title {\r
 116   font-family: sans-serif;\r
 117   font-weight: bold;\r
 118   text-align: left;\r
 119   margin-top: 1.0em;\r
 120   margin-bottom: 0.5em;\r
 121 }\r
 122 div.title + * {\r
 123   margin-top: 0;\r
 124 }\r
 125 \r
 126 td div.title:first-child {\r
 127   margin-top: 0.0em;\r
 128 }\r
 129 div.content div.title:first-child {\r
 130   margin-top: 0.0em;\r
 131 }\r
 132 div.content + div.title {\r
 133   margin-top: 0.0em;\r
 134 }\r
 135 \r
 136 div.sidebarblock > div.content {\r
 137   background: #ffffee;\r
 138   border: 1px solid silver;\r
 139   padding: 0.5em;\r
 140 }\r
 141 \r
 142 div.listingblock > div.content {\r
 143   border: 1px solid silver;\r
 144   background: #f4f4f4;\r
 145   padding: 0.5em;\r
 146 }\r
 147 \r
 148 div.quoteblock > div.content {\r
 149   padding-left: 2.0em;\r
 150 }\r
 151 div.quoteblock .attribution {\r
 152   text-align: right;\r
 153 }\r
 154 \r
 155 div.admonitionblock .icon {\r
 156   vertical-align: top;\r
 157   font-size: 1.1em;\r
 158   font-weight: bold;\r
 159   text-decoration: underline;\r
 160   color: #527bbd;\r
 161   padding-right: 0.5em;\r
 162 }\r
 163 div.admonitionblock td.content {\r
 164   padding-left: 0.5em;\r
 165   border-left: 2px solid silver;\r
 166 }\r
 167 \r
 168 div.exampleblock > div.content {\r
 169   border-left: 2px solid silver;\r
 170   padding: 0.5em;\r
 171 }\r
 172 \r
 173 div.verseblock div.content {\r
 174   white-space: pre;\r
 175 }\r
 176 \r
 177 div.imageblock div.content { padding-left: 0; }\r
 178 div.imageblock img { border: 1px solid silver; }\r
 179 span.image img { border-style: none; }\r
 180 \r
 181 dl {\r
 182   margin-top: 0.8em;\r
 183   margin-bottom: 0.8em;\r
 184 }\r
 185 dt {\r
 186   margin-top: 0.5em;\r
 187   margin-bottom: 0;\r
 188   font-style: italic;\r
 189 }\r
 190 dd > *:first-child {\r
 191   margin-top: 0;\r
 192 }\r
 193 \r
 194 ul, ol {\r
 195     list-style-position: outside;\r
 196 }\r
 197 ol.olist2 {\r
 198   list-style-type: lower-alpha;\r
 199 }\r
 200 \r
 201 div.tableblock > table {\r
 202   border-color: #527bbd;\r
 203   border-width: 3px;\r
 204 }\r
 205 thead {\r
 206   font-family: sans-serif;\r
 207   font-weight: bold;\r
 208 }\r
 209 tfoot {\r
 210   font-weight: bold;\r
 211 }\r
 212 \r
 213 div.hlist {\r
 214   margin-top: 0.8em;\r
 215   margin-bottom: 0.8em;\r
 216 }\r
 217 td.hlist1 {\r
 218   vertical-align: top;\r
 219   font-style: italic;\r
 220   padding-right: 0.8em;\r
 221 }\r
 222 td.hlist2 {\r
 223   vertical-align: top;\r
 224 }\r
 225 \r
 226 @media print {\r
 227   div#footer-badges { display: none; }\r
 228 }\r
 229 include::./stylesheets/xhtml11-manpage.css[]\r
 230 /* Workarounds for IE6's broken and incomplete CSS2. */\r
 231 \r
 232 div.sidebar-content {\r
 233   background: #ffffee;\r
 234   border: 1px solid silver;\r
 235   padding: 0.5em;\r
 236 }\r
 237 div.sidebar-title, div.image-title {\r
 238   font-family: sans-serif;\r
 239   font-weight: bold;\r
 240   margin-top: 0.0em;\r
 241   margin-bottom: 0.5em;\r
 242 }\r
 243 \r
 244 div.listingblock div.content {\r
 245   border: 1px solid silver;\r
 246   background: #f4f4f4;\r
 247   padding: 0.5em;\r
 248 }\r
 249 \r
 250 div.quoteblock-content {\r
 251   padding-left: 2.0em;\r
 252 }\r
 253 \r
 254 div.exampleblock-content {\r
 255   border-left: 2px solid silver;\r
 256   padding-left: 0.5em;\r
 257 }\r
 258 </style>\r
 259 <title>git-clone(1)</title>\r
 260 </head>\r
 261 <body>\r
 262 <div id="header">\r
 263 <h1>\r
 264 git-clone(1) Manual Page\r
 265 </h1>\r
 266 <h2>NAME</h2>\r
 267 <div class="sectionbody">\r
 268 <p>git-clone -\r
 269    Clones a repository\r
 270 </p>\r
 271 </div>\r
 272 </div>\r
 273 <h2>SYNOPSIS</h2>\r
 274 <div class="sectionbody">\r
 275 <div class="verseblock">\r
 276 <div class="content"><em>git-clone</em> [-l [-s]] [-q] [-n] [--bare] [-o &lt;name&gt;] [-u &lt;upload-pack&gt;]\r
 277           [--reference &lt;repository&gt;]\r
 278           &lt;repository&gt; [&lt;directory&gt;]</div></div>\r
 279 </div>\r
 280 <h2>DESCRIPTION</h2>\r
 281 <div class="sectionbody">\r
 282 <p>Clones a repository into a newly created directory.  All remote\r
 283 branch heads are copied under <tt>$GIT_DIR/refs/heads/</tt>, except\r
 284 that the remote <tt>master</tt> is also copied to <tt>origin</tt> branch.</p>\r
 285 <p>In addition, <tt>$GIT_DIR/remotes/origin</tt> file is set up to have\r
 286 this line:</p>\r
 287 <div class="literalblock">\r
 288 <div class="content">\r
 289 <pre><tt>Pull: master:origin</tt></pre>\r
 290 </div></div>\r
 291 <p>This is to help the typical workflow of working off of the\r
 292 remote <tt>master</tt> branch.  Every time <tt>git pull</tt> without argument\r
 293 is run, the progress on the remote <tt>master</tt> branch is tracked by\r
 294 copying it into the local <tt>origin</tt> branch, and merged into the\r
 295 branch you are currently working on.  Remote branches other than\r
 296 <tt>master</tt> are also added there to be tracked.</p>\r
 297 </div>\r
 298 <h2>OPTIONS</h2>\r
 299 <div class="sectionbody">\r
 300 <dl>\r
 301 <dt>\r
 302 --local\r
 303 </dt>\r
 304 <dt>\r
 305 -l\r
 306 </dt>\r
 307 <dd>\r
 308 <p>\r
 309         When the repository to clone from is on a local machine,\r
 310         this flag bypasses normal "git aware" transport\r
 311         mechanism and clones the repository by making a copy of\r
 312         HEAD and everything under objects and refs directories.\r
 313         The files under .git/objects/ directory are hardlinked\r
 314         to save space when possible.\r
 315 </p>\r
 316 </dd>\r
 317 <dt>\r
 318 --shared\r
 319 </dt>\r
 320 <dt>\r
 321 -s\r
 322 </dt>\r
 323 <dd>\r
 324 <p>\r
 325         When the repository to clone is on the local machine,\r
 326         instead of using hard links, automatically setup\r
 327         .git/objects/info/alternates to share the objects\r
 328         with the source repository.  The resulting repository\r
 329         starts out without any object of its own.\r
 330 </p>\r
 331 </dd>\r
 332 <dt>\r
 333 --reference &lt;repository&gt;\r
 334 </dt>\r
 335 <dd>\r
 336 <p>\r
 337         If the reference repository is on the local machine\r
 338         automatically setup .git/objects/info/alternates to\r
 339         obtain objects from the reference repository.  Using\r
 340         an already existing repository as an alternate will\r
 341         require less objects to be copied from the repository\r
 342         being cloned, reducing network and local storage costs.\r
 343 </p>\r
 344 </dd>\r
 345 <dt>\r
 346 --quiet\r
 347 </dt>\r
 348 <dt>\r
 349 -q\r
 350 </dt>\r
 351 <dd>\r
 352 <p>\r
 353         Operate quietly.  This flag is passed to "rsync" and\r
 354         "git-clone-pack" commands when given.\r
 355 </p>\r
 356 </dd>\r
 357 <dt>\r
 358 -n\r
 359 </dt>\r
 360 <dd>\r
 361 <p>\r
 362         No checkout of HEAD is performed after the clone is complete.\r
 363 </p>\r
 364 </dd>\r
 365 <dt>\r
 366 --bare\r
 367 </dt>\r
 368 <dd>\r
 369 <p>\r
 370         Make a <em>bare</em> GIT repository.  That is, instead of\r
 371         creating <tt>&lt;directory&gt;</tt> and placing the administrative\r
 372         files in <tt>&lt;directory&gt;/.git</tt>, make the <tt>&lt;directory&gt;</tt>\r
 373         itself the <tt>$GIT_DIR</tt>. This implies <tt>-n</tt> option.  When\r
 374         this option is used, neither the <tt>origin</tt> branch nor the\r
 375         default <tt>remotes/origin</tt> file is created.\r
 376 </p>\r
 377 </dd>\r
 378 <dt>\r
 379 -o &lt;name&gt;\r
 380 </dt>\r
 381 <dd>\r
 382 <p>\r
 383         Instead of using the branch name <em>origin</em> to keep track\r
 384         of the upstream repository, use &lt;name&gt; instead.  Note\r
 385         that the shorthand name stored in <tt>remotes/origin</tt> is\r
 386         not affected, but the local branch name to pull the\r
 387         remote <tt>master</tt> branch into is.\r
 388 </p>\r
 389 </dd>\r
 390 <dt>\r
 391 --upload-pack &lt;upload-pack&gt;\r
 392 </dt>\r
 393 <dt>\r
 394 -u &lt;upload-pack&gt;\r
 395 </dt>\r
 396 <dd>\r
 397 <p>\r
 398         When given, and the repository to clone from is handled\r
 399         by <em>git-clone-pack</em>, <em>--exec=&lt;upload-pack&gt;</em> is passed to\r
 400         the command to specify non-default path for the command\r
 401         run on the other end.\r
 402 </p>\r
 403 </dd>\r
 404 <dt>\r
 405 &lt;repository&gt;\r
 406 </dt>\r
 407 <dd>\r
 408 <p>\r
 409         The (possibly remote) repository to clone from.  It can\r
 410         be any URL git-fetch supports.\r
 411 </p>\r
 412 </dd>\r
 413 <dt>\r
 414 &lt;directory&gt;\r
 415 </dt>\r
 416 <dd>\r
 417 <p>\r
 418         The name of a new directory to clone into.  The "humanish"\r
 419         part of the source repository is used if no directory is\r
 420         explicitly given ("repo" for "/path/to/repo.git" and "foo"\r
 421         for "host.xz:foo/.git").  Cloning into an existing directory\r
 422         is not allowed.\r
 423 </p>\r
 424 </dd>\r
 425 </dl>\r
 426 </div>\r
 427 <h2>Examples</h2>\r
 428 <div class="sectionbody">\r
 429 <dl>\r
 430 <dt>\r
 431 Clone from upstream\r
 432 </dt>\r
 433 <dd>\r
 434 <div class="listingblock">\r
 435 <div class="content">\r
 436 <pre><tt>$ git clone git://git.kernel.org/pub/scm/.../linux-2.6 my2.6\r
 437 $ cd my2.6\r
 438 $ make</tt></pre>\r
 439 </div></div>\r
 440 </dd>\r
 441 <dt>\r
 442 Make a local clone that borrows from the current directory, without checking things out\r
 443 </dt>\r
 444 <dd>\r
 445 <div class="listingblock">\r
 446 <div class="content">\r
 447 <pre><tt>$ git clone -l -s -n . ../copy\r
 448 $ cd copy\r
 449 $ git show-branch</tt></pre>\r
 450 </div></div>\r
 451 </dd>\r
 452 <dt>\r
 453 Clone from upstream while borrowing from an existing local directory\r
 454 </dt>\r
 455 <dd>\r
 456 <div class="listingblock">\r
 457 <div class="content">\r
 458 <pre><tt>$ git clone --reference my2.6 \\r
 459         git://git.kernel.org/pub/scm/.../linux-2.7 \\r
 460         my2.7\r
 461 $ cd my2.7</tt></pre>\r
 462 </div></div>\r
 463 </dd>\r
 464 <dt>\r
 465 Create a bare repository to publish your changes to the public\r
 466 </dt>\r
 467 <dd>\r
 468 <div class="listingblock">\r
 469 <div class="content">\r
 470 <pre><tt>$ git clone --bare -l /home/proj/.git /pub/scm/proj.git</tt></pre>\r
 471 </div></div>\r
 472 </dd>\r
 473 <dt>\r
 474 Create a repository on the kernel.org machine that borrows from Linus\r
 475 </dt>\r
 476 <dd>\r
 477 <div class="listingblock">\r
 478 <div class="content">\r
 479 <pre><tt>$ git clone --bare -l -s /pub/scm/.../torvalds/linux-2.6.git \\r
 480     /pub/scm/.../me/subsys-2.6.git</tt></pre>\r
 481 </div></div>\r
 482 </dd>\r
 483 </dl>\r
 484 </div>\r
 485 <h2>Author</h2>\r
 486 <div class="sectionbody">\r
 487 <p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;</p>\r
 488 </div>\r
 489 <h2>Documentation</h2>\r
 490 <div class="sectionbody">\r
 491 <p>Documentation by Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p>\r
 492 </div>\r
 493 <h2>GIT</h2>\r
 494 <div class="sectionbody">\r
 495 <p>Part of the <a href="git.html">git(7)</a> suite</p>\r
 496 </div>\r
 497 <div id="footer">\r
 498 <div id="footer-text">\r
 499 Last updated 05-May-2006 23:14:11 UTC\r
 500 </div>\r
 501 </div>\r
 502 </body>\r
 503 </html>\r