include agent identifier in capability string
[gitweb.git] / Documentation / git-verify-pack.txt
index 2df77de0f3730c37bcc792c733414cde44e0c0af..cd230769fdc6db2575d274d2a64608fe414c0d2e 100644 (file)
@@ -1,21 +1,21 @@
 git-verify-pack(1)
 ==================
-v0.1, June 2005
 
 NAME
 ----
-git-verify-pack - Validate packed GIT archive files.
+git-verify-pack - Validate packed git archive files
 
 
 SYNOPSIS
 --------
-'git-verify-pack' <pack>.idx ...
+[verse]
+'git verify-pack' [-v|--verbose] [-s|--stat-only] [--] <pack>.idx ...
 
 
 DESCRIPTION
 -----------
-Reads given idx file for packed GIT archive created with
-git-pack-objects command and verifies idx file and the
+Reads given idx file for packed git archive created with the
+'git pack-objects' command and verifies idx file and the
 corresponding pack file.
 
 OPTIONS
@@ -23,16 +23,31 @@ OPTIONS
 <pack>.idx ...::
        The idx files to verify.
 
+-v::
+--verbose::
+       After verifying the pack, show list of objects contained
+       in the pack and a histogram of delta chain length.
 
-Author
-------
-Written by Junio C Hamano <junkio@cox.net>
+-s::
+--stat-only::
+       Do not verify the pack contents; only show the histogram of delta
+       chain length.  With `--verbose`, list of objects is also shown.
 
-Documentation
---------------
-Documentation by Junio C Hamano
+\--::
+       Do not interpret any more arguments as options.
+
+OUTPUT FORMAT
+-------------
+When specifying the -v option the format used is:
+
+       SHA1 type size size-in-pack-file offset-in-packfile
+
+for objects that are not deltified in the pack, and
+
+       SHA1 type size size-in-packfile offset-in-packfile depth base-SHA1
+
+for objects that are deltified.
 
 GIT
 ---
-Part of the link:git.html[git] suite
-
+Part of the linkgit:git[1] suite