Update git-pack-objects documentation.
[debian-git.git] / Documentation / git-mailinfo.txt
blobdc7d725ea155f9eccb7ebab7df6335ae7589d483
1 git-mailinfo(1)
2 ===============
4 NAME
5 ----
6 git-mailinfo - Extracts patch from a single e-mail message.
9 SYNOPSIS
10 --------
11 'git-mailinfo' [-k] [-u] <msg> <patch>
14 DESCRIPTION
15 -----------
16 Reading a single e-mail message from the standard input, and
17 writes the commit log message in <msg> file, and the patches in
18 <patch> file.  The author name, e-mail and e-mail subject are
19 written out to the standard output to be used by git-applypatch
20 to create a commit.  It is usually not necessary to use this
21 command directly.
24 OPTIONS
25 -------
26 -k::
27         Usually the program 'cleans up' the Subject: header line
28         to extract the title line for the commit log message,
29         among which (1) remove 'Re:' or 're:', (2) leading
30         whitespaces, (3) '[' up to ']', typically '[PATCH]', and
31         then prepends "[PATCH] ".  This flag forbids this
32         munging, and is most useful when used to read back 'git
33         format-patch --mbox' output.
35 -u::
36         By default, the commit log message, author name and
37         author email are taken from the e-mail without any
38         charset conversion, after minimally decoding MIME
39         transfer encoding.  This flag causes the resulting
40         commit to be encoded in utf-8 by transliterating them.
41         Note that the patch is always used as is without charset
42         conversion, even with this flag.
44 <msg>::
45         The commit log message extracted from e-mail, usually
46         except the title line which comes from e-mail Subject.
48 <patch>::
49         The patch extracted from e-mail.
52 Author
53 ------
54 Written by Linus Torvalds <torvalds@osdl.org> and
55 Junio C Hamano <junkio@cox.net>
58 Documentation
59 --------------
60 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
62 GIT
63 ---
64 Part of the gitlink:git[7] suite