user-manual: use pithier example commit
[gitweb.git] / Documentation / git-archive.txt
index 913528d3732999fd3c5a4648b8544fc80827d3dc..4da07c158053bd037f32ff74516c7b2dfeec723b 100644 (file)
@@ -3,11 +3,12 @@ git-archive(1)
 
 NAME
 ----
-git-archive - Creates a archive of the files in the named tree
+git-archive - Create an archive of files from a named tree
 
 
 SYNOPSIS
 --------
+[verse]
 'git-archive' --format=<fmt> [--list] [--prefix=<prefix>/] [<extra>]
              [--remote=<repo>] <tree-ish> [path...]
 
@@ -30,16 +31,21 @@ OPTIONS
 -------
 
 --format=<fmt>::
-       Format of the resulting archive: 'tar', 'zip'...
+       Format of the resulting archive: 'tar', 'zip'...  The default
+       is 'tar'.
 
---list::
+--list, -l::
        Show all available formats.
 
+--verbose, -v::
+       Report progress to stderr.
+
 --prefix=<prefix>/::
        Prepend <prefix>/ to each filename in the archive.
 
 <extra>::
        This can be any options that the archiver backend understand.
+       See next section.
 
 --remote=<repo>::
        Instead of making a tar archive from local repository,
@@ -52,6 +58,18 @@ path::
        If one or more paths are specified, include only these in the
        archive, otherwise include all files and subdirectories.
 
+BACKEND EXTRA OPTIONS
+---------------------
+
+zip
+~~~
+-0::
+       Store the files instead of deflating them.
+-9::
+       Highest and slowest compression level.  You can specify any
+       number from 1 to 9 to adjust compression speed and ratio.
+
+
 CONFIGURATION
 -------------
 By default, file and directories modes are set to 0666 or 0777 in tar