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 03a9477664310c2dc5ee9bddc0b34a99b8ab6687..c4f4cabbdcdaae18491c301d44fd68ae89b18352 100644 (file)
--- a/Documentation/git-mailsplit.txt
+++ b/Documentation/git-mailsplit.txt
@@ -3,16 +3,19 @@ git-mailsplit(1)
  
  NAME
  ----
  
  NAME
  ----
-git-mailsplit - Totally braindamaged mbox splitter program.
+git-mailsplit - Simple UNIX mbox splitter program
  
  SYNOPSIS
  --------
  
  SYNOPSIS
  --------
-'git-mailsplit' [-d<prec>] [<mbox>] <directory>
+'git-mailsplit' [-b] [-f<nn>] [-d<prec>] -o<directory> [--] [<mbox>|<Maildir>...]
  
  DESCRIPTION
  -----------
  
  DESCRIPTION
  -----------
-Splits a mbox file into a list of files: "0001" "0002" ..  in the specified
-directory so you can process them further from there.
+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
  -------
  
  OPTIONS
  -------
@@ -20,14 +23,25 @@ OPTIONS
         Mbox file to split.  If not given, the mbox is read from
         the standard input.
  
         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.
  
  <directory>::
         Directory in which to place the individual messages.
  
+-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.
  
  -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
  ------
  
  Author
  ------
@@ -42,4 +56,3 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
  GIT
  ---
  Part of the gitlink:git[7] suite
  GIT
  ---
  Part of the gitlink:git[7] suite
-