Merge branch 'rh/merge-options-doc-fix'
[git/jrn.git] / Documentation / git-mailsplit.txt
blob4d1b871d96177ca36e7fadd115685316292dc727
1 git-mailsplit(1)
2 ================
4 NAME
5 ----
6 git-mailsplit - Simple UNIX mbox splitter program
8 SYNOPSIS
9 --------
10 [verse]
11 'git mailsplit' [-b] [-f<nn>] [-d<prec>] [--keep-cr] -o<directory> [--] [(<mbox>|<Maildir>)...]
13 DESCRIPTION
14 -----------
15 Splits a mbox file or a Maildir into a list of files: "0001" "0002" ..  in the
16 specified directory so you can process them further from there.
18 IMPORTANT: Maildir splitting relies upon filenames being sorted to output
19 patches in the correct order.
21 OPTIONS
22 -------
23 <mbox>::
24         Mbox file to split.  If not given, the mbox is read from
25         the standard input.
27 <Maildir>::
28         Root of the Maildir to split. This directory should contain the cur, tmp
29         and new subdirectories.
31 -o<directory>::
32         Directory in which to place the individual messages.
34 -b::
35         If any file doesn't begin with a From line, assume it is a
36         single mail message instead of signaling error.
38 -d<prec>::
39         Instead of the default 4 digits with leading zeros,
40         different precision can be specified for the generated
41         filenames.
43 -f<nn>::
44         Skip the first <nn> numbers, for example if -f3 is specified,
45         start the numbering with 0004.
47 --keep-cr::
48         Do not remove `\r` from lines ending with `\r\n`.
50 GIT
51 ---
52 Part of the linkgit:git[1] suite