| blob | 0e2d59d9de4005b40811da5fe89428a050a4f0d3 |
1 '\" t
2 .\" Title: git-clone
3 .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\" Date: 10/27/2022
6 .\" Manual: Git Manual
7 .\" Source: Git 2.38.1.220.g9388e93f00
8 .\" Language: English
9 .\"
10 .TH "GIT\-CLONE" "1" "10/27/2022" "Git 2\&.38\&.1\&.220\&.g9388e9" "Git Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 git-clone \- Clone a repository into a new directory
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 \fIgit clone\fR [\-\-template=<template\-directory>]
36 [\-l] [\-s] [\-\-no\-hardlinks] [\-q] [\-n] [\-\-bare] [\-\-mirror]
37 [\-o <name>] [\-b <name>] [\-u <upload\-pack>] [\-\-reference <repository>]
38 [\-\-dissociate] [\-\-separate\-git\-dir <git\-dir>]
39 [\-\-depth <depth>] [\-\-[no\-]single\-branch] [\-\-no\-tags]
40 [\-\-recurse\-submodules[=<pathspec>]] [\-\-[no\-]shallow\-submodules]
41 [\-\-[no\-]remote\-submodules] [\-\-jobs <n>] [\-\-sparse] [\-\-[no\-]reject\-shallow]
42 [\-\-filter=<filter> [\-\-also\-filter\-submodules]] [\-\-] <repository>
43 [<directory>]
44 .fi
45 .sp
46 .SH "DESCRIPTION"
47 .sp
48 Clones a repository into a newly created directory, creates remote\-tracking branches for each branch in the cloned repository (visible using \fBgit branch \-\-remotes\fR), and creates and checks out an initial branch that is forked from the cloned repository\(cqs currently active branch\&.
49 .sp
50 After the clone, a plain \fBgit fetch\fR without arguments will update all the remote\-tracking branches, and a \fBgit pull\fR without arguments will in addition merge the remote master branch into the current master branch, if any (this is untrue when "\-\-single\-branch" is given; see below)\&.
51 .sp
52 This default configuration is achieved by creating references to the remote branch heads under \fBrefs/remotes/origin\fR and by initializing \fBremote\&.origin\&.url\fR and \fBremote\&.origin\&.fetch\fR configuration variables\&.
53 .SH "OPTIONS"
54 .PP
55 \-l, \-\-local
56 .RS 4
57 When the repository to clone from is on a local machine, this flag bypasses the normal "Git aware" transport mechanism and clones the repository by making a copy of HEAD and everything under objects and refs directories\&. The files under
58 \fB\&.git/objects/\fR
59 directory are hardlinked to save space when possible\&.
60 .sp
61 If the repository is specified as a local path (e\&.g\&.,
62 \fB/path/to/repo\fR), this is the default, and \-\-local is essentially a no\-op\&. If the repository is specified as a URL, then this flag is ignored (and we never use the local optimizations)\&. Specifying
63 \fB\-\-no\-local\fR
64 will override the default when
65 \fB/path/to/repo\fR
66 is given, using the regular Git transport instead\&.
67 .sp
68 \fBNOTE\fR: this operation can race with concurrent modification to the source repository, similar to running
69 \fBcp \-r src dst\fR
70 while modifying
71 \fBsrc\fR\&.
72 .RE
73 .PP
74 \-\-no\-hardlinks
75 .RS 4
76 Force the cloning process from a repository on a local filesystem to copy the files under the
77 \fB\&.git/objects\fR
78 directory instead of using hardlinks\&. This may be desirable if you are trying to make a back\-up of your repository\&.
79 .RE
80 .PP
81 \-s, \-\-shared
82 .RS 4
83 When the repository to clone is on the local machine, instead of using hard links, automatically setup
84 \fB\&.git/objects/info/alternates\fR
85 to share the objects with the source repository\&. The resulting repository starts out without any object of its own\&.
86 .sp
87 \fBNOTE\fR: this is a possibly dangerous operation; do
88 \fBnot\fR
89 use it unless you understand what it does\&. If you clone your repository using this option and then delete branches (or use any other Git command that makes any existing commit unreferenced) in the source repository, some objects may become unreferenced (or dangling)\&. These objects may be removed by normal Git operations (such as
90 \fBgit commit\fR) which automatically call
91 \fBgit maintenance run \-\-auto\fR\&. (See
92 \fBgit-maintenance\fR(1)\&.) If these objects are removed and were referenced by the cloned repository, then the cloned repository will become corrupt\&.
93 .sp
94 Note that running
95 \fBgit repack\fR
96 without the
97 \fB\-\-local\fR
98 option in a repository cloned with
99 \fB\-\-shared\fR
100 will copy objects from the source repository into a pack in the cloned repository, removing the disk space savings of
101 \fBclone \-\-shared\fR\&. It is safe, however, to run
102 \fBgit gc\fR, which uses the
103 \fB\-\-local\fR
104 option by default\&.
105 .sp
106 If you want to break the dependency of a repository cloned with
107 \fB\-\-shared\fR
108 on its source repository, you can simply run
109 \fBgit repack \-a\fR
110 to copy all objects from the source repository into a pack in the cloned repository\&.
111 .RE
112 .PP
113 \-\-reference[\-if\-able] <repository>
114 .RS 4
115 If the reference repository is on the local machine, automatically setup
116 \fB\&.git/objects/info/alternates\fR
117 to obtain objects from the reference repository\&. Using an already existing repository as an alternate will require fewer objects to be copied from the repository being cloned, reducing network and local storage costs\&. When using the
118 \fB\-\-reference\-if\-able\fR, a non existing directory is skipped with a warning instead of aborting the clone\&.
119 .sp
120 \fBNOTE\fR: see the NOTE for the
121 \fB\-\-shared\fR
122 option, and also the
123 \fB\-\-dissociate\fR
124 option\&.
125 .RE
126 .PP
127 \-\-dissociate
128 .RS 4
129 Borrow the objects from reference repositories specified with the
130 \fB\-\-reference\fR
131 options only to reduce network transfer, and stop borrowing from them after a clone is made by making necessary local copies of borrowed objects\&. This option can also be used when cloning locally from a repository that already borrows objects from another repository\(emthe new repository will borrow objects from the same repository, and this option can be used to stop the borrowing\&.
132 .RE
133 .PP
134 \-q, \-\-quiet
135 .RS 4
136 Operate quietly\&. Progress is not reported to the standard error stream\&.
137 .RE
138 .PP
139 \-v, \-\-verbose
140 .RS 4
141 Run verbosely\&. Does not affect the reporting of progress status to the standard error stream\&.
142 .RE
143 .PP
144 \-\-progress
145 .RS 4
146 Progress status is reported on the standard error stream by default when it is attached to a terminal, unless
147 \fB\-\-quiet\fR
148 is specified\&. This flag forces progress status even if the standard error stream is not directed to a terminal\&.
149 .RE
150 .PP
151 \-\-server\-option=<option>
152 .RS 4
153 Transmit the given string to the server when communicating using protocol version 2\&. The given string must not contain a NUL or LF character\&. The server\(cqs handling of server options, including unknown ones, is server\-specific\&. When multiple
154 \fB\-\-server\-option=<option>\fR
155 are given, they are all sent to the other side in the order listed on the command line\&.
156 .RE
157 .PP
158 \-n, \-\-no\-checkout
159 .RS 4
160 No checkout of HEAD is performed after the clone is complete\&.
161 .RE
162 .PP
163 \-\-[no\-]reject\-shallow
164 .RS 4
165 Fail if the source repository is a shallow repository\&. The
166 \fIclone\&.rejectShallow\fR
167 configuration variable can be used to specify the default\&.
168 .RE
169 .PP
170 \-\-bare
171 .RS 4
172 Make a
173 \fIbare\fR
174 Git repository\&. That is, instead of creating
175 \fB<directory>\fR
176 and placing the administrative files in
177 \fB<directory>/\&.git\fR, make the
178 \fB<directory>\fR
179 itself the
180 \fB$GIT_DIR\fR\&. This obviously implies the
181 \fB\-\-no\-checkout\fR
182 because there is nowhere to check out the working tree\&. Also the branch heads at the remote are copied directly to corresponding local branch heads, without mapping them to
183 \fBrefs/remotes/origin/\fR\&. When this option is used, neither remote\-tracking branches nor the related configuration variables are created\&.
184 .RE
185 .PP
186 \-\-sparse
187 .RS 4
188 Employ a sparse\-checkout, with only files in the toplevel directory initially being present\&. The
189 \fBgit-sparse-checkout\fR(1)
190 command can be used to grow the working directory as needed\&.
191 .RE
192 .PP
193 \-\-filter=<filter\-spec>
194 .RS 4
195 Use the partial clone feature and request that the server sends a subset of reachable objects according to a given object filter\&. When using
196 \fB\-\-filter\fR, the supplied
197 \fB<filter\-spec>\fR
198 is used for the partial clone filter\&. For example,
199 \fB\-\-filter=blob:none\fR
200 will filter out all blobs (file contents) until needed by Git\&. Also,
201 \fB\-\-filter=blob:limit=<size>\fR
202 will filter out all blobs of size at least
203 \fB<size>\fR\&. For more details on filter specifications, see the
204 \fB\-\-filter\fR
205 option in
206 \fBgit-rev-list\fR(1)\&.
207 .RE
208 .PP
209 \-\-also\-filter\-submodules
210 .RS 4
211 Also apply the partial clone filter to any submodules in the repository\&. Requires
212 \fB\-\-filter\fR
213 and
214 \fB\-\-recurse\-submodules\fR\&. This can be turned on by default by setting the
215 \fBclone\&.filterSubmodules\fR
216 config option\&.
217 .RE
218 .PP
219 \-\-mirror
220 .RS 4
221 Set up a mirror of the source repository\&. This implies
222 \fB\-\-bare\fR\&. Compared to
223 \fB\-\-bare\fR,
224 \fB\-\-mirror\fR
225 not only maps local branches of the source to local branches of the target, it maps all refs (including remote\-tracking branches, notes etc\&.) and sets up a refspec configuration such that all these refs are overwritten by a
226 \fBgit remote update\fR
227 in the target repository\&.
228 .RE
229 .PP
230 \-o <name>, \-\-origin <name>
231 .RS 4
232 Instead of using the remote name
233 \fBorigin\fR
234 to keep track of the upstream repository, use
235 \fB<name>\fR\&. Overrides
236 \fBclone\&.defaultRemoteName\fR
237 from the config\&.
238 .RE
239 .PP
240 \-b <name>, \-\-branch <name>
241 .RS 4
242 Instead of pointing the newly created HEAD to the branch pointed to by the cloned repository\(cqs HEAD, point to
243 \fB<name>\fR
244 branch instead\&. In a non\-bare repository, this is the branch that will be checked out\&.
245 \fB\-\-branch\fR
246 can also take tags and detaches the HEAD at that commit in the resulting repository\&.
247 .RE
248 .PP
249 \-u <upload\-pack>, \-\-upload\-pack <upload\-pack>
250 .RS 4
251 When given, and the repository to clone from is accessed via ssh, this specifies a non\-default path for the command run on the other end\&.
252 .RE
253 .PP
254 \-\-template=<template\-directory>
255 .RS 4
256 Specify the directory from which templates will be used; (See the "TEMPLATE DIRECTORY" section of
257 \fBgit-init\fR(1)\&.)
258 .RE
259 .PP
260 \-c <key>=<value>, \-\-config <key>=<value>
261 .RS 4
262 Set a configuration variable in the newly\-created repository; this takes effect immediately after the repository is initialized, but before the remote history is fetched or any files checked out\&. The key is in the same format as expected by
263 \fBgit-config\fR(1)
264 (e\&.g\&.,
265 \fBcore\&.eol=true\fR)\&. If multiple values are given for the same key, each value will be written to the config file\&. This makes it safe, for example, to add additional fetch refspecs to the origin remote\&.
266 .sp
267 Due to limitations of the current implementation, some configuration variables do not take effect until after the initial fetch and checkout\&. Configuration variables known to not take effect are:
268 \fBremote\&.<name>\&.mirror\fR
269 and
270 \fBremote\&.<name>\&.tagOpt\fR\&. Use the corresponding
271 \fB\-\-mirror\fR
272 and
273 \fB\-\-no\-tags\fR
274 options instead\&.
275 .RE
276 .PP
277 \-\-depth <depth>
278 .RS 4
279 Create a
280 \fIshallow\fR
281 clone with a history truncated to the specified number of commits\&. Implies
282 \fB\-\-single\-branch\fR
283 unless
284 \fB\-\-no\-single\-branch\fR
285 is given to fetch the histories near the tips of all branches\&. If you want to clone submodules shallowly, also pass
286 \fB\-\-shallow\-submodules\fR\&.
287 .RE
288 .PP
289 \-\-shallow\-since=<date>
290 .RS 4
291 Create a shallow clone with a history after the specified time\&.
292 .RE
293 .PP
294 \-\-shallow\-exclude=<revision>
295 .RS 4
296 Create a shallow clone with a history, excluding commits reachable from a specified remote branch or tag\&. This option can be specified multiple times\&.
297 .RE
298 .PP
299 \-\-[no\-]single\-branch
300 .RS 4
301 Clone only the history leading to the tip of a single branch, either specified by the
302 \fB\-\-branch\fR
303 option or the primary branch remote\(cqs
304 \fBHEAD\fR
305 points at\&. Further fetches into the resulting repository will only update the remote\-tracking branch for the branch this option was used for the initial cloning\&. If the HEAD at the remote did not point at any branch when
306 \fB\-\-single\-branch\fR
307 clone was made, no remote\-tracking branch is created\&.
308 .RE
309 .PP
310 \-\-no\-tags
311 .RS 4
312 Don\(cqt clone any tags, and set
313 \fBremote\&.<remote>\&.tagOpt=\-\-no\-tags\fR
314 in the config, ensuring that future
315 \fBgit pull\fR
316 and
317 \fBgit fetch\fR
318 operations won\(cqt follow any tags\&. Subsequent explicit tag fetches will still work, (see
319 \fBgit-fetch\fR(1))\&.
320 .sp
321 Can be used in conjunction with
322 \fB\-\-single\-branch\fR
323 to clone and maintain a branch with no references other than a single cloned branch\&. This is useful e\&.g\&. to maintain minimal clones of the default branch of some repository for search indexing\&.
324 .RE
325 .PP
326 \-\-recurse\-submodules[=<pathspec>]
327 .RS 4
328 After the clone is created, initialize and clone submodules within based on the provided pathspec\&. If no pathspec is provided, all submodules are initialized and cloned\&. This option can be given multiple times for pathspecs consisting of multiple entries\&. The resulting clone has
329 \fBsubmodule\&.active\fR
330 set to the provided pathspec, or "\&." (meaning all submodules) if no pathspec is provided\&.
331 .sp
332 Submodules are initialized and cloned using their default settings\&. This is equivalent to running
333 \fBgit submodule update \-\-init \-\-recursive <pathspec>\fR
334 immediately after the clone is finished\&. This option is ignored if the cloned repository does not have a worktree/checkout (i\&.e\&. if any of
335 \fB\-\-no\-checkout\fR/\fB\-n\fR,
336 \fB\-\-bare\fR, or
337 \fB\-\-mirror\fR
338 is given)
339 .RE
340 .PP
341 \-\-[no\-]shallow\-submodules
342 .RS 4
343 All submodules which are cloned will be shallow with a depth of 1\&.
344 .RE
345 .PP
346 \-\-[no\-]remote\-submodules
347 .RS 4
348 All submodules which are cloned will use the status of the submodule\(cqs remote\-tracking branch to update the submodule, rather than the superproject\(cqs recorded SHA\-1\&. Equivalent to passing
349 \fB\-\-remote\fR
350 to
351 \fBgit submodule update\fR\&.
352 .RE
353 .PP
354 \-\-separate\-git\-dir=<git\-dir>
355 .RS 4
356 Instead of placing the cloned repository where it is supposed to be, place the cloned repository at the specified directory, then make a filesystem\-agnostic Git symbolic link to there\&. The result is Git repository can be separated from working tree\&.
357 .RE
358 .PP
359 \-j <n>, \-\-jobs <n>
360 .RS 4
361 The number of submodules fetched at the same time\&. Defaults to the
362 \fBsubmodule\&.fetchJobs\fR
363 option\&.
364 .RE
365 .PP
366 <repository>
367 .RS 4
368 The (possibly remote) repository to clone from\&. See the
369 GIT URLS
370 section below for more information on specifying repositories\&.
371 .RE
372 .PP
373 <directory>
374 .RS 4
375 The name of a new directory to clone into\&. The "humanish" part of the source repository is used if no directory is explicitly given (\fBrepo\fR
376 for
377 \fB/path/to/repo\&.git\fR
378 and
379 \fBfoo\fR
380 for
381 \fBhost\&.xz:foo/\&.git\fR)\&. Cloning into an existing directory is only allowed if the directory is empty\&.
382 .RE
383 .PP
384 \-\-bundle\-uri=<uri>
385 .RS 4
386 Before fetching from the remote, fetch a bundle from the given
387 \fB<uri>\fR
388 and unbundle the data into the local repository\&. The refs in the bundle will be stored under the hidden
389 \fBrefs/bundle/*\fR
390 namespace\&. This option is incompatible with
391 \fB\-\-depth\fR,
392 \fB\-\-shallow\-since\fR, and
393 \fB\-\-shallow\-exclude\fR\&.
394 .RE
395 .SH "GIT URLS"
396 .sp
397 In general, URLs contain information about the transport protocol, the address of the remote server, and the path to the repository\&. Depending on the transport protocol, some of this information may be absent\&.
398 .sp
399 Git supports ssh, git, http, and https protocols (in addition, ftp, and ftps can be used for fetching, but this is inefficient and deprecated; do not use it)\&.
400 .sp
401 The native transport (i\&.e\&. git:// URL) does no authentication and should be used with caution on unsecured networks\&.
402 .sp
403 The following syntaxes may be used with them:
404 .sp
405 .RS 4
406 .ie n \{\
407 \h'-04'\(bu\h'+03'\c
408 .\}
409 .el \{\
410 .sp -1
411 .IP \(bu 2.3
412 .\}
413 ssh://[user@]host\&.xz[:port]/path/to/repo\&.git/
414 .RE
415 .sp
416 .RS 4
417 .ie n \{\
418 \h'-04'\(bu\h'+03'\c
419 .\}
420 .el \{\
421 .sp -1
422 .IP \(bu 2.3
423 .\}
424 git://host\&.xz[:port]/path/to/repo\&.git/
425 .RE
426 .sp
427 .RS 4
428 .ie n \{\
429 \h'-04'\(bu\h'+03'\c
430 .\}
431 .el \{\
432 .sp -1
433 .IP \(bu 2.3
434 .\}
435 http[s]://host\&.xz[:port]/path/to/repo\&.git/
436 .RE
437 .sp
438 .RS 4
439 .ie n \{\
440 \h'-04'\(bu\h'+03'\c
441 .\}
442 .el \{\
443 .sp -1
444 .IP \(bu 2.3
445 .\}
446 ftp[s]://host\&.xz[:port]/path/to/repo\&.git/
447 .RE
448 .sp
449 An alternative scp\-like syntax may also be used with the ssh protocol:
450 .sp
451 .RS 4
452 .ie n \{\
453 \h'-04'\(bu\h'+03'\c
454 .\}
455 .el \{\
456 .sp -1
457 .IP \(bu 2.3
458 .\}
459 [user@]host\&.xz:path/to/repo\&.git/
460 .RE
461 .sp
462 This syntax is only recognized if there are no slashes before the first colon\&. This helps differentiate a local path that contains a colon\&. For example the local path \fBfoo:bar\fR could be specified as an absolute path or \fB\&./foo:bar\fR to avoid being misinterpreted as an ssh url\&.
463 .sp
464 The ssh and git protocols additionally support ~username expansion:
465 .sp
466 .RS 4
467 .ie n \{\
468 \h'-04'\(bu\h'+03'\c
469 .\}
470 .el \{\
471 .sp -1
472 .IP \(bu 2.3
473 .\}
474 ssh://[user@]host\&.xz[:port]/~[user]/path/to/repo\&.git/
475 .RE
476 .sp
477 .RS 4
478 .ie n \{\
479 \h'-04'\(bu\h'+03'\c
480 .\}
481 .el \{\
482 .sp -1
483 .IP \(bu 2.3
484 .\}
485 git://host\&.xz[:port]/~[user]/path/to/repo\&.git/
486 .RE
487 .sp
488 .RS 4
489 .ie n \{\
490 \h'-04'\(bu\h'+03'\c
491 .\}
492 .el \{\
493 .sp -1
494 .IP \(bu 2.3
495 .\}
496 [user@]host\&.xz:/~[user]/path/to/repo\&.git/
497 .RE
498 .sp
499 For local repositories, also supported by Git natively, the following syntaxes may be used:
500 .sp
501 .RS 4
502 .ie n \{\
503 \h'-04'\(bu\h'+03'\c
504 .\}
505 .el \{\
506 .sp -1
507 .IP \(bu 2.3
508 .\}
509 /path/to/repo\&.git/
510 .RE
511 .sp
512 .RS 4
513 .ie n \{\
514 \h'-04'\(bu\h'+03'\c
515 .\}
516 .el \{\
517 .sp -1
518 .IP \(bu 2.3
519 .\}
520 file:///path/to/repo\&.git/
521 .RE
522 .sp
523 These two syntaxes are mostly equivalent, except the former implies \-\-local option\&.
524 .sp
525 \fIgit clone\fR, \fIgit fetch\fR and \fIgit pull\fR, but not \fIgit push\fR, will also accept a suitable bundle file\&. See \fBgit-bundle\fR(1)\&.
526 .sp
527 When Git doesn\(cqt know how to handle a certain transport protocol, it attempts to use the \fIremote\-<transport>\fR remote helper, if one exists\&. To explicitly request a remote helper, the following syntax may be used:
528 .sp
529 .RS 4
530 .ie n \{\
531 \h'-04'\(bu\h'+03'\c
532 .\}
533 .el \{\
534 .sp -1
535 .IP \(bu 2.3
536 .\}
537 <transport>::<address>
538 .RE
539 .sp
540 where <address> may be a path, a server and path, or an arbitrary URL\-like string recognized by the specific remote helper being invoked\&. See \fBgitremote-helpers\fR(7) for details\&.
541 .sp
542 If there are a large number of similarly\-named remote repositories and you want to use a different format for them (such that the URLs you use will be rewritten into URLs that work), you can create a configuration section of the form:
543 .sp
544 .if n \{\
545 .RS 4
546 .\}
547 .nf
548 [url "<actual url base>"]
549 insteadOf = <other url base>
550 .fi
551 .if n \{\
552 .RE
553 .\}
554 .sp
555 .sp
556 For example, with this:
557 .sp
558 .if n \{\
559 .RS 4
560 .\}
561 .nf
562 [url "git://git\&.host\&.xz/"]
563 insteadOf = host\&.xz:/path/to/
564 insteadOf = work:
565 .fi
566 .if n \{\
567 .RE
568 .\}
569 .sp
570 .sp
571 a URL like "work:repo\&.git" or like "host\&.xz:/path/to/repo\&.git" will be rewritten in any context that takes a URL to be "git://git\&.host\&.xz/repo\&.git"\&.
572 .sp
573 If you want to rewrite URLs for push only, you can create a configuration section of the form:
574 .sp
575 .if n \{\
576 .RS 4
577 .\}
578 .nf
579 [url "<actual url base>"]
580 pushInsteadOf = <other url base>
581 .fi
582 .if n \{\
583 .RE
584 .\}
585 .sp
586 .sp
587 For example, with this:
588 .sp
589 .if n \{\
590 .RS 4
591 .\}
592 .nf
593 [url "ssh://example\&.org/"]
594 pushInsteadOf = git://example\&.org/
595 .fi
596 .if n \{\
597 .RE
598 .\}
599 .sp
600 .sp
601 a URL like "git://example\&.org/path/to/repo\&.git" will be rewritten to "ssh://example\&.org/path/to/repo\&.git" for pushes, but pulls will still use the original URL\&.
602 .SH "EXAMPLES"
603 .sp
604 .RS 4
605 .ie n \{\
606 \h'-04'\(bu\h'+03'\c
607 .\}
608 .el \{\
609 .sp -1
610 .IP \(bu 2.3
611 .\}
612 Clone from upstream:
613 .sp
614 .if n \{\
615 .RS 4
616 .\}
617 .nf
618 $ git clone git://git\&.kernel\&.org/pub/scm/\&.\&.\&./linux\&.git my\-linux
619 $ cd my\-linux
620 $ make
621 .fi
622 .if n \{\
623 .RE
624 .\}
625 .sp
626 .RE
627 .sp
628 .RS 4
629 .ie n \{\
630 \h'-04'\(bu\h'+03'\c
631 .\}
632 .el \{\
633 .sp -1
634 .IP \(bu 2.3
635 .\}
636 Make a local clone that borrows from the current directory, without checking things out:
637 .sp
638 .if n \{\
639 .RS 4
640 .\}
641 .nf
642 $ git clone \-l \-s \-n \&. \&.\&./copy
643 $ cd \&.\&./copy
644 $ git show\-branch
645 .fi
646 .if n \{\
647 .RE
648 .\}
649 .sp
650 .RE
651 .sp
652 .RS 4
653 .ie n \{\
654 \h'-04'\(bu\h'+03'\c
655 .\}
656 .el \{\
657 .sp -1
658 .IP \(bu 2.3
659 .\}
660 Clone from upstream while borrowing from an existing local directory:
661 .sp
662 .if n \{\
663 .RS 4
664 .\}
665 .nf
666 $ git clone \-\-reference /git/linux\&.git \e
667 git://git\&.kernel\&.org/pub/scm/\&.\&.\&./linux\&.git \e
668 my\-linux
669 $ cd my\-linux
670 .fi
671 .if n \{\
672 .RE
673 .\}
674 .sp
675 .RE
676 .sp
677 .RS 4
678 .ie n \{\
679 \h'-04'\(bu\h'+03'\c
680 .\}
681 .el \{\
682 .sp -1
683 .IP \(bu 2.3
684 .\}
685 Create a bare repository to publish your changes to the public:
686 .sp
687 .if n \{\
688 .RS 4
689 .\}
690 .nf
691 $ git clone \-\-bare \-l /home/proj/\&.git /pub/scm/proj\&.git
692 .fi
693 .if n \{\
694 .RE
695 .\}
696 .sp
697 .RE
698 .SH "CONFIGURATION"
699 .sp
700 Everything below this line in this section is selectively included from the \fBgit-config\fR(1) documentation\&. The content is the same as what\(cqs found there:
701 .PP
702 init\&.templateDir
703 .RS 4
704 Specify the directory from which templates will be copied\&. (See the "TEMPLATE DIRECTORY" section of
705 \fBgit-init\fR(1)\&.)
706 .RE
707 .PP
708 init\&.defaultBranch
709 .RS 4
710 Allows overriding the default branch name e\&.g\&. when initializing a new repository\&.
711 .RE
712 .PP
713 clone\&.defaultRemoteName
714 .RS 4
715 The name of the remote to create when cloning a repository\&. Defaults to
716 \fBorigin\fR, and can be overridden by passing the
717 \fB\-\-origin\fR
718 command\-line option to
719 \fBgit-clone\fR(1)\&.
720 .RE
721 .PP
722 clone\&.rejectShallow
723 .RS 4
724 Reject to clone a repository if it is a shallow one, can be overridden by passing option
725 \fB\-\-reject\-shallow\fR
726 in command line\&. See
727 \fBgit-clone\fR(1)
728 .RE
729 .PP
730 clone\&.filterSubmodules
731 .RS 4
732 If a partial clone filter is provided (see
733 \fB\-\-filter\fR
734 in
735 \fBgit-rev-list\fR(1)) and
736 \fB\-\-recurse\-submodules\fR
737 is used, also apply the filter to submodules\&.
738 .RE
739 .SH "GIT"
740 .sp
741 Part of the \fBgit\fR(1) suite