Brief documentation for the mysterious git-am script
[git/dscho.git] / Documentation / git-am.txt
blobc73a8c5bcd6aa5fb78bdf673d0107ac78d6c22e0
1 git-am(1)
2 ================
4 NAME
5 ----
6 git-am - Apply a series of patches in a mailbox
9 SYNOPSIS
10 --------
11 'git-am' [--signoff] [--dotest=<dir>] [--utf8] [--3way] <mbox>
12 'git-am' [--skip]
14 DESCRIPTION
15 -----------
16 Splits mail messages in a mailbox into commit log message,
17 authorship information and patches, and applies them to the
18 current branch.
20 This is the replacement for the 'git-applymbox' script.
21 Unlike git-applymbox, it can take more than one mailbox file from
22 the command line, as well as reading from the standard input when
23 '-' is specified. Other differences include changed parameter names
24 and less descriptive command name.
27 When initially invoking it, you give it name of the mailbox to crunch.
28 The usage hints that it might get interrupted and you will want to
29 resume the last round of applying - to do that, pass it no mailbox
30 name, and optionally the mysterious '--skip' parameter.
33 SEE ALSO
34 --------
35 gitlink:git-applymbox[1], gitlink:git-applypatch[1].
38 Author
39 ------
40 Written by Junio C Hamano <junkio@cox.net>
42 Documentation
43 --------------
44 Documentation by Petr Baudis, Junio C Hamano and the git-list <git@vger.kernel.org>.
46 This manual page is a stub. You can help the git documentation by expanding it.
48 GIT
49 ---
50 Part of the gitlink:git[7] suite