[PATCH] Documentation: git-peek-remote.

Add documentation for the git-peek-remote and link it from the
main index.

Signed-off-by: Junio C Hamano <junkio@cox.net>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>

diff --git a/Documentation/git-peek-remote.txt b/Documentation/git-peek-remote.txt
new file mode 100644 (file)
index 0000000..ab783c1
--- /dev/null
+++ b/Documentation/git-peek-remote.txt
@@ -0,0 +1,53 @@
+git-peek-remote(1)
+==================
+v0.1, July 2005
+
+NAME
+----
+git-peek-remote - Lists the references on a remote repository.
+
+
+SYNOPSIS
+--------
+'git-peek-remote' [--exec=<git-upload-pack>] [<host>:]<directory>
+
+DESCRIPTION
+-----------
+Lists the references the remote repository has, and optionally
+stores them in the local repository under the same name.
+
+OPTIONS
+-------
+--exec=<git-upload-pack>::
+       Use this to specify the path to 'git-upload-pack' on the
+       remote side, if is not found on your $PATH.
+       Installations of sshd ignores the user's environment
+       setup scripts for login shells (e.g. .bash_profile) and
+       your privately installed GIT may not be found on the system
+       default $PATH.  Another workaround suggested is to set
+       up your $PATH in ".bashrc", but this flag is for people
+       who do not want to pay the overhead for non-interactive
+       shells by having a lean .bashrc file (they set most of
+       the things up in .bash_profile).
+
+<host>::
+       A remote host that houses the repository.  When this
+       part is specified, 'git-upload-pack' is invoked via
+       ssh.
+
+<directory>::
+       The repository to sync from.
+
+
+Author
+------
+Written by Junio C Hamano <junkio@cox.net>
+
+Documentation
+--------------
+Documentation by Junio C Hamano.
+
+GIT
+---
+Part of the link:git.html[git] suite
+

diff --git a/Documentation/git.txt b/Documentation/git.txt
index ffc27d5..004383b 100644 (file)
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -131,12 +131,12 @@ link:git-clone-pack.html[git-clone-pack]::
        Clones a repository into the current repository (engine
        for ssh and local transport)
 
-link:git-fetch-script.html[git-pull-script]::
-       Pull from a repote repository via various protocols
+link:git-fetch-script.html[git-fetch-script]::
+       Download from a remote repository via various protocols
        (user interface).
 
 link:git-pull-script.html[git-pull-script]::
-       Fetch from and merge with a repote repository via
+       Fetch from and merge with a remote repository via
        various protocols (user interface).
 
 link:git-http-pull.html[git-http-pull]::
@@ -160,6 +160,9 @@ link:git-clone-pack.html[git-clone-pack]::
 link:git-fetch-pack.html[git-fetch-pack]::
        Updates from a remote repository.
 
+link:git-peek-remote.html[git-peek-remote]::
+       Lists references on a remote repository using upload-pack protocol.
+
 link:git-upload-pack.html[git-upload-pack]::
        Invoked by 'git-clone-pack' and 'git-fetch-pack' to push
        what are asked for.