git-ls-remote.1   [plain text]


'\" t
.\"     Title: git-ls-remote
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: 02/24/2014
.\"    Manual: Git Manual
.\"    Source: Git 1.9.0
.\"  Language: English
.\"
.TH "GIT\-LS\-REMOTE" "1" "02/24/2014" "Git 1\&.9\&.0" "Git Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
git-ls-remote \- List references in a remote repository
.SH "SYNOPSIS"
.sp
.nf
\fIgit ls\-remote\fR [\-\-heads] [\-\-tags]  [\-u <exec> | \-\-upload\-pack <exec>]
              [\-\-exit\-code] <repository> [<refs>\&...]
.fi
.sp
.SH "DESCRIPTION"
.sp
Displays references available in a remote repository along with the associated commit IDs\&.
.SH "OPTIONS"
.PP
\-h, \-\-heads, \-t, \-\-tags
.RS 4
Limit to only refs/heads and refs/tags, respectively\&. These options are
\fInot\fR
mutually exclusive; when given both, references stored in refs/heads and refs/tags are displayed\&.
.RE
.PP
\-u <exec>, \-\-upload\-pack=<exec>
.RS 4
Specify the full path of
\fIgit\-upload\-pack\fR
on the remote host\&. This allows listing references from repositories accessed via SSH and where the SSH daemon does not use the PATH configured by the user\&.
.RE
.PP
\-\-exit\-code
.RS 4
Exit with status "2" when no matching refs are found in the remote repository\&. Usually the command exits with status "0" to indicate it successfully talked with the remote repository, whether it found any matching refs\&.
.RE
.PP
\-\-get\-url
.RS 4
Expand the URL of the given remote repository taking into account any "url\&.<base>\&.insteadOf" config setting (See
\fBgit-config\fR(1)) and exit without talking to the remote\&.
.RE
.PP
<repository>
.RS 4
The "remote" repository to query\&. This parameter can be either a URL or the name of a remote (see the GIT URLS and REMOTES sections of
\fBgit-fetch\fR(1))\&.
.RE
.PP
<refs>\&...
.RS 4
When unspecified, all references, after filtering done with \-\-heads and \-\-tags, are shown\&. When <refs>\&... are specified, only references matching the given patterns are displayed\&.
.RE
.SH "EXAMPLES"
.sp
.if n \{\
.RS 4
.\}
.nf
$ git ls\-remote \-\-tags \&./\&.
d6602ec5194c87b0fc87103ca4d67251c76f233a        refs/tags/v0\&.99
f25a265a342aed6041ab0cc484224d9ca54b6f41        refs/tags/v0\&.99\&.1
7ceca275d047c90c0c7d5afb13ab97efdf51bd6e        refs/tags/v0\&.99\&.3
c5db5456ae3b0873fc659c19fafdde22313cc441        refs/tags/v0\&.99\&.2
0918385dbd9656cab0d1d81ba7453d49bbc16250        refs/tags/junio\-gpg\-pub
$ git ls\-remote http://www\&.kernel\&.org/pub/scm/git/git\&.git master pu rc
5fe978a5381f1fbad26a80e682ddd2a401966740        refs/heads/master
c781a84b5204fb294c9ccc79f8b3baceeb32c061        refs/heads/pu
$ git remote add korg http://www\&.kernel\&.org/pub/scm/git/git\&.git
$ git ls\-remote \-\-tags korg v\e*
d6602ec5194c87b0fc87103ca4d67251c76f233a        refs/tags/v0\&.99
f25a265a342aed6041ab0cc484224d9ca54b6f41        refs/tags/v0\&.99\&.1
c5db5456ae3b0873fc659c19fafdde22313cc441        refs/tags/v0\&.99\&.2
7ceca275d047c90c0c7d5afb13ab97efdf51bd6e        refs/tags/v0\&.99\&.3
.fi
.if n \{\
.RE
.\}
.SH "GIT"
.sp
Part of the \fBgit\fR(1) suite