blob: 64aa6a1ea6bca248e7078efcecb3d582cf8a0f5f [file] [log] [blame]
Junio C Hamano1a4e8412005-12-27 08:17:231git-mailinfo(1)
2===============
3
4NAME
5----
Junio C Hamano7c73c662007-01-19 00:37:506git-mailinfo - Extracts patch and authorship from a single e-mail message
Junio C Hamano1a4e8412005-12-27 08:17:237
8
9SYNOPSIS
10--------
11'git-mailinfo' [-k] [-u | --encoding=<encoding>] <msg> <patch>
12
13
14DESCRIPTION
15-----------
16Reading a single e-mail message from the standard input, and
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
Junio C Hamano38b693c2007-06-03 08:40:1419written out to the standard output to be used by git-am
Junio C Hamano1a4e8412005-12-27 08:17:2320to create a commit. It is usually not necessary to use this
Junio C Hamanoe58607f2007-01-17 23:27:4521command directly. See gitlink:git-am[1] instead.
Junio C Hamano1a4e8412005-12-27 08:17:2322
23
24OPTIONS
25-------
26-k::
27Usually the program 'cleans up' the Subject: header line
28to extract the title line for the commit log message,
29among which (1) remove 'Re:' or 're:', (2) leading
30whitespaces, (3) '[' up to ']', typically '[PATCH]', and
31then prepends "[PATCH] ". This flag forbids this
32munging, and is most useful when used to read back 'git
Junio C Hamano0430e3a2007-05-15 03:13:1733format-patch -k' output.
Junio C Hamano1a4e8412005-12-27 08:17:2334
35-u::
Junio C Hamano27eacdb2007-01-10 05:37:4736The commit log message, author name and author email are
37taken from the e-mail, and after minimally decoding MIME
38transfer encoding, re-coded in UTF-8 by transliterating
39them. 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.
Junio C Hamano1a4e8412005-12-27 08:17:2343
44--encoding=<encoding>::
45Similar to -u but if the local convention is different
46from what is specified by i18n.commitencoding, this flag
47can be used to override it.
48
49<msg>::
50The commit log message extracted from e-mail, usually
51except the title line which comes from e-mail Subject.
52
53<patch>::
54The patch extracted from e-mail.
55
56
57Author
58------
59Written by Linus Torvalds <torvalds@osdl.org> and
60Junio C Hamano <junkio@cox.net>
61
62
63Documentation
64--------------
65Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
66
67GIT
68---
69Part of the gitlink:git[7] suite