Fix generation of "humanish" part of source repo
[git.git] / Documentation / git-mailinfo.txt
1 git-mailinfo(1)
2 ===============
3
4 NAME
5 ----
6 git-mailinfo - Extracts patch from a single e-mail message.
7
8
9 SYNOPSIS
10 --------
11 'git-mailinfo' [-k] [-u | --encoding=<encoding>] <msg> <patch>
12
13
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.
22
23
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.
34
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 the encoding specified by
41         i18n.commitencoding configuration (defaults to utf-8) by
42         transliterating them. 
43         Note that the patch is always used as is without charset
44         conversion, even with this flag.
45
46 --encoding=<encoding>::
47         Similar to -u but if the local convention is different
48         from what is specified by i18n.commitencoding, this flag
49         can be used to override it.
50
51 <msg>::
52         The commit log message extracted from e-mail, usually
53         except the title line which comes from e-mail Subject.
54
55 <patch>::
56         The patch extracted from e-mail.
57
58
59 Author
60 ------
61 Written by Linus Torvalds <torvalds@osdl.org> and
62 Junio C Hamano <junkio@cox.net>
63
64
65 Documentation
66 --------------
67 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
68
69 GIT
70 ---
71 Part of the gitlink:git[7] suite
72