doc/source/en/TortoiseGit/git_doc/git-mailinfo.xml

   1 <?xml version="1.0" encoding="UTF-8"?>\r
   2 <!DOCTYPE sect2 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">\r
   3 \r
   4 <sect2 lang="en" id="git-mailinfo(1)">\r
   5     <title>git-mailinfo(1)</title>\r
   6 <indexterm>\r
   7 <primary>git-mailinfo(1)</primary>\r
   8 </indexterm>\r
   9 <simplesect id="git-mailinfo(1)__name">\r
  10 <title>NAME</title>\r
  11 <simpara>git-mailinfo - Extracts patch and authorship from a single e-mail message</simpara>\r
  12 </simplesect>\r
  13 <simplesect id="git-mailinfo(1)__synopsis">\r
  14 <title>SYNOPSIS</title>\r
  15 <blockquote>\r
  16 <literallayout><emphasis>git mailinfo</emphasis> [-k|-b] [-u | --encoding=&lt;encoding&gt; | -n] [--scissors] &lt;msg&gt; &lt;patch&gt;</literallayout>\r
  17 </blockquote>\r
  18 </simplesect>\r
  19 <simplesect id="git-mailinfo(1)__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="git-mailinfo(1)__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 removes email cruft from the Subject:\r
  38         header line to extract the title line for the commit log\r
  39         message.  This option prevents this munging, and is most\r
  40         useful when used to read back <emphasis>git format-patch -k</emphasis> output.\r
  41 </simpara>\r
  42 <simpara>Specifically, the following are removed until none of them remain:</simpara>\r
  43 <itemizedlist>\r
  44 <listitem>\r
  45 <simpara>\r
  46 Leading and trailing whitespace.\r
  47 </simpara>\r
  48 </listitem>\r
  49 <listitem>\r
  50 <simpara>\r
  51 Leading <emphasis>Re:</emphasis>, <emphasis>re:</emphasis>, and <emphasis>:</emphasis>.\r
  52 </simpara>\r
  53 </listitem>\r
  54 <listitem>\r
  55 <simpara>\r
  56 Leading bracketed strings (between <emphasis>[</emphasis> and <emphasis>]</emphasis>, usually\r
  57         <emphasis>[PATCH]</emphasis>).\r
  58 </simpara>\r
  59 </listitem>\r
  60 </itemizedlist>\r
  61 <simpara>Finally, runs of whitespace are normalized to a single ASCII space\r
  62 character.</simpara>\r
  63 </listitem>\r
  64 </varlistentry>\r
  65 <varlistentry>\r
  66 <term>\r
  67 -b\r
  68 </term>\r
  69 <listitem>\r
  70 <simpara>\r
  71         When -k is not in effect, all leading strings bracketed with <emphasis>[</emphasis>\r
  72         and <emphasis>]</emphasis> pairs are stripped.  This option limits the stripping to\r
  73         only the pairs whose bracketed string contains the word "PATCH".\r
  74 </simpara>\r
  75 </listitem>\r
  76 </varlistentry>\r
  77 <varlistentry>\r
  78 <term>\r
  79 -u\r
  80 </term>\r
  81 <listitem>\r
  82 <simpara>\r
  83         The commit log message, author name and author email are\r
  84         taken from the e-mail, and after minimally decoding MIME\r
  85         transfer encoding, re-coded in the charset specified by\r
  86         i18n.commitencoding (defaulting to UTF-8) by transliterating\r
  87         them.  This used to be optional but now it is the default.\r
  88 </simpara>\r
  89 <simpara>Note that the patch is always used as-is without charset\r
  90 conversion, even with this flag.</simpara>\r
  91 </listitem>\r
  92 </varlistentry>\r
  93 <varlistentry>\r
  94 <term>\r
  95 --encoding=&lt;encoding&gt;\r
  96 </term>\r
  97 <listitem>\r
  98 <simpara>\r
  99         Similar to -u.  But when re-coding, the charset specified here is\r
 100         used instead of the one specified by i18n.commitencoding or UTF-8.\r
 101 </simpara>\r
 102 </listitem>\r
 103 </varlistentry>\r
 104 <varlistentry>\r
 105 <term>\r
 106 -n\r
 107 </term>\r
 108 <listitem>\r
 109 <simpara>\r
 110         Disable all charset re-coding of the metadata.\r
 111 </simpara>\r
 112 </listitem>\r
 113 </varlistentry>\r
 114 <varlistentry>\r
 115 <term>\r
 116 --scissors\r
 117 </term>\r
 118 <listitem>\r
 119 <simpara>\r
 120         Remove everything in body before a scissors line.  A line that\r
 121         mainly consists of scissors (either "&gt;8" or "8&lt;") and perforation\r
 122         (dash "-") marks is called a scissors line, and is used to request\r
 123         the reader to cut the message at that line.  If such a line\r
 124         appears in the body of the message before the patch, everything\r
 125         before it (including the scissors line itself) is ignored when\r
 126         this option is used.\r
 127 </simpara>\r
 128 <simpara>This is useful if you want to begin your message in a discussion thread\r
 129 with comments and suggestions on the message you are responding to, and to\r
 130 conclude it with a patch submission, separating the discussion and the\r
 131 beginning of the proposed commit log message with a scissors line.</simpara>\r
 132 <simpara>This can enabled by default with the configuration option mailinfo.scissors.</simpara>\r
 133 </listitem>\r
 134 </varlistentry>\r
 135 <varlistentry>\r
 136 <term>\r
 137 --no-scissors\r
 138 </term>\r
 139 <listitem>\r
 140 <simpara>\r
 141         Ignore scissors lines. Useful for overriding mailinfo.scissors settings.\r
 142 </simpara>\r
 143 </listitem>\r
 144 </varlistentry>\r
 145 <varlistentry>\r
 146 <term>\r
 147 &lt;msg&gt;\r
 148 </term>\r
 149 <listitem>\r
 150 <simpara>\r
 151         The commit log message extracted from e-mail, usually\r
 152         except the title line which comes from e-mail Subject.\r
 153 </simpara>\r
 154 </listitem>\r
 155 </varlistentry>\r
 156 <varlistentry>\r
 157 <term>\r
 158 &lt;patch&gt;\r
 159 </term>\r
 160 <listitem>\r
 161 <simpara>\r
 162         The patch extracted from e-mail.\r
 163 </simpara>\r
 164 </listitem>\r
 165 </varlistentry>\r
 166 </variablelist>\r
 167 </simplesect>\r
 168 <simplesect id="git-mailinfo(1)__git">\r
 169 <title>GIT</title>\r
 170 <simpara>Part of the <xref linkend="git(1)" /> suite</simpara>\r
 171 </simplesect>\r
 172 </sect2>\r