| blob | db85d92cc42a3bd40c1582a14dc1f3493c35c1ee |
4 <head>
9 /* Debug borders */
11 /*
12 border: 1px solid red;
13 */
14 }
16 body {
18 }
20 a {
23 }
26 }
28 em {
31 }
33 strong {
36 }
38 tt {
40 }
48 }
52 }
53 h2 {
55 }
56 h3 {
58 }
59 h3 + * {
61 }
66 }
68 hr {
70 }
72 p {
75 }
79 }
81 pre {
84 }
86 span#author {
91 }
92 span#email {
93 }
96 }
98 div#footer {
104 }
105 div#footer-text {
108 }
109 div#footer-badges {
112 }
114 div#preamble {
117 }
123 }
127 }
131 }
133 /* Block element titles. */
141 }
144 }
148 }
151 }
154 }
160 }
166 }
171 }
175 }
180 }
183 }
187 }
188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
191 }
200 }
204 }
209 }
215 dl {
218 }
219 dt {
224 }
227 }
231 }
234 }
237 }
240 }
243 }
246 }
253 }
257 }
258 thead {
261 }
262 tfoot {
264 }
267 }
270 }
271 /* Because the table frame attribute is overriden by CSS in most browsers. */
274 }
278 }
282 }
288 }
291 }
294 }
300 }
303 }
307 }
311 }
315 }
317 div#toctitle {
324 }
329 }
333 }
337 }
341 }
342 /* Overrides for manpage documents */
343 h1 {
348 }
349 h2 {
351 }
354 }
358 }
360 /* Workarounds for IE6's broken and incomplete CSS2. */
366 }
373 }
379 }
384 }
388 }
392 }
397 }
399 /* IE6 sets dynamically generated links as visited. */
401 </style>
402 </head>
403 <body>
405 <h1>
406 git-clone(1) Manual Page
407 </h1>
410 <p>git-clone -
411 Clone a repository into a new directory
412 </p>
413 </div>
414 </div>
419 [-l] [-s] [--no-hardlinks] [-q] [-n] [--bare] [--mirror]
425 </div></div>
426 </div>
430 remote-tracking branches for each branch in the cloned repository
432 initial branch that is forked from the cloned repository’s
433 currently active branch.</p></div>
434 <div class="paragraph"><p>After the clone, a plain <tt>git fetch</tt> without arguments will update
436 arguments will in addition merge the remote master branch into the
437 current master branch, if any.</p></div>
441 configuration variables.</p></div>
442 </div>
447 --local
448 </dt>
450 -l
451 </dt>
452 <dd>
453 <p>
454 When the repository to clone from is on a local machine,
455 this flag bypasses the normal "git aware" transport
456 mechanism and clones the repository by making a copy of
457 HEAD and everything under objects and refs directories.
459 to save space when possible. This is now the default when
461 syntax, so it essentially is a no-op option. To force
462 copying instead of hardlinking (which may be desirable
463 if you are trying to make a back-up of your repository),
464 but still avoid the usual "git aware" transport
466 </p>
467 </dd>
469 --no-hardlinks
470 </dt>
471 <dd>
472 <p>
473 Optimize the cloning process from a repository on a
475 directory.
476 </p>
477 </dd>
479 --shared
480 </dt>
482 -s
483 </dt>
484 <dd>
485 <p>
486 When the repository to clone is on the local machine,
487 instead of using hard links, automatically setup
489 with the source repository. The resulting repository
490 starts out without any object of its own.
491 </p>
492 <div class="paragraph"><p><strong>NOTE</strong>: this is a possibly dangerous operation; do <strong>not</strong> use
493 it unless you understand what it does. If you clone your
494 repository using this option and then delete branches (or use any
495 other git command that makes any existing commit unreferenced) in the
496 source repository, some objects may become unreferenced (or dangling).
499 If these objects are removed and were referenced by the cloned repository,
500 then the cloned repository will become corrupt.</p></div>
501 <div class="paragraph"><p>Note that running <tt>git repack</tt> without the <tt>-l</tt> option in a repository
505 default.</p></div>
506 <div class="paragraph"><p>If you want to break the dependency of a repository cloned with <tt>-s</tt> on
508 objects from the source repository into a pack in the cloned repository.</p></div>
509 </dd>
512 </dt>
513 <dd>
514 <p>
515 If the reference repository is on the local machine,
517 obtain objects from the reference repository. Using
518 an already existing repository as an alternate will
519 require fewer objects to be copied from the repository
520 being cloned, reducing network and local storage costs.
521 </p>
522 <div class="paragraph"><p><strong>NOTE</strong>: see the NOTE for the <tt>--shared</tt> option.</p></div>
523 </dd>
525 --quiet
526 </dt>
528 -q
529 </dt>
530 <dd>
531 <p>
532 Operate quietly. Progress is not reported to the standard
534 command when given.
535 </p>
536 </dd>
538 --verbose
539 </dt>
541 -v
542 </dt>
543 <dd>
544 <p>
545 Run verbosely. Does not affect the reporting of progress status
546 to the standard error stream.
547 </p>
548 </dd>
550 --progress
551 </dt>
552 <dd>
553 <p>
554 Progress status is reported on the standard error stream
555 by default when it is attached to a terminal, unless -q
556 is specified. This flag forces progress status even if the
557 standard error stream is not directed to a terminal.
558 </p>
559 </dd>
561 --no-checkout
562 </dt>
564 -n
565 </dt>
566 <dd>
567 <p>
568 No checkout of HEAD is performed after the clone is complete.
569 </p>
570 </dd>
572 --bare
573 </dt>
574 <dd>
575 <p>
580 because there is nowhere to check out the working tree.
581 Also the branch heads at the remote are copied directly
582 to corresponding local branch heads, without mapping
584 used, neither remote-tracking branches nor the related
585 configuration variables are created.
586 </p>
587 </dd>
589 --mirror
590 </dt>
591 <dd>
592 <p>
595 source to local branches of the target, it maps all refs (including
596 remote-tracking branches, notes etc.) and sets up a refspec configuration such
598 target repository.
599 </p>
600 </dd>
603 </dt>
606 </dt>
607 <dd>
608 <p>
611 </p>
612 </dd>
615 </dt>
618 </dt>
619 <dd>
620 <p>
621 Instead of pointing the newly created HEAD to the branch pointed
623 instead. In a non-bare repository, this is the branch that will
624 be checked out.
625 </p>
626 </dd>
629 </dt>
632 </dt>
633 <dd>
634 <p>
635 When given, and the repository to clone from is accessed
636 via ssh, this specifies a non-default path for the command
637 run on the other end.
638 </p>
639 </dd>
642 </dt>
643 <dd>
644 <p>
645 Specify the directory from which templates will be used;
647 </p>
648 </dd>
651 </dt>
654 </dt>
655 <dd>
656 <p>
657 Set a configuration variable in the newly-created repository;
658 this takes effect immediately after the repository is
659 initialized, but before the remote history is fetched or any
660 files checked out. The key is in the same format as expected by
662 values are given for the same key, each value will be written to
663 the config file. This makes it safe, for example, to add
664 additional fetch refspecs to the origin remote.
665 </p>
666 </dd>
669 </dt>
670 <dd>
671 <p>
673 specified number of revisions. A shallow repository has a
674 number of limitations (you cannot clone or fetch from
675 it, nor push from nor into it), but is adequate if you
676 are only interested in the recent history of a large project
677 with a long history, and would want to send in fixes
678 as patches.
679 </p>
680 </dd>
682 --recursive
683 </dt>
685 --recurse-submodules
686 </dt>
687 <dd>
688 <p>
689 After the clone is created, initialize all submodules within,
690 using their default settings. This is equivalent to running
692 the clone is finished. This option is ignored if the cloned
693 repository does not have a worktree/checkout (i.e. if any of
695 </p>
696 </dd>
699 </dt>
700 <dd>
701 <p>
702 Instead of placing the cloned repository where it is supposed
703 to be, place the cloned repository at the specified directory,
704 then make a filesytem-agnostic git symbolic link to there.
705 The result is git repository can be separated from working
706 tree.
707 </p>
708 </dd>
711 </dt>
712 <dd>
713 <p>
714 The (possibly remote) repository to clone from. See the
716 repositories.
717 </p>
718 </dd>
721 </dt>
722 <dd>
723 <p>
724 The name of a new directory to clone into. The "humanish"
725 part of the source repository is used if no directory is
728 is only allowed if the directory is empty.
729 </p>
730 </dd>
731 </dl></div>
732 </div>
735 <div class="paragraph"><p>In general, URLs contain information about the transport protocol, the
736 address of the remote server, and the path to the repository.
737 Depending on the transport protocol, some of this information may be
738 absent.</p></div>
740 protocols. The following syntaxes may be used with them:</p></div>
742 <li>
743 <p>
745 </p>
746 </li>
747 <li>
748 <p>
750 </p>
751 </li>
752 <li>
753 <p>
755 </p>
756 </li>
757 <li>
758 <p>
760 </p>
761 </li>
762 <li>
763 <p>
764 rsync://host.xz/path/to/repo.git/
765 </p>
766 </li>
767 </ul></div>
768 <div class="paragraph"><p>An alternative scp-like syntax may also be used with the ssh protocol:</p></div>
770 <li>
771 <p>
773 </p>
774 </li>
775 </ul></div>
776 <div class="paragraph"><p>The ssh and git protocols additionally support ~username expansion:</p></div>
778 <li>
779 <p>
781 </p>
782 </li>
783 <li>
784 <p>
786 </p>
787 </li>
788 <li>
789 <p>
791 </p>
792 </li>
793 </ul></div>
795 syntaxes may be used:</p></div>
797 <li>
798 <p>
799 /path/to/repo.git/
800 </p>
801 </li>
802 <li>
803 <p>
805 </p>
806 </li>
807 </ul></div>
809 --local option.</p></div>
810 <div class="paragraph"><p>When git doesn’t know how to handle a certain transport protocol, it
812 exists. To explicitly request a remote helper, the following syntax
813 may be used:</p></div>
815 <li>
816 <p>
818 </p>
819 </li>
820 </ul></div>
821 <div class="paragraph"><p>where <address> may be a path, a server and path, or an arbitrary
822 URL-like string recognized by the specific remote helper being
824 <div class="paragraph"><p>If there are a large number of similarly-named remote repositories and
825 you want to use a different format for them (such that the URLs you
826 use will be rewritten into URLs that work), you can create a
827 configuration section of the form:</p></div>
832 </div></div>
837 insteadOf = host.xz:/path/to/
838 insteadOf = work:</tt></pre>
839 </div></div>
840 <div class="paragraph"><p>a URL like "work:repo.git" or like "host.xz:/path/to/repo.git" will be
843 configuration section of the form:</p></div>
848 </div></div>
853 pushInsteadOf = git://example.org/</tt></pre>
854 </div></div>
856 "ssh://example.org/path/to/repo.git" for pushes, but pulls will still
857 use the original URL.</p></div>
858 </div>
862 <li>
863 <p>
864 Clone from upstream:
865 </p>
869 $ cd my2.6
870 $ make</tt></pre>
871 </div></div>
872 </li>
873 <li>
874 <p>
875 Make a local clone that borrows from the current directory, without checking things out:
876 </p>
879 <pre><tt>$ git clone -l -s -n . ../copy
880 $ cd ../copy
881 $ git show-branch</tt></pre>
882 </div></div>
883 </li>
884 <li>
885 <p>
886 Clone from upstream while borrowing from an existing local directory:
887 </p>
890 <pre><tt>$ git clone --reference my2.6 \
891 git://git.kernel.org/pub/scm/.../linux-2.7 \
892 my2.7
893 $ cd my2.7</tt></pre>
894 </div></div>
895 </li>
896 <li>
897 <p>
898 Create a bare repository to publish your changes to the public:
899 </p>
903 </div></div>
904 </li>
905 <li>
906 <p>
907 Create a repository on the kernel.org machine that borrows from Linus:
908 </p>
913 </div></div>
914 </li>
915 </ul></div>
916 </div>
920 </div>
924 </div>
925 </div>
926 </body>
927 </html>