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