git-mailinfo.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
   2     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
   6 <meta name="generator" content="AsciiDoc 8.2.5" />
   7 <style type="text/css">
   8 /* Debug borders */
   9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
  10 /*
  11   border: 1px solid red;
  12 */
  13 }
  14
  15 body {
  16   margin: 1em 5% 1em 5%;
  17 }
  18
  19 a {
  20   color: blue;
  21   text-decoration: underline;
  22 }
  23 a:visited {
  24   color: fuchsia;
  25 }
  26
  27 em {
  28   font-style: italic;
  29 }
  30
  31 strong {
  32   font-weight: bold;
  33 }
  34
  35 tt {
  36   color: navy;
  37 }
  38
  39 h1, h2, h3, h4, h5, h6 {
  40   color: #527bbd;
  41   font-family: sans-serif;
  42   margin-top: 1.2em;
  43   margin-bottom: 0.5em;
  44   line-height: 1.3;
  45 }
  46
  47 h1, h2, h3 {
  48   border-bottom: 2px solid silver;
  49 }
  50 h2 {
  51   padding-top: 0.5em;
  52 }
  53 h3 {
  54   float: left;
  55 }
  56 h3 + * {
  57   clear: left;
  58 }
  59
  60 div.sectionbody {
  61   font-family: serif;
  62   margin-left: 0;
  63 }
  64
  65 hr {
  66   border: 1px solid silver;
  67 }
  68
  69 p {
  70   margin-top: 0.5em;
  71   margin-bottom: 0.5em;
  72 }
  73
  74 pre {
  75   padding: 0;
  76   margin: 0;
  77 }
  78
  79 span#author {
  80   color: #527bbd;
  81   font-family: sans-serif;
  82   font-weight: bold;
  83   font-size: 1.1em;
  84 }
  85 span#email {
  86 }
  87 span#revision {
  88   font-family: sans-serif;
  89 }
  90
  91 div#footer {
  92   font-family: sans-serif;
  93   font-size: small;
  94   border-top: 2px solid silver;
  95   padding-top: 0.5em;
  96   margin-top: 4.0em;
  97 }
  98 div#footer-text {
  99   float: left;
 100   padding-bottom: 0.5em;
 101 }
 102 div#footer-badges {
 103   float: right;
 104   padding-bottom: 0.5em;
 105 }
 106
 107 div#preamble,
 108 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
 109 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 110 div.admonitionblock {
 111   margin-right: 10%;
 112   margin-top: 1.5em;
 113   margin-bottom: 1.5em;
 114 }
 115 div.admonitionblock {
 116   margin-top: 2.5em;
 117   margin-bottom: 2.5em;
 118 }
 119
 120 div.content { /* Block element content. */
 121   padding: 0;
 122 }
 123
 124 /* Block element titles. */
 125 div.title, caption.title {
 126   font-family: sans-serif;
 127   font-weight: bold;
 128   text-align: left;
 129   margin-top: 1.0em;
 130   margin-bottom: 0.5em;
 131 }
 132 div.title + * {
 133   margin-top: 0;
 134 }
 135
 136 td div.title:first-child {
 137   margin-top: 0.0em;
 138 }
 139 div.content div.title:first-child {
 140   margin-top: 0.0em;
 141 }
 142 div.content + div.title {
 143   margin-top: 0.0em;
 144 }
 145
 146 div.sidebarblock > div.content {
 147   background: #ffffee;
 148   border: 1px solid silver;
 149   padding: 0.5em;
 150 }
 151
 152 div.listingblock {
 153   margin-right: 0%;
 154 }
 155 div.listingblock > div.content {
 156   border: 1px solid silver;
 157   background: #f4f4f4;
 158   padding: 0.5em;
 159 }
 160
 161 div.quoteblock > div.content {
 162   padding-left: 2.0em;
 163 }
 164
 165 div.attribution {
 166   text-align: right;
 167 }
 168 div.verseblock + div.attribution {
 169   text-align: left;
 170 }
 171
 172 div.admonitionblock .icon {
 173   vertical-align: top;
 174   font-size: 1.1em;
 175   font-weight: bold;
 176   text-decoration: underline;
 177   color: #527bbd;
 178   padding-right: 0.5em;
 179 }
 180 div.admonitionblock td.content {
 181   padding-left: 0.5em;
 182   border-left: 2px solid silver;
 183 }
 184
 185 div.exampleblock > div.content {
 186   border-left: 2px solid silver;
 187   padding: 0.5em;
 188 }
 189
 190 div.verseblock div.content {
 191   white-space: pre;
 192 }
 193
 194 div.imageblock div.content { padding-left: 0; }
 195 div.imageblock img { border: 1px solid silver; }
 196 span.image img { border-style: none; }
 197
 198 dl {
 199   margin-top: 0.8em;
 200   margin-bottom: 0.8em;
 201 }
 202 dt {
 203   margin-top: 0.5em;
 204   margin-bottom: 0;
 205   font-style: italic;
 206 }
 207 dd > *:first-child {
 208   margin-top: 0;
 209 }
 210
 211 ul, ol {
 212     list-style-position: outside;
 213 }
 214 div.olist2 ol {
 215   list-style-type: lower-alpha;
 216 }
 217
 218 div.tableblock > table {
 219   border: 3px solid #527bbd;
 220 }
 221 thead {
 222   font-family: sans-serif;
 223   font-weight: bold;
 224 }
 225 tfoot {
 226   font-weight: bold;
 227 }
 228
 229 div.hlist {
 230   margin-top: 0.8em;
 231   margin-bottom: 0.8em;
 232 }
 233 div.hlist td {
 234   padding-bottom: 5px;
 235 }
 236 td.hlist1 {
 237   vertical-align: top;
 238   font-style: italic;
 239   padding-right: 0.8em;
 240 }
 241 td.hlist2 {
 242   vertical-align: top;
 243 }
 244
 245 @media print {
 246   div#footer-badges { display: none; }
 247 }
 248
 249 div#toctitle {
 250   color: #527bbd;
 251   font-family: sans-serif;
 252   font-size: 1.1em;
 253   font-weight: bold;
 254   margin-top: 1.0em;
 255   margin-bottom: 0.1em;
 256 }
 257
 258 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 259   margin-top: 0;
 260   margin-bottom: 0;
 261 }
 262 div.toclevel2 {
 263   margin-left: 2em;
 264   font-size: 0.9em;
 265 }
 266 div.toclevel3 {
 267   margin-left: 4em;
 268   font-size: 0.9em;
 269 }
 270 div.toclevel4 {
 271   margin-left: 6em;
 272   font-size: 0.9em;
 273 }
 274 include1::./stylesheets/xhtml11-manpage.css[]
 275 /* Workarounds for IE6's broken and incomplete CSS2. */
 276
 277 div.sidebar-content {
 278   background: #ffffee;
 279   border: 1px solid silver;
 280   padding: 0.5em;
 281 }
 282 div.sidebar-title, div.image-title {
 283   font-family: sans-serif;
 284   font-weight: bold;
 285   margin-top: 0.0em;
 286   margin-bottom: 0.5em;
 287 }
 288
 289 div.listingblock div.content {
 290   border: 1px solid silver;
 291   background: #f4f4f4;
 292   padding: 0.5em;
 293 }
 294
 295 div.quoteblock-content {
 296   padding-left: 2.0em;
 297 }
 298
 299 div.exampleblock-content {
 300   border-left: 2px solid silver;
 301   padding-left: 0.5em;
 302 }
 303
 304 /* IE6 sets dynamically generated links as visited. */
 305 div#toc a:visited { color: blue; }
 306 </style>
 307 <title>git-mailinfo(1)</title>
 308 </head>
 309 <body>
 310 <div id="header">
 311 <h1>
 312 git-mailinfo(1) Manual Page
 313 </h1>
 314 <h2>NAME</h2>
 315 <div class="sectionbody">
 316 <p>git-mailinfo -
 317    Extracts patch and authorship from a single e-mail message
 318 </p>
 319 </div>
 320 </div>
 321 <h2>SYNOPSIS</h2>
 322 <div class="sectionbody">
 323 <div class="para"><p><em>git mailinfo</em> [-k|-b] [-u | --encoding=&lt;encoding&gt; | -n] [--scissors] &lt;msg&gt; &lt;patch&gt;</p></div>
 324 </div>
 325 <h2 id="_description">DESCRIPTION</h2>
 326 <div class="sectionbody">
 327 <div class="para"><p>Reads a single e-mail message from the standard input, and
 328 writes the commit log message in &lt;msg&gt; file, and the patches in
 329 &lt;patch&gt; file.  The author name, e-mail and e-mail subject are
 330 written out to the standard output to be used by <em>git am</em>
 331 to create a commit.  It is usually not necessary to use this
 332 command directly.  See <a href="git-am.html">git-am(1)</a> instead.</p></div>
 333 </div>
 334 <h2 id="_options">OPTIONS</h2>
 335 <div class="sectionbody">
 336 <div class="vlist"><dl>
 337 <dt>
 338 -k
 339 </dt>
 340 <dd>
 341 <p>
 342         Usually the program <em>cleans up</em> the Subject: header line
 343         to extract the title line for the commit log message,
 344         among which (1) remove <em>Re:</em> or <em>re:</em>, (2) leading
 345         whitespaces, (3) <em>[</em> up to <em>]</em>, typically <em>[PATCH]</em>, and
 346         then prepends "[PATCH] ".  This flag forbids this
 347         munging, and is most useful when used to read back
 348         <em>git format-patch -k</em> output.
 349 </p>
 350 </dd>
 351 <dt>
 352 -b
 353 </dt>
 354 <dd>
 355 <p>
 356         When -k is not in effect, all leading strings bracketed with <em>[</em>
 357         and <em>]</em> pairs are stripped.  This option limits the stripping to
 358         only the pairs whose bracketed string contains the word "PATCH".
 359 </p>
 360 </dd>
 361 <dt>
 362 -u
 363 </dt>
 364 <dd>
 365 <p>
 366         The commit log message, author name and author email are
 367         taken from the e-mail, and after minimally decoding MIME
 368         transfer encoding, re-coded in the charset specified by
 369         i18n.commitencoding (defaulting to UTF-8) by transliterating
 370         them.  This used to be optional but now it is the default.
 371 </p>
 372 <div class="para"><p>Note that the patch is always used as-is without charset
 373 conversion, even with this flag.</p></div>
 374 </dd>
 375 <dt>
 376 --encoding=&lt;encoding&gt;
 377 </dt>
 378 <dd>
 379 <p>
 380         Similar to -u.  But when re-coding, the charset specified here is
 381         used instead of the one specified by i18n.commitencoding or UTF-8.
 382 </p>
 383 </dd>
 384 <dt>
 385 -n
 386 </dt>
 387 <dd>
 388 <p>
 389         Disable all charset re-coding of the metadata.
 390 </p>
 391 </dd>
 392 <dt>
 393 --scissors
 394 </dt>
 395 <dd>
 396 <p>
 397         Remove everything in body before a scissors line.  A line that
 398         mainly consists of scissors (either "&gt;8" or "8&lt;") and perforation
 399         (dash "-") marks is called a scissors line, and is used to request
 400         the reader to cut the message at that line.  If such a line
 401         appears in the body of the message before the patch, everything
 402         before it (including the scissors line itself) is ignored when
 403         this option is used.
 404 </p>
 405 <div class="para"><p>This is useful if you want to begin your message in a discussion thread
 406 with comments and suggestions on the message you are responding to, and to
 407 conclude it with a patch submission, separating the discussion and the
 408 beginning of the proposed commit log message with a scissors line.</p></div>
 409 <div class="para"><p>This can enabled by default with the configuration option mailinfo.scissors.</p></div>
 410 </dd>
 411 <dt>
 412 --no-scissors
 413 </dt>
 414 <dd>
 415 <p>
 416         Ignore scissors lines. Useful for overriding mailinfo.scissors settings.
 417 </p>
 418 </dd>
 419 <dt>
 420 &lt;msg&gt;
 421 </dt>
 422 <dd>
 423 <p>
 424         The commit log message extracted from e-mail, usually
 425         except the title line which comes from e-mail Subject.
 426 </p>
 427 </dd>
 428 <dt>
 429 &lt;patch&gt;
 430 </dt>
 431 <dd>
 432 <p>
 433         The patch extracted from e-mail.
 434 </p>
 435 </dd>
 436 </dl></div>
 437 </div>
 438 <h2 id="_author">Author</h2>
 439 <div class="sectionbody">
 440 <div class="para"><p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt; and
 441 Junio C Hamano &lt;gitster@pobox.com&gt;</p></div>
 442 </div>
 443 <h2 id="_documentation">Documentation</h2>
 444 <div class="sectionbody">
 445 <div class="para"><p>Documentation by Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p></div>
 446 </div>
 447 <h2 id="_git">GIT</h2>
 448 <div class="sectionbody">
 449 <div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
 450 </div>
 451 <div id="footer">
 452 <div id="footer-text">
 453 Last updated 2010-09-18 23:56:48 UTC
 454 </div>
 455 </div>
 456 </body>
 457 </html>