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

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