| blob | 5796947707a54918a8a0f6eff86cf564c63e7df3 |
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: 2023-08-04
6 .\" Manual: Git Manual
7 .\" Source: Git 2.42.0.rc0
8 .\" Language: English
9 .\"
10 .TH "GIT\-CLONE" "1" "2023\-08\-04" "Git 2\&.42\&.0\&.rc0" "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 If the repository\(cqs
69 \fB$GIT_DIR/objects\fR
70 has symbolic links or is a symbolic link, the clone will fail\&. This is a security measure to prevent the unintentional copying of files by dereferencing the symbolic links\&.
71 .sp
72 \fBNOTE\fR: this operation can race with concurrent modification to the source repository, similar to running
73 \fBcp \-r src dst\fR
74 while modifying
75 \fBsrc\fR\&.
76 .RE
77 .PP
78 \-\-no\-hardlinks
79 .RS 4
80 Force the cloning process from a repository on a local filesystem to copy the files under the
81 \fB\&.git/objects\fR
82 directory instead of using hardlinks\&. This may be desirable if you are trying to make a back\-up of your repository\&.
83 .RE
84 .PP
85 \-s, \-\-shared
86 .RS 4
87 When the repository to clone is on the local machine, instead of using hard links, automatically setup
88 \fB\&.git/objects/info/alternates\fR
89 to share the objects with the source repository\&. The resulting repository starts out without any object of its own\&.
90 .sp
91 \fBNOTE\fR: this is a possibly dangerous operation; do
92 \fBnot\fR
93 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
94 \fBgit commit\fR) which automatically call
95 \fBgit maintenance run \-\-auto\fR\&. (See
96 \fBgit-maintenance\fR(1)\&.) If these objects are removed and were referenced by the cloned repository, then the cloned repository will become corrupt\&.
97 .sp
98 Note that running
99 \fBgit repack\fR
100 without the
101 \fB\-\-local\fR
102 option in a repository cloned with
103 \fB\-\-shared\fR
104 will copy objects from the source repository into a pack in the cloned repository, removing the disk space savings of
105 \fBclone \-\-shared\fR\&. It is safe, however, to run
106 \fBgit gc\fR, which uses the
107 \fB\-\-local\fR
108 option by default\&.
109 .sp
110 If you want to break the dependency of a repository cloned with
111 \fB\-\-shared\fR
112 on its source repository, you can simply run
113 \fBgit repack \-a\fR
114 to copy all objects from the source repository into a pack in the cloned repository\&.
115 .RE
116 .PP
117 \-\-reference[\-if\-able] <repository>
118 .RS 4
119 If the reference repository is on the local machine, automatically setup
120 \fB\&.git/objects/info/alternates\fR
121 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
122 \fB\-\-reference\-if\-able\fR, a non existing directory is skipped with a warning instead of aborting the clone\&.
123 .sp
124 \fBNOTE\fR: see the NOTE for the
125 \fB\-\-shared\fR
126 option, and also the
127 \fB\-\-dissociate\fR
128 option\&.
129 .RE
130 .PP
131 \-\-dissociate
132 .RS 4
133 Borrow the objects from reference repositories specified with the
134 \fB\-\-reference\fR
135 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\&.
136 .RE
137 .PP
138 \-q, \-\-quiet
139 .RS 4
140 Operate quietly\&. Progress is not reported to the standard error stream\&.
141 .RE
142 .PP
143 \-v, \-\-verbose
144 .RS 4
145 Run verbosely\&. Does not affect the reporting of progress status to the standard error stream\&.
146 .RE
147 .PP
148 \-\-progress
149 .RS 4
150 Progress status is reported on the standard error stream by default when it is attached to a terminal, unless
151 \fB\-\-quiet\fR
152 is specified\&. This flag forces progress status even if the standard error stream is not directed to a terminal\&.
153 .RE
154 .PP
155 \-\-server\-option=<option>
156 .RS 4
157 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
158 \fB\-\-server\-option=<option>\fR
159 are given, they are all sent to the other side in the order listed on the command line\&.
160 .RE
161 .PP
162 \-n, \-\-no\-checkout
163 .RS 4
164 No checkout of HEAD is performed after the clone is complete\&.
165 .RE
166 .PP
167 \-\-[no\-]reject\-shallow
168 .RS 4
169 Fail if the source repository is a shallow repository\&. The
170 \fIclone\&.rejectShallow\fR
171 configuration variable can be used to specify the default\&.
172 .RE
173 .PP
174 \-\-bare
175 .RS 4
176 Make a
177 \fIbare\fR
178 Git repository\&. That is, instead of creating
179 \fB<directory>\fR
180 and placing the administrative files in
181 \fB<directory>/\&.git\fR, make the
182 \fB<directory>\fR
183 itself the
184 \fB$GIT_DIR\fR\&. This obviously implies the
185 \fB\-\-no\-checkout\fR
186 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
187 \fBrefs/remotes/origin/\fR\&. When this option is used, neither remote\-tracking branches nor the related configuration variables are created\&.
188 .RE
189 .PP
190 \-\-sparse
191 .RS 4
192 Employ a sparse\-checkout, with only files in the toplevel directory initially being present\&. The
193 \fBgit-sparse-checkout\fR(1)
194 command can be used to grow the working directory as needed\&.
195 .RE
196 .PP
197 \-\-filter=<filter\-spec>
198 .RS 4
199 Use the partial clone feature and request that the server sends a subset of reachable objects according to a given object filter\&. When using
200 \fB\-\-filter\fR, the supplied
201 \fB<filter\-spec>\fR
202 is used for the partial clone filter\&. For example,
203 \fB\-\-filter=blob:none\fR
204 will filter out all blobs (file contents) until needed by Git\&. Also,
205 \fB\-\-filter=blob:limit=<size>\fR
206 will filter out all blobs of size at least
207 \fB<size>\fR\&. For more details on filter specifications, see the
208 \fB\-\-filter\fR
209 option in
210 \fBgit-rev-list\fR(1)\&.
211 .RE
212 .PP
213 \-\-also\-filter\-submodules
214 .RS 4
215 Also apply the partial clone filter to any submodules in the repository\&. Requires
216 \fB\-\-filter\fR
217 and
218 \fB\-\-recurse\-submodules\fR\&. This can be turned on by default by setting the
219 \fBclone\&.filterSubmodules\fR
220 config option\&.
221 .RE
222 .PP
223 \-\-mirror
224 .RS 4
225 Set up a mirror of the source repository\&. This implies
226 \fB\-\-bare\fR\&. Compared to
227 \fB\-\-bare\fR,
228 \fB\-\-mirror\fR
229 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
230 \fBgit remote update\fR
231 in the target repository\&.
232 .RE
233 .PP
234 \-o <name>, \-\-origin <name>
235 .RS 4
236 Instead of using the remote name
237 \fBorigin\fR
238 to keep track of the upstream repository, use
239 \fB<name>\fR\&. Overrides
240 \fBclone\&.defaultRemoteName\fR
241 from the config\&.
242 .RE
243 .PP
244 \-b <name>, \-\-branch <name>
245 .RS 4
246 Instead of pointing the newly created HEAD to the branch pointed to by the cloned repository\(cqs HEAD, point to
247 \fB<name>\fR
248 branch instead\&. In a non\-bare repository, this is the branch that will be checked out\&.
249 \fB\-\-branch\fR
250 can also take tags and detaches the HEAD at that commit in the resulting repository\&.
251 .RE
252 .PP
253 \-u <upload\-pack>, \-\-upload\-pack <upload\-pack>
254 .RS 4
255 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\&.
256 .RE
257 .PP
258 \-\-template=<template\-directory>
259 .RS 4
260 Specify the directory from which templates will be used; (See the "TEMPLATE DIRECTORY" section of
261 \fBgit-init\fR(1)\&.)
262 .RE
263 .PP
264 \-c <key>=<value>, \-\-config <key>=<value>
265 .RS 4
266 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
267 \fBgit-config\fR(1)
268 (e\&.g\&.,
269 \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\&.
270 .sp
271 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:
272 \fBremote\&.<name>\&.mirror\fR
273 and
274 \fBremote\&.<name>\&.tagOpt\fR\&. Use the corresponding
275 \fB\-\-mirror\fR
276 and
277 \fB\-\-no\-tags\fR
278 options instead\&.
279 .RE
280 .PP
281 \-\-depth <depth>
282 .RS 4
283 Create a
284 \fIshallow\fR
285 clone with a history truncated to the specified number of commits\&. Implies
286 \fB\-\-single\-branch\fR
287 unless
288 \fB\-\-no\-single\-branch\fR
289 is given to fetch the histories near the tips of all branches\&. If you want to clone submodules shallowly, also pass
290 \fB\-\-shallow\-submodules\fR\&.
291 .RE
292 .PP
293 \-\-shallow\-since=<date>
294 .RS 4
295 Create a shallow clone with a history after the specified time\&.
296 .RE
297 .PP
298 \-\-shallow\-exclude=<revision>
299 .RS 4
300 Create a shallow clone with a history, excluding commits reachable from a specified remote branch or tag\&. This option can be specified multiple times\&.
301 .RE
302 .PP
303 \-\-[no\-]single\-branch
304 .RS 4
305 Clone only the history leading to the tip of a single branch, either specified by the
306 \fB\-\-branch\fR
307 option or the primary branch remote\(cqs
308 \fBHEAD\fR
309 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
310 \fB\-\-single\-branch\fR
311 clone was made, no remote\-tracking branch is created\&.
312 .RE
313 .PP
314 \-\-no\-tags
315 .RS 4
316 Don\(cqt clone any tags, and set
317 \fBremote\&.<remote>\&.tagOpt=\-\-no\-tags\fR
318 in the config, ensuring that future
319 \fBgit pull\fR
320 and
321 \fBgit fetch\fR
322 operations won\(cqt follow any tags\&. Subsequent explicit tag fetches will still work, (see
323 \fBgit-fetch\fR(1))\&.
324 .sp
325 Can be used in conjunction with
326 \fB\-\-single\-branch\fR
327 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\&.
328 .RE
329 .PP
330 \-\-recurse\-submodules[=<pathspec>]
331 .RS 4
332 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
333 \fBsubmodule\&.active\fR
334 set to the provided pathspec, or "\&." (meaning all submodules) if no pathspec is provided\&.
335 .sp
336 Submodules are initialized and cloned using their default settings\&. This is equivalent to running
337 \fBgit submodule update \-\-init \-\-recursive <pathspec>\fR
338 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
339 \fB\-\-no\-checkout\fR/\fB\-n\fR,
340 \fB\-\-bare\fR, or
341 \fB\-\-mirror\fR
342 is given)
343 .RE
344 .PP
345 \-\-[no\-]shallow\-submodules
346 .RS 4
347 All submodules which are cloned will be shallow with a depth of 1\&.
348 .RE
349 .PP
350 \-\-[no\-]remote\-submodules
351 .RS 4
352 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
353 \fB\-\-remote\fR
354 to
355 \fBgit submodule update\fR\&.
356 .RE
357 .PP
358 \-\-separate\-git\-dir=<git\-dir>
359 .RS 4
360 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\&.
361 .RE
362 .PP
363 \-j <n>, \-\-jobs <n>
364 .RS 4
365 The number of submodules fetched at the same time\&. Defaults to the
366 \fBsubmodule\&.fetchJobs\fR
367 option\&.
368 .RE
369 .PP
370 <repository>
371 .RS 4
372 The (possibly remote) repository to clone from\&. See the
373 GIT URLS
374 section below for more information on specifying repositories\&.
375 .RE
376 .PP
377 <directory>
378 .RS 4
379 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
380 for
381 \fB/path/to/repo\&.git\fR
382 and
383 \fBfoo\fR
384 for
385 \fBhost\&.xz:foo/\&.git\fR)\&. Cloning into an existing directory is only allowed if the directory is empty\&.
386 .RE
387 .PP
388 \-\-bundle\-uri=<uri>
389 .RS 4
390 Before fetching from the remote, fetch a bundle from the given
391 \fB<uri>\fR
392 and unbundle the data into the local repository\&. The refs in the bundle will be stored under the hidden
393 \fBrefs/bundle/*\fR
394 namespace\&. This option is incompatible with
395 \fB\-\-depth\fR,
396 \fB\-\-shallow\-since\fR, and
397 \fB\-\-shallow\-exclude\fR\&.
398 .RE
399 .SH "GIT URLS"
400 .sp
401 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\&.
402 .sp
403 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)\&.
404 .sp
405 The native transport (i\&.e\&. git:// URL) does no authentication and should be used with caution on unsecured networks\&.
406 .sp
407 The following syntaxes may be used with them:
408 .sp
409 .RS 4
410 .ie n \{\
411 \h'-04'\(bu\h'+03'\c
412 .\}
413 .el \{\
414 .sp -1
415 .IP \(bu 2.3
416 .\}
417 ssh://[user@]host\&.xz[:port]/path/to/repo\&.git/
418 .RE
419 .sp
420 .RS 4
421 .ie n \{\
422 \h'-04'\(bu\h'+03'\c
423 .\}
424 .el \{\
425 .sp -1
426 .IP \(bu 2.3
427 .\}
428 git://host\&.xz[:port]/path/to/repo\&.git/
429 .RE
430 .sp
431 .RS 4
432 .ie n \{\
433 \h'-04'\(bu\h'+03'\c
434 .\}
435 .el \{\
436 .sp -1
437 .IP \(bu 2.3
438 .\}
439 http[s]://host\&.xz[:port]/path/to/repo\&.git/
440 .RE
441 .sp
442 .RS 4
443 .ie n \{\
444 \h'-04'\(bu\h'+03'\c
445 .\}
446 .el \{\
447 .sp -1
448 .IP \(bu 2.3
449 .\}
450 ftp[s]://host\&.xz[:port]/path/to/repo\&.git/
451 .RE
452 .sp
453 An alternative scp\-like syntax may also be used with the ssh protocol:
454 .sp
455 .RS 4
456 .ie n \{\
457 \h'-04'\(bu\h'+03'\c
458 .\}
459 .el \{\
460 .sp -1
461 .IP \(bu 2.3
462 .\}
463 [user@]host\&.xz:path/to/repo\&.git/
464 .RE
465 .sp
466 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\&.
467 .sp
468 The ssh and git protocols additionally support ~username expansion:
469 .sp
470 .RS 4
471 .ie n \{\
472 \h'-04'\(bu\h'+03'\c
473 .\}
474 .el \{\
475 .sp -1
476 .IP \(bu 2.3
477 .\}
478 ssh://[user@]host\&.xz[:port]/~[user]/path/to/repo\&.git/
479 .RE
480 .sp
481 .RS 4
482 .ie n \{\
483 \h'-04'\(bu\h'+03'\c
484 .\}
485 .el \{\
486 .sp -1
487 .IP \(bu 2.3
488 .\}
489 git://host\&.xz[:port]/~[user]/path/to/repo\&.git/
490 .RE
491 .sp
492 .RS 4
493 .ie n \{\
494 \h'-04'\(bu\h'+03'\c
495 .\}
496 .el \{\
497 .sp -1
498 .IP \(bu 2.3
499 .\}
500 [user@]host\&.xz:/~[user]/path/to/repo\&.git/
501 .RE
502 .sp
503 For local repositories, also supported by Git natively, the following syntaxes may be used:
504 .sp
505 .RS 4
506 .ie n \{\
507 \h'-04'\(bu\h'+03'\c
508 .\}
509 .el \{\
510 .sp -1
511 .IP \(bu 2.3
512 .\}
513 /path/to/repo\&.git/
514 .RE
515 .sp
516 .RS 4
517 .ie n \{\
518 \h'-04'\(bu\h'+03'\c
519 .\}
520 .el \{\
521 .sp -1
522 .IP \(bu 2.3
523 .\}
524 file:///path/to/repo\&.git/
525 .RE
526 .sp
527 These two syntaxes are mostly equivalent, except the former implies \-\-local option\&.
528 .sp
529 \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)\&.
530 .sp
531 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:
532 .sp
533 .RS 4
534 .ie n \{\
535 \h'-04'\(bu\h'+03'\c
536 .\}
537 .el \{\
538 .sp -1
539 .IP \(bu 2.3
540 .\}
541 <transport>::<address>
542 .RE
543 .sp
544 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\&.
545 .sp
546 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:
547 .sp
548 .if n \{\
549 .RS 4
550 .\}
551 .nf
552 [url "<actual url base>"]
553 insteadOf = <other url base>
554 .fi
555 .if n \{\
556 .RE
557 .\}
558 .sp
559 .sp
560 For example, with this:
561 .sp
562 .if n \{\
563 .RS 4
564 .\}
565 .nf
566 [url "git://git\&.host\&.xz/"]
567 insteadOf = host\&.xz:/path/to/
568 insteadOf = work:
569 .fi
570 .if n \{\
571 .RE
572 .\}
573 .sp
574 .sp
575 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"\&.
576 .sp
577 If you want to rewrite URLs for push only, you can create a configuration section of the form:
578 .sp
579 .if n \{\
580 .RS 4
581 .\}
582 .nf
583 [url "<actual url base>"]
584 pushInsteadOf = <other url base>
585 .fi
586 .if n \{\
587 .RE
588 .\}
589 .sp
590 .sp
591 For example, with this:
592 .sp
593 .if n \{\
594 .RS 4
595 .\}
596 .nf
597 [url "ssh://example\&.org/"]
598 pushInsteadOf = git://example\&.org/
599 .fi
600 .if n \{\
601 .RE
602 .\}
603 .sp
604 .sp
605 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\&.
606 .SH "EXAMPLES"
607 .sp
608 .RS 4
609 .ie n \{\
610 \h'-04'\(bu\h'+03'\c
611 .\}
612 .el \{\
613 .sp -1
614 .IP \(bu 2.3
615 .\}
616 Clone from upstream:
617 .sp
618 .if n \{\
619 .RS 4
620 .\}
621 .nf
622 $ git clone git://git\&.kernel\&.org/pub/scm/\&.\&.\&./linux\&.git my\-linux
623 $ cd my\-linux
624 $ make
625 .fi
626 .if n \{\
627 .RE
628 .\}
629 .sp
630 .RE
631 .sp
632 .RS 4
633 .ie n \{\
634 \h'-04'\(bu\h'+03'\c
635 .\}
636 .el \{\
637 .sp -1
638 .IP \(bu 2.3
639 .\}
640 Make a local clone that borrows from the current directory, without checking things out:
641 .sp
642 .if n \{\
643 .RS 4
644 .\}
645 .nf
646 $ git clone \-l \-s \-n \&. \&.\&./copy
647 $ cd \&.\&./copy
648 $ git show\-branch
649 .fi
650 .if n \{\
651 .RE
652 .\}
653 .sp
654 .RE
655 .sp
656 .RS 4
657 .ie n \{\
658 \h'-04'\(bu\h'+03'\c
659 .\}
660 .el \{\
661 .sp -1
662 .IP \(bu 2.3
663 .\}
664 Clone from upstream while borrowing from an existing local directory:
665 .sp
666 .if n \{\
667 .RS 4
668 .\}
669 .nf
670 $ git clone \-\-reference /git/linux\&.git \e
671 git://git\&.kernel\&.org/pub/scm/\&.\&.\&./linux\&.git \e
672 my\-linux
673 $ cd my\-linux
674 .fi
675 .if n \{\
676 .RE
677 .\}
678 .sp
679 .RE
680 .sp
681 .RS 4
682 .ie n \{\
683 \h'-04'\(bu\h'+03'\c
684 .\}
685 .el \{\
686 .sp -1
687 .IP \(bu 2.3
688 .\}
689 Create a bare repository to publish your changes to the public:
690 .sp
691 .if n \{\
692 .RS 4
693 .\}
694 .nf
695 $ git clone \-\-bare \-l /home/proj/\&.git /pub/scm/proj\&.git
696 .fi
697 .if n \{\
698 .RE
699 .\}
700 .sp
701 .RE
702 .SH "CONFIGURATION"
703 .sp
704 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:
705 .PP
706 init\&.templateDir
707 .RS 4
708 Specify the directory from which templates will be copied\&. (See the "TEMPLATE DIRECTORY" section of
709 \fBgit-init\fR(1)\&.)
710 .RE
711 .PP
712 init\&.defaultBranch
713 .RS 4
714 Allows overriding the default branch name e\&.g\&. when initializing a new repository\&.
715 .RE
716 .PP
717 clone\&.defaultRemoteName
718 .RS 4
719 The name of the remote to create when cloning a repository\&. Defaults to
720 \fBorigin\fR, and can be overridden by passing the
721 \fB\-\-origin\fR
722 command\-line option to
723 \fBgit-clone\fR(1)\&.
724 .RE
725 .PP
726 clone\&.rejectShallow
727 .RS 4
728 Reject to clone a repository if it is a shallow one, can be overridden by passing option
729 \fB\-\-reject\-shallow\fR
730 in command line\&. See
731 \fBgit-clone\fR(1)
732 .RE
733 .PP
734 clone\&.filterSubmodules
735 .RS 4
736 If a partial clone filter is provided (see
737 \fB\-\-filter\fR
738 in
739 \fBgit-rev-list\fR(1)) and
740 \fB\-\-recurse\-submodules\fR
741 is used, also apply the filter to submodules\&.
742 .RE
743 .SH "GIT"
744 .sp
745 Part of the \fBgit\fR(1) suite