add a howto document about corrupted blob recovery

[git.git] / Documentation / git-mailsplit.txt

diff --git a/Documentation/git-mailsplit.txt b/Documentation/git-mailsplit.txt
index 617276a011584cce6119161afabee5dd64f1a011..c4f4cabbdcdaae18491c301d44fd68ae89b18352 100644 (file)
--- a/Documentation/git-mailsplit.txt
+++ b/Documentation/git-mailsplit.txt
@@ -3,30 +3,51 @@ git-mailsplit(1)
 
 NAME
 ----
-git-mailsplit - Some git command not yet documented.
-
+git-mailsplit - Simple UNIX mbox splitter program
 
 SYNOPSIS
 --------
-'git-mailsplit' [ --option ] <args>...
+'git-mailsplit' [-b] [-f<nn>] [-d<prec>] -o<directory> [--] [<mbox>|<Maildir>...]
 
 DESCRIPTION
 -----------
-Does something not yet documented.
+Splits a mbox file or a Maildir into a list of files: "0001" "0002" ..  in the
+specified directory so you can process them further from there.
 
+IMPORTANT: Maildir splitting relies upon filenames being sorted to output
+patches in the correct order.
 
 OPTIONS
 -------
---option::
-       Some option not yet documented.
+<mbox>::
+       Mbox file to split.  If not given, the mbox is read from
+       the standard input.
+
+<Maildir>::
+       Root of the Maildir to split. This directory should contain the cur, tmp
+       and new subdirectories.
+
+<directory>::
+       Directory in which to place the individual messages.
 
-<args>...::
-       Some argument not yet documented.
+-b::
+       If any file doesn't begin with a From line, assume it is a
+       single mail message instead of signaling error.
 
+-d<prec>::
+       Instead of the default 4 digits with leading zeros,
+       different precision can be specified for the generated
+       filenames.
+
+-f<nn>::
+       Skip the first <nn> numbers, for example if -f3 is specified,
+       start the numbering with 0004.
 
 Author
 ------
 Written by Linus Torvalds <torvalds@osdl.org>
+and Junio C Hamano <junkio@cox.net>
+
 
 Documentation
 --------------
@@ -34,5 +55,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 
 GIT
 ---
-Part of the link:git.html[git] suite
-
+Part of the gitlink:git[7] suite