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