blob: e3d58cbac3f162cc01d8731485f220fd70fed17b [file] [log] [blame]
Junio C Hamano7fc9d692005-08-23 01:49:47 -07001git-mailinfo(1)
2===============
3
4NAME
5----
Junio C Hamanoc3f0baa2007-01-18 15:53:37 -08006git-mailinfo - Extracts patch and authorship from a single e-mail message
Junio C Hamano7fc9d692005-08-23 01:49:47 -07007
8
9SYNOPSIS
10--------
Junio C Hamanod268cb92009-11-30 14:43:24 -080011'git mailinfo' [-k|-b] [-u | --encoding=<encoding> | -n] [--scissors] <msg> <patch>
Junio C Hamanof85a4192005-08-29 17:21:06 -070012
Junio C Hamano7fc9d692005-08-23 01:49:47 -070013
14DESCRIPTION
15-----------
Markus Heidelberg04c8ce92008-12-19 13:14:18 +010016Reads a single e-mail message from the standard input, and
Junio C Hamanof85a4192005-08-29 17:21:06 -070017writes the commit log message in <msg> file, and the patches in
18<patch> file. The author name, e-mail and e-mail subject are
Thomas Rast0b444cd2010-01-10 00:33:00 +010019written out to the standard output to be used by 'git am'
Junio C Hamanof85a4192005-08-29 17:21:06 -070020to create a commit. It is usually not necessary to use this
Dan McGee5162e692007-12-29 00:20:38 -060021command directly. See linkgit:git-am[1] instead.
Junio C Hamano7fc9d692005-08-23 01:49:47 -070022
23
24OPTIONS
25-------
Junio C Hamanof85a4192005-08-29 17:21:06 -070026-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
Jonathan Nieder46e56e82008-06-30 17:17:07 -050032 munging, and is most useful when used to read back
Thomas Rast0b444cd2010-01-10 00:33:00 +010033 'git format-patch -k' output.
Junio C Hamano7fc9d692005-08-23 01:49:47 -070034
Junio C Hamano17635fc2009-07-15 15:31:12 -070035-b::
36 When -k is not in effect, all leading strings bracketed with '['
37 and ']' pairs are stripped. This option limits the stripping to
38 only the pairs whose bracketed string contains the word "PATCH".
39
Junio C Hamanof85a4192005-08-29 17:21:06 -070040-u::
Junio C Hamanobb1091a2007-01-09 21:31:36 -080041 The commit log message, author name and author email are
42 taken from the e-mail, and after minimally decoding MIME
43 transfer encoding, re-coded in UTF-8 by transliterating
44 them. This used to be optional but now it is the default.
45+
46Note that the patch is always used as-is without charset
47conversion, even with this flag.
Junio C Hamanof85a4192005-08-29 17:21:06 -070048
Junio C Hamano9f638922005-11-28 01:29:52 -080049--encoding=<encoding>::
50 Similar to -u but if the local convention is different
51 from what is specified by i18n.commitencoding, this flag
52 can be used to override it.
53
Lukas Sandströmb4958182008-07-10 23:36:28 +020054-n::
55 Disable all charset re-coding of the metadata.
56
Junio C Hamano017678b2009-08-26 21:36:05 -070057--scissors::
58 Remove everything in body before a scissors line. A line that
59 mainly consists of scissors (either ">8" or "8<") and perforation
60 (dash "-") marks is called a scissors line, and is used to request
61 the reader to cut the message at that line. If such a line
62 appears in the body of the message before the patch, everything
63 before it (including the scissors line itself) is ignored when
64 this option is used.
65+
66This is useful if you want to begin your message in a discussion thread
67with comments and suggestions on the message you are responding to, and to
68conclude it with a patch submission, separating the discussion and the
69beginning of the proposed commit log message with a scissors line.
Nicolas Sebrecht434a6db2009-09-11 02:29:58 +020070+
71This can enabled by default with the configuration option mailinfo.scissors.
72
73--no-scissors::
74 Ignore scissors lines. Useful for overriding mailinfo.scissors settings.
Junio C Hamano017678b2009-08-26 21:36:05 -070075
Junio C Hamanof85a4192005-08-29 17:21:06 -070076<msg>::
77 The commit log message extracted from e-mail, usually
78 except the title line which comes from e-mail Subject.
79
80<patch>::
81 The patch extracted from e-mail.
Junio C Hamano7fc9d692005-08-23 01:49:47 -070082
83
84Author
85------
Junio C Hamanof85a4192005-08-29 17:21:06 -070086Written by Linus Torvalds <torvalds@osdl.org> and
Junio C Hamano59eb68a2008-07-21 12:14:42 -070087Junio C Hamano <gitster@pobox.com>
Junio C Hamanof85a4192005-08-29 17:21:06 -070088
Junio C Hamano7fc9d692005-08-23 01:49:47 -070089
90Documentation
91--------------
92Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
93
94GIT
95---
Christian Couder9e1f0a82008-06-06 09:07:32 +020096Part of the linkgit:git[1] suite