]> git.ipfire.org Git - thirdparty/git.git/blame - Documentation/git-mailinfo.txt
Documentation: describe the scissors mark support of "git am"
[thirdparty/git.git] / Documentation / git-mailinfo.txt
CommitLineData
7fc9d69f
JH
1git-mailinfo(1)
2===============
3
4NAME
5----
c3f0baac 6git-mailinfo - Extracts patch and authorship from a single e-mail message
7fc9d69f
JH
7
8
9SYNOPSIS
10--------
447d0cca 11'git mailinfo' [-k] [-u | --encoding=<encoding> | -n] <msg> <patch>
f85a4191 12
7fc9d69f
JH
13
14DESCRIPTION
15-----------
04c8ce9c 16Reads a single e-mail message from the standard input, and
f85a4191
JH
17writes the commit log message in <msg> file, and the patches in
18<patch> file. The author name, e-mail and e-mail subject are
ba020ef5 19written out to the standard output to be used by 'git-am'
f85a4191 20to create a commit. It is usually not necessary to use this
5162e697 21command directly. See linkgit:git-am[1] instead.
7fc9d69f
JH
22
23
24OPTIONS
25-------
f85a4191
JH
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
46e56e81 32 munging, and is most useful when used to read back
ba020ef5 33 'git-format-patch -k' output.
f85a4191
JH
34
35-u::
bb1091a4
JH
36 The commit log message, author name and author email are
37 taken from the e-mail, and after minimally decoding MIME
38 transfer encoding, re-coded in UTF-8 by transliterating
39 them. This used to be optional but now it is the default.
40+
41Note that the patch is always used as-is without charset
42conversion, even with this flag.
7fc9d69f 43
9f63892b
JH
44--encoding=<encoding>::
45 Similar to -u but if the local convention is different
46 from what is specified by i18n.commitencoding, this flag
47 can be used to override it.
48
b4958181
LS
49-n::
50 Disable all charset re-coding of the metadata.
51
f85a4191
JH
52<msg>::
53 The commit log message extracted from e-mail, usually
54 except the title line which comes from e-mail Subject.
55
56<patch>::
57 The patch extracted from e-mail.
7fc9d69f
JH
58
59
60Author
61------
f85a4191 62Written by Linus Torvalds <torvalds@osdl.org> and
59eb68aa 63Junio C Hamano <gitster@pobox.com>
f85a4191 64
7fc9d69f
JH
65
66Documentation
67--------------
68Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
69
70GIT
71---
9e1f0a85 72Part of the linkgit:git[1] suite