diff options
| author | Junio C Hamano <gitster@pobox.com> | 2024-04-09 14:47:35 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2024-04-09 14:47:35 -0700 |
| commit | eabec52c201642649f007d7ec9e9f99e2b7fb25a (patch) | |
| tree | 0e50fb48fb2ea0265972a630f9f7e819f25b4630 /git-clone.html | |
| parent | fd00376c5a0146b5ede1fdaf0fbb5987081406d6 (diff) | |
| download | git-htmldocs-eabec52c201642649f007d7ec9e9f99e2b7fb25a.tar.gz | |
Autogenerated HTML docs for v2.44.0-548-g91ec36
Diffstat (limited to 'git-clone.html')
| -rw-r--r-- | git-clone.html | 181 |
1 files changed, 91 insertions, 90 deletions
diff --git a/git-clone.html b/git-clone.html index 8195bf02c..8a53789d5 100644 --- a/git-clone.html +++ b/git-clone.html @@ -749,15 +749,15 @@ git-clone(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>git clone</em> [--template=<template-directory>]
- [-l] [-s] [--no-hardlinks] [-q] [-n] [--bare] [--mirror]
- [-o <name>] [-b <name>] [-u <upload-pack>] [--reference <repository>]
- [--dissociate] [--separate-git-dir <git-dir>]
- [--depth <depth>] [--[no-]single-branch] [--no-tags]
- [--recurse-submodules[=<pathspec>]] [--[no-]shallow-submodules]
- [--[no-]remote-submodules] [--jobs <n>] [--sparse] [--[no-]reject-shallow]
- [--filter=<filter> [--also-filter-submodules]] [--] <repository>
- [<directory>]</pre>
+<pre class="content"><code>git clone</code> [<code>--template=</code><em><template-directory></em>]
+ [<code>-l</code>] [<code>-s</code>] [<code>--no-hardlinks</code>] [<code>-q</code>] [<code>-n</code>] [<code>--bare</code>] [<code>--mirror</code>]
+ [<code>-o</code> <em><name></em>] [<code>-b</code> <em><name></em>] [<code>-u</code> <em><upload-pack></em>] [<code>--reference</code> <em><repository></em>]
+ [<code>--dissociate</code>] [<code>--separate-git-dir</code> <em><git-dir></em>]
+ [<code>--depth</code> <em><depth></em>] [<code>--</code>[<code>no-</code>]<code>single-branch</code>] [<code>--no-tags</code>]
+ [<code>--recurse-submodules</code>[<code>=</code><em><pathspec></em>]] [<code>--</code>[<code>no-</code>]<code>shallow-submodules</code>]
+ [<code>--</code>[<code>no-</code>]<code>remote-submodules</code>] [<code>--jobs</code> <em><n></em>] [<code>--sparse</code>] [<code>--</code>[<code>no-</code>]<code>reject-shallow</code>]
+ [<code>--filter=</code><em><filter-spec></em>] [<code>--also-filter-submodules</code>]] [<code>--</code>] <em><repository></em>
+ [<em><directory></em>]</pre>
<div class="attribution">
</div></div>
</div>
@@ -773,7 +773,7 @@ currently active branch.</p></div> <div class="paragraph"><p>After the clone, a plain <code>git fetch</code> without arguments will update
all the remote-tracking branches, and a <code>git pull</code> without
arguments will in addition merge the remote master branch into the
-current master branch, if any (this is untrue when "--single-branch"
+current master branch, if any (this is untrue when <code>--single-branch</code>
is given; see below).</p></div>
<div class="paragraph"><p>This default configuration is achieved by creating references to
the remote branch heads under <code>refs/remotes/origin</code> and
@@ -786,17 +786,17 @@ configuration variables.</p></div> <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--l
+<code>-l</code>
</dt>
<dt class="hdlist1">
---local
+<code>--local</code>
</dt>
<dd>
<p>
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.
+ <code>HEAD</code> and everything under objects and refs directories.
The files under <code>.git/objects/</code> directory are hardlinked
to save space when possible.
</p>
@@ -815,7 +815,7 @@ source repository, similar to running <code>cp -r src dst</code> while modifying <code>src</code>.</p></div>
</dd>
<dt class="hdlist1">
---no-hardlinks
+<code>--no-hardlinks</code>
</dt>
<dd>
<p>
@@ -826,10 +826,10 @@ source repository, similar to running <code>cp -r src dst</code> while modifying </p>
</dd>
<dt class="hdlist1">
--s
+<code>-s</code>
</dt>
<dt class="hdlist1">
---shared
+<code>--shared</code>
</dt>
<dd>
<p>
@@ -858,7 +858,7 @@ its source repository, you can simply run <code>git repack -a</code> to copy all objects from the source repository into a pack in the cloned repository.</p></div>
</dd>
<dt class="hdlist1">
---reference[-if-able] <repository>
+<code>--reference</code>[<code>-if-able</code>] <em><repository></em>
</dt>
<dd>
<p>
@@ -876,7 +876,7 @@ objects from the source repository into a pack in the cloned repository.</p></di <code>--dissociate</code> option.</p></div>
</dd>
<dt class="hdlist1">
---dissociate
+<code>--dissociate</code>
</dt>
<dd>
<p>
@@ -892,10 +892,10 @@ objects from the source repository into a pack in the cloned repository.</p></di </p>
</dd>
<dt class="hdlist1">
--q
+<code>-q</code>
</dt>
<dt class="hdlist1">
---quiet
+<code>--quiet</code>
</dt>
<dd>
<p>
@@ -904,10 +904,10 @@ objects from the source repository into a pack in the cloned repository.</p></di </p>
</dd>
<dt class="hdlist1">
--v
+<code>-v</code>
</dt>
<dt class="hdlist1">
---verbose
+<code>--verbose</code>
</dt>
<dd>
<p>
@@ -916,7 +916,7 @@ objects from the source repository into a pack in the cloned repository.</p></di </p>
</dd>
<dt class="hdlist1">
---progress
+<code>--progress</code>
</dt>
<dd>
<p>
@@ -927,7 +927,7 @@ objects from the source repository into a pack in the cloned repository.</p></di </p>
</dd>
<dt class="hdlist1">
---server-option=<option>
+<code>--server-option=</code><em><option></em>
</dt>
<dd>
<p>
@@ -935,15 +935,15 @@ objects from the source repository into a pack in the cloned repository.</p></di protocol version 2. The given string must not contain a NUL or LF
character. The server’s handling of server options, including
unknown ones, is server-specific.
- When multiple <code>--server-option=<option></code> are given, they are all
+ When multiple <code>--server-option=</code><em><option></em> are given, they are all
sent to the other side in the order listed on the command line.
</p>
</dd>
<dt class="hdlist1">
--n
+<code>-n</code>
</dt>
<dt class="hdlist1">
---no-checkout
+<code>--no-checkout</code>
</dt>
<dd>
<p>
@@ -951,7 +951,7 @@ objects from the source repository into a pack in the cloned repository.</p></di </p>
</dd>
<dt class="hdlist1">
---[no-]reject-shallow
+<code>--</code>[<code>no-</code>]<code>reject-shallow</code>
</dt>
<dd>
<p>
@@ -961,13 +961,13 @@ objects from the source repository into a pack in the cloned repository.</p></di </p>
</dd>
<dt class="hdlist1">
---bare
+<code>--bare</code>
</dt>
<dd>
<p>
Make a <em>bare</em> Git repository. That is, instead of
creating <em><directory></em> and placing the administrative
- files in <code><directory>/.git</code>, make the <em><directory></em>
+ files in <em><directory></em><code>/.git</code>, make the <em><directory></em>
itself the <code>$GIT_DIR</code>. This obviously implies the <code>--no-checkout</code>
because there is nowhere to check out the working tree.
Also the branch heads at the remote are copied directly
@@ -978,7 +978,7 @@ objects from the source repository into a pack in the cloned repository.</p></di </p>
</dd>
<dt class="hdlist1">
---sparse
+<code>--sparse</code>
</dt>
<dd>
<p>
@@ -989,7 +989,7 @@ objects from the source repository into a pack in the cloned repository.</p></di </p>
</dd>
<dt class="hdlist1">
---filter=<filter-spec>
+<code>--filter=</code><em><filter-spec></em>
</dt>
<dd>
<p>
@@ -998,13 +998,13 @@ objects from the source repository into a pack in the cloned repository.</p></di When using <code>--filter</code>, the supplied <em><filter-spec></em> is used for
the partial clone filter. For example, <code>--filter=blob:none</code> will
filter out all blobs (file contents) until needed by Git. Also,
- <code>--filter=blob:limit=<size></code> will filter out all blobs of size
+ <code>--filter=blob:limit=</code><em><size></em> will filter out all blobs of size
at least <em><size></em>. For more details on filter specifications, see
the <code>--filter</code> option in <a href="git-rev-list.html">git-rev-list(1)</a>.
</p>
</dd>
<dt class="hdlist1">
---also-filter-submodules
+<code>--also-filter-submodules</code>
</dt>
<dd>
<p>
@@ -1014,7 +1014,7 @@ objects from the source repository into a pack in the cloned repository.</p></di </p>
</dd>
<dt class="hdlist1">
---mirror
+<code>--mirror</code>
</dt>
<dd>
<p>
@@ -1027,10 +1027,10 @@ objects from the source repository into a pack in the cloned repository.</p></di </p>
</dd>
<dt class="hdlist1">
--o <name>
+<code>-o</code> <em><name></em>
</dt>
<dt class="hdlist1">
---origin <name>
+<code>--origin</code> <em><name></em>
</dt>
<dd>
<p>
@@ -1040,10 +1040,10 @@ objects from the source repository into a pack in the cloned repository.</p></di </p>
</dd>
<dt class="hdlist1">
--b <name>
+<code>-b</code> <em><name></em>
</dt>
<dt class="hdlist1">
---branch <name>
+<code>--branch</code> <em><name></em>
</dt>
<dd>
<p>
@@ -1056,10 +1056,10 @@ objects from the source repository into a pack in the cloned repository.</p></di </p>
</dd>
<dt class="hdlist1">
--u <upload-pack>
+<code>-u</code> <em><upload-pack></em>
</dt>
<dt class="hdlist1">
---upload-pack <upload-pack>
+<code>--upload-pack</code> <em><upload-pack></em>
</dt>
<dd>
<p>
@@ -1069,7 +1069,7 @@ objects from the source repository into a pack in the cloned repository.</p></di </p>
</dd>
<dt class="hdlist1">
---template=<template-directory>
+<code>--template=</code><em><template-directory></em>
</dt>
<dd>
<p>
@@ -1078,10 +1078,10 @@ objects from the source repository into a pack in the cloned repository.</p></di </p>
</dd>
<dt class="hdlist1">
--c <key>=<value>
+<code>-c</code> <em><key></em><code>=</code><em><value></em>
</dt>
<dt class="hdlist1">
---config <key>=<value>
+<code>--config</code> <em><key></em><code>=</code><em><value></em>
</dt>
<dd>
<p>
@@ -1097,11 +1097,11 @@ objects from the source repository into a pack in the cloned repository.</p></di <div class="paragraph"><p>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:
-<code>remote.<name>.mirror</code> and <code>remote.<name>.tagOpt</code>. Use the
+<code>remote.</code><em><name></em><code>.mirror</code> and <code>remote.</code><em><name></em><code>.tagOpt</code>. Use the
corresponding <code>--mirror</code> and <code>--no-tags</code> options instead.</p></div>
</dd>
<dt class="hdlist1">
---depth <depth>
+<code>--depth</code> <em><depth></em>
</dt>
<dd>
<p>
@@ -1113,7 +1113,7 @@ corresponding <code>--mirror</code> and <code>--no-tags</code> options instead.< </p>
</dd>
<dt class="hdlist1">
---shallow-since=<date>
+<code>--shallow-since=</code><em><date></em>
</dt>
<dd>
<p>
@@ -1121,7 +1121,7 @@ corresponding <code>--mirror</code> and <code>--no-tags</code> options instead.< </p>
</dd>
<dt class="hdlist1">
---shallow-exclude=<revision>
+<code>--shallow-exclude=</code><em><revision></em>
</dt>
<dd>
<p>
@@ -1131,7 +1131,7 @@ corresponding <code>--mirror</code> and <code>--no-tags</code> options instead.< </p>
</dd>
<dt class="hdlist1">
---[no-]single-branch
+<code>--</code>[<code>no-</code>]<code>single-branch</code>
</dt>
<dd>
<p>
@@ -1146,7 +1146,7 @@ corresponding <code>--mirror</code> and <code>--no-tags</code> options instead.< </p>
</dd>
<dt class="hdlist1">
---no-tags
+<code>--no-tags</code>
</dt>
<dd>
<p>
@@ -1162,7 +1162,7 @@ branch. This is useful e.g. to maintain minimal clones of the default branch of some repository for search indexing.</p></div>
</dd>
<dt class="hdlist1">
---recurse-submodules[=<pathspec>]
+<code>--recurse-submodules</code>[<code>=</code><em><pathspec></em>]
</dt>
<dd>
<p>
@@ -1182,7 +1182,7 @@ not have a worktree/checkout (i.e. if any of <code>--no-checkout</code>/<code>-n or <code>--mirror</code> is given)</p></div>
</dd>
<dt class="hdlist1">
---[no-]shallow-submodules
+<code>--</code>[<code>no-</code>]<code>shallow-submodules</code>
</dt>
<dd>
<p>
@@ -1190,7 +1190,7 @@ or <code>--mirror</code> is given)</p></div> </p>
</dd>
<dt class="hdlist1">
---[no-]remote-submodules
+<code>--</code>[<code>no-</code>]<code>remote-submodules</code>
</dt>
<dd>
<p>
@@ -1201,7 +1201,7 @@ or <code>--mirror</code> is given)</p></div> </p>
</dd>
<dt class="hdlist1">
---separate-git-dir=<git-dir>
+<code>--separate-git-dir=</code><em><git-dir></em>
</dt>
<dd>
<p>
@@ -1213,7 +1213,7 @@ or <code>--mirror</code> is given)</p></div> </p>
</dd>
<dt class="hdlist1">
---ref-format=<ref-format>
+<code>--ref-format=</code><em><ref-format></em>
</dt>
<dd>
<p>
@@ -1234,10 +1234,10 @@ Specify the given ref storage format for the repository. The valid values are: </ul></div>
</dd>
<dt class="hdlist1">
--j <n>
+<code>-j</code> <em><n></em>
</dt>
<dt class="hdlist1">
---jobs <n>
+<code>--jobs</code> <em><n></em>
</dt>
<dd>
<p>
@@ -1246,7 +1246,7 @@ Specify the given ref storage format for the repository. The valid values are: </p>
</dd>
<dt class="hdlist1">
-<repository>
+<em><repository></em>
</dt>
<dd>
<p>
@@ -1256,7 +1256,7 @@ Specify the given ref storage format for the repository. The valid values are: </p>
</dd>
<dt class="hdlist1">
-<directory>
+<em><directory></em>
</dt>
<dd>
<p>
@@ -1268,7 +1268,7 @@ Specify the given ref storage format for the repository. The valid values are: </p>
</dd>
<dt class="hdlist1">
---bundle-uri=<uri>
+<code>--bundle-uri=</code><em><uri></em>
</dt>
<dd>
<p>
@@ -1298,22 +1298,22 @@ should be used with caution on unsecured networks.</p></div> <div class="ulist"><ul>
<li>
<p>
-ssh://[user@]host.xz[:port]/path/to/repo.git/
+<code>ssh://</code>[<em><user></em><code>@</code>]<em><host></em>[<code>:</code><em><port></em>]<code>/</code><em><path-to-git-repo></em>
</p>
</li>
<li>
<p>
-git://host.xz[:port]/path/to/repo.git/
+<code>git://</code><em><host></em>[:<em><port></em>]<code>/</code><em><path-to-git-repo></em>
</p>
</li>
<li>
<p>
-http[s]://host.xz[:port]/path/to/repo.git/
+<code>http</code>[<code>s</code>]<code>://</code><em><host></em>[<code>:</code><em><port></em>]<code>/</code><em><path-to-git-repo></em>
</p>
</li>
<li>
<p>
-ftp[s]://host.xz[:port]/path/to/repo.git/
+<code>ftp</code>[<code>s</code>]<code>://</code><em><host></em>[<code>:</code><em><port></em>]<code>/</code><em><path-to-git-repo></em>
</p>
</li>
</ul></div>
@@ -1321,7 +1321,7 @@ ftp[s]://host.xz[:port]/path/to/repo.git/ <div class="ulist"><ul>
<li>
<p>
-[user@]host.xz:path/to/repo.git/
+[<em><user></em><code>@</code>]<em><host></em><code>:/</code><em><path-to-git-repo></em>
</p>
</li>
</ul></div>
@@ -1330,21 +1330,21 @@ first colon. This helps differentiate a local path that contains a colon. For example the local path <code>foo:bar</code> could be specified as an
absolute path or <code>./foo:bar</code> to avoid being misinterpreted as an ssh
url.</p></div>
-<div class="paragraph"><p>The ssh and git protocols additionally support ~username expansion:</p></div>
+<div class="paragraph"><p>The ssh and git protocols additionally support <code>~</code><em><username></em> expansion:</p></div>
<div class="ulist"><ul>
<li>
<p>
-ssh://[user@]host.xz[:port]/~[user]/path/to/repo.git/
+<code>ssh://</code>[<em><user></em><code>@</code>]<em><host></em>[<code>:</code><em><port></em>]<code>/~</code><em><user></em><code>/</code><em><path-to-git-repo></em>
</p>
</li>
<li>
<p>
-git://host.xz[:port]/~[user]/path/to/repo.git/
+<code>git://</code><em><host></em>[<code>:</code><em><port></em>]<code>/~</code><em><user></em><code>/</code><em><path-to-git-repo></em>
</p>
</li>
<li>
<p>
-[user@]host.xz:/~[user]/path/to/repo.git/
+[<em><user></em><code>@</code>]<em><host></em><code>:~</code><em><user></em><code>/</code><em><path-to-git-repo></em>
</p>
</li>
</ul></div>
@@ -1353,12 +1353,12 @@ syntaxes may be used:</p></div> <div class="ulist"><ul>
<li>
<p>
-/path/to/repo.git/
+<code>/path/to/repo.git/</code>
</p>
</li>
<li>
<p>
-file:///path/to/repo.git/
+<code>file:///path/to/repo.git/</code>
</p>
</li>
</ul></div>
@@ -1367,13 +1367,13 @@ file:///path/to/repo.git/ <div class="paragraph"><p><code>git clone</code>, <code>git fetch</code> and <code>git pull</code>, but not <code>git push</code>, will also
accept a suitable bundle file. See <a href="git-bundle.html">git-bundle(1)</a>.</p></div>
<div class="paragraph"><p>When Git doesn’t know how to handle a certain transport protocol, it
-attempts to use the <code>remote-<transport></code> remote helper, if one
+attempts to use the <code>remote-</code><em><transport></em> remote helper, if one
exists. To explicitly request a remote helper, the following syntax
may be used:</p></div>
<div class="ulist"><ul>
<li>
<p>
-<em><transport></em>::_<address>_
+<em><transport></em>::<em><address></em>
</p>
</li>
</ul></div>
@@ -1384,10 +1384,10 @@ invoked. See <a href="gitremote-helpers.html">gitremote-helpers(7)</a> for detai 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:</p></div>
-<div class="listingblock">
-<div class="content">
-<pre><code> [url "<actual-url-base>"]
- insteadOf = <other-url-base></code></pre>
+<div class="verseblock">
+<pre class="content"> [url "<em><actual-url-base></em>"]
+ insteadOf = <em><other-url-base></em></pre>
+<div class="attribution">
</div></div>
<div class="paragraph"><p>For example, with this:</p></div>
<div class="listingblock">
@@ -1400,10 +1400,10 @@ configuration section of the form:</p></div> rewritten in any context that takes a URL to be "git://git.host.xz/repo.git".</p></div>
<div class="paragraph"><p>If you want to rewrite URLs for push only, you can create a
configuration section of the form:</p></div>
-<div class="listingblock">
-<div class="content">
-<pre><code> [url "<actual-url-base>"]
- pushInsteadOf = <other-url-base></code></pre>
+<div class="verseblock">
+<pre class="content"> [url "<em><actual-url-base></em>"]
+ pushInsteadOf = <em><other-url-base></em></pre>
+<div class="attribution">
</div></div>
<div class="paragraph"><p>For example, with this:</p></div>
<div class="listingblock">
@@ -1474,7 +1474,7 @@ from the <a href="git-config.html">git-config(1)</a> documentation. The content as what’s found there:</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
-init.templateDir
+<code>init.templateDir</code>
</dt>
<dd>
<p>
@@ -1482,7 +1482,7 @@ init.templateDir </p>
</dd>
<dt class="hdlist1">
-init.defaultBranch
+<code>init.defaultBranch</code>
</dt>
<dd>
<p>
@@ -1491,26 +1491,27 @@ init.defaultBranch </p>
</dd>
<dt class="hdlist1">
-clone.defaultRemoteName
+<code>clone.defaultRemoteName</code>
</dt>
<dd>
<p>
The name of the remote to create when cloning a repository. Defaults to
- <code>origin</code>, and can be overridden by passing the <code>--origin</code> command-line
- option to <a href="git-clone.html">git-clone(1)</a>.
+ <code>origin</code>.
+ It can be overridden by passing the <code>--origin</code> command-line
+ option.
</p>
</dd>
<dt class="hdlist1">
-clone.rejectShallow
+<code>clone.rejectShallow</code>
</dt>
<dd>
<p>
Reject cloning a repository if it is a shallow one; this can be overridden by
- passing the <code>--reject-shallow</code> option on the command line. See <a href="git-clone.html">git-clone(1)</a>
+ passing the <code>--reject-shallow</code> option on the command line.
</p>
</dd>
<dt class="hdlist1">
-clone.filterSubmodules
+<code>clone.filterSubmodules</code>
</dt>
<dd>
<p>
@@ -1533,7 +1534,7 @@ clone.filterSubmodules <div id="footer">
<div id="footer-text">
Last updated
- 2024-03-21 16:28:38 PDT
+ 2024-04-09 14:45:01 PDT
</div>
</div>
</body>
|