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