blob: 4477d4d88da6eb6e099cf1f0da5b2fce1a9269cd [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.2.5" />
<style type="text/css">
/* Debug borders */
p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
/*
border: 1px solid red;
*/
}
body {
margin: 1em 5% 1em 5%;
}
a {
color: blue;
text-decoration: underline;
}
a:visited {
color: fuchsia;
}
em {
font-style: italic;
}
strong {
font-weight: bold;
}
tt {
color: navy;
}
h1, h2, h3, h4, h5, h6 {
color: #527bbd;
font-family: sans-serif;
margin-top: 1.2em;
margin-bottom: 0.5em;
line-height: 1.3;
}
h1, h2, h3 {
border-bottom: 2px solid silver;
}
h2 {
padding-top: 0.5em;
}
h3 {
float: left;
}
h3 + * {
clear: left;
}
div.sectionbody {
font-family: serif;
margin-left: 0;
}
hr {
border: 1px solid silver;
}
p {
margin-top: 0.5em;
margin-bottom: 0.5em;
}
pre {
padding: 0;
margin: 0;
}
span#author {
color: #527bbd;
font-family: sans-serif;
font-weight: bold;
font-size: 1.1em;
}
span#email {
}
span#revision {
font-family: sans-serif;
}
div#footer {
font-family: sans-serif;
font-size: small;
border-top: 2px solid silver;
padding-top: 0.5em;
margin-top: 4.0em;
}
div#footer-text {
float: left;
padding-bottom: 0.5em;
}
div#footer-badges {
float: right;
padding-bottom: 0.5em;
}
div#preamble,
div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
margin-right: 10%;
margin-top: 1.5em;
margin-bottom: 1.5em;
}
div.admonitionblock {
margin-top: 2.5em;
margin-bottom: 2.5em;
}
div.content { /* Block element content. */
padding: 0;
}
/* Block element titles. */
div.title, caption.title {
font-family: sans-serif;
font-weight: bold;
text-align: left;
margin-top: 1.0em;
margin-bottom: 0.5em;
}
div.title + * {
margin-top: 0;
}
td div.title:first-child {
margin-top: 0.0em;
}
div.content div.title:first-child {
margin-top: 0.0em;
}
div.content + div.title {
margin-top: 0.0em;
}
div.sidebarblock > div.content {
background: #ffffee;
border: 1px solid silver;
padding: 0.5em;
}
div.listingblock {
margin-right: 0%;
}
div.listingblock > div.content {
border: 1px solid silver;
background: #f4f4f4;
padding: 0.5em;
}
div.quoteblock > div.content {
padding-left: 2.0em;
}
div.attribution {
text-align: right;
}
div.verseblock + div.attribution {
text-align: left;
}
div.admonitionblock .icon {
vertical-align: top;
font-size: 1.1em;
font-weight: bold;
text-decoration: underline;
color: #527bbd;
padding-right: 0.5em;
}
div.admonitionblock td.content {
padding-left: 0.5em;
border-left: 2px solid silver;
}
div.exampleblock > div.content {
border-left: 2px solid silver;
padding: 0.5em;
}
div.verseblock div.content {
white-space: pre;
}
div.imageblock div.content { padding-left: 0; }
div.imageblock img { border: 1px solid silver; }
span.image img { border-style: none; }
dl {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
dt {
margin-top: 0.5em;
margin-bottom: 0;
font-style: italic;
}
dd > *:first-child {
margin-top: 0;
}
ul, ol {
list-style-position: outside;
}
div.olist2 ol {
list-style-type: lower-alpha;
}
div.tableblock > table {
border: 3px solid #527bbd;
}
thead {
font-family: sans-serif;
font-weight: bold;
}
tfoot {
font-weight: bold;
}
div.hlist {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
div.hlist td {
padding-bottom: 5px;
}
td.hlist1 {
vertical-align: top;
font-style: italic;
padding-right: 0.8em;
}
td.hlist2 {
vertical-align: top;
}
@media print {
div#footer-badges { display: none; }
}
div#toctitle {
color: #527bbd;
font-family: sans-serif;
font-size: 1.1em;
font-weight: bold;
margin-top: 1.0em;
margin-bottom: 0.1em;
}
div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
margin-top: 0;
margin-bottom: 0;
}
div.toclevel2 {
margin-left: 2em;
font-size: 0.9em;
}
div.toclevel3 {
margin-left: 4em;
font-size: 0.9em;
}
div.toclevel4 {
margin-left: 6em;
font-size: 0.9em;
}
include1::./stylesheets/xhtml11-manpage.css[]
/* Workarounds for IE6's broken and incomplete CSS2. */
div.sidebar-content {
background: #ffffee;
border: 1px solid silver;
padding: 0.5em;
}
div.sidebar-title, div.image-title {
font-family: sans-serif;
font-weight: bold;
margin-top: 0.0em;
margin-bottom: 0.5em;
}
div.listingblock div.content {
border: 1px solid silver;
background: #f4f4f4;
padding: 0.5em;
}
div.quoteblock-content {
padding-left: 2.0em;
}
div.exampleblock-content {
border-left: 2px solid silver;
padding-left: 0.5em;
}
/* IE6 sets dynamically generated links as visited. */
div#toc a:visited { color: blue; }
</style>
<title>git-remote(1)</title>
</head>
<body>
<div id="header">
<h1>
git-remote(1) Manual Page
</h1>
<h2>NAME</h2>
<div class="sectionbody">
<p>git-remote -
manage set of tracked repositories
</p>
</div>
</div>
<h2>SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
<div class="content"><em>git remote</em> [-v | --verbose]
<em>git remote add</em> [-t &lt;branch&gt;] [-m &lt;master&gt;] [-f] [--mirror] &lt;name&gt; &lt;url&gt;
<em>git remote rename</em> &lt;old&gt; &lt;new&gt;
<em>git remote rm</em> &lt;name&gt;
<em>git remote set-head</em> &lt;name&gt; [-a | -d | &lt;branch&gt;]
<em>git remote show</em> [-n] &lt;name&gt;
<em>git remote prune</em> [-n | --dry-run] &lt;name&gt;
<em>git remote update</em> [group]</div></div>
</div>
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
<div class="para"><p>Manage the set of repositories ("remotes") whose branches you track.</p></div>
</div>
<h2 id="_options">OPTIONS</h2>
<div class="sectionbody">
<div class="vlist"><dl>
<dt>
-v
</dt>
<dt>
--verbose
</dt>
<dd>
<p>
Be a little more verbose and show remote url after name.
</p>
</dd>
</dl></div>
</div>
<h2 id="_commands">COMMANDS</h2>
<div class="sectionbody">
<div class="para"><p>With no arguments, shows a list of existing remotes. Several
subcommands are available to perform operations on the remotes.</p></div>
<div class="vlist"><dl>
<dt>
<em>add</em>
</dt>
<dd>
<p>
Adds a remote named &lt;name&gt; for the repository at
&lt;url&gt;. The command <tt>git fetch &lt;name&gt;</tt> can then be used to create and
update remote-tracking branches &lt;name&gt;/&lt;branch&gt;.
</p>
<div class="para"><p>With <tt>-f</tt> option, <tt>git fetch &lt;name&gt;</tt> is run immediately after
the remote information is set up.</p></div>
<div class="para"><p>With <tt>-t &lt;branch&gt;</tt> option, instead of the default glob
refspec for the remote to track all branches under
<tt>$GIT_DIR/remotes/&lt;name&gt;/</tt>, a refspec to track only <tt>&lt;branch&gt;</tt>
is created. You can give more than one <tt>-t &lt;branch&gt;</tt> to track
multiple branches without grabbing all branches.</p></div>
<div class="para"><p>With <tt>-m &lt;master&gt;</tt> option, <tt>$GIT_DIR/remotes/&lt;name&gt;/HEAD</tt> is set
up to point at remote's <tt>&lt;master&gt;</tt> branch. See also the set-head command.</p></div>
<div class="para"><p>In mirror mode, enabled with <tt>--mirror</tt>, the refs will not be stored
in the <em>refs/remotes/</em> namespace, but in <em>refs/heads/</em>. This option
only makes sense in bare repositories. If a remote uses mirror
mode, furthermore, <tt>git push</tt> will always behave as if <tt>--mirror</tt>
was passed.</p></div>
</dd>
<dt>
<em>rename</em>
</dt>
<dd>
<p>
Rename the remote named &lt;old&gt; to &lt;new&gt;. All remote tracking branches and
configuration settings for the remote are updated.
</p>
<div class="para"><p>In case &lt;old&gt; and &lt;new&gt; are the same, and &lt;old&gt; is a file under
<tt>$GIT_DIR/remotes</tt> or <tt>$GIT_DIR/branches</tt>, the remote is converted to
the configuration file format.</p></div>
</dd>
<dt>
<em>rm</em>
</dt>
<dd>
<p>
Remove the remote named &lt;name&gt;. All remote tracking branches and
configuration settings for the remote are removed.
</p>
</dd>
<dt>
<em>set-head</em>
</dt>
<dd>
<p>
Sets or deletes the default branch (<tt>$GIT_DIR/remotes/&lt;name&gt;/HEAD</tt>) for
the named remote. Having a default branch for a remote is not required,
but allows the name of the remote to be specified in lieu of a specific
branch. For example, if the default branch for <tt>origin</tt> is set to
<tt>master</tt>, then <tt>origin</tt> may be specified wherever you would normally
specify <tt>origin/master</tt>.
</p>
<div class="para"><p>With <tt>-d</tt>, <tt>$GIT_DIR/remotes/&lt;name&gt;/HEAD</tt> is deleted.</p></div>
<div class="para"><p>With <tt>-a</tt>, the remote is queried to determine its <tt>HEAD</tt>, then
<tt>$GIT_DIR/remotes/&lt;name&gt;/HEAD</tt> is set to the same branch. e.g., if the remote
<tt>HEAD</tt> is pointed at <tt>next</tt>, "<tt>git remote set-head origin -a</tt>" will set
<tt>$GIT_DIR/refs/remotes/origin/HEAD</tt> to <tt>refs/remotes/origin/next</tt>. This will
only work if <tt>refs/remotes/origin/next</tt> already exists; if not it must be
fetched first.</p></div>
<div class="para"><p>Use <tt>&lt;branch&gt;</tt> to set <tt>$GIT_DIR/remotes/&lt;name&gt;/HEAD</tt> explicitly. e.g., "git
remote set-head origin master" will set <tt>$GIT_DIR/refs/remotes/origin/HEAD</tt> to
<tt>refs/remotes/origin/master</tt>. This will only work if
<tt>refs/remotes/origin/master</tt> already exists; if not it must be fetched first.</p></div>
</dd>
<dt>
<em>show</em>
</dt>
<dd>
<p>
Gives some information about the remote &lt;name&gt;.
</p>
<div class="para"><p>With <tt>-n</tt> option, the remote heads are not queried first with
<tt>git ls-remote &lt;name&gt;</tt>; cached information is used instead.</p></div>
</dd>
<dt>
<em>prune</em>
</dt>
<dd>
<p>
Deletes all stale tracking branches under &lt;name&gt;.
These stale branches have already been removed from the remote repository
referenced by &lt;name&gt;, but are still locally available in
"remotes/&lt;name&gt;".
</p>
<div class="para"><p>With <tt>--dry-run</tt> option, report what branches will be pruned, but do no
actually prune them.</p></div>
</dd>
<dt>
<em>update</em>
</dt>
<dd>
<p>
Fetch updates for a named set of remotes in the repository as defined by
remotes.&lt;group&gt;. If a named group is not specified on the command line,
the configuration parameter remotes.default will get used; if
remotes.default is not defined, all remotes which do not have the
configuration parameter remote.&lt;name&gt;.skipDefaultUpdate set to true will
be updated. (See <a href="git-config.html">git-config(1)</a>).
</p>
</dd>
</dl></div>
</div>
<h2 id="_discussion">DISCUSSION</h2>
<div class="sectionbody">
<div class="para"><p>The remote configuration is achieved using the <tt>remote.origin.url</tt> and
<tt>remote.origin.fetch</tt> configuration variables. (See
<a href="git-config.html">git-config(1)</a>).</p></div>
</div>
<h2 id="_examples">Examples</h2>
<div class="sectionbody">
<div class="ilist"><ul>
<li>
<p>
Add a new remote, fetch, and check out a branch from it
</p>
<div class="listingblock">
<div class="content">
<pre><tt>$ git remote
origin
$ git branch -r
origin/master
$ git remote add linux-nfs git://linux-nfs.org/pub/linux/nfs-2.6.git
$ git remote
linux-nfs
origin
$ git fetch
* refs/remotes/linux-nfs/master: storing branch 'master' ...
commit: bf81b46
$ git branch -r
origin/master
linux-nfs/master
$ git checkout -b nfs linux-nfs/master
...</tt></pre>
</div></div>
</li>
<li>
<p>
Imitate <em>git-clone</em> but track only selected branches
</p>
<div class="listingblock">
<div class="content">
<pre><tt>$ mkdir project.git
$ cd project.git
$ git init
$ git remote add -f -t master -m master origin git://example.com/git.git/
$ git merge origin</tt></pre>
</div></div>
</li>
</ul></div>
</div>
<h2 id="_see_also">SEE ALSO</h2>
<div class="sectionbody">
<div class="para"><p><a href="git-fetch.html">git-fetch(1)</a>
<a href="git-branch.html">git-branch(1)</a>
<a href="git-config.html">git-config(1)</a></p></div>
</div>
<h2 id="_author">Author</h2>
<div class="sectionbody">
<div class="para"><p>Written by Junio Hamano</p></div>
</div>
<h2 id="_documentation">Documentation</h2>
<div class="sectionbody">
<div class="para"><p>Documentation by J. Bruce Fields and the git-list &lt;git@vger.kernel.org&gt;.</p></div>
</div>
<h2 id="_git">GIT</h2>
<div class="sectionbody">
<div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2009-03-18 05:27:01 UTC
</div>
</div>
</body>
</html>