OSDN Git Service

merge original branch.
[tortoisegit/TortoiseGitJp.git] / doc / source / en / TortoiseGit / git_doc / git-mailinfo.html.xml
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">\r
3 \r
4 <article lang="en" id="git-mailinfo(1)">\r
5 <articleinfo>\r
6     <title>git-mailinfo(1)</title>\r
7         <indexterm>\r
8                 <primary>git-mailinfo(1)</primary>\r
9         </indexterm>\r
10 </articleinfo>\r
11 <simplesect id="_name">\r
12 <title>NAME</title>\r
13 <simpara>git-mailinfo - Extracts patch and authorship from a single e-mail message</simpara>\r
14 </simplesect>\r
15 <simplesect id="_synopsis">\r
16 <title>SYNOPSIS</title>\r
17 <simpara><emphasis>git mailinfo</emphasis> [-k] [-u | --encoding=&lt;encoding&gt; | -n] &lt;msg&gt; &lt;patch&gt;</simpara>\r
18 </simplesect>\r
19 <simplesect id="_description">\r
20 <title>DESCRIPTION</title>\r
21 <simpara>Reads a single e-mail message from the standard input, and\r
22 writes the commit log message in &lt;msg&gt; file, and the patches in\r
23 &lt;patch&gt; file.  The author name, e-mail and e-mail subject are\r
24 written out to the standard output to be used by <emphasis>git-am</emphasis>\r
25 to create a commit.  It is usually not necessary to use this\r
26 command directly.  See <xref linkend="git-am(1)"/> instead.</simpara>\r
27 </simplesect>\r
28 <simplesect id="_options">\r
29 <title>OPTIONS</title>\r
30 <variablelist>\r
31 <varlistentry>\r
32 <term>\r
33 -k\r
34 </term>\r
35 <listitem>\r
36 <simpara>\r
37         Usually the program <emphasis>cleans up</emphasis> the Subject: header line\r
38         to extract the title line for the commit log message,\r
39         among which (1) remove <emphasis>Re:</emphasis> or <emphasis>re:</emphasis>, (2) leading\r
40         whitespaces, (3) <emphasis>[</emphasis> up to <emphasis>]</emphasis>, typically <emphasis>[PATCH]</emphasis>, and\r
41         then prepends "[PATCH] ".  This flag forbids this\r
42         munging, and is most useful when used to read back\r
43         <emphasis>git-format-patch -k</emphasis> output.\r
44 </simpara>\r
45 </listitem>\r
46 </varlistentry>\r
47 <varlistentry>\r
48 <term>\r
49 -u\r
50 </term>\r
51 <listitem>\r
52 <simpara>\r
53         The commit log message, author name and author email are\r
54         taken from the e-mail, and after minimally decoding MIME\r
55         transfer encoding, re-coded in UTF-8 by transliterating\r
56         them.  This used to be optional but now it is the default.\r
57 </simpara>\r
58 <simpara>Note that the patch is always used as-is without charset\r
59 conversion, even with this flag.</simpara>\r
60 </listitem>\r
61 </varlistentry>\r
62 <varlistentry>\r
63 <term>\r
64 --encoding=&lt;encoding&gt;\r
65 </term>\r
66 <listitem>\r
67 <simpara>\r
68         Similar to -u but if the local convention is different\r
69         from what is specified by i18n.commitencoding, this flag\r
70         can be used to override it.\r
71 </simpara>\r
72 </listitem>\r
73 </varlistentry>\r
74 <varlistentry>\r
75 <term>\r
76 -n\r
77 </term>\r
78 <listitem>\r
79 <simpara>\r
80         Disable all charset re-coding of the metadata.\r
81 </simpara>\r
82 </listitem>\r
83 </varlistentry>\r
84 <varlistentry>\r
85 <term>\r
86 &lt;msg&gt;\r
87 </term>\r
88 <listitem>\r
89 <simpara>\r
90         The commit log message extracted from e-mail, usually\r
91         except the title line which comes from e-mail Subject.\r
92 </simpara>\r
93 </listitem>\r
94 </varlistentry>\r
95 <varlistentry>\r
96 <term>\r
97 &lt;patch&gt;\r
98 </term>\r
99 <listitem>\r
100 <simpara>\r
101         The patch extracted from e-mail.\r
102 </simpara>\r
103 </listitem>\r
104 </varlistentry>\r
105 </variablelist>\r
106 </simplesect>\r
107 <simplesect id="_author">\r
108 <title>Author</title>\r
109 <simpara>Written by Linus Torvalds &lt;<ulink url="mailto:torvalds@osdl.org">torvalds@osdl.org</ulink>&gt; and\r
110 Junio C Hamano &lt;<ulink url="mailto:gitster@pobox.com">gitster@pobox.com</ulink>&gt;</simpara>\r
111 </simplesect>\r
112 <simplesect id="_documentation">\r
113 <title>Documentation</title>\r
114 <simpara>Documentation by Junio C Hamano and the git-list &lt;<ulink url="mailto:git@vger.kernel.org">git@vger.kernel.org</ulink>&gt;.</simpara>\r
115 </simplesect>\r
116 <simplesect id="_git">\r
117 <title>GIT</title>\r
118 <simpara>Part of the <xref linkend="git(1)"/> suite</simpara>\r
119 </simplesect>\r
120 </article>\r