git/Documentation/git-mailinfo.txt

   1 git-mailinfo(1)
   2 ===============
   3
   4 NAME
   5 ----
   6 git-mailinfo - Extracts patch and authorship from a single e-mail message
   7
   8
   9 SYNOPSIS
  10 --------
  11 'git-mailinfo' [-k] [-u | --encoding=<encoding>] <msg> <patch>
  12
  13
  14 DESCRIPTION
  15 -----------
  16 Reading a single e-mail message from the standard input, and
  17 writes the commit log message in <msg> file, and the patches in
  18 <patch> file.  The author name, e-mail and e-mail subject are
  19 written out to the standard output to be used by git-am
  20 to create a commit.  It is usually not necessary to use this
  21 command directly.  See gitlink:git-am[1] instead.
  22
  23
  24 OPTIONS
  25 -------
  26 -k::
  27         Usually the program 'cleans up' the Subject: header line
  28         to extract the title line for the commit log message,
  29         among which (1) remove 'Re:' or 're:', (2) leading
  30         whitespaces, (3) '[' up to ']', typically '[PATCH]', and
  31         then prepends "[PATCH] ".  This flag forbids this
  32         munging, and is most useful when used to read back 'git
  33         format-patch -k' output.
  34
  35 -u::
  36         The commit log message, author name and author email are
  37         taken from the e-mail, and after minimally decoding MIME
  38         transfer encoding, re-coded in UTF-8 by transliterating
  39         them.  This used to be optional but now it is the default.
  40 +
  41 Note that the patch is always used as-is without charset
  42 conversion, even with this flag.
  43
  44 --encoding=<encoding>::
  45         Similar to -u but if the local convention is different
  46         from what is specified by i18n.commitencoding, this flag
  47         can be used to override it.
  48
  49 <msg>::
  50         The commit log message extracted from e-mail, usually
  51         except the title line which comes from e-mail Subject.
  52
  53 <patch>::
  54         The patch extracted from e-mail.
  55
  56
  57 Author
  58 ------
  59 Written by Linus Torvalds <torvalds@osdl.org> and
  60 Junio C Hamano <junkio@cox.net>
  61
  62
  63 Documentation
  64 --------------
  65 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
  66
  67 GIT
  68 ---
  69 Part of the gitlink:git[7] suite