blob: e3d58cbac3f162cc01d8731485f220fd70fed17b [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--------
Junio C Hamano2bd8a742009-12-01 21:16:5911'git mailinfo' [-k|-b] [-u | --encoding=<encoding> | -n] [--scissors] <msg> <patch>
Junio C Hamano1a4e8412005-12-27 08:17:2312
13
14DESCRIPTION
15-----------
Junio C Hamano54bf1e22008-12-20 06:30:1116Reads a single e-mail message from the standard input, and
Junio C Hamano1a4e8412005-12-27 08:17:2317writes 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 Hamano1aa40d22010-01-21 17:46:4319written 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 Hamano35738e82008-01-07 07:55:4621command directly. See linkgit: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
Junio C Hamanofce7c7e2008-07-02 03:06:3832munging, and is most useful when used to read back
Junio C Hamano1aa40d22010-01-21 17:46:4333'git format-patch -k' output.
Junio C Hamano1a4e8412005-12-27 08:17:2334
Junio C Hamano2bd8a742009-12-01 21:16:5935-b::
36When -k is not in effect, all leading strings bracketed with '['
37and ']' pairs are stripped. This option limits the stripping to
38only the pairs whose bracketed string contains the word "PATCH".
39
Junio C Hamano1a4e8412005-12-27 08:17:2340-u::
Junio C Hamano27eacdb2007-01-10 05:37:4741The commit log message, author name and author email are
42taken from the e-mail, and after minimally decoding MIME
43transfer encoding, re-coded in UTF-8 by transliterating
44them. 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 Hamano1a4e8412005-12-27 08:17:2348
49--encoding=<encoding>::
50Similar to -u but if the local convention is different
51from what is specified by i18n.commitencoding, this flag
52can be used to override it.
53
Junio C Hamano46a38aa2008-07-14 03:13:2754-n::
55Disable all charset re-coding of the metadata.
56
Junio C Hamanoc28068f2009-09-08 00:55:2357--scissors::
58Remove everything in body before a scissors line. A line that
59mainly consists of scissors (either ">8" or "8<") and perforation
60(dash "-") marks is called a scissors line, and is used to request
61the reader to cut the message at that line. If such a line
62appears in the body of the message before the patch, everything
63before it (including the scissors line itself) is ignored when
64this 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.
Junio C Hamanocf5b7732009-09-11 23:28:3270+
71This can enabled by default with the configuration option mailinfo.scissors.
72
73--no-scissors::
74Ignore scissors lines. Useful for overriding mailinfo.scissors settings.
Junio C Hamanoc28068f2009-09-08 00:55:2375
Junio C Hamano1a4e8412005-12-27 08:17:2376<msg>::
77The commit log message extracted from e-mail, usually
78except the title line which comes from e-mail Subject.
79
80<patch>::
81The patch extracted from e-mail.
82
83
84Author
85------
86Written by Linus Torvalds <torvalds@osdl.org> and
Junio C Hamano0868a302008-07-22 09:20:4487Junio C Hamano <gitster@pobox.com>
Junio C Hamano1a4e8412005-12-27 08:17:2388
89
90Documentation
91--------------
92Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
93
94GIT
95---
Junio C Hamanof7c042d2008-06-06 22:50:5396Part of the linkgit:git[1] suite