Merge branch 'maint'
[gitweb.git] / Documentation / git-prune-packed.txt
index 0cb19b00586231a6cc108b09177c405a1ba5c5d9..93ee82ae57ed408969117229283e0c06cb1e9ef9 100644 (file)
@@ -1,28 +1,38 @@
 git-prune-packed(1)
 =====================
-v0.1, August 2005
 
 NAME
 ----
-git-prune-packed - Program used to remove the extra object files that are now
-residing in a pack file.
+git-prune-packed - Remove extra objects that are already in pack files
 
 
 SYNOPSIS
 --------
-'git-prune-packed'
+'git-prune-packed' [-n] [-q]
+
 
 DESCRIPTION
 -----------
-This program search the GIT_OBJECT_DIR for all objects that currently exist in
-a pack file as well as the independent object directories.
+This program searches the `$GIT_OBJECT_DIR` for all objects that currently
+exist in a pack file as well as the independent object directories.
 
 All such extra objects are removed.
 
 A pack is a collection of objects, individually compressed, with delta
 compression applied, stored in a single file, with an associated index file.
 
-Packs are used to reduce the load on mirror systems, backup engines, disk storage, etc.
+Packs are used to reduce the load on mirror systems, backup engines,
+disk storage, etc.
+
+
+OPTIONS
+-------
+-n::
+        Don't actually remove any objects, only show those that would have been
+        removed.
+
+-q::
+       Squelch the progress indicator.
 
 Author
 ------
@@ -32,11 +42,11 @@ Documentation
 --------------
 Documentation by Ryan Anderson <ryan@michonline.com>
 
-See-Also
+See Also
 --------
-git-pack-objects(1) git-repack(1)
+linkgit:git-pack-objects[1]
+linkgit:git-repack[1]
 
 GIT
 ---
-Part of the gitlink:git[7] suite
-
+Part of the linkgit:git[7] suite