Autogenerated man pages for v1.3.2-g8611
[git.git] / man1 / git-mailinfo.1
1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
2 .de Sh \" Subsection
3 .br
4 .if t .Sp
5 .ne 5
6 .PP
7 \fB\\$1\fR
8 .PP
9 ..
10 .de Sp \" Vertical space (when we can't use .PP)
11 .if t .sp .5v
12 .if n .sp
13 ..
14 .de Ip \" List item
15 .br
16 .ie \\n(.$>=3 .ne \\$3
17 .el .ne 3
18 .IP "\\$1" \\$2
19 ..
20 .TH "GIT-MAILINFO" 1 "" "" ""
21 .SH NAME
22 git-mailinfo \- Extracts patch from a single e-mail message
23 .SH "SYNOPSIS"
24
25
26 \fIgit\-mailinfo\fR [\-k] [\-u | \-\-encoding=<encoding>] <msg> <patch>
27
28 .SH "DESCRIPTION"
29
30
31 Reading a single e\-mail message from the standard input, and writes the commit log message in <msg> file, and the patches in <patch> file\&. The author name, e\-mail and e\-mail subject are written out to the standard output to be used by git\-applypatch to create a commit\&. It is usually not necessary to use this command directly\&.
32
33 .SH "OPTIONS"
34
35 .TP
36 \-k
37 Usually the program \fIcleans up\fR the Subject: header line to extract the title line for the commit log message, among which (1) remove \fIRe:\fR or \fIre:\fR, (2) leading whitespaces, (3) \fI[\fR up to \fI]\fR, typically \fI[PATCH]\fR, and then prepends "[PATCH] "\&. This flag forbids this munging, and is most useful when used to read back \fIgit format\-patch \-\-mbox\fR output\&.
38
39 .TP
40 \-u
41 By default, the commit log message, author name and author email are taken from the e\-mail without any charset conversion, after minimally decoding MIME transfer encoding\&. This flag causes the resulting commit to be encoded in the encoding specified by i18n\&.commitencoding configuration (defaults to utf\-8) by transliterating them\&. Note that the patch is always used as is without charset conversion, even with this flag\&.
42
43 .TP
44 \-\-encoding=<encoding>
45 Similar to \-u but if the local convention is different from what is specified by i18n\&.commitencoding, this flag can be used to override it\&.
46
47 .TP
48 <msg>
49 The commit log message extracted from e\-mail, usually except the title line which comes from e\-mail Subject\&.
50
51 .TP
52 <patch>
53 The patch extracted from e\-mail\&.
54
55 .SH "AUTHOR"
56
57
58 Written by Linus Torvalds <torvalds@osdl\&.org> and Junio C Hamano <junkio@cox\&.net>
59
60 .SH "DOCUMENTATION"
61
62
63 Documentation by Junio C Hamano and the git\-list <git@vger\&.kernel\&.org>\&.
64
65 .SH "GIT"
66
67
68 Part of the \fBgit\fR(7) suite
69