GIT 1.4.3-rc1
[gitweb.git] / Documentation / git-unpack-objects.txt
index a12b8438bfd67df7fdee520fd039a9b39415d3bb..ff6184b0f7498a44995fe4c55dab49c5517ec458 100644 (file)
@@ -1,22 +1,44 @@
 git-unpack-objects(1)
 =====================
-v0.1, July 2005
 
 NAME
 ----
-git-unpack-objects - Unpack objects from a packed archive.
+git-unpack-objects - Unpack objects from a packed archive
 
 
 SYNOPSIS
 --------
-'git-unpack-objects' pack-file
+'git-unpack-objects' [-n] [-q] [-r] <pack-file
 
 
 DESCRIPTION
 -----------
-Reads a packed archive (.pack) from the standard input, and
-expands the objects contained in the pack into "one-file
-one-object" format in $GIT_OBJECT_DIRECTORY.
+Read a packed archive (.pack) from the standard input, expanding
+the objects contained within and writing them into the repository in
+"loose" (one object per file) format.
+
+Objects that already exist in the repository will *not* be unpacked
+from the pack-file.  Therefore, nothing will be unpacked if you use
+this command on a pack-file that exists within the target repository.
+
+Please see the `git-repack` documentation for options to generate
+new packs and replace existing ones.
+
+OPTIONS
+-------
+-n::
+        Only list the objects that would be unpacked, don't actually unpack
+        them.
+
+-q::
+       The command usually shows percentage progress.  This
+       flag suppresses it.
+
+-r::
+       When unpacking a corrupt packfile, the command dies at
+       the first corruption.  This flag tells it to keep going
+       and make the best effort to recover as many objects as
+       possible.
 
 
 Author
@@ -29,5 +51,5 @@ Documentation by Junio C Hamano
 
 GIT
 ---
-Part of the link:git.html[git] suite
+Part of the gitlink:git[7] suite