user-manual: quick-start updates

[git.git] / Documentation / git-local-fetch.txt

diff --git a/Documentation/git-local-fetch.txt b/Documentation/git-local-fetch.txt
index 87abec1c4e46ad53e018264046091af4455da307..51389ef37da443c981f3bb5d46f819e90c3d2980 100644 (file)
--- a/Documentation/git-local-fetch.txt
+++ b/Documentation/git-local-fetch.txt
@@ -3,12 +3,14 @@ git-local-fetch(1)
 
 NAME
 ----
-git-local-fetch - Duplicates another git repository on a local system
+git-local-fetch - Duplicate another git repository on a local system
 
 
 SYNOPSIS
 --------
-'git-local-fetch' [-c] [-t] [-a] [-d] [-v] [-w filename] [--recover] [-l] [-s] [-n] commit-id path
+[verse]
+'git-local-fetch' [-c] [-t] [-a] [-d] [-v] [-w filename] [--recover] [-l] [-s] [-n]
+                  commit-id path
 
 DESCRIPTION
 -----------
@@ -24,11 +26,31 @@ OPTIONS
        Get all the objects.
 -v::
        Report what is downloaded.
+-s::
+       Instead of regular file-to-file copying use symbolic links to the objects
+       in the remote repository.
+-l::
+       Before attempting symlinks (if -s is specified) or file-to-file copying the
+       remote objects, try to hardlink the remote objects into the local
+       repository.
+-n::
+       Never attempt to file-to-file copy remote objects.  Only useful with
+       -s or -l command-line options.
 
 -w <filename>::
         Writes the commit-id into the filename under $GIT_DIR/refs/<filename> on
         the local end after the transfer is complete.
 
+--stdin::
+       Instead of a commit id on the commandline (which is not expected in this
+       case), 'git-local-fetch' expects lines on stdin in the format
+
+               <commit-id>['\t'<filename-as-in--w>]
+
+--recover::
+       Verify that everything reachable from target is fetched.  Used after
+       an earlier fetch is interrupted.
+
 Author
 ------
 Written by Junio C Hamano <junkio@cox.net>