user-manual: use pithier example commit
[gitweb.git] / Documentation / git-prune-packed.txt
index 28a1500d39a503e8341ad9c39c1c1597b1653d7c..310033e4605d20b99c21a769e79b25b64abbb618 100644 (file)
@@ -3,25 +3,36 @@ git-prune-packed(1)
 
 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 search 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
 ------
@@ -31,7 +42,7 @@ Documentation
 --------------
 Documentation by Ryan Anderson <ryan@michonline.com>
 
-See-Also
+See Also
 --------
 gitlink:git-pack-objects[1]
 gitlink:git-repack[1]